POST
/
transactions:query
Search transactions
curl --request POST \
  --url https://api.shipbob.com/experimental/transactions:query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "fromDate": "2019-08-24",
  "invoiceIds": [
    "123",
    "456"
  ],
  "invoicedStatus": true,
  "pageSize": 0,
  "referenceIds": [
    "11553288",
    "43-12000928-Pallet00"
  ],
  "referenceTypes": [
    "FC"
  ],
  "sortOrder": "Ascending",
  "toDate": "2019-08-24",
  "transactionFees": [
    "Kitting Fee",
    "Warehousing Fee"
  ],
  "transactionTypes": [
    "Charge"
  ]
}'
{
  "first": "f8cUk/xJkbeYp2L8oHqxL2hFiGz3qjre",
  "items": [
    {
      "additionalDetails": {
        "Comment": "TestInvoice"
      },
      "amount": 0.09,
      "chargeDate": "2025-01-01",
      "currencyCode": "USD",
      "fulfillmentCenter": "Altona VIC",
      "invoiceDate": "2025-01-01",
      "invoiceId": 12345,
      "invoiceType": "Shipping",
      "invoicedStatus": true,
      "referenceId": "12345",
      "referenceType": "Shipment",
      "taxes": [
        {
          "taxAmount": 0.01,
          "taxRate": 10,
          "taxType": "GST"
        }
      ],
      "transactionFee": "Shipping",
      "transactionType": "Charge"
    }
  ],
  "last": "f8cUk/xJkbeYp2L8oHqxL2hFiGz3qjqt",
  "next": "f8cUk/xjhyEYp2L8oHqxL2hFiGz3qjqt",
  "prev": "f8cUk/xJkbeYp2L8oHqxL2hFiGz3qjcc"
}

Authorizations

​
Authorization
string
header
required

Authentication using Personal Access Token (PAT) token

Query Parameters

​
cursor
string

[Optional] A pagination token used to jump to first, last, next or previous pages. When supplied, it overrides all other filter parameters.

Body

application/json

Used to filter transactions based on search criteria. Required if cursor is not provided. Ignored when cursor is present (i.e., for paginated requests).

The body is of type object.

Response

200
application/json

Success

The response is of type object.