# Webhook/winkelstraat/push api/v2/shipment

**POST winkelstraat/push-api/v2/shipment**


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.

## Servers
- http://api.example.com: http://api.example.com ()



## Parameters
### Headers
- **x-version** (string)
  Version of the webhook.
- **x-api-key** (string)
  The API-key is a shared secret that can be used to authenticate the incomming request.



### Body: application/json (object)

- **items** (array[object])

- **shipping_address** (object)

- **shipment_id** (string)

- **order_id** (string)

- **date** (string(date-time))

- **discount** (number(float))

- **grand_total** (number(float))

- **shipping_method** (string | null)
  The shipping method that is actually used for the current shipment
- **picking_pdf_url** (string | null)

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

- **purchase_origin** (string)
  The source where the payment for the purchase was made.
- **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
- **addressee** (object | null)
  Address information. Value is only specified for package point deliveries.


## Responses
### 200
Ok

### 202
Accepted

### 406
Not accepted


[Powered by Bump.sh](https://bump.sh)