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

Inventory updated
V1
Square V1 APIs

We recommend using the Square API (V2) for all new development when possible. See When to use Connect V1 to learn more about working with V1 endpoints.

Deprecated
- INVENTORY_UPDATED

Published when the inventory quantity for a catalog item is updated.

Required permissions: ITEMS_READ

Event payload

Name Description
merchant_id
string

The ID of the target merchant associated with the event.

location_id
string

The ID of the target merchant associated with the event.

event_type
string

The type of event this represents, i.e. INVENTORY_UPDATED.

entity_id
string

The ID of the V1 Item whose inventory was updated.

Examples

You are viewing an old version of the API
Example payload
{
  "merchant_id": "18YC4JBH91E1H",
  "location_id": "JGHJ0343",
  "event_type": "INVENTORY_UPDATED",
  "entity_id": "Jq74mCczmFXk1tC10GB"
}

Share Feedback

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