Locations

Location limits

GET read_locations

Fetch location limits and per-field constraints.

Returns the per-field maximum lengths, list limits, sort columns, and request caps that apply to location endpoints. This endpoint is for external integrations; Tringify admin clients use the admin contract endpoint.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

curl https://api-store.tringify.com/api/2025-01/locations/limits \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/locations/limits", {
  method: "GET",
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/locations/limits",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "fields": {
      "address_line1": {
        "max_length": 255
      },
      "address_line2": {
        "max_length": 255
      },
      "city": {
        "max_length": 100
      },
      "country_code": {
        "max_length": 2
      },
      "name": {
        "max_length": 100
      },
      "phone": {
        "max_length": 32
      },
      "postal_code": {
        "max_length": 20
      },
      "slug": {
        "max_length": 100
      },
      "state_province": {
        "max_length": 100
      }
    },
    "request_caps": {
      "list_default_limit": 50,
      "list_max_limit": 200,
      "max_per_store": 20,
      "page_size_options": [
        20,
        50,
        100,
        200
      ],
      "search_default_limit": 10,
      "search_max_length": 200,
      "search_max_limit": 50,
      "slug_retry_max": 100,
      "sort_columns": [
        "name",
        "fulfillment_priority",
        "created_at",
        "updated_at"
      ]
    },
    "resource_type": "location"
  },
  "success": true
}

List locations

GET read_locations

List store locations.

Returns paginated locations. The primary location is pinned first; the chosen sort orders the remaining rows.

Query parameters

Name	Type	Description
`page`	`integer`	Page number. Example: `1`
`limit`	`integer`	Page size. Example: `20`
`search`	`string`	Search locations by name, slug, city, state/province, or address line. Example: `Main Warehouse`
`sort_by`	`string`	Sort field from the Location list contract. Allowed values `namefulfillment_prioritycreated_atupdated_at` Example: `fulfillment_priority`
`sort_direction`	`string`	Sort direction from the Location list contract. Allowed values `ascdesc` Example: `asc`
`writable_only`	`boolean`	When true, exclude app-managed locations from the list. Example: `false`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

curl https://api-store.tringify.com/api/2025-01/locations?limit=20&page=1&search=Main Warehouse&sort_by=fulfillment_priority&sort_direction=asc&writable_only=false \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/locations?limit=20&page=1&search=Main Warehouse&sort_by=fulfillment_priority&sort_direction=asc&writable_only=false", {
  method: "GET",
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/locations?limit=20&page=1&search=Main Warehouse&sort_by=fulfillment_priority&sort_direction=asc&writable_only=false",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "active_merchant_total": 1,
    "limit": 20,
    "locations": [
      {
        "address_line1": "123 Market Street",
        "address_line2": "Suite 4",
        "app_id": null,
        "app_installation_active": false,
        "app_name": null,
        "app_slug": null,
        "city": "San Francisco",
        "country_code": "US",
        "created_at": "2026-07-06T10:00:00Z",
        "fulfillment_priority": 0,
        "fulfills_online_orders": true,
        "id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
        "is_active": true,
        "is_app_managed": false,
        "is_primary": true,
        "local_delivery_enabled": false,
        "name": "Main Warehouse",
        "phone": "+14155550100",
        "pickup_enabled": true,
        "postal_code": "94105",
        "slug": "main-warehouse",
        "state_province": "CA",
        "store_id": "74e634ea-84ec-43b8-b66b-986214c2c5a3",
        "updated_at": "2026-07-06T10:00:00Z"
      }
    ],
    "page": 1,
    "total": 1,
    "total_pages": 1
  },
  "success": true
}

Get a location

GET read_locations

Fetch one location by id.

Returns the location if it belongs to the token's store.

Path parameters

