Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Fees

Creates a fee

This method adds a new fee to an existing SKU.

post/fees

Request body

type'battery' | 'weee' | 'copyright' | 'e_waste' | 'packaging' required

The type of fee.

skuIdstring required

The unique identifer of the stock keeping unit associated with the fee.

categorystring required

The category of the fee as defined by regulatory law.

valuestring required

The value of the product.

amountnumber double required

The fee amount.

complianceAgencystring

The unique identifier of the recycling agency associated with the product's jurisdiction.

feeExemptionstring

Indicates whether business to business sales are exempt from paying the fee.

brandNamestring

The product's brand name.

weightAndUnitsstring

The weight of the unit, minus packaging or batteries, and the unit of measurement applied to the weight.

currencystring required

A three-letter ISO 4217 currency code.

countrystring required

A two-letter ISO 3166 country code.

subdivisionsstring[]

An array of ISO 3166-2 subdivision codes.

metadataMetadata

Key-value pairs used to store additional data. Value can be string, boolean or integer types.

Example request

{
  "type": "weee",
  "skuId": "sku_7834561209",
  "category": "3. IT and Telecommunication Equipment",
  "value": "85\" Class Q900 QLED Smart 8K UHD TV.",
  "amount": 0.5,
  "battery": {
    "quantity": 2,
    "chemicalSystem": "Alkaline",
    "iecCode": "R20"
  },
  "complianceAgency": "WEEE_ecologic",
  "feeExemption": "exempt",
  "brandName": "Samsung",
  "weightAndUnits": "3.00 kg",
  "currency": "USD",
  "country": "US",
  "subdivisions": [
    "CA"
  ],
  "metadata": {
    "coupon": "iOS"
  }
}

Response

201 Created

idstring

The unique identifier of the fee.

createdTimestring date-time

The time when the fee was created.

type'battery' | 'weee' | 'copyright' | 'e_waste' | 'packaging'

The type of fee.

skuIdstring

The unique identifer of the stock keeping unit associated with the fee.

categorystring

The category of the fee as defined by regulatory law.

valuestring

The value of the product.

amountnumber double

The fee amount.

complianceAgencystring

The unique identifier of the recycling agency associated with the product's jurisdiction.

feeExemptionstring

Indicates whether business to business sales are exempt from paying the fee.

brandNamestring

The product's brand name.

weightAndUnitsstring

The weight of the unit, minus packaging or batteries, and the unit of measurement applied to the weight.

rateAndUnitsstring

The fee amount to be charged per product quantity.

currencystring

A three-letter ISO 4217 currency code.

countrystring

A two-letter ISO 3166 country code.

subdivisionsstring[]

An array of ISO 3166-2 subdivision codes.

liveModeboolean

Has the value <code>true</code> if the object exists in live mode or the value <code>false</code> if the object exists in test mode.

metadataMetadata

Key-value pairs used to store additional data. Value can be string, boolean or integer types.

updatedTimestring date-time

Time when the fee was last updated.

Example response

{
  "id": "fee_1971b9b5-7d6b-49d5-b2a6-88ca7e53f750",
  "createdTime": "2018-04-25T20:36:00Z",
  "type": "weee",
  "skuId": "sku_7834561209",
  "category": "3. IT and Telecommunication Equipment",
  "value": "85\" Class Q900 QLED Smart 8K UHD TV.",
  "amount": 0.5,
  "battery": {
    "quantity": 2,
    "chemicalSystem": "Alkaline",
    "iecCode": "R20"
  },
  "feeExemption": "exempt",
  "brandName": "Samsung",
  "weightAndUnits": "3.00 kg",
  "rateAndUnits": "2.00 EUR",
  "currency": "USD",
  "country": "US",
  "subdivisions": [
    "CA"
  ],
  "metadata": {
    "coupon": "iOS"
  },
  "updatedTime": "2018-04-25T20:36:00Z"
}