v1

latestOpenAPI 3.1.02026-08-06911,228852.2 KB

Order and Pay

Item Availability Notification

What your webhook implementation will receive when item sales restrictions are updated

postWebhookapeItem availability notification

Payload

skustring required

The SKU of the item with updated availability

businessLocationIdinteger required

The unique identifier for the business location.

countinteger nullable

The available count of the item. null indicates no restriction

countUpdatedAtstring date-time required

The timestamp when the count was last updated

status'RESTRICTED' | 'NOT_RESTRICTED' required

The restriction status of the item

typestring required

Notification type

Example payload

{
  "sku": "UGG-BB-PUR-06",
  "businessLocationId": 45454565682155,
  "count": 5,
  "countUpdatedAt": "2024-04-04T09:42:00.000+00:00",
  "status": "RESTRICTED",
  "type": "ITEM"
}

Response

Your server returns this code if it accepts the callback