Name	Type	Description
`id` required	`string`	Location id. Example: `d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

404 LOCATION_NOT_FOUND
Location does not exist in this store.

curl https://api-store.tringify.com/api/2025-01/locations/d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/locations/d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a", {
  method: "GET",
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/locations/d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "location": {
      "address_line1": "123 Market Street",
      "address_line2": "Suite 4",
      "app_id": null,
      "app_installation_active": false,
      "app_name": null,
      "app_slug": null,
      "city": "San Francisco",
      "country_code": "US",
      "created_at": "2026-07-06T10:00:00Z",
      "fulfillment_priority": 0,
      "fulfills_online_orders": true,
      "id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
      "is_active": true,
      "is_app_managed": false,
      "is_primary": true,
      "local_delivery_enabled": false,
      "name": "Main Warehouse",
      "phone": "+14155550100",
      "pickup_enabled": true,
      "postal_code": "94105",
      "slug": "main-warehouse",
      "state_province": "CA",
      "store_id": "74e634ea-84ec-43b8-b66b-986214c2c5a3",
      "updated_at": "2026-07-06T10:00:00Z"
    }
  },
  "success": true
}

Create a location

POST write_locations

Create a merchant-managed or app-managed location.

Creates a location. name is required; slug is generated when omitted. Ownership follows the authenticated token: app tokens create app-managed locations owned by their active installation, while merchant tokens create merchant-managed locations. App-managed rows use the installation's separate bounded allowance and do not consume the merchant location allowance.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`name` required	`string`	Location name. Example: `Main Warehouse`
`slug`	`string`	Optional slug. Omit to generate from name. Example: `main-warehouse`
`fulfills_online_orders`	`boolean`	Whether this location fulfills online orders. Example: `true`
`pickup_enabled`	`boolean`	Whether pickup is enabled for this location. Example: `true`
`local_delivery_enabled`	`boolean`	Whether local delivery is enabled for this location. Example: `false`
`address_line1`	`string`	Street address line 1. Example: `123 Market Street`
`address_line2`	`string`	Street address line 2. Example: `Suite 4`
`city`	`string`	City. Example: `San Francisco`
`state_province`	`string`	State, province, or region. Example: `CA`
`postal_code`	`string`	Postal or ZIP code. Validated against the selected country when possible. Example: `94105`
`country_code`	`string`	Uppercase ISO 3166-1 alpha-2 country code. Example: `US`
`phone`	`string`	Phone number. Validated and normalized using the country code when provided. Example: `+14155550100`

Errors

400 LOCATION_NAME_REQUIRED
Name is empty after normalization.
400 LOCATION_NAME_TOO_LONG
Name exceeds the Location contract max length.
400 LOCATION_SLUG_REQUIRED
Slug cannot be empty on update.
400 LOCATION_SLUG_INVALID_FORMAT
Slug is not valid for location URLs.
400 LOCATION_COUNTRY_CODE_INVALID
Country code is invalid.
400 LOCATION_PHONE_INVALID
Phone number is invalid for the selected country.
400 LOCATION_PRIMARY_MUST_BE_ACTIVE
The primary location must remain active.
400 LOCATION_PRIMARY_MUST_FULFILL
The primary location must fulfill online orders.
400 LOCATION_LAST_FULFILLMENT
At least one location must fulfill online orders.
403 LOCATION_LIMIT_REACHED
Store location cap has been reached.
403 LOCATION_APP_MANAGED_NO_EDIT
App-managed locations can be edited only by their owning active installation.
404 LOCATION_NOT_FOUND
Location does not exist in this store.
409 LOCATION_DUPLICATE
Name or slug already exists in this store.

curl -X POST https://api-store.tringify.com/api/2025-01/locations \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "address_line1": "123 Market Street",
  "address_line2": "Suite 4",
  "city": "San Francisco",
  "country_code": "US",
  "fulfills_online_orders": true,
  "local_delivery_enabled": false,
  "name": "Main Warehouse",
  "phone": "+14155550100",
  "pickup_enabled": true,
  "postal_code": "94105",
  "slug": "main-warehouse",
  "state_province": "CA"
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/locations", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_STORE_API_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "address_line1": "123 Market Street",
    "address_line2": "Suite 4",
    "city": "San Francisco",
    "country_code": "US",
    "fulfills_online_orders": true,
    "local_delivery_enabled": false,
    "name": "Main Warehouse",
    "phone": "+14155550100",
    "pickup_enabled": true,
    "postal_code": "94105",
    "slug": "main-warehouse",
    "state_province": "CA"
  }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://api-store.tringify.com/api/2025-01/locations",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
    json={
        "address_line1": "123 Market Street",
        "address_line2": "Suite 4",
        "city": "San Francisco",
        "country_code": "US",
        "fulfills_online_orders": True,
        "local_delivery_enabled": False,
        "name": "Main Warehouse",
        "phone": "+14155550100",
        "pickup_enabled": True,
        "postal_code": "94105",
        "slug": "main-warehouse",
        "state_province": "CA",
    },
)
data = res.json()

Response

201

Sample response

{
  "data": {
    "location": {
      "address_line1": "123 Market Street",
      "address_line2": "Suite 4",
      "app_id": null,
      "app_installation_active": false,
      "app_name": null,
      "app_slug": null,
      "city": "San Francisco",
      "country_code": "US",
      "created_at": "2026-07-06T10:00:00Z",
      "fulfillment_priority": 0,
      "fulfills_online_orders": true,
      "id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
      "is_active": true,
      "is_app_managed": false,
      "is_primary": true,
      "local_delivery_enabled": false,
      "name": "Main Warehouse",
      "phone": "+14155550100",
      "pickup_enabled": true,
      "postal_code": "94105",
      "slug": "main-warehouse",
      "state_province": "CA",
      "store_id": "74e634ea-84ec-43b8-b66b-986214c2c5a3",
      "updated_at": "2026-07-06T10:00:00Z"
    }
  },
  "success": true
}

Update a location

PUT write_locations

Update a location.

Updates provided location fields. Omitted fields are unchanged. Merchant-managed locations follow normal write_locations access. An app-managed location can be updated only by the active installation that owns it; merchants and other apps receive LOCATION_APP_MANAGED_NO_EDIT.

Path parameters

Name	Type	Description
`id` required	`string`	Location id. Example: `d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`is_active`	`boolean`	Whether the location is active. Primary locations must remain active. Example: `true`
`name`	`string`	Location name. Example: `Main Warehouse`
`slug`	`string`	Optional slug. Omit to generate from name. Example: `main-warehouse`
`fulfills_online_orders`	`boolean`	Whether this location fulfills online orders. Example: `true`
`pickup_enabled`	`boolean`	Whether pickup is enabled for this location. Example: `true`
`local_delivery_enabled`	`boolean`	Whether local delivery is enabled for this location. Example: `false`
`address_line1`	`string`	Street address line 1. Example: `123 Market Street`
`address_line2`	`string`	Street address line 2. Example: `Suite 4`
`city`	`string`	City. Example: `San Francisco`
`state_province`	`string`	State, province, or region. Example: `CA`
`postal_code`	`string`	Postal or ZIP code. Validated against the selected country when possible. Example: `94105`
`country_code`	`string`	Uppercase ISO 3166-1 alpha-2 country code. Example: `US`
`phone`	`string`	Phone number. Validated and normalized using the country code when provided. Example: `+14155550100`

Errors

400 LOCATION_NAME_REQUIRED
Name is empty after normalization.
400 LOCATION_NAME_TOO_LONG
Name exceeds the Location contract max length.
400 LOCATION_SLUG_REQUIRED
Slug cannot be empty on update.
400 LOCATION_SLUG_INVALID_FORMAT
Slug is not valid for location URLs.
400 LOCATION_COUNTRY_CODE_INVALID
Country code is invalid.
400 LOCATION_PHONE_INVALID
Phone number is invalid for the selected country.
400 LOCATION_PRIMARY_MUST_BE_ACTIVE
The primary location must remain active.
400 LOCATION_PRIMARY_MUST_FULFILL
The primary location must fulfill online orders.
400 LOCATION_LAST_FULFILLMENT
At least one location must fulfill online orders.
403 LOCATION_LIMIT_REACHED
Store location cap has been reached.
403 LOCATION_APP_MANAGED_NO_EDIT
App-managed locations can be edited only by their owning active installation.
404 LOCATION_NOT_FOUND
Location does not exist in this store.
409 LOCATION_DUPLICATE
Name or slug already exists in this store.

