younifyd
Menu

Post 2026 07 Transactions Query

Search Transactions

POST/2026-07/transactions:query

Use it in a workflow

  1. Add a step and choose the ShipBob connector.
  2. Pick the Post 2026 07 Transactions Query action (under ShipBob).
  3. Fill in the fields below, then reference the result from later steps as {{post202607TransactionsQuery.response.data}}.

Request

Query parameters

Cursorstring

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

Request body

Enter the body as JSON in the step's Body field.

from_datestring (date-time)

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

invoice_idsarray<string>

List of invoice IDs to filter transactions by.

invoiced_statusboolean

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

page_sizeinteger (int32)

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

reference_idsarray<string>

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

reference_typesarray<string>

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

sort_orderstring

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

One ofAscendingDescendingDefault "Descending"

to_datestring (date-time)

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

transaction_feesarray<string>

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

transaction_typesarray<string>

The classification or nature of the transactions to filter by.

json
{
  "from_date": "2025-01-01T00:00:00Z",
  "invoice_ids": [
    "string"
  ],
  "invoiced_status": false,
  "page_size": 0,
  "reference_ids": [
    "string"
  ],
  "reference_types": [
    "Shipment"
  ],
  "sort_order": "Descending",
  "to_date": "2025-01-01T00:00:00Z",
  "transaction_fees": [
    "string"
  ],
  "transaction_types": [
    "Charge"
  ]
}

Response

Returns 200 with an object. Read it in later steps with {{post202607TransactionsQuery.response.data.<field>}}.

firststring

Go to the first page

itemsarray<object>
additional_detailsobject

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

amountnumber (double)

The charge amount for the transaction.

charge_datestring

The date when the transaction was charged.

currency_codestring

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

fulfillment_centerstring

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

invoice_datestring

The date the invoice was generated.

invoice_idinteger (int32)

The unique identifier of the invoice associated with this transaction.

invoice_typestring

The type or category of the invoice.

One ofShippingInbound FeeWarehouseStorageAdditionalFeeReturnCreditsBalanceAdjustmentPayment

invoiced_statusboolean

Indicates whether the transaction has been invoiced. True if billed, false if unbilled.

reference_idstring

A unique reference identifier associated with the transaction.

reference_typestring

The type of reference associated with the reference ID.

One ofShipmentReturnWROUROTicket NumberFCLPN ReferenceTransfer Plan

taxesarray<object>3 fields

A list of tax details applied to the transaction, if any exist.

transaction_feestring

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

transaction_idstring

The unique identifier for the transaction.

transaction_typestring

The classification or nature of the transaction.

One ofChargeRefundCreditPaymentBalanceAdjustment

laststring

Go to the Last page

nextstring

Go to the Next page

prevstring

Go to the Previous page

json
{
  "first": "string",
  "items": [
    {
      "additional_details": {},
      "amount": 0.09,
      "charge_date": "2026-07-01",
      "currency_code": "USD",
      "fulfillment_center": "Altona VIC",
      "invoice_date": "2026-07-01",
      "invoice_id": 12345,
      "invoice_type": "Shipping",
      "invoiced_status": false,
      "reference_id": "12345",
      "reference_type": "Shipment",
      "taxes": [
        {
          "tax_amount": 0.01,
          "tax_rate": 10,
          "tax_type": "GST"
        }
      ]
    }
  ],
  "last": "string",
  "next": "string",
  "prev": "string"
}

Need more? See the ShipBob guide for connection setup and behaviour shared by every action.