List Lines of Receipt

GET

https://api-b2b.bigcommerce.com/api/v3/io/ip/receipts/:receiptId/lines

GET

/api/v3/io/ip/receipts/:receiptId/lines

curl https://api-b2b.bigcommerce.com/api/v3/io/ip/receipts/receiptId/lines \
     -H "X-Auth-Token: <apiKey>"

{
  "code": 200,
  "data": [
    {
      "id": 92,
      "createdAt": 1630570416,
      "updatedAt": 1630570416,
      "storeHash": "1i6zpxpe3g",
      "customerId": "5707",
      "externalId": "",
      "externalCustomerId": "",
      "receiptId": 83,
      "invoiceId": 19,
      "amount": {
        "code": "CNY",
        "value": "0.7000"
      },
      "paymentStatus": 3,
      "paymentType": "Offline",
      "invoiceNumber": "00000019",
      "paymentId": 90,
      "referenceNumber": "test",
      "transactionType": "Paid"
    },
    {
      "id": 91,
      "createdAt": 1630570416,
      "updatedAt": 1630570416,
      "storeHash": "1i6zpxpe3g",
      "customerId": "5707",
      "externalId": "",
      "externalCustomerId": "",
      "receiptId": 83,
      "invoiceId": 22,
      "amount": {
        "code": "CNY",
        "value": "0.5000"
      },
      "paymentStatus": 3,
      "paymentType": "Offline",
      "invoiceNumber": "00000022",
      "paymentId": 90,
      "referenceNumber": "test",
      "transactionType": "Paid"
    }
  ],
  "meta": {
    "message": "SUCCESS",
    "pagination": {
      "limit": 10,
      "offset": 0,
      "totalCount": 2
    }
  }
}

Get lines of a receipt, with pagination data

Authentication

X-Auth-Tokenstring

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

X-Store-Hashstring

Header	Argument	Description
`X-Store-Hash`	`store_hash`	The unique store hash associated with a BigCommerce store that has B2B Edition enabled.

Path parameters

receiptIdstringRequired

The unique ID of the receipt.

Query parameters

offsetintegerOptional>=0

Pagination offset default: 0

limitintegerOptional1-250Defaults to 10

Pagination limit default: 10

orderByenumOptionalDefaults to DESC

Allow: ‘DESC’, ‘ASC’

Allowed values:

paymentStatus[]list of enumsOptional

Payment processing status. 0 means ‘Incomplete’ status, 1 means ‘Awaiting Processing’ status, 2 means ‘Processing’ status, 3 means ‘Completed’ status, 4 means ‘Refunded’ status

Allowed values:

qstringOptional

You can perform keyword queries on fields corresponding to the value of "searchBy" or, if "searchBy" is empty, on all fields supported by "searchBy".

searchByenumOptional

The response search by which field

sortByenumOptionalDefaults to createdAt

The response sorted by which field

Response

codedouble

datalist of objects

metaobject

Errors

404

Not Found Error