curl -X PUT https://api-store.tringify.com/api/2025-01/locations/d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "address_line1": "123 Market Street",
  "address_line2": "Suite 4",
  "city": "San Francisco",
  "country_code": "US",
  "fulfills_online_orders": true,
  "is_active": true,
  "local_delivery_enabled": false,
  "name": "Main Warehouse",
  "phone": "+14155550100",
  "pickup_enabled": true,
  "postal_code": "94105",
  "slug": "main-warehouse",
  "state_province": "CA"
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/locations/d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_STORE_API_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "address_line1": "123 Market Street",
    "address_line2": "Suite 4",
    "city": "San Francisco",
    "country_code": "US",
    "fulfills_online_orders": true,
    "is_active": true,
    "local_delivery_enabled": false,
    "name": "Main Warehouse",
    "phone": "+14155550100",
    "pickup_enabled": true,
    "postal_code": "94105",
    "slug": "main-warehouse",
    "state_province": "CA"
  }),
});
const data = await res.json();

import requests

res = requests.put(
    "https://api-store.tringify.com/api/2025-01/locations/d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
    json={
        "address_line1": "123 Market Street",
        "address_line2": "Suite 4",
        "city": "San Francisco",
        "country_code": "US",
        "fulfills_online_orders": True,
        "is_active": True,
        "local_delivery_enabled": False,
        "name": "Main Warehouse",
        "phone": "+14155550100",
        "pickup_enabled": True,
        "postal_code": "94105",
        "slug": "main-warehouse",
        "state_province": "CA",
    },
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "location": {
      "address_line1": "123 Market Street",
      "address_line2": "Suite 4",
      "app_id": null,
      "app_installation_active": false,
      "app_name": null,
      "app_slug": null,
      "city": "San Francisco",
      "country_code": "US",
      "created_at": "2026-07-06T10:00:00Z",
      "fulfillment_priority": 0,
      "fulfills_online_orders": true,
      "id": "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
      "is_active": true,
      "is_app_managed": false,
      "is_primary": true,
      "local_delivery_enabled": false,
      "name": "Main Warehouse",
      "phone": "+14155550100",
      "pickup_enabled": true,
      "postal_code": "94105",
      "slug": "main-warehouse",
      "state_province": "CA",
      "store_id": "74e634ea-84ec-43b8-b66b-986214c2c5a3",
      "updated_at": "2026-07-06T10:00:00Z"
    }
  },
  "success": true
}

Delete a location

DELETE write_locations

Delete a location.

Deletes a location only when it is not primary, not the last online-fulfilling location, and has no inventory assignments or active transfers. App-managed locations can be deleted only by their owning active installation.

Path parameters

