POST
/
experimental
/
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).

​
fromDate
string<date-time> | null

Start date for filtering transactions by transaction charge date.

​
invoiceIds
string[] | null

List of invoice IDs to filter transactions

​
invoicedStatus
boolean | null

Filter Transactions by invoicing status:

  • True(Billed Transactions)
  • False(Unbilled Transactions)
  • null (Billed + Unbilled Transactions)
​
pageSize
integer

Number of transactions to return per page (default is 100, to be entered when API is called for first time). Must be between 1 and 1000.

​
referenceIds
string[] | null

List of reference IDs (like Shipment ID, WRO id) to filter transactions (can be numeric or string identifiers).

​
referenceTypes
string[] | null

The type of reference associated with the ReferenceId. Available options:

  • Shipment
  • Return
  • WRO
  • URO
​
sortOrder
enum<string>
Available options:
Ascending,
Descending
​
toDate
string<date-time> | null

End date for filtering transactions by transaction charge date.

​
transactionFees
string[] | null

To get all the available transaction fees use this endpoint:- '/transaction-fees'

​
transactionTypes
string[] | null

The classification or nature of the transaction Transaction Types - Charge, Refund, Credit, Payment, BalanceAdjustment

Response

Success

​
first
string | null

Go to the first page

​
items
object[] | null
​
last
string | null

Go to the Last page

​
next
string | null

Go to the Next page

​
prev
string | null

Go to the Previous page