publicProducts

Public: no authentication required.

Lists a seller's active products for the public storefront, one page at a time. Needs no sign-in. An unknown subdomain gives an empty list.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query PublicProducts($subdomain: String!) {
  publicProducts(subdomain: $subdomain) {
    items {
      id
      name
      brandName
      availabilityState
      brandId
      canAddToCart
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query PublicProducts($subdomain: String!) {\n  publicProducts(subdomain: $subdomain) {\n    items {\n      id\n      name\n      brandName\n      availabilityState\n      brandId\n      canAddToCart\n    }\n  }\n}",
  "variables": {
    "subdomain": "string"
  }
}
EOF

Variables:

{
  "subdomain": "string"
}

Response:

{
  "data": {
    "publicProducts": {
      "items": [
        {
          "id": "id",
          "name": "string",
          "brandName": "string",
          "availabilityState": "string",
          "brandId": "id",
          "canAddToCart": true
        }
      ]
    }
  }
}

publicProducts(
  filter: CustomerProductFilterInput
  subdomain: String!
): CustomerProductConnection!

Arguments

publicProducts.filter ● CustomerProductFilterInput input

Search text, filters, sort order and paging for the list.

publicProducts.subdomain ● String! non-null scalar

The seller's storefront subdomain.

Type

CustomerProductConnection object

A page of products.