GoDaddy
Support
API ReferenceCommerceProducts & inventoryCatalog GraphQLInventoryQuerylocations

locations

View as Markdown

Query `locations` on the catalog subgraph (Inventory).

query

Requires commerce.product:read.

Query locations on the catalog subgraph (Inventory).

Required headers

HeaderRequiredDescription
x-store-idYesID of the store the operation targets. Omitting it returns HTTP 200 with a GraphQL error: extensions.code: "UNAUTHENTICATED".

Go to Authentication for credential setup.

Arguments

  • after String optional
  • before String optional
  • createdAt CreatedAtFilter optional
    • gt String optional
    • lt String optional
  • first Int optional
  • id LocationIdsFilter optional
    • in [String!] optional
  • last Int optional
  • name NameFilter optional
    • contains String optional — Filters items where the name contains the specified string, case-insensitive.
    • eq String optional
    • in [String!] optional — Filters items where the name matches any of the specified names.
  • orderBy LocationOrderBy optional
    • createdAt OrderByDirectionEnum optional
    • id OrderByDirectionEnum optional
    • name OrderByDirectionEnum optional
    • updatedAt OrderByDirectionEnum optional
  • paginationType PaginationType optional Default: "CURSOR".
  • referenceValue ReferenceValueFilter optional
    • eq String optional
    • in [String!] optional
  • skuId SKUIdFilter optional
    • eq String optional
    • in [String!] optional
  • status LocationStatusFilter optional
    • eq String optional
    • in [String!] optional
  • updatedAt UpdatedAtFilter optional
    • gt String optional
    • lt String optional

Possible returns

  • QueryLocationsConnection QueryLocationsConnection

Last updated on

How is this guide?