receipts | BigCommerce Developer Center

query ExampleQuery($paymentStatus: [Int], $offset: Int, $before: String, $after: String, $first: Int, $last: Int, $search: String, $orderBy: String) {
  receipts(paymentStatus: $paymentStatus, offset: $offset, before: $before, after: $after, first: $first, last: $last, search: $search, orderBy: $orderBy) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    edges {
      node
      cursor
    }
    totalCount
  }
}

{
  "paymentStatus": [
    0
  ],
  "offset": 0,
  "before": "example",
  "after": "example",
  "first": 0,
  "last": 0,
  "search": "example",
  "orderBy": "example"
}

{
  "data": {
    "receipts": {
      "pageInfo": {
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example",
        "endCursor": "example"
      },
      "edges": [
        {
          "node": {
            "id": null,
            "createdAt": null,
            "updatedAt": null,
            "storeHash": null,
            "customerId": null,
            "externalId": null,
            "externalCustomerId": null,
            "totalCode": null,
            "totalAmount": null,
            "payerName": null
          },
          "cursor": "example"
        }
      ],
      "totalCount": 0
    }
  }
}

A list of receipts. Requires IP authentication.

Arguments

paymentStatuslist of optional IntegersOptional

The payment status

offsetIntegerOptional

beforeStringOptional

afterStringOptional

firstIntegerOptional

lastIntegerOptional

searchStringOptional

orderByStringOptional

Ordering

Returns

an optional Object

pageInfoObject

Pagination data for this connection.

edgeslist of Objects

totalCountInteger

A total count of items in the collection.