Identifiers and Classifications

Use identifiers and classifications to identify parties such as carriers or other IDs like an Order ID.

You can add the following information for identification and classification purposes:

  • A description
  • Your e-commerce/order IDs
  • A parcel reference text
  • The product's class
  • A carrier ID

You add these as fields in the JSON for the relevant request.

The following table summarizes the relevant fields:

FieldDescription
descriptionThis is the description of the product being sold and will appear on the VAT invoice.
product_classUsed to specify if goods are physical or services. For example, 'P' = 'Physical Goods' or 'D' = 'Digital Goods' and 'S' = 'Services' (for example, for shipping or postage or insurance).
See Product Classes.
custom_idIdentifier for the specific transaction line item. See Custom IDs.
parcel_referenceIdentifier reference for the parcel. (This field is optional.)
carrier_idIdentifier for the postal carrier.

For example:

"description": "Example sale to GB.",
		"transaction_lines": [
			{
				"custom_id": "line_1",
				"amount": 150,
				"ship_from_address": {"country_code": "CN"},
				"product_class": "P",
				"description": "Goods #1",				
				"parcel_reference": "3897329872423",
				"carrier_id": "DHL", 
			},