Winkelstraat/stock hub/v1/shipment

POST https://reseller.server.com/api/v1/stockhub/shipment

The shipment webhook performs a POST in JSON format to a designated endpoint of the reseller.

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

increment_id string
created_at string(date-time)
updated_at string(date-time)
items array[object]
Hide items attributes Show items attributes object
- sku string
- qty integer
- item_price_inc_tax number(float)
- row_total_inc_tax number(float)
- parent_sku string | null
- manufacturer string
- size string
- mpn string
shipping_address object
Hide shipping_address attributes Show shipping_address attributes object
- first_name string | null
- last_name string | null
- email string
- telephone string
- street string
- houseNumber string
- postcode string
- city string
- region_code string | null
- country_id string
- company_name string | null
order_increment_id string
origin_address object
Hide origin_address attributes Show origin_address attributes object
- first_name string | null
- last_name string | null
- email string
- telephone string
- street string
- houseNumber string
- postcode string
- city string
- region_code string | null
- country_id string
- company_name string | null
track object
Hide track attributes Show track attributes object
- tracking_number string
- carrier string
- method string | null
- tracking_url string | null
collected_at string | null
delivered_at string | null
status string | null

Values are UNKNOWN, READY_FOR_PICKUP, IN_TRANSIT, DELIVERED, or EXCEPTION.
currency string
po_number string | null

The PO (Purchase order) number is the reference number to pay for approved purchases. The PO number is used to link the shipment to the order of the purchasing company.

Responses

200

Ok
202

Accepted
406

Not accepted

POST winkelstraat/stock-hub/v1/shipment

Request examples

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

# Payload
{
  "increment_id": "000000288",
  "created_at": "2024-02-20 15:28:51",
  "updated_at": "2024-02-20 15:31:54",
  "items": [
    {
      "sku": "wsnl199-5c9de5ad4681ed3eb551e7ee",
      "qty": 2,
      "item_price_inc_tax": 270,
      "row_total_inc_tax": 540,
      "parent_sku": "381189",
      "manufacturer": "Emporio Armani",
      "size": "L",
      "mpn": "3G1MXE1MXVZF982"
    }
  ],
  "shipping_address": {
    "first_name": "Jan",
    "last_name": "Jansen",
    "email": "jan.jansen@gwinkelstraat.nl",
    "telephone": "+31621510775",
    "street": "Edsger Dijkstraat",
    "house_number": "12",
    "postcode": "9012DE",
    "city": "Zonnewijk",
    "region_code": null,
    "country_id": "NL",
    "company_name": null
  },
  "order_increment_id": "000000549",
  "origin_address": {
    "email": "info@winkelstraat.nl",
    "telephone": "+55512345679",
    "street": "Buizerdlaan",
    "house_number": "2",
    "postcode": "3435SB",
    "city": "Nieuwegein",
    "region_code": null,
    "country_id": "NL",
    "company_name": "Winkelstraat.nl"
  },
  "track": {
    "tracking_number": "1Z7E3V556825150AAP",
    "carrier": "ups",
    "method": null,
    "tracking_url": "https://wwwapps.ups.com/WebTracking/processInputRequest?loc=nl_NL&tracknum=1Z7E3V556825150AAP"
  },
  "collected_at": "2024-02-23 21:20:39",
  "delivered_at": null,
  "status": "IN_TRANSIT",
  "currency": "EUR",
  "po_number": "YOUR_ORDER_REFERENCE"
}