orderedProducts

Example Query

query ExampleQuery($channelId: Int, $offset: Int, $before: String, $after: String, $first: Int, $last: Int, $q: String, $productId: Decimal, $beginDateAt: Date, $endDateAt: Date, $minOrderedTimes: Decimal, $maxOrderedTimes: Decimal, $orderBy: String) {
  orderedProducts(channelId: $channelId, offset: $offset, before: $before, after: $after, first: $first, last: $last, q: $q, productId: $productId, beginDateAt: $beginDateAt, endDateAt: $endDateAt, minOrderedTimes: $minOrderedTimes, maxOrderedTimes: $maxOrderedTimes, orderBy: $orderBy) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    edges {
      node
      cursor
    }
    totalCount
  }
}

Variables

{
  "channelId": null,
  "offset": 0,
  "before": "example",
  "after": "example",
  "first": 0,
  "last": 0,
  "q": "example",
  "productId": 0,
  "beginDateAt": "2026-10-15",
  "endDateAt": "2026-10-15",
  "minOrderedTimes": 0,
  "maxOrderedTimes": 0,
  "orderBy": "example"
}

Example response

{
  "data": {
    "orderedProducts": {
      "pageInfo": {
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example",
        "endCursor": "example"
      },
      "edges": [
        {
          "node": {
            "id": null,
            "createdAt": null,
            "updatedAt": null,
            "productName": null,
            "productBrandName": null,
            "variantSku": null,
            "productId": null,
            "variantId": null,
            "optionList": null,
            "orderedTimes": null
          },
          "cursor": "example"
        }
      ],
      "totalCount": 0
    }
  }
}

Get an ordered list of the products. Requires a B2B or BC Token.

Arguments

channelIdIntegerOptional

Filter by BC channel id. Supported in MSF stores

offsetIntegerOptional

beforeStringOptional

afterStringOptional

firstIntegerOptional

lastIntegerOptional

qStringOptional

productIdDoubleOptional

beginDateAtDateOptional

endDateAtDateOptional

minOrderedTimesDoubleOptional

maxOrderedTimesDoubleOptional

orderByStringOptional

Ordering

Returns

an optional OrderedProductTypeCountableConnection

pageInfoPageInfo

Pagination data for this connection.

edgeslist of OrderedProductTypeCountableEdges

totalCountIntegerOptional

A total count of items in the collection.