Commerce · Commerce

List locations

Returns locations. Works with Shopify and WooCommerce accounts.

GEThttps://api.pozy.ai/v1/commerce/locations

Shopify and WooCommercelistCommerceLocations

Guides: Commerce & blogs, Products and catalog

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the commerce resource group disabled get 403 resource_group_disabled. Authentication

Query parameters

Name	Type	Notes
`accountId`required	string

Example

curl -X GET "https://api.pozy.ai/v1/commerce/locations?accountId=696e0b682d0a31188e7a2ba9" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/commerce/locations?accountId=696e0b682d0a31188e7a2ba9", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.get(
    "https://api.pozy.ai/v1/commerce/locations",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    params={
        "accountId": "696e0b682d0a31188e7a2ba9",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

locationsarray of object
- idstring
- namestring
- isActiveboolean
- fulfillsOnlineOrdersboolean
- addressobject
  7 child fields
  - line1string
    Can be null.
  - line2string
    Can be null.
  - citystring
    Can be null.
  - regionstring
    Can be null.
  - postalCodestring
    Can be null.
  - countryCodestring
    Can be null.
  - phonestring
    Can be null.

200 response

{
  "locations": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "name": "Acme",
      "isActive": true,
      "fulfillsOnlineOrders": true,
      "address": {
        "line1": "string",
        "line2": "string",
        "city": "string",
        "region": "string",
        "postalCode": "string",
        "countryCode": "US",
        "phone": "+14155550123"
      }
    }
  ]
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is scoped to other profiles or has this resource group disabled.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

More in Commerce

GETGet a store GETList orders GETGet an order GETList products POSTCreate a product POSTActivate, deactivate, archive or delete products GETGet a product PATCHUpdate a product POSTUpdate variant prices GETList collections POSTCreate a collection GETGet a collection PATCHUpdate a collection DELDelete a collection POSTAdd or remove products in a collection POSTAdd variants DELDelete variants POSTAdd options DELDelete options POSTAdd images DELRemove images POSTReorder images POSTDuplicate a product GETList product metafields PUTSet product metafields DELDelete product metafields POSTPublish or unpublish a product GETList collection metafields PUTSet collection metafields DELDelete collection metafields POSTPublish or unpublish a collection POSTAdd or remove tags in bulk POSTReorder products in a collection GETList pages POSTCreate a page GETGet a page PATCHUpdate a page DELDelete a page GETGet a product's stock POSTSet or adjust stock GETList sales channels GETList discounts POSTCreate a discount GETGet a discount PATCHUpdate a discount DELDelete a discount POSTActivate or deactivate a discount POSTAdd codes to a discount GETList URL redirects POSTCreate a URL redirect PATCHUpdate a URL redirect DELDelete a URL redirect GETList navigation menus POSTCreate a navigation menu GETGet a navigation menu PUTReplace a navigation menu DELDelete a navigation menu GETList metaobject definitions GETList metaobjects of a type POSTCreate a metaobject GETGet a metaobject PATCHUpdate a metaobject DELDelete a metaobject GETList markets GETList price lists PUTSet fixed prices DELRemove fixed prices PUTRecord a marketing activity DELDelete a marketing activity POSTReport daily engagement GETList catalog syncs POSTSync a store into a Meta catalog GETGet a catalog sync DELStop a catalog sync POSTRun a catalog sync now