BigCommerce Docs

query ExampleQuery($channelId: Int, $offset: Int, $before: String, $after: String, $first: Int, $last: Int, $search: String, $orderBy: String) {
  customerShoppingLists(channelId: $channelId, offset: $offset, before: $before, after: $after, first: $first, last: $last, search: $search, orderBy: $orderBy) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    edges {
      node
      cursor
    }
    totalCount
  }
}

{
  "channelId": 0,
  "offset": 0,
  "before": "example",
  "after": "example",
  "first": 0,
  "last": 0,
  "search": "example",
  "orderBy": "example"
}

{
  "data": {
    "customerShoppingLists": {
      "pageInfo": {
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example",
        "endCursor": "example"
      },
      "edges": [
        {
          "node": {
            "id": null,
            "createdAt": null,
            "updatedAt": null,
            "name": null,
            "description": null,
            "reason": null,
            "products": null,
            "channelId": null,
            "channelName": null
          },
          "cursor": "example"
        }
      ],
      "totalCount": 0
    }
  }
}

Get all the shopping lists. Requires a BC Token.

Arguments

channelIdIntegerOptional

Filter by BC channel id. Supported in MSF stores

offsetIntegerOptional

beforeStringOptional

afterStringOptional

firstIntegerOptional

lastIntegerOptional

searchStringOptional

orderByStringOptional

Ordering

Returns

an optional CustomerShoppingListPageTypeCountableConnection

pageInfoPageInfo

Pagination data for this connection.

edgeslist of CustomerShoppingListPageTypeCountableEdges

totalCountInteger

A total count of items in the collection.