shoppingLists

Queryin Shopping lists

Get paginated list of shopping lists for the current user

Arguments

Argument	Type	Description
page	Int!	Default 1
pageSize	Int!	Default 20

Returns

ShoppingListResult

Field	Type	Description
items	[ShoppingList!]!	List of shopping lists returned in the result
pagination	Pagination!	Where this page sits within the full result set

Example

Query

query {
  shoppingLists(page: 1, pageSize: 20) {
    items {
      id
      name
      description
      lineItems {
        id
      }
    }
    pagination {
      page
      pageSize
      totalCount
      pageCount
      hasNextPage
      hasPreviousPage
    }
  }
}

Response

{
  "data": {
    "shoppingLists": {
      "items": [
        {
          "id": "id-1",
          "name": "Example",
          "description": "Example",
          "lineItems": [
            {
              "id": "id-1"
            }
          ]
        }
      ],
      "pagination": {
        "page": 1,
        "pageSize": 1,
        "totalCount": 1,
        "pageCount": 1,
        "hasNextPage": true,
        "hasPreviousPage": true
      }
    }
  }
}

The query is the example the schema documents. The response shows its shape with placeholder values.

Served by

@evolve-framework/commercetools	Resolved
@evolve-framework/medusa	Resolved
@evolve-framework/sfcc	Resolved

Used by

The storefront packages that send it, in these GraphQL documents:

• @evolve-storefront/feature-shopping-list: GetGuestShoppingLists