customerOrders query

The Sales module performs a wide variety of functions, including order, invoice, and shipment management. However, most of these functions are performed on the backend, and the customer does not have access to this information. By returning a list of customer orders, the customerOrders query allows a customer to retrieve their order histories.

We recommend you use customer tokens in the header of your GraphQL calls. However, you also can use session authentication.

Syntax

{customerOrders {CustomerOrders}}

Example usage

The following query returns the order history of the logged in customer.

Request:

1
2
3
4
5
6
7
8
9
10
11
{
  customerOrders {
    items {
      order_number
      id
      created_at
      grand_total
      status
    }
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
  "data": {
    "customerOrders": {
      "items": [
        {
          "order_number": "000000001",
          "id": 1,
          "created_at": "2019-02-21 00:24:34",
          "grand_total": 36.39,
          "status": "processing"
        },
        {
          "order_number": "000000002",
          "id": 2,
          "created_at": "2019-02-21 00:24:35",
          "grand_total": 39.64,
          "status": "closed"
        }
      ]
    }
  }
}

Output attributes

The CustomerOrders object contains the items attribute.

Customer order items attributes

The CustomerOrder object defines details about each order the customer has placed.

Errors