Base URL: https://api.shipbob.com/experimental
Sandbox URL: https://sandbox-api.shipbob.com/experimental Authentication:
All requests must include one of the following:
  • Personal Access Token (PAT): Authorization: Bearer <TOKEN>
  • OAuth2 Access Token

​
🔹 Get Invoices

Endpoint: GET /invoices
API Reference ↗ Retrieve a paginated list of billing invoices.

​
Query Parameters

NameTypeDescription
limitintNumber of invoices per page (default is 100)
offsetintOffset used for pagination
invoiceTypesarrayFilter by invoice type: AdditionalFee, Inbound Fee, Shipping, Payment, WarehouseStorage

​
Example Request

GET /invoices
Authorization: Bearer <TOKEN>

​
Example Response

{
  "items": [
    {
      "invoiceId": 7997798,
      "invoiceDate": "2025-07-14",
      "invoiceType": "AdditionalFee",
      "amount": 4.07,
      "currencyCode": "USD",
      "runningBalance": 100.00
    }
  ]
}

​
🔹 Get Transactions by Invoice ID

Endpoint: GET /invoices/{invoiceId}/transactions
API Reference ↗ Get all transactions tied to a specific invoice.

​
Path Parameters

NameTypeDescription
invoiceIdintThe ID of the invoice

​
Example Request

GET /invoices/123/transactions
Authorization: Bearer <TOKEN>

​
Example Response

[
  {
    "transaction_id": 456,
    "amount": 75.00,
    "type": "Charge",
    "reference_id": "INV-2024-07-123",
    "date": "2024-06-15T10:00:00Z"
  }
]

​
🔹 Search Transactions

Endpoint: POST /transactions:query
API Reference ↗ Search billing transactions using filters like invoice ID, transaction type, or reference ID.

​
Body Parameters

NameTypeDescription
invoice_idsarrayFilter by one or more invoice IDs
transaction_typesarrayFilter by type: Charge, Refund, etc.
start_datestringStart date in ISO 8601 (e.g. 2024-06-01T00:00:00Z)
end_datestringEnd date in ISO 8601 format
reference_idsarrayFilter by reference IDs

​
Example Request

POST /transactions:query
Authorization: Bearer <TOKEN>
Content-Type: application/json

{
  "reference_ids": ["200000000"]
}

​
Example Response

{
  "items": [
    {
      "amount": 5.00,
      "currencyCode": "USD",
      "insertDate": "2025-07-01",
      "invoiced": false,
      "referenceId": "200000000",
      "transactionType": "Charge"
    }
  ]
}

​
🔹 Get Transaction Fees

Endpoint: GET /transaction-fees
API Reference ↗ Returns a list of all transaction fees that may be used in billing.

​
Example Request

GET /transaction-fees
Authorization: Bearer <TOKEN>

​
Example Response

[
  {
    "name": "Shipping",
    "description": "Fees related to shipping services"
  },
  {
    "name": "WarehouseStorage",
    "description": "Fees related to warehouse storage usage"
  }
]

​
🔐 Authentication

Add one of the following headers to all requests:
  • Personal Access Token:
Authorization: Bearer <your-token>
  • OAuth2 Access Token:
Authorization: Bearer <your-oauth-token>

​
🕒 Notes

  • All dates and times are in UTC and follow ISO 8601 format.
  • For paginated endpoints, use limit and offset to navigate through results.