Community Support Portal YouTube Start a free trial

Item Fee search

PreviousProduct Fees management NextModels

Was this helpful?

Searching itemFees by product ID

post

Search itemFees by product ID.

Authorizations

Path parameters

tenantstringRequired

the tenant to work on.

Example: testtenant

Body

Search ItemFee request body.

productIdstringRequired

siteCodesstring[]Required

pageNumberintegerOptionalDefault: 1

pageSizeintegerOptionalDefault: 16

Responses

200Success

application/json

400

Request was syntactically incorrect. Any details will be provided within the response payload.

application/json

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

application/json

403

Access token does not contain necessary scopes or tenant in path does not match tenant from token.

application/json

post

POST /fee/{tenant}/itemFees/searchByProductId HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "productId": "Apple_A_productId",
  "siteCodes": [
    "example_site_code"
  ],
  "pageNumber": 1,
  "pageSize": 10
}

[
  {
    "id": "5d94b80beec29eba2ad2793e",
    "feeIds": [
      "5d94b7e8eec29eba2ad2793d"
    ],
    "itemYrn": "urn:yaas:saasag:caasproduct:product:tenantName;5d934ed1eec29e0f8706b381",
    "siteCode": "main",
    "fees": [
      {
        "name": "Pear Fee",
        "code": "pear_fee",
        "feeType": "ABSOLUTE",
        "siteCode": "main",
        "feeAbsolute": {
          "amount": 2.5,
          "currency": "EUR"
        },
        "active": true,
        "taxable": false
      },
      {
        "name": "Plum Fee",
        "code": "plum_fee",
        "feeType": "ABSOLUTE",
        "siteCode": "main",
        "feeAbsolute": {
          "amount": 2.99,
          "currency": "EUR"
        },
        "active": true,
        "taxable": false
      }
    ]
  },
  {
    "id": "5d94b674eec29eba2ad2793a",
    "feeIds": [
      "5d94b5ffeec29eba2ad27938",
      "5d94b610eec29eba2ad27939"
    ],
    "fees": [
      {
        "name": "Apple Picking Fee",
        "code": "apple_picking_fee",
        "feeType": "ABSOLUTE",
        "siteCode": "main",
        "feeAbsolute": {
          "amount": 3.5,
          "currency": "EUR"
        },
        "active": true,
        "taxable": false
      },
      {
        "name": "Apple Mackintosh Fee",
        "code": "apple_mackintosh_fee",
        "feeType": "ABSOLUTE",
        "siteCode": "main",
        "feeAbsolute": {
          "amount": 4.5,
          "currency": "EUR"
        },
        "active": true,
        "taxable": false
      }
    ],
    "itemYrn": "urn:yaas:saasag:caasproduct:product:tenantName;5c2e4957a46b0e0008491095",
    "siteCode": "main"
  }
]

Searching itemFees by product IDs

post

Search itemFees by multiple product IDs.

Authorizations

Path parameters

tenantstringRequired

the tenant to work on.

Example: testtenant

Query parameters

siteFallbackbooleanOptionalDefault: false

Body

Search ItemsFee request body.

productIdsstringRequired

siteCodestringRequired

pageNumberintegerOptionalDefault: 1

pageSizeintegerOptionalDefault: 16

Responses

200Success

application/json

400

Request was syntactically incorrect. Any details will be provided within the response payload.

application/json

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

application/json

403

Access token does not contain necessary scopes or tenant in path does not match tenant from token.

application/json

post

POST /fee/{tenant}/itemFees/searchByProductIds HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "productIds": "Apple_A_productId,Apple_B_productId",
  "siteCode": "example_site_code",
  "pageNumber": 1,
  "pageSize": 10
}

