Search transactions

curl --request POST \
  --url https://api.shipbob.com/2025-07/transactions:query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from_date": "2019-08-24",
  "invoice_ids": [
    "12345"
  ],
  "invoiced_status": true,
  "page_size": 10,
  "reference_ids": [
    "11553288",
    "43-12000928-Pallet00"
  ],
  "reference_types": [
    "FC"
  ],
  "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"
}

POST

2025-07

transactions:query

Search transactions

curl --request POST \
  --url https://api.shipbob.com/2025-07/transactions:query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from_date": "2019-08-24",
  "invoice_ids": [
    "12345"
  ],
  "invoiced_status": true,
  "page_size": 10,
  "reference_ids": [
    "11553288",
    "43-12000928-Pallet00"
  ],
  "reference_types": [
    "FC"
  ],
  "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"
}

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).

from_date

string<date-time> | null

Start date for filtering transactions by transaction charge date. Default is current – 7 days

invoice_ids

string[] | null

List of invoice IDs to filter transactions

invoiced_status

boolean | null

Filter Transactions by invoicing status:

True(Billed Transactions)
False(Unbilled Transactions)
null (Billed + Unbilled Transactions)

page_size

integer<int32>

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.

reference_ids

string[] | null

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

reference_types

string[] | null

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

Shipment
Return
WRO
URO

sort_order

enum<string>

Available options:

Ascending,

Descending

to_date

string<date-time> | null

End date for filtering transactions by transaction charge date. Default is current date.

transaction_fees

string[] | null

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

transaction_types

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

Show child attributes

items.additional_details

object

Any additional details related to the transaction in a key-value pair format.

Show child attributes

items.additional_details.{key}

object

items.amount

number<double> | null

Charge Amount for the transaction

Example:

0.09

items.charge_date

string | null

The Charge date of transaction

Example:

"2025-01-01"

items.currency_code

string | null

The ISO currency code (e.g., USD, EUR) for the transaction.

Example:

"USD"

items.fulfillment_center

string | null

The name or code of the fulfillment center involved in the transaction.

Example:

"Altona VIC"

items.invoice_date

string | null

The date the invoice was generated.

Example:

"2025-01-01"

items.invoice_id

integer<int32> | null

The unique identifier of the related invoice.

Example:

12345

items.invoice_type

string | null

The type or category of the invoice. Available options:

Shipping
Inbound Fee
WarehouseStorage
AdditionalFee
Return
Credits
BalanceAdjustment
Payment

Example:

"Shipping"

items.invoiced_status

boolean | null

items.reference_id

string | null

A unique reference identifier associated with the transaction.

Example:

"12345"

items.reference_type

string | null

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

Shipment
Return
WRO
URO
Ticket Number
FC
LPN Reference
Transfer Plan

Example:

"Shipment"

items.taxes

object[] | null

A list of tax details applied to the transaction if exists.

Show child attributes

items.taxes.tax_amount

number<double>

Tax amount charged for the tax type.

Example:

0.01

items.taxes.tax_rate

number<double>

Rate of Tax charged for the tax type

Example:

10

items.taxes.tax_type

string | null

Type of tax charged for eg. GST

Example:

"GST"

items.transaction_fee

string | null

The fee type associated with the transaction for eg. Shipping fees To get all the available transaction fees use the endpoint - '/transaction-fees'

Example:

"Shipping"

items.transaction_id

string | null

The unique identifier for transaction

Example:

"01AN4Z07BY79KA1307SR9X4MV3"

items.transaction_type

string | null

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

Example:

"Charge"

last

string | null

Go to the Last page

string | null

Go to the Next page

string | null

Go to the Previous page

Get Invoices Get transactions by invoiceid

⌘I

API Reference

Authorizations

Query Parameters

Body

Response