wholesale_order

Fetch wholesale order records matching the supplied arguments.

Arguments

ArgumentTypeRequiredDefaultDescription
idStringNo

Filter by ID; pass the public API ID unless the field name says legacy ID.

order_idStringNo

Filter by order ID; pass the public API ID unless the field name says legacy ID.

analyzeBooleanNo

If true, the query will only be analyzed (cost estimated) without executing it.

Return Type

WholesaleOrderQueryResult

Query

query wholesale_order(
  $id: String,
  $order_id: String,
  $analyze: Boolean
) {
  wholesale_order(
    id: $id,
    order_id: $order_id,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...WholesaleOrderFragment
    }
  }
}

Variables

{
  "id": "UmVjb3JkOjEyMzQ=",
  "order_id": "T3JkZXI6MTIzNA==",
  "analyze": true
}

Response

{
  "data": {
    "wholesale_order": {
      "request_id": "UmVjb3JkOjEyMzQ=",
      "complexity": 100,
      "data": {id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"}
    }
  }
}