orderedProducts | BigCommerce Developer Center

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
  }
}

{
  "channelId": 0,
  "offset": 0,
  "before": "example",
  "after": "example",
  "first": 0,
  "last": 0,
  "q": "example",
  "productId": "Decimal",
  "beginDateAt": "Date",
  "endDateAt": "Date",
  "minOrderedTimes": "Decimal",
  "maxOrderedTimes": "Decimal",
  "orderBy": "example"
}

{
  "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

productIdDecimalOptional

beginDateAtDateOptional

endDateAtDateOptional

minOrderedTimesDecimalOptional

maxOrderedTimesDecimalOptional

orderByStringOptional

Ordering

Returns

an optional Object

pageInfoObject

Pagination data for this connection.

edgeslist of Objects

totalCountInteger

A total count of items in the collection.