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"
  ],
  "isInvoiced": true,
  "pageSize": 10,
  "referenceIds": [
    "11553288",
    "43-12000928-Pallet00"
  ],
  "sortOrder": 0,
  "toDate": "2019-08-24",
  "transactionFees": [
    "Kitting Fee",
    "Warehousing Fee"
  ],
  "transactionLogTypes": [
    "Charge"
  ]
}'
{
  "first": "f8cUk/xJkbeYp2L8oHqxL2hFiGz3qjre",
  "items": [
    {
      "additionalDetails": {
        "InvoiceAdditionalDetails": "TestInvoice"
      },
      "amount": 0.09,
      "currencyCode": "USD",
      "fulfillmentCenter": "Altona VIC",
      "insertDate": "2025-01-01",
      "invoiceDate": "2025-01-01",
      "invoiceId": 12345,
      "invoiceType": "Shipping",
      "invoiced": true,
      "referenceId": "12345",
      "referenceType": "Shipment",
      "taxes": [
        {
          "taxAmount": 0.1,
          "taxRate": 0.1,
          "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 cursor for paginated results. It is a random string to go to subsequent pages provided in first/prev/next/last column. If provided, pagination is based on the cursor and other filters are ignored.

Body

application/json

The transaction search filters. <b>Required</b> when cursor is not provided. Ignored when cursor is passed (i.e., on subsequent pages).

The body is of type object.

Response

200
application/json

Success

The response is of type object.