[
  {
    "id": "5d94b80beec29eba2ad2793e",
    "feeIds": [
      "5d94b7e8eec29eba2ad2793d"
    ],
    "itemYrn": "urn:yaas:saasag:caasproduct:product:tenantName;5d934ed1eec29e0f8706b381",
    "siteCode": "main",
    "fees": [
      {
        "name": "Pear Fee",
        "code": "pear_fee",
        "feeType": "ABSOLUTE",
        "siteCode": "main",
        "feeAbsolute": {
          "amount": 2.5,
          "currency": "EUR"
        },
        "active": true,
        "taxable": false
      },
      {
        "name": "Plum Fee",
        "code": "plum_fee",
        "feeType": "ABSOLUTE",
        "siteCode": "main",
        "feeAbsolute": {
          "amount": 2.99,
          "currency": "EUR"
        },
        "active": true,
        "taxable": false
      }
    ]
  },
  {
    "id": "5d94b674eec29eba2ad2793a",
    "feeIds": [
      "5d94b5ffeec29eba2ad27938",
      "5d94b610eec29eba2ad27939"
    ],
    "fees": [
      {
        "name": "Apple Picking Fee",
        "code": "apple_picking_fee",
        "feeType": "ABSOLUTE",
        "siteCode": "main",
        "feeAbsolute": {
          "amount": 3.5,
          "currency": "EUR"
        },
        "active": true,
        "taxable": false
      },
      {
        "name": "Apple Mackintosh Fee",
        "code": "apple_mackintosh_fee",
        "feeType": "ABSOLUTE",
        "siteCode": "main",
        "feeAbsolute": {
          "amount": 4.5,
          "currency": "EUR"
        },
        "active": true,
        "taxable": false
      }
    ],
    "itemYrn": "urn:yaas:saasag:caasproduct:product:tenantName;5c2e4957a46b0e0008491095",
    "siteCode": "main"
  }
]

Checking if a fee has been applied

post

Checks if the itemYrns in the request have a fee applied to. Responds with the itemYRN and the corresponding fees.

Authorizations

Path parameters

tenantstringRequired

the tenant to work on.

Example: testtenant

Query parameters

siteCodestringOptional

A list of site codes.

Default: main

Body

the itemYrns this fee is applied to

itemYrnsstring[]RequiredExample:

["urn:yaas:saasag:caasproduct:product:tenantName;5c2e4957a46b0e0008491095","urn:yaas:saasag:caasproduct:product:tenantName;5c2e4957a46b0e0008491096"]

siteCodestringRequiredExample: main

Responses

200Success

application/json

400

Request was syntactically incorrect. Any details will be provided within the response payload.

application/json

401

Given request is unauthorized - the authorization token is invalid or has expired. Details will be provided in the response payload.

application/json

403

Access token does not contain necessary scopes or tenant in path does not match tenant from token.

application/json

post

POST /fee/{tenant}/itemFees/search HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 180

{
  "itemYrns": [
    "urn:yaas:saasag:caasproduct:product:tenantName;5c2e4957a46b0e0008491095",
    "urn:yaas:saasag:caasproduct:product:tenantName;5c2e4957a46b0e0008491096"
  ],
  "siteCode": "main"
}

[
  {
    "id": "5d94b80beec29eba2ad2793e",
    "feeIds": [
      "5d94b7e8eec29eba2ad2793d"
    ],
    "itemYrn": "urn:yaas:saasag:caasproduct:product:tenantName;5d934ed1eec29e0f8706b381",
    "siteCode": "main",
    "fees": [
      {
        "name": "Pear Fee",
        "code": "pear_fee",
        "feeType": "ABSOLUTE",
        "siteCode": "main",
        "feeAbsolute": {
          "amount": 2.5,
          "currency": "EUR"
        },
        "active": true,
        "taxable": false
      },
      {
        "name": "Plum Fee",
        "code": "plum_fee",
        "feeType": "ABSOLUTE",
        "siteCode": "main",
        "feeAbsolute": {
          "amount": 2.99,
          "currency": "EUR"
        },
        "active": true,
        "taxable": false
      }
    ]
  },
  {
    "id": "5d94b674eec29eba2ad2793a",
    "feeIds": [
      "5d94b5ffeec29eba2ad27938",
      "5d94b610eec29eba2ad27939"
    ],
    "fees": [
      {
        "name": "Apple Picking Fee",
        "code": "apple_picking_fee",
        "feeType": "ABSOLUTE",
        "siteCode": "main",
        "feeAbsolute": {
          "amount": 3.5,
          "currency": "EUR"
        },
        "active": true,
        "taxable": false
      },
      {
        "name": "Apple Mackintosh Fee",
        "code": "apple_mackintosh_fee",
        "feeType": "ABSOLUTE",
        "siteCode": "main",
        "feeAbsolute": {
          "amount": 4.5,
          "currency": "EUR"
        },
        "active": true,
        "taxable": false
      }
    ],
    "itemYrn": "urn:yaas:saasag:caasproduct:product:tenantName;5c2e4957a46b0e0008491095",
    "siteCode": "main"
  }
]