ParcelLabel API

2.0.x
(2 reviews)

Customs charges

Validating customs charges against Shipping Options

The Shipping Options API returns a "customs_charges_options" for each service, listing the valid incoterm/method combinations.

When submitting a request to create a label, the incoterm and method values under "customs_charges" must match one of the combinations listed in the customs charges options.

For more details, refer to Shipping Option API response link for the types of customs_charges_options returned by Shipping Options here.

Sample customs_charges_options resopnse from Shipping Options api:

"customs_charges_options": [
  {
    "incoterm": "DAP",
    "methods": [
      "COLLECT_FROM_RECEIVER"
    ]
  },
  {
    "incoterm": "DDP",
    "methods": [
      "TAX_NZP_REMIT",
      "TAX_SENDER_REMIT"
    ]
  }
]
  • COLLECT_FROM_RECEIVER: Duties and taxes (if applicable) are collected from the receiver.
  • TAX_NZP_REMIT: NZ Post handles EU VAT remittance on your behalf using its own IOSS number.
  • TAX_SENDER_REMIT: You supply your own IOSS number and take care of EU VAT remittance yourself.

Specify a single incoterm/method combination that matches one of the options listed in customs_charges_options.

For example: When shipping with a DDP service, specify incoterm as "DDP" and provide a customs charges option that is available for the selected service.

"customs_charges": {
    "incoterm": "DDP",
    "method": "TAX_NZP_REMIT"
}
  • If you provide incoterm or method, you cannot provide only one, both fields must be provided together.
  • If you do not provide, the system will default to one valid option, or if both DAP and DDP are valid, then it will default to DAP

Error Codes

Code Message Details Where to look?
400001 If providing customs_charges method, you also need to provide incoterm customs_charges data was invalid Check for the field 'incoterm' under 'customs_charges'
400001 If providing customs_charges incoterm, you also need to provide method customs_charges data was invalid Check for the field 'method' under 'customs_charges'
400001 The only valid incoterms are DAP and DDP. You provided: {customer_provided} customs_charges data was invalid Check for the field 'incoterm' under 'customs_charges'. It should be either "DDP" or "DAP"
400001 The destination country and service-code does not support your requested incoterm. You requested {customer_provided_incoterm}, and it only supports {supported_incoterm} customs_charges data was invalid Check for the field 'method' under 'customs_charges'
400001 The destination country and service-code supports your requested incoterm, but does not support the requested method. Supported methods: {supported_methods} customs_charges data was invalid Check for the field 'method' under 'customs_charges'

Reviews