Webhook/winkelstraat/push api/v1/shipment | Push API Sales documentation

Webhook/winkelstraat/push api/v1/shipment Webhook

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://push-api.doc.winkelstraat.nl/mcp

Standard setup for AI tools providing an mcp.json file

{
  "Push API Sales MCP server": {
    "url": "https://push-api.doc.winkelstraat.nl/mcp"
  }
}

POST https://webhook.example.com

What it does. Notifies you that a shipment has been created for a paid order.

When it is sent. After the customer has fully paid the order and a shipment has been created.

Version. ⚠️ Deprecated. Use the V2 winkelstraat/push-api/v2/shipment webhook instead.

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 incoming request.

application/json

Body Deprecated

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) 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

URL to the picking / packing-slip PDF.
uid string Deprecated

Use shipment_token instead
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.
id string Deprecated

Use shipment_id instead
main_order_id string Deprecated

Use order_id instead

Responses

200 application/json

Delivered. Return any 2xx status to acknowledge receipt; the response body may be empty or contain anything, as Winkelstraat does not read it. Any 2xx response is treated as a successful delivery and the webhook is not retried.

No response body is expected; Winkelstraat does not read it. Returning a 2xx with an empty body is sufficient.
202

Accepted for asynchronous processing. Treated the same as 200 — the webhook is not retried.
406

Not accepted. Any non-2xx response — or a connection/timeout failure — is treated as a failed delivery, and the webhook is retried several times over the next 24 hours.

POST winkelstraat/push-api/v1/shipment

Request examples

# Headers
x-version: V1
x-api-key: string

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

Response examples (200)

{}