Create Or Update Integration Shipment

The ID of the integration

The address of the shipment.

A secondary address of the shipment.

The company name of the shipment.

Timestamp when the shipment was created in the shop system. Example: 2022-05-07T15:08:12.152000Z

ISO 4217 currency code

Commercial invoice number

The type of shipment for customs purposes.

The email of the recipient.

External order ID assigned by the shop system

External shipment ID assigned by the shop system

House number of the recipient

Name of the recipient

Unique order number generated manually or by the shop system

Custom internal shop status ID

User-defined human readable status

Array of JSON objects describing each item in the parcel. Each item must include the following fields:

• description (string, required): Description of the product. Example: Bag
• hs_code (string): Harmonized System Code (<= 12 chars). Example: 01013000
• origin_country (string | null): ISO 3166-1 alpha-2 country code where the product was produced. Example: NL
• product_id (string): Internal product ID. Example: 1458734634
• properties (object): Key-value pairs with additional product properties (e.g., { "color": "Black" })
• quantity (integer, required): Number of units (>= 1). Example: 2
• sku (string): Internal stock keeping unit. Example: WW-DR-GR-XS-001
• value (string, required): Price per item as a decimal string. Example: 19.99
• weight (string | null): Weight per item as a decimal string. Example: 0.5
• mid_code (string | null): Manufacturer's Identification code. Example: NLOZR92MEL
• material_content (string | null): Description of materials. Example: 100% Cotton
• intended_use (string | null): Intended use of the contents. Example: Personal use

Example item JSON:

{
  "description": "Bag",
  "hs_code": "01013000",
  "origin_country": "NL",
  "product_id": "1458734634",
  "properties": { "color": "Black" },
  "quantity": 2,
  "sku": "WW-DR-GR-XS-001",
  "value": "19.99",
  "weight": "0.5",
  "mid_code": "NLOZR92MEL",
  "material_content": "100% Cotton",
  "intended_use": "Personal use"
}

Provide each array element as a JSON object string in the UI, or programmatically as an array of objects.

Custom internal payment status ID

User-defined payment status

Zip code of the recipient

Human readable shipping method name

The telephone number of the recipient.

The post number of the recipient.

Country of the recipient

The service point ID of the recipient.

The state of the recipient.

Timestamp when the shipment was updated in the shop system. Example: 2022-05-07T15:08:12.152000Z

The city of the shipment.

The unique identifier of the shipping method

Total price of the order (decimal string)

Total weight of the order (decimal string)

Object capturing checkout selections made by the end-consumer.

Required keys:

• sender_address_id (integer): The sender address ID associated with the order.
• shipping_product (object): The shipping product chosen at checkout. Must include:
  • code (string)
  • name (string)
  • selected_functionalities (array): Functionalities selected for this product.
• delivery_method_type (string): One of "standard_delivery", "nominated_day_delivery", or "same_day_delivery".
• delivery_method_data (object):
  • delivery_date (string, date-time): Delivery date required by the end-consumer.
  • formatted_delivery_date (string): Human-readable date (e.g., "February 21, 2012").
  • parcel_handover_date (string, date-time): Date the parcel must be handed to the carrier.

Example:

{
  "sender_address_id": 12345,
  "shipping_product": {
    "code": "pd-pickup",
    "name": "Pickup Point",
    "selected_functionalities": ["signature", "age_check"]
  },
  "delivery_method_type": "nominated_day_delivery",
  "delivery_method_data": {
    "delivery_date": "2025-02-20T09:00:00Z",
    "formatted_delivery_date": "February 20, 2025",
    "parcel_handover_date": "2025-02-19T18:00:00Z"
  }
}

Volumetric width (decimal string)

Volumetric height (decimal string)

Volumetric length (decimal string)

Optional object to provide order-level costs and tax numbers.

• discount_granted (object): Discount granted on the total order
  • value (string | null): Decimal amount (e.g., "3.99"), pattern: [\d]+(.[\d]+)?
  • currency (string | null): ISO 4217 code (e.g., "EUR")
• insurance_costs (object): Amount the order is insured for
  • value (string | null): Decimal amount (e.g., "3.99"), pattern: [\d]+(.[\d]+)?
  • currency (string | null): ISO 4217 code (e.g., "EUR")
• freight_costs (object): Shipping cost of the order
  • value (string | null): Decimal amount (e.g., "3.99"), pattern: [\d]+(.[\d]+)?
  • currency (string | null): ISO 4217 code (e.g., "EUR")
• other_costs (object): Any other costs (e.g., wrapping costs)
  • value (string | null): Decimal amount (e.g., "3.99"), pattern: [\d]+(.[\d]+)?
  • currency (string | null): ISO 4217 code (e.g., "EUR")
• tax_numbers (object | null): Tax info about sender, receiver, and importer of records
  • sender (array of Tax Number): Each has { name (string|null), country_code (string|null), value (string|null) }
  • receiver (array of Tax Number): Same structure as sender
  • importer_of_records (array of Tax Number): Same structure as sender

Example:

{
  "discount_granted": { "value": "3.99", "currency": "EUR" },
  "insurance_costs": { "value": "2.50", "currency": "EUR" },
  "freight_costs": { "value": "5.00", "currency": "EUR" },
  "other_costs": { "value": null, "currency": null },
  "tax_numbers": {
    "sender": [{ "name": "VAT", "country_code": "NL", "value": "NL987654321B02" }],
    "receiver": [],
    "importer_of_records": []
  }
}