Name	Type	Description
`id` required	`string`	Location id. Example: `d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

403 LOCATION_APP_MANAGED_NO_DELETE
App-managed locations can be deleted only by their owning active installation.
404 LOCATION_NOT_FOUND
Location does not exist in this store.
409 LOCATION_DELETE_PRIMARY
Primary location cannot be deleted.
409 LOCATION_DELETE_HAS_INVENTORY
Location has inventory assignments.
409 LOCATION_DELETE_HAS_TRANSFERS
Location has pending or in-transit stock transfers.
409 LOCATION_DELETE_LAST_FULFILLMENT
Cannot delete the only location that fulfills online orders.

curl -X DELETE https://api-store.tringify.com/api/2025-01/locations/d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/locations/d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a", {
  method: "DELETE",
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.delete(
    "https://api-store.tringify.com/api/2025-01/locations/d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {},
  "success": true
}

Reorder locations

POST write_locations

Set the full fulfillment priority order.

Merchant API tokens only. Send every location id exactly once in the desired fulfillment order: array position 0 becomes priority 0, position 1 becomes priority 1, and so on. Include the primary location, inactive locations, and app-managed locations returned by GET /locations; this changes routing priority but not ownership or status. Partial lists, duplicates, malformed ids, and ids from another store are rejected atomically.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`ordered_ids` required	`array<uuid>`	The complete location-id set from `GET /locations`, ordered from highest to lowest fulfillment priority. Example: `["d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a", "91d83dd2-2bb5-42f8-8db7-5ef755ad749c"]`

Errors

403 FORBIDDEN
App tokens cannot change the store-wide fulfillment order; use a merchant API token.
400 LOCATION_REORDER_INVALID
The reorder list must include every location exactly once.

curl -X POST https://api-store.tringify.com/api/2025-01/locations/reorder \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "ordered_ids": [
    "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
    "91d83dd2-2bb5-42f8-8db7-5ef755ad749c"
  ]
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/locations/reorder", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_STORE_API_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "ordered_ids": [
      "d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a",
      "91d83dd2-2bb5-42f8-8db7-5ef755ad749c"
    ]
  }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://api-store.tringify.com/api/2025-01/locations/reorder",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
    json={
        "ordered_ids": ["d6a26466-7903-4e2f-8fd7-7c59f3c8cd9a", "91d83dd2-2bb5-42f8-8db7-5ef755ad749c"],
    },
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "success": true
  },
  "success": true
}

Field	Kind	Create	Update	Required	Translatable
`name`	text	Yes	Yes	create	No
`slug`	slug	Yes	Yes		No
`is_active`	boolean	No	Yes		No
`fulfills_online_orders`	boolean	Yes	Yes		No
`pickup_enabled`	boolean	Yes	Yes		No
`local_delivery_enabled`	boolean	Yes	Yes		No
`address_line1`	text	Yes	Yes		No
`address_line2`	text	Yes	Yes		No
`city`	text	Yes	Yes		No
`state_province`	text	Yes	Yes		No
`postal_code`	text	Yes	Yes		No
`country_code`	select	Yes	Yes		No
`phone`	text	Yes	Yes		No
`is_primary`	boolean	No	No		No
`is_app_managed`	boolean	No	No		No
`app_id`	text	No	No		No
`fulfillment_priority`	integer	No	No		No
`created_at`	datetime	No	No		No
`updated_at`	datetime	No	No		No

Location created

EVENT locations/create write_locations locations:write

Fired when a new location is created.

Payload fields

Field	Type	Description
`resource_type`	`string`	Can be removed/added via the Payload builder
`resource_id`	`string`	Can be removed/added via the Payload builder
`occurred_at`	`string`	Can be removed/added via the Payload builder
`previous.id`	`string`	Can be removed/added via the Payload builder
`previous.name`	`string`	Can be removed/added via the Payload builder
`previous.slug`	`string`	Can be removed/added via the Payload builder
`previous.app_id`	`string`	Can be removed/added via the Payload builder
`previous.is_app_managed`	`boolean`	Can be removed/added via the Payload builder
`previous.is_primary`	`boolean`	Can be removed/added via the Payload builder
`previous.is_active`	`boolean`	Can be removed/added via the Payload builder
`previous.fulfills_online_orders`	`boolean`	Can be removed/added via the Payload builder
`previous.fulfillment_priority`	`integer`	Can be removed/added via the Payload builder
`previous.pickup_enabled`	`boolean`	Can be removed/added via the Payload builder
`previous.local_delivery_enabled`	`boolean`	Can be removed/added via the Payload builder
`previous.address_line1`	`string`	Can be removed/added via the Payload builder
`previous.address_line2`	`string`	Can be removed/added via the Payload builder
`previous.city`	`string`	Can be removed/added via the Payload builder
`previous.state_province`	`string`	Can be removed/added via the Payload builder
`previous.postal_code`	`string`	Can be removed/added via the Payload builder
`previous.country_code`	`string`	Can be removed/added via the Payload builder
`previous.phone`	`string`	Can be removed/added via the Payload builder
`current.id`	`string`	Can be removed/added via the Payload builder
`current.name`	`string`	Can be removed/added via the Payload builder
`current.slug`	`string`	Can be removed/added via the Payload builder
`current.app_id`	`string`	Can be removed/added via the Payload builder
`current.is_app_managed`	`boolean`	Can be removed/added via the Payload builder
`current.is_primary`	`boolean`	Can be removed/added via the Payload builder
`current.is_active`	`boolean`	Can be removed/added via the Payload builder
`current.fulfills_online_orders`	`boolean`	Can be removed/added via the Payload builder
`current.fulfillment_priority`	`integer`	Can be removed/added via the Payload builder
`current.pickup_enabled`	`boolean`	Can be removed/added via the Payload builder
`current.local_delivery_enabled`	`boolean`	Can be removed/added via the Payload builder
`current.address_line1`	`string`	Can be removed/added via the Payload builder
`current.address_line2`	`string`	Can be removed/added via the Payload builder
`current.city`	`string`	Can be removed/added via the Payload builder
`current.state_province`	`string`	Can be removed/added via the Payload builder
`current.postal_code`	`string`	Can be removed/added via the Payload builder
`current.country_code`	`string`	Can be removed/added via the Payload builder
`current.phone`	`string`	Can be removed/added via the Payload builder
`changed_fields`	`array`	Can be removed/added via the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [],
  "current": {
    "address_line1": null,
    "address_line2": null,
    "app_id": null,
    "city": null,
    "country_code": null,
    "fulfillment_priority": 0,
    "fulfills_online_orders": false,
    "id": 7,
    "is_active": false,
    "is_app_managed": false,
    "is_primary": false,
    "local_delivery_enabled": false,
    "name": "Acme",
    "phone": null,
    "pickup_enabled": false,
    "postal_code": null,
    "slug": "acme",
    "state_province": null
  },
  "occurred_at": "...",
  "previous": {
    "address_line1": null,
    "address_line2": null,
    "app_id": null,
    "city": null,
    "country_code": null,
    "fulfillment_priority": 0,
    "fulfills_online_orders": false,
    "id": 7,
    "is_active": false,
    "is_app_managed": false,
    "is_primary": false,
    "local_delivery_enabled": false,
    "name": "Acme",
    "phone": null,
    "pickup_enabled": false,
    "postal_code": null,
    "slug": "acme",
    "state_province": null
  },
  "resource_id": "...",
  "resource_type": "..."
}

Location updated

EVENT locations/update write_locations locations:write

Fired when a location's non-state fields change (name, slug, address, phone, pickup_enabled, or local_delivery_enabled). State transitions fire their specific topic instead; if state and non-state fields change in one save, both fire.

Payload fields

Field	Type	Description
`resource_type`	`string`	Can be removed/added via the Payload builder
`resource_id`	`string`	Can be removed/added via the Payload builder
`occurred_at`	`string`	Can be removed/added via the Payload builder
`previous.id`	`string`	Can be removed/added via the Payload builder
`previous.name`	`string`	Can be removed/added via the Payload builder
`previous.slug`	`string`	Can be removed/added via the Payload builder
`previous.app_id`	`string`	Can be removed/added via the Payload builder
`previous.is_app_managed`	`boolean`	Can be removed/added via the Payload builder
`previous.is_primary`	`boolean`	Can be removed/added via the Payload builder
`previous.is_active`	`boolean`	Can be removed/added via the Payload builder
`previous.fulfills_online_orders`	`boolean`	Can be removed/added via the Payload builder
`previous.fulfillment_priority`	`integer`	Can be removed/added via the Payload builder
`previous.pickup_enabled`	`boolean`	Can be removed/added via the Payload builder
`previous.local_delivery_enabled`	`boolean`	Can be removed/added via the Payload builder
`previous.address_line1`	`string`	Can be removed/added via the Payload builder
`previous.address_line2`	`string`	Can be removed/added via the Payload builder
`previous.city`	`string`	Can be removed/added via the Payload builder
`previous.state_province`	`string`	Can be removed/added via the Payload builder
`previous.postal_code`	`string`	Can be removed/added via the Payload builder
`previous.country_code`	`string`	Can be removed/added via the Payload builder
`previous.phone`	`string`	Can be removed/added via the Payload builder
`current.id`	`string`	Can be removed/added via the Payload builder
`current.name`	`string`	Can be removed/added via the Payload builder
`current.slug`	`string`	Can be removed/added via the Payload builder
`current.app_id`	`string`	Can be removed/added via the Payload builder
`current.is_app_managed`	`boolean`	Can be removed/added via the Payload builder
`current.is_primary`	`boolean`	Can be removed/added via the Payload builder
`current.is_active`	`boolean`	Can be removed/added via the Payload builder
`current.fulfills_online_orders`	`boolean`	Can be removed/added via the Payload builder
`current.fulfillment_priority`	`integer`	Can be removed/added via the Payload builder
`current.pickup_enabled`	`boolean`	Can be removed/added via the Payload builder
`current.local_delivery_enabled`	`boolean`	Can be removed/added via the Payload builder
`current.address_line1`	`string`	Can be removed/added via the Payload builder
`current.address_line2`	`string`	Can be removed/added via the Payload builder
`current.city`	`string`	Can be removed/added via the Payload builder
`current.state_province`	`string`	Can be removed/added via the Payload builder
`current.postal_code`	`string`	Can be removed/added via the Payload builder
`current.country_code`	`string`	Can be removed/added via the Payload builder
`current.phone`	`string`	Can be removed/added via the Payload builder
`changed_fields`	`array`	Can be removed/added via the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [],
  "current": {
    "address_line1": null,
    "address_line2": null,
    "app_id": null,
    "city": null,
    "country_code": null,
    "fulfillment_priority": 0,
    "fulfills_online_orders": false,
    "id": 7,
    "is_active": false,
    "is_app_managed": false,
    "is_primary": false,
    "local_delivery_enabled": false,
    "name": "Acme",
    "phone": null,
    "pickup_enabled": false,
    "postal_code": null,
    "slug": "acme",
    "state_province": null
  },
  "occurred_at": "...",
  "previous": {
    "address_line1": null,
    "address_line2": null,
    "app_id": null,
    "city": null,
    "country_code": null,
    "fulfillment_priority": 0,
    "fulfills_online_orders": false,
    "id": 7,
    "is_active": false,
    "is_app_managed": false,
    "is_primary": false,
    "local_delivery_enabled": false,
    "name": "Acme",
    "phone": null,
    "pickup_enabled": false,
    "postal_code": null,
    "slug": "acme",
    "state_province": null
  },
  "resource_id": "...",
  "resource_type": "..."
}

Location deleted

EVENT locations/delete write_locations locations:write

Fired when a location is deleted.

Payload fields

Field	Type	Description
`resource_type`	`string`	Can be removed/added via the Payload builder
`resource_id`	`string`	Can be removed/added via the Payload builder
`occurred_at`	`string`	Can be removed/added via the Payload builder
`previous.id`	`string`	Can be removed/added via the Payload builder
`previous.name`	`string`	Can be removed/added via the Payload builder
`previous.slug`	`string`	Can be removed/added via the Payload builder
`previous.app_id`	`string`	Can be removed/added via the Payload builder
`previous.is_app_managed`	`boolean`	Can be removed/added via the Payload builder
`previous.is_primary`	`boolean`	Can be removed/added via the Payload builder
`previous.is_active`	`boolean`	Can be removed/added via the Payload builder
`previous.fulfills_online_orders`	`boolean`	Can be removed/added via the Payload builder
`previous.fulfillment_priority`	`integer`	Can be removed/added via the Payload builder
`previous.pickup_enabled`	`boolean`	Can be removed/added via the Payload builder
`previous.local_delivery_enabled`	`boolean`	Can be removed/added via the Payload builder
`previous.address_line1`	`string`	Can be removed/added via the Payload builder
`previous.address_line2`	`string`	Can be removed/added via the Payload builder
`previous.city`	`string`	Can be removed/added via the Payload builder
`previous.state_province`	`string`	Can be removed/added via the Payload builder
`previous.postal_code`	`string`	Can be removed/added via the Payload builder
`previous.country_code`	`string`	Can be removed/added via the Payload builder
`previous.phone`	`string`	Can be removed/added via the Payload builder
`current.id`	`string`	Can be removed/added via the Payload builder
`current.name`	`string`	Can be removed/added via the Payload builder
`current.slug`	`string`	Can be removed/added via the Payload builder
`current.app_id`	`string`	Can be removed/added via the Payload builder
`current.is_app_managed`	`boolean`	Can be removed/added via the Payload builder
`current.is_primary`	`boolean`	Can be removed/added via the Payload builder
`current.is_active`	`boolean`	Can be removed/added via the Payload builder
`current.fulfills_online_orders`	`boolean`	Can be removed/added via the Payload builder
`current.fulfillment_priority`	`integer`	Can be removed/added via the Payload builder
`current.pickup_enabled`	`boolean`	Can be removed/added via the Payload builder
`current.local_delivery_enabled`	`boolean`	Can be removed/added via the Payload builder
`current.address_line1`	`string`	Can be removed/added via the Payload builder
`current.address_line2`	`string`	Can be removed/added via the Payload builder
`current.city`	`string`	Can be removed/added via the Payload builder
`current.state_province`	`string`	Can be removed/added via the Payload builder
`current.postal_code`	`string`	Can be removed/added via the Payload builder
`current.country_code`	`string`	Can be removed/added via the Payload builder
`current.phone`	`string`	Can be removed/added via the Payload builder
`changed_fields`	`array`	Can be removed/added via the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [],
  "current": {
    "address_line1": null,
    "address_line2": null,
    "app_id": null,
    "city": null,
    "country_code": null,
    "fulfillment_priority": 0,
    "fulfills_online_orders": false,
    "id": 7,
    "is_active": false,
    "is_app_managed": false,
    "is_primary": false,
    "local_delivery_enabled": false,
    "name": "Acme",
    "phone": null,
    "pickup_enabled": false,
    "postal_code": null,
    "slug": "acme",
    "state_province": null
  },
  "occurred_at": "...",
  "previous": {
    "address_line1": null,
    "address_line2": null,
    "app_id": null,
    "city": null,
    "country_code": null,
    "fulfillment_priority": 0,
    "fulfills_online_orders": false,
    "id": 7,
    "is_active": false,
    "is_app_managed": false,
    "is_primary": false,
    "local_delivery_enabled": false,
    "name": "Acme",
    "phone": null,
    "pickup_enabled": false,
    "postal_code": null,
    "slug": "acme",
    "state_province": null
  },
  "resource_id": "...",
  "resource_type": "..."
}

Location activated

EVENT locations/activated write_locations locations:write

Fired when a location's is_active flips from false to true.

Payload fields

Field	Type	Description
`resource_type`	`string`	Can be removed/added via the Payload builder
`resource_id`	`string`	Can be removed/added via the Payload builder
`occurred_at`	`string`	Can be removed/added via the Payload builder
`previous.id`	`string`	Can be removed/added via the Payload builder
`previous.name`	`string`	Can be removed/added via the Payload builder
`previous.slug`	`string`	Can be removed/added via the Payload builder
`previous.app_id`	`string`	Can be removed/added via the Payload builder
`previous.is_app_managed`	`boolean`	Can be removed/added via the Payload builder
`previous.is_primary`	`boolean`	Can be removed/added via the Payload builder
`previous.is_active`	`boolean`	Can be removed/added via the Payload builder
`previous.fulfills_online_orders`	`boolean`	Can be removed/added via the Payload builder
`previous.fulfillment_priority`	`integer`	Can be removed/added via the Payload builder
`previous.pickup_enabled`	`boolean`	Can be removed/added via the Payload builder
`previous.local_delivery_enabled`	`boolean`	Can be removed/added via the Payload builder
`previous.address_line1`	`string`	Can be removed/added via the Payload builder
`previous.address_line2`	`string`	Can be removed/added via the Payload builder
`previous.city`	`string`	Can be removed/added via the Payload builder
`previous.state_province`	`string`	Can be removed/added via the Payload builder
`previous.postal_code`	`string`	Can be removed/added via the Payload builder
`previous.country_code`	`string`	Can be removed/added via the Payload builder
`previous.phone`	`string`	Can be removed/added via the Payload builder
`current.id`	`string`	Can be removed/added via the Payload builder
`current.name`	`string`	Can be removed/added via the Payload builder
`current.slug`	`string`	Can be removed/added via the Payload builder
`current.app_id`	`string`	Can be removed/added via the Payload builder
`current.is_app_managed`	`boolean`	Can be removed/added via the Payload builder
`current.is_primary`	`boolean`	Can be removed/added via the Payload builder
`current.is_active`	`boolean`	Can be removed/added via the Payload builder
`current.fulfills_online_orders`	`boolean`	Can be removed/added via the Payload builder
`current.fulfillment_priority`	`integer`	Can be removed/added via the Payload builder
`current.pickup_enabled`	`boolean`	Can be removed/added via the Payload builder
`current.local_delivery_enabled`	`boolean`	Can be removed/added via the Payload builder
`current.address_line1`	`string`	Can be removed/added via the Payload builder
`current.address_line2`	`string`	Can be removed/added via the Payload builder
`current.city`	`string`	Can be removed/added via the Payload builder
`current.state_province`	`string`	Can be removed/added via the Payload builder
`current.postal_code`	`string`	Can be removed/added via the Payload builder
`current.country_code`	`string`	Can be removed/added via the Payload builder
`current.phone`	`string`	Can be removed/added via the Payload builder
`changed_fields`	`array`	Can be removed/added via the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [],
  "current": {
    "address_line1": null,
    "address_line2": null,
    "app_id": null,
    "city": null,
    "country_code": null,
    "fulfillment_priority": 0,
    "fulfills_online_orders": false,
    "id": 7,
    "is_active": false,
    "is_app_managed": false,
    "is_primary": false,
    "local_delivery_enabled": false,
    "name": "Acme",
    "phone": null,
    "pickup_enabled": false,
    "postal_code": null,
    "slug": "acme",
    "state_province": null
  },
  "occurred_at": "...",
  "previous": {
    "address_line1": null,
    "address_line2": null,
    "app_id": null,
    "city": null,
    "country_code": null,
    "fulfillment_priority": 0,
    "fulfills_online_orders": false,
    "id": 7,
    "is_active": false,
    "is_app_managed": false,
    "is_primary": false,
    "local_delivery_enabled": false,
    "name": "Acme",
    "phone": null,
    "pickup_enabled": false,
    "postal_code": null,
    "slug": "acme",
    "state_province": null
  },
  "resource_id": "...",
  "resource_type": "..."
}

Location deactivated

EVENT locations/deactivated write_locations locations:write

Fired when a location's is_active flips from true to false. Fulfillment integrations typically reassign pending work on this event.

Payload fields

Field	Type	Description
`resource_type`	`string`	Can be removed/added via the Payload builder
`resource_id`	`string`	Can be removed/added via the Payload builder
`occurred_at`	`string`	Can be removed/added via the Payload builder
`previous.id`	`string`	Can be removed/added via the Payload builder
`previous.name`	`string`	Can be removed/added via the Payload builder
`previous.slug`	`string`	Can be removed/added via the Payload builder
`previous.app_id`	`string`	Can be removed/added via the Payload builder
`previous.is_app_managed`	`boolean`	Can be removed/added via the Payload builder
`previous.is_primary`	`boolean`	Can be removed/added via the Payload builder
`previous.is_active`	`boolean`	Can be removed/added via the Payload builder
`previous.fulfills_online_orders`	`boolean`	Can be removed/added via the Payload builder
`previous.fulfillment_priority`	`integer`	Can be removed/added via the Payload builder
`previous.pickup_enabled`	`boolean`	Can be removed/added via the Payload builder
`previous.local_delivery_enabled`	`boolean`	Can be removed/added via the Payload builder
`previous.address_line1`	`string`	Can be removed/added via the Payload builder
`previous.address_line2`	`string`	Can be removed/added via the Payload builder
`previous.city`	`string`	Can be removed/added via the Payload builder
`previous.state_province`	`string`	Can be removed/added via the Payload builder
`previous.postal_code`	`string`	Can be removed/added via the Payload builder
`previous.country_code`	`string`	Can be removed/added via the Payload builder
`previous.phone`	`string`	Can be removed/added via the Payload builder
`current.id`	`string`	Can be removed/added via the Payload builder
`current.name`	`string`	Can be removed/added via the Payload builder
`current.slug`	`string`	Can be removed/added via the Payload builder
`current.app_id`	`string`	Can be removed/added via the Payload builder
`current.is_app_managed`	`boolean`	Can be removed/added via the Payload builder
`current.is_primary`	`boolean`	Can be removed/added via the Payload builder
`current.is_active`	`boolean`	Can be removed/added via the Payload builder
`current.fulfills_online_orders`	`boolean`	Can be removed/added via the Payload builder
`current.fulfillment_priority`	`integer`	Can be removed/added via the Payload builder
`current.pickup_enabled`	`boolean`	Can be removed/added via the Payload builder
`current.local_delivery_enabled`	`boolean`	Can be removed/added via the Payload builder
`current.address_line1`	`string`	Can be removed/added via the Payload builder
`current.address_line2`	`string`	Can be removed/added via the Payload builder
`current.city`	`string`	Can be removed/added via the Payload builder
`current.state_province`	`string`	Can be removed/added via the Payload builder
`current.postal_code`	`string`	Can be removed/added via the Payload builder
`current.country_code`	`string`	Can be removed/added via the Payload builder
`current.phone`	`string`	Can be removed/added via the Payload builder
`changed_fields`	`array`	Can be removed/added via the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [],
  "current": {
    "address_line1": null,
    "address_line2": null,
    "app_id": null,
    "city": null,
    "country_code": null,
    "fulfillment_priority": 0,
    "fulfills_online_orders": false,
    "id": 7,
    "is_active": false,
    "is_app_managed": false,
    "is_primary": false,
    "local_delivery_enabled": false,
    "name": "Acme",
    "phone": null,
    "pickup_enabled": false,
    "postal_code": null,
    "slug": "acme",
    "state_province": null
  },
  "occurred_at": "...",
  "previous": {
    "address_line1": null,
    "address_line2": null,
    "app_id": null,
    "city": null,
    "country_code": null,
    "fulfillment_priority": 0,
    "fulfills_online_orders": false,
    "id": 7,
    "is_active": false,
    "is_app_managed": false,
    "is_primary": false,
    "local_delivery_enabled": false,
    "name": "Acme",
    "phone": null,
    "pickup_enabled": false,
    "postal_code": null,
    "slug": "acme",
    "state_province": null
  },
  "resource_id": "...",
  "resource_type": "..."
}

Location fulfillment enabled

EVENT locations/fulfillment_enabled write_locations locations:write

Fired when a location's fulfills_online_orders flips from false to true.

Payload fields

Field	Type	Description
`resource_type`	`string`	Can be removed/added via the Payload builder
`resource_id`	`string`	Can be removed/added via the Payload builder
`occurred_at`	`string`	Can be removed/added via the Payload builder
`previous.id`	`string`	Can be removed/added via the Payload builder
`previous.name`	`string`	Can be removed/added via the Payload builder
`previous.slug`	`string`	Can be removed/added via the Payload builder
`previous.app_id`	`string`	Can be removed/added via the Payload builder
`previous.is_app_managed`	`boolean`	Can be removed/added via the Payload builder
`previous.is_primary`	`boolean`	Can be removed/added via the Payload builder
`previous.is_active`	`boolean`	Can be removed/added via the Payload builder
`previous.fulfills_online_orders`	`boolean`	Can be removed/added via the Payload builder
`previous.fulfillment_priority`	`integer`	Can be removed/added via the Payload builder
`previous.pickup_enabled`	`boolean`	Can be removed/added via the Payload builder
`previous.local_delivery_enabled`	`boolean`	Can be removed/added via the Payload builder
`previous.address_line1`	`string`	Can be removed/added via the Payload builder
`previous.address_line2`	`string`	Can be removed/added via the Payload builder
`previous.city`	`string`	Can be removed/added via the Payload builder
`previous.state_province`	`string`	Can be removed/added via the Payload builder
`previous.postal_code`	`string`	Can be removed/added via the Payload builder
`previous.country_code`	`string`	Can be removed/added via the Payload builder
`previous.phone`	`string`	Can be removed/added via the Payload builder
`current.id`	`string`	Can be removed/added via the Payload builder
`current.name`	`string`	Can be removed/added via the Payload builder
`current.slug`	`string`	Can be removed/added via the Payload builder
`current.app_id`	`string`	Can be removed/added via the Payload builder
`current.is_app_managed`	`boolean`	Can be removed/added via the Payload builder
`current.is_primary`	`boolean`	Can be removed/added via the Payload builder
`current.is_active`	`boolean`	Can be removed/added via the Payload builder
`current.fulfills_online_orders`	`boolean`	Can be removed/added via the Payload builder
`current.fulfillment_priority`	`integer`	Can be removed/added via the Payload builder
`current.pickup_enabled`	`boolean`	Can be removed/added via the Payload builder
`current.local_delivery_enabled`	`boolean`	Can be removed/added via the Payload builder
`current.address_line1`	`string`	Can be removed/added via the Payload builder
`current.address_line2`	`string`	Can be removed/added via the Payload builder
`current.city`	`string`	Can be removed/added via the Payload builder
`current.state_province`	`string`	Can be removed/added via the Payload builder
`current.postal_code`	`string`	Can be removed/added via the Payload builder
`current.country_code`	`string`	Can be removed/added via the Payload builder
`current.phone`	`string`	Can be removed/added via the Payload builder
`changed_fields`	`array`	Can be removed/added via the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [],
  "current": {
    "address_line1": null,
    "address_line2": null,
    "app_id": null,
    "city": null,
    "country_code": null,
    "fulfillment_priority": 0,
    "fulfills_online_orders": false,
    "id": 7,
    "is_active": false,
    "is_app_managed": false,
    "is_primary": false,
    "local_delivery_enabled": false,
    "name": "Acme",
    "phone": null,
    "pickup_enabled": false,
    "postal_code": null,
    "slug": "acme",
    "state_province": null
  },
  "occurred_at": "...",
  "previous": {
    "address_line1": null,
    "address_line2": null,
    "app_id": null,
    "city": null,
    "country_code": null,
    "fulfillment_priority": 0,
    "fulfills_online_orders": false,
    "id": 7,
    "is_active": false,
    "is_app_managed": false,
    "is_primary": false,
    "local_delivery_enabled": false,
    "name": "Acme",
    "phone": null,
    "pickup_enabled": false,
    "postal_code": null,
    "slug": "acme",
    "state_province": null
  },
  "resource_id": "...",
  "resource_type": "..."
}

Location fulfillment disabled

EVENT locations/fulfillment_disabled write_locations locations:write

Fired when a location's fulfills_online_orders flips from true to false. Fulfillment integrations should stop routing new online orders here.

Payload fields

Field	Type	Description
`resource_type`	`string`	Can be removed/added via the Payload builder
`resource_id`	`string`	Can be removed/added via the Payload builder
`occurred_at`	`string`	Can be removed/added via the Payload builder
`previous.id`	`string`	Can be removed/added via the Payload builder
`previous.name`	`string`	Can be removed/added via the Payload builder
`previous.slug`	`string`	Can be removed/added via the Payload builder
`previous.app_id`	`string`	Can be removed/added via the Payload builder
`previous.is_app_managed`	`boolean`	Can be removed/added via the Payload builder
`previous.is_primary`	`boolean`	Can be removed/added via the Payload builder
`previous.is_active`	`boolean`	Can be removed/added via the Payload builder
`previous.fulfills_online_orders`	`boolean`	Can be removed/added via the Payload builder
`previous.fulfillment_priority`	`integer`	Can be removed/added via the Payload builder
`previous.pickup_enabled`	`boolean`	Can be removed/added via the Payload builder
`previous.local_delivery_enabled`	`boolean`	Can be removed/added via the Payload builder
`previous.address_line1`	`string`	Can be removed/added via the Payload builder
`previous.address_line2`	`string`	Can be removed/added via the Payload builder
`previous.city`	`string`	Can be removed/added via the Payload builder
`previous.state_province`	`string`	Can be removed/added via the Payload builder
`previous.postal_code`	`string`	Can be removed/added via the Payload builder
`previous.country_code`	`string`	Can be removed/added via the Payload builder
`previous.phone`	`string`	Can be removed/added via the Payload builder
`current.id`	`string`	Can be removed/added via the Payload builder
`current.name`	`string`	Can be removed/added via the Payload builder
`current.slug`	`string`	Can be removed/added via the Payload builder
`current.app_id`	`string`	Can be removed/added via the Payload builder
`current.is_app_managed`	`boolean`	Can be removed/added via the Payload builder
`current.is_primary`	`boolean`	Can be removed/added via the Payload builder
`current.is_active`	`boolean`	Can be removed/added via the Payload builder
`current.fulfills_online_orders`	`boolean`	Can be removed/added via the Payload builder
`current.fulfillment_priority`	`integer`	Can be removed/added via the Payload builder
`current.pickup_enabled`	`boolean`	Can be removed/added via the Payload builder
`current.local_delivery_enabled`	`boolean`	Can be removed/added via the Payload builder
`current.address_line1`	`string`	Can be removed/added via the Payload builder
`current.address_line2`	`string`	Can be removed/added via the Payload builder
`current.city`	`string`	Can be removed/added via the Payload builder
`current.state_province`	`string`	Can be removed/added via the Payload builder
`current.postal_code`	`string`	Can be removed/added via the Payload builder
`current.country_code`	`string`	Can be removed/added via the Payload builder
`current.phone`	`string`	Can be removed/added via the Payload builder
`changed_fields`	`array`	Can be removed/added via the Payload builder

Payload shape

Sample payload

{
  "changed_fields": [],
  "current": {
    "address_line1": null,
    "address_line2": null,
    "app_id": null,
    "city": null,
    "country_code": null,
    "fulfillment_priority": 0,
    "fulfills_online_orders": false,
    "id": 7,
    "is_active": false,
    "is_app_managed": false,
    "is_primary": false,
    "local_delivery_enabled": false,
    "name": "Acme",
    "phone": null,
    "pickup_enabled": false,
    "postal_code": null,
    "slug": "acme",
    "state_province": null
  },
  "occurred_at": "...",
  "previous": {
    "address_line1": null,
    "address_line2": null,
    "app_id": null,
    "city": null,
    "country_code": null,
    "fulfillment_priority": 0,
    "fulfills_online_orders": false,
    "id": 7,
    "is_active": false,
    "is_app_managed": false,
    "is_primary": false,
    "local_delivery_enabled": false,
    "name": "Acme",
    "phone": null,
    "pickup_enabled": false,
    "postal_code": null,
    "slug": "acme",
    "state_province": null
  },
  "resource_id": "...",
  "resource_type": "..."
}

Endpoints#

Headers

Query parameters

Headers

Path parameters

Headers

Errors

Headers

Body parameters

Errors

Path parameters

Headers

Body parameters

Errors

Path parameters

Headers

Errors

Headers

Body parameters

Errors

Fields#

Webhook events#

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields

Payload fields