Winkelstraat/stock hub/v1/creditmemo

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

The creditmemo 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
- manufacturer string
- size string
- mpn string
- reversal string
  
  Values are NONE, DEFICIENT, CANCELLED, or FUNDED_BY_PLATFORM.
- return_item_fee number(float)
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
shipping_price number(float)
grand_total number(float)
subtotal number(float)
currency string
order_increment_id string
adjustment number(float)
fee_amount number(float)
return_fee_amount number(float)
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 credit memo to the order of the purchasing company.

Responses

200

Ok
202

Accepted
406

Not accepted

POST winkelstraat/stock-hub/v1/creditmemo

Request example

{
  "items": [
    {
      "mpn": "3G1MXE1MXVZF982",
      "qty": 1,
      "sku": "wsnl199-5c9de5ad4681ed3eb551e7ee",
      "size": "L",
      "reversal": "NONE",
      "parent_sku": "381189",
      "manufacturer": "Emporio Armani",
      "return_item_fee": 0,
      "row_total_inc_tax": 270,
      "item_price_inc_tax": 270
    }
  ],
  "currency": "EUR",
  "subtotal": 270,
  "po_number": "YOUR_ORDER_REFERENCE",
  "adjustment": 0,
  "created_at": "2024-12-18T08:40:35.000+00:00",
  "fee_amount": 2.95,
  "updated_at": "2024-12-18T08:40:35.000+00:00",
  "grand_total": 267.05,
  "increment_id": "000000060",
  "shipping_price": 0,
  "billing_address": {
    "city": "Zonnewijk",
    "email": "jan.jansen@gwinkelstraat.nl",
    "street": "Edsger Dijkstraat",
    "postcode": "9012DE",
    "last_name": "Jansen",
    "telephone": "+31621510775",
    "country_id": "NL",
    "first_name": "Jan",
    "region_code": null,
    "company_name": null,
    "house_number": "12"
  },
  "order_increment_id": "000000568"
}