Webhook Notification - Stock Status Change Example

POST

https://your.endpoint.here

Data
The data will be sent as a POST call to your webhook url. The data will be formatted as JSON and sent over in the following format

Request

Body Params application/json

event

object

required

uuid

string

required

UUID of the event.

name

enum<string>

required

Allowed value:

stock_notify

timestamp

string

required

Indicating when the event occurred.

data

object

required

Contains the latest stock-related information in the same format as GET requests.

string

required

name

string

required

sku

string

required

color

string

required

style

string

required

size

string

required

brand

string

required

print_areas

array[string]

required

stock

integer

required

status

enum<string>

required

There are three available status values

Allowed values:

in_stockout_of_stockdiscontinued

Example

{
  "event": {
    "uuid": "4e3f192a-c674-4de1-adb1-2f12e1adc62f",
    "name": "stock_notify",
    "timestamp": "2022-07-08T13:24:00.128774Z"
  },
  "data": {
    "id": "745626",
    "name": "BELLA",
    "sku": "UNPT1K00M",
    "color": "Black",
    "style": "3001",
    "size": "L",
    "brand": "BELLA",
    "print_areas": [
      "front",
      "back"
    ],
    "stock": 10,
    "status": "discontinued"
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://your.endpoint.here' \
--header 'Content-Type: application/json' \
--data-raw '{
    "event": {
        "uuid": "4e3f192a-c674-4de1-adb1-2f12e1adc62f",
        "name": "stock_notify",
        "timestamp": "2022-07-08T13:24:00.128774Z"
    },
    "data": {
        "id": "745626",
        "name": "BELLA",
        "sku": "UNPT1K00M",
        "color": "Black",
        "style": "3001",
        "size": "L",
        "brand": "BELLA",
        "print_areas": [
            "front",
            "back"
        ],
        "stock": 10,
        "status": "discontinued"
    }
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}

Webhook Notification - In Transit and Delivered Status Example

Orders