Item Availability Notification

POST https://webhook.example.com

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

application/json

Body Required

  • sku string Required

    The SKU of the item with updated availability

  • businessLocationId integer(int64) Required

    The unique identifier for the business location.

  • count integer | null

    The available count of the item. null indicates no restriction

  • countUpdatedAt string(date-time) Required

    The timestamp when the count was last updated

  • status string Required

    The restriction status of the item

    Values are RESTRICTED or NOT_RESTRICTED.

  • type string Required

    Notification type

    Default value is ITEM.

Responses

  • 200

    Your server returns this code if it accepts the callback

POST apeItem availability notification
Request examples 
{
  "sku": "UGG-BB-PUR-06",
  "type": "ITEM",
  "count": 5,
  "status": "RESTRICTED",
  "countUpdatedAt": "2024-04-04T09:42:00.000+00:00",
  "businessLocationId": 247158188015618
}
{
  "sku": "UGG-BB-PUR-06",
  "type": "ITEM",
  "count": null,
  "status": "NOT_RESTRICTED",
  "countUpdatedAt": "2024-04-04T09:42:00.000+00:00",
  "businessLocationId": 247158188015618
}