• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”
You are viewing an old version of the API

Inventory count updated

EVENT inventory.count.updated

Published when the quantity is updated for a CatalogItemVariation.


Permissions
INVENTORY_READ
Name Description
merchant_id
string

The ID of the target merchant associated with the event.

type
string

The type of event this represents.

event_id
string

A unique ID for the webhook event.

created_at
string

Timestamp of when the webhook event was created, in RFC 3339 format.

Examples for January 25th, 2020 6:27.34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

data
InventoryCountUpdatedWebhookData

Data associated with the event.

Examples

You are viewing an old version of the API
Example payload
{
  "merchant_id": "6SSW7HV8K2ST5",
  "type": "inventory.count.updated",
  "event_id": "df5f3813-a913-45a1-94e9-fdc3f7d5e3b6",
  "created_at": "2019-10-29T18:38:45.455006797Z",
  "data": {
    "type": "inventory",
    "id": "84e4ac73-d605-4dbd-a9e5-ffff794ddb9d",
    "object": {
      "inventory_counts": [
        {
          "calculated_at": "2019-10-29T18:38:45.10296Z",
          "catalog_object_id": "FGQ5JJWT2PYTHF35CKZ2DSKP",
          "catalog_object_type": "ITEM_VARIATION",
          "location_id": "YYQR03DGCTXA4",
          "quantity": "10",
          "state": "IN_STOCK"
        }
      ]
    }
  }
}

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?