salesOrders

Requires at least one of the permissions sales:sales_order:list or sales:sales_order:read.

List sales orders for the organization, optionally filtered. Omit skip and take to return the whole filtered list, or send both for paging. Reps see only orders for their own customers. Needs the sales order read or list permission.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query SalesOrders {
  salesOrders {
    id
    customerPoNumber
    orderNumber
    sourceQuoteNumber
    trackingNumber
    creatorName
    billingAddress {
      postalCode
      city
      country
      state
      street1
      street2
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query SalesOrders {\n  salesOrders {\n    id\n    customerPoNumber\n    orderNumber\n    sourceQuoteNumber\n    trackingNumber\n    creatorName\n    billingAddress {\n      postalCode\n      city\n      country\n      state\n      street1\n      street2\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "salesOrders": [
      {
        "id": "id",
        "customerPoNumber": "string",
        "orderNumber": "string",
        "sourceQuoteNumber": "string",
        "trackingNumber": "string",
        "creatorName": "string",
        "billingAddress": {
          "postalCode": "string",
          "city": "string",
          "country": "string",
          "state": "string",
          "street1": "string",
          "street2": "string"
        }
      }
    ]
  }
}

salesOrders(
  filters: SalesOrderFiltersInput
  skip: Int
  take: Int
): [SalesOrder!]!

Arguments

salesOrders.filters ● SalesOrderFiltersInput input

Optional filters.

salesOrders.skip ● Int scalar

Number of orders to skip. Send with take for paging.

salesOrders.take ● Int scalar

Number of orders to return. Omit skip and take to return the whole filtered list.

Type

SalesOrder object

A confirmed demand from a customer to ship goods, usually converted from a quote. Moves through confirmation, shipment, invoicing and payment.