List all invoice items

Endpoint is in beta and API contract is subject to change.

Retrieves a collection of invoice items that belong to the authenticated user. Invoice object ID and object owner object ID can be used to filter the result set. The results are paginated. Please see filtering documentation for more information on date filtering and pagination.

SecurityAPIKeyHeader
Request
query Parameters
invoiceObjectId
string

The invoice object ID identifier of the Invoice whose Invoice Items you want to select.

invoiceNumber
string

The invoice number identifier of the Invoice whose Invoice Items you want to select.

shippoAccountId
string

Account identifier for the owner of the Invoice Item. Use this to filter Invoice Items for Shippo Managed Accounts.

page
integer <int64>
Default: 1

The page number you want to select

results
integer <int64> <= 100
Default: 25

The number of results to return per page (max 100)

header Parameters
SHIPPO-API-VERSION
string

String used to pick a non-default API version to use

Responses
200
get/invoice-items
Request samples 
curl /invoice-items?results=20&page=2  \
  -H "Authorization: ShippoToken <API_TOKEN>" \
  -H "Content-Type: application/json"
Response samples
application/json
{
  • "next": "baseurl?page=3&results=10",
  • "previous": "baseurl?page=1&results=10",
  • "results": [
    ]
}