v1

latestOpenAPI 3.0.02026-07-24192576.2 KB
Invoices

List invoices by shipment identifier

This endpoint allows a user to retrieve all invoices associated with a specific shipment identifier.

get/invoices/by_shipment_id/{shipmentId}

Path parameters

shipmentIdstring string required

The public shipment reference number or internal shipment UUID to query invoices for

Query parameters

limitstring string

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

pagestring string

A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the nextPage value returned in a previous response to request subsequent results.

Response

Response is wrapped inside an object named "data"