# Webhook/winkelstraat/push api/v1/shipment

**POST winkelstraat/push-api/v1/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.

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

        The use of this webhook has been deprecated. Please use a new webhook for the new version of the API. The new webhook is called `winkelstraat/push-api/v2/shipment`.
        

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

- **uid** (string)
  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])

- **id** (string)
  Use `shipment_id` instead
- **main_order_id** (string)
  Use `order_id` instead


## Responses
### 200
Ok

### 202
Accepted

### 406
Not accepted


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