Stock Hub
POST https://reseller.server.com/api/v1/stockhub/order

The order 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_ordered 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
  • billing_address object
    Hide billing_address attributes Show billing_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
  • status string | null
  • shipping_price number | null
  • grand_total number | null
  • subtotal number | null
  • currency string | null
  • po_number string | null

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

Responses

  • 200

    Ok

  • 202

    Accepted

  • 406

    Not accepted

POST winkelstraat/stock-hub/v1/order
Request examples 
# Headers
x-version: V1
x-api-key: string

# Payload
{
  "increment_id": "000000549",
  "created_at": "2024-03-11T10:58:51.000+00:00",
  "updated_at": "2024-03-11T11:03:21.000+00:00",
  "items": [
    {
      "sku": "wsnl199-5c9de5ad4681ed3eb551e7ee",
      "qty_ordered": 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
  },
  "billing_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
  },
  "status": "complete",
  "shipping_price": 5.95,
  "grand_total": 545.95,
  "subtotal": 540,
  "currency": "EUR",
  "po_number": "YOUR_ORDER_REFERENCE"
}