Body

• items array[object] Required

  The items included in this shipment or return.

  Hide items attributes Show items attributes object

  • sku string Required

    Marketplace SKU of the product.

  • reference string | null

    The reference value specifies the product reference given by a merchant.

  • article_number string | null

    The article number value specifies the manufacturer product number (MPN).

  • manufacturer string Required

    Brand / manufacturer name.

  • name string Required

    Product name.

  • size string Required

    Product size.

  • color string Required

    Product colour.

  • quantity integer Required

    Number of units of this item.

  • image string Required

    URL of the product image.

  • price number(float) Required

    Unit price of the item including VAT, in the order currency.

  • shipment_item_id string Required

    Opaque identifier of this item within the shipment.

• shipping_address object Required

  Shipping address of the order.

  Hide shipping_address attributes Show shipping_address attributes object

  • name string Required

    Full name of the recipient at this address.

  • street string Required

    Street name.

  • housenumber string Required

    House number, including any suffix (e.g. 12A).

  • postcode string Required

    Postal code.

  • city string Required

    City.

  • province string | null

    Province or region; null when not applicable.

  • country string Required

    Two-letter ISO 3166-1 alpha-2 country code (e.g. NL).

  • email string Required

    Customer e-mail address.

• shipment_id string Required

  Winkelstraat shipment increment ID (e.g. 000000284).

• order_id string Required

  Winkelstraat order increment ID (e.g. 000000549).

• date string(date-time) Required

  Order creation date/time.

• discount number(float) Required

  Discount amount on this shipment, in the store's base currency.

• grand_total number(float) Required

  Grand total of this shipment, in the store's base currency.

• shipping_method string | null

  The shipping method that is actually used for the current shipment

• picking_pdf_url string | null

  URL to the picking / packing-slip PDF.

• shipment_token string Required

  Opaque, signed token identifying the shipment; used in follow-up API calls.

• carrier_code string | null

  Preferred carrier code selected by customer in checkout

• carrier_method string | null

  Preferred carrier method selected by customer in checkout

• logistics_service_provider_code string | null

  The logistics service provider code is only set when an outsourced company performs the distribution service

• available_delivery_methods array[object] Required

  Carrier methods available for this shipment (populated when the method is not yet fixed; empty otherwise).

  Hide available_delivery_methods attributes Show available_delivery_methods attributes object

  • carrier_code string Required

    Code of the shipping carrier (e.g. ups, dhlparcel, tig_postnl). Not a fixed list — it depends on the carriers configured for the merchant.

  • carrier_method string Required

    The carrier method. The special value '*' is reserved for any carrier method.

• purchase_origin string Required

  The selling entity for this purchase: the B2B company name when the order belongs to a company, otherwise the Winkelstraat store name (e.g. ws.nl). Free text.

• po_number string | null

  The PO number (external order reference)

• package_point object | null

  Specifies package point delivery information. Value is NULL for regular shipments

  Hide package_point attributes Show package_point attributes object | null

  • identifier string Required

    Carrier identifier of the pickup/package point.

  • name string Required

    Name of the pickup/package point.

  • carrier_code string Required

    Code of the shipping carrier (e.g. ups, dhlparcel, tig_postnl).

  • street_lines array[string] Required

    Address lines of the pickup/package point.

  • postcode string Required

    Postal code.

  • city string Required

    City.

  • state string | null

    State/province of the pickup point; may be null.

  • country_id string Required

    Two-letter ISO 3166-1 alpha-2 country code.

  • email string | null

    Contact e-mail of the pickup point; may be null.

  • fax string | null

    Contact fax number of the pickup point; may be null.

  • telephone string | null

    Contact telephone number of the pickup point; may be null.

• addressee object | null

  Address information. Value is only specified for package point deliveries.

  Hide addressee attributes Show addressee attributes object | null

  • name string Required

    Full name of the recipient at this address.

  • street string Required

    Street name.

  • housenumber string Required

    House number, including any suffix (e.g. 12A).

  • postcode string Required

    Postal code.

  • city string Required

    City.

  • province string | null

    Province or region; null when not applicable.

  • country string Required

    Two-letter ISO 3166-1 alpha-2 country code (e.g. NL).

  • email string Required

    Customer e-mail address.