Webhook/winkelstraat/push api/v1/shipment

POST https://webhook.example.com

The shipment webhook executes a POST in JSON format to a designated endpoint of the merchant. The shipment webhook event is executed after the customer has fully paid the order and a shipment has been created afterwards.

When using the APIs, the "shipment token" is needed to: * mark shipments as packed, or * to mark items deficient, or * update state of RMA items

The shipment webhook specifies carrier information several times. The semantics of the different fields are listed below: * carrier_code/carrier_method: This is the preferred shipping carrier method selected by the customer during checkout. * shipping_method: The (already) selected shipping carrier method that is used for the current shipment. When the choice for the selected shipping carrier method is diverted to an external logistics service provider the value of the shipping carrier method is empty. * available_delivery_methods: A list of shipping carrier methods that can be for the current shipment. When the choice for the selected shipping carrier method is diverted to an external logistics service provider, this field presents the available shipping methods options. The list is empty when no options are available (e.g., the shipping carrier method has already been determined).

Headers

x-version string Required

Version of the webhook.
x-api-key string

The API-key is a shared secret that can be used to authenticate the incomming request.

application/json

Body

items array[object]
Hide items attributes Show items attributes object
- sku string
- 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
- name string
- size string
- color string
- quantity integer
- image string
- price number(float)
- shipment_item_id string
shipping_address object

Additional properties are allowed.
Hide shipping_address attributes Show shipping_address attributes object
- name string
- street string
- housenumber string
- postcode string
- city string
- province string | null
- country string
- email string
shipment_id string
order_id string
date string(date-time)
discount number(float) Deprecated
grand_total number(float) Deprecated
shipping_method string | null

The shipping method that is actually used for the current shipment
picking_pdf_url string | null
uid string Deprecated

Use shipment_token instead
shipment_token string
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]
Hide available_delivery_methods attributes Show available_delivery_methods attributes object
- carrier_code string
  
  The carrier code.
- carrier_method string
  
  The carrier method. The special value '*' is reserved for any carrier method.
id string Deprecated

Use shipment_id instead
main_order_id string Deprecated

Use order_id instead

Responses

200

Ok
202

Accepted
406

Not accepted

POST winkelstraat/push-api/v1/shipment

Request example

{
  "id": "000000284",
  "uid": "0:3:Z4NL1nrn+/9i2KiKABT7RlTjpct2zm0o2frptz8EoA==",
  "date": "2024-01-26T21:45:30.000+00:00",
  "items": [
    {
      "sku": "wsnl199-wsnl199-5c9de5ad4681ed3eb551e7ee",
      "name": "t-shirts",
      "size": "L",
      "color": "Blauw",
      "image": "https://www.winkelstraat.nl/img/744/744/resize/catalog/product/1/6/1660847_wsnl199-3g1mxe1mxvzf982-image_default.jpeg",
      "price": 271,
      "quantity": 1,
      "reference": "3G1MXE1MXVZF982",
      "manufacturer": "Emporio Armani",
      "article_number": "3G1MXE1MXVZF982 L",
      "shipment_item_id": "lDV"
    }
  ],
  "discount": 0,
  "order_id": "000000549",
  "grand_total": 0,
  "shipment_id": "000000284",
  "main_order_id": "000000549",
  "shipment_token": "0:3:CS70ed/6GtDiRsvfuF2Q/5iArqmSr7mYy832e5xZTQ==",
  "picking_pdf_url": "https://m2.winkelstraat.nl/shippingpackingslip/shipment/packingslip/token/MDozOkJhRVpmQ3NHZmVBV0k0WGlteFdYNWtIdVhkb0Y0Y2FCTnRDZjlGZWNZWVR1TktuK09nWkF2cmtOdkpLWHZ0L3RaelhQZUE4aWxwSmVlbHN3QmlVNCtyTTA4ZFFlWEJ1RjRRPT0/",
  "shipping_method": null,
  "shipping_address": {
    "city": "Zonnewijk",
    "name": "Jan Jansen",
    "email": "jan.jansen@gwinkelstraat.nl",
    "street": "Edsger Dijkstraat",
    "country": "NL",
    "postcode": "9012DE",
    "province": null,
    "housenumber": "12"
  },
  "available_delivery_methods": [
    {
      "carrier_code": "ups",
      "carrier_method": "11"
    }
  ],
  "logistics_service_provider_code": "lspwarehouse"
}