CommunitySupport PortalYouTubeFree trialSign Up!

Item fee management

Retrieve all itemFees

get

Retrieve all itemFees.

Authorizations
Path parameters
tenantstringRequired

the tenant to work on.

Example: testtenant
Query parameters
siteCodestringOptional

A list of site codes.

Default: main
feeIdsstringOptional

A list of feeIds.

productIdsstringOptional

A list of product Ids.

expandbooleanOptional

Whether only the fee-id is in the response or the full fees.

Default: false
pageNumberinteger · min: 1Optional

The page number to be retrieved where the size of the pages must be specified by the pageSize parameter. The number of the first page is 1.

Default: 1
pageSizeinteger · min: 1Optional

The number of documents being retrieved on one page.

Default: 16
siteFallbackbooleanOptionalDefault: false
Header parameters
Accept-Languagestring · min: 1Optional

The value of the locale identifier of the language in which the attribute should be returned. Provide several values separated by comma, in order to specify fallback languages.

Default: *
Responses
200

Request was successful.

application/json
get
/fee/{tenant}/itemFees
GET /fee/{tenant}/itemFees HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "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 Packaging Fee",
        "code": "apple_packaging_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"
  }
]

Creating an itemFee

post

Creates a new itemFee. This endpoint allows you to assign one or more predefined fees to a specific item within a tenant. By associating fees with items, you can manage charges such as packaging, handling, or other service fees directly at the item level.

Required scopes

  • fee.item_create

Authorizations
Path parameters
tenantstringRequired

the tenant to work on.

Example: testtenant
Header parameters
Content-LanguagestringOptional

The locale identifier of the language of the updated attribute.

Body
idstringOptional

Unique identifier of the item fee.

siteCodestringRequired

The SiteCode this fee belongs to.

itemYrnstringRequired

YRN of the item to assign fees to.

feeIdsstring[]Required

List of unique identifiers of fees to assign to the item.

Responses
201

The resource has been successfully created.

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

{
  "siteCode": "main",
  "itemYrn": "urn:yaas:saasag:caasproduct:product:tenantName;5c2e4957a46b0e0008491095",
  "feeIds": [
    "57b30fd2289c48001daf5486",
    "96b30fd4586c48001daf1752"
  ]
}
{
  "id": "5d80a196eec29e04726e921e",
  "yrn": "urn:yaas:saasag:fee:id:tenantName;5d80a196eec29e04726e921e"
}

Retrieving all item fees

get

Retrieves all item fees for specified itemYRN.

Authorizations
Path parameters
itemYRNstringRequired
tenantstringRequired

the tenant to work on.

Example: testtenant
Query parameters
siteCodestringOptional

A list of site codes.

Default: main
expandbooleanOptional

Whether only the fee-id is in the response or the full fees.

Default: false
Header parameters
Accept-Languagestring · min: 1Optional

The value of the locale identifier of the language in which the attribute should be returned. Provide several values separated by comma, in order to specify fallback languages.

Default: *
Responses
200Success
application/json
Responseone of
or
string[]OptionalExample: ["57b30fd2289c48001daf5486","96b30fd4586c48001daf1752"]
get
/fee/{tenant}/itemFees/{itemYRN}/fees
GET /fee/{tenant}/itemFees/{itemYRN}/fees HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "5d94587853b0c7036ab0ab7b",
    "active": true,
    "code": "lemon_picking_fee",
    "feeAbsolute": {
      "amount": 4.5,
      "currency": "EUR"
    },
    "feeType": "ABSOLUTE",
    "name": "Lemon Picking Fee",
    "siteCode": "main",
    "taxable": false,
    "yrn": "urn:yaas:saasag:fee:id:tenantName;5d94587853b0c7036ab0ab7b"
  },
  {
    "id": "5d94587853b0c7036ab0ab7b",
    "active": true,
    "code": "apple_picking_fee",
    "feeAbsolute": {
      "amount": 3.5,
      "currency": "EUR"
    },
    "feeType": "ABSOLUTE",
    "name": "Apple Picking Fee",
    "siteCode": "main",
    "taxable": false,
    "yrn": "urn:yaas:saasag:fee:id:tenantName;5d9457d953b0c7036ab0ab7a"
  }
]

Adding a list of fees to an item

put

Adds a list of feeIds to the itemYRN.

Required scopes

  • fee.item_update

Authorizations
Path parameters
itemYRNstringRequired
tenantstringRequired

the tenant to work on.

Example: testtenant
Query parameters
partialbooleanOptional

Boolean parameter that defines the update type. By default, its value is false. For partial updates, the value is true.

Default: false
Body
feeIdsstring[]Required
Responses
200

FeeIds successfully added.

No content
put
/fee/{tenant}/itemFees/{itemYRN}/fees
PUT /fee/{tenant}/itemFees/{itemYRN}/fees HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "feeIds": [
    "57b30fd2289c48001daf5486",
    "96b30fd4586c48001daf1752"
  ]
}
No content

Deleting an item fee with itemYRN

delete

Deletes item fee with the specified itemYRN.

Required scopes

  • fee.item_delete

Authorizations
Path parameters
itemYRNstringRequired
tenantstringRequired

the tenant to work on.

Example: testtenant
Responses
204

Item fee successfully deleted

No content
delete
/fee/{tenant}/itemFees/{itemYRN}/fees
DELETE /fee/{tenant}/itemFees/{itemYRN}/fees HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Deleting a fee from the itemYRN

delete

Deletes a fee for the specified itemYRN and optionally deletes item fee if does not contain any more fee ids.

Required scopes

  • fee.item_delete

Authorizations
Path parameters
itemYRNstringRequired
tenantstringRequired

the tenant to work on.

Example: testtenant
feeIdstringRequired
Responses
204

Fee successfully deleted from itemYRN.

No content
delete
/fee/{tenant}/itemFees/{itemYRN}/fees/{feeId}
DELETE /fee/{tenant}/itemFees/{itemYRN}/fees/{feeId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content
PreviousFee managementNextProduct fees management

Was this helpful?