Search Transactions | ShipBob Developer API

curl -X POST "https://sandbox-api.shipbob.com/2026-01/transactions:query?Cursor=f8cUk%2FxJkbeYp2fCr3yJJvL8oHqxL2hFiGz3qjqtkQ5Q0%2BBVMffFoIfoqzOkEsAw" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "from_date": "2019-08-24",
  "invoice_ids": [
    "12345"
  ],
  "invoiced_status": true,
  "page_size": 10,
  "reference_ids": [
    "11553288",
    "43-12000928-Pallet00"
  ],
  "reference_types": [
    "Shipment"
  ],
  "sort_order": "Ascending",
  "to_date": "2019-08-24",
  "transaction_fees": [
    "Kitting Fee",
    "Warehousing Fee"
  ],
  "transaction_types": [
    "Charge"
  ]
}'

{
  "first": "f8cUk/xJkbeYp2L8oHqxL2hFiGz3qjre",
  "items": [
    {
      "additional_details": {
        "comment": "TestInvoice"
      },
      "amount": 0.09,
      "charge_date": "2025-01-01",
      "currency_code": "USD",
      "fulfillment_center": "Altona VIC",
      "invoice_date": "2025-01-01",
      "invoice_id": 12345,
      "invoice_type": "Shipping",
      "invoiced_status": true,
      "reference_id": "12345",
      "reference_type": "Shipment",
      "taxes": [
        {
          "tax_amount": 0.01,
          "tax_rate": 10,
          "tax_type": "GST"
        }
      ],
      "transaction_fee": "Shipping",
      "transaction_id": "01AN4Z07BY79KA1307SR9X4MV3",
      "transaction_type": "Charge"
    }
  ],
  "last": "f8cUk/xJkbeYp2L8oHqxL2hFiGz3qjqt",
  "next": "f8cUk/xjhyEYp2L8oHqxL2hFiGz3qjqt",
  "prev": "f8cUk/xJkbeYp2L8oHqxL2hFiGz3qjcc"
}

Search transactions with filters (date, invoice, fee type, etc.)

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

AuthorizationBearer

OAuth2 authentication using JWT tokens

Query parameters

CursorstringOptional

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

Request

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

from_datedatetimeOptional

Start date for filtering transactions by charge date. Defaults to 7 days before the current date if not specified.

invoice_idslist of stringsOptional

List of invoice IDs to filter transactions by.

invoiced_statusbooleanOptional

Filter transactions by invoicing status. True returns billed transactions, false returns unbilled transactions, and null returns both billed and unbilled transactions.

page_sizeintegerOptional

Number of transactions to return per page. Default is 100. Must be between 1 and 1000.

reference_idslist of stringsOptional

List of reference IDs (such as Shipment IDs, WRO IDs) to filter transactions. Can be numeric or string identifiers.

reference_typeslist of enumsOptional

The types of references associated with the reference IDs to filter by.

sort_orderenumOptionalDefaults to Descending

Sort order for results. Ascending sorts from lowest to highest, Descending sorts from highest to lowest.

to_datedatetimeOptional

End date for filtering transactions by charge date. Defaults to the current date if not specified.

transaction_feeslist of stringsOptional

List of transaction fee types to filter by. To get all available transaction fees, use the ‘/transaction-fees’ endpoint.

transaction_typeslist of enumsOptional

The classification or nature of the transactions to filter by.

Response

Success

firststring

Go to the first page

itemslist of objects

laststring

Go to the Last page

nextstring

Go to the Next page

prevstring

Go to the Previous page

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error