Skip to content
Documentation sections

Retrieve list of shipments called with the API

GET /shipment-usage on the Webhooks API. Base URL: https://api.sinay.ai/webhook/api/v1.

Retrieve the list of shipments called with the API within the provided timeframe, that usages have a minimum resolution of a month (you cant select the usage for one week for example, the usage will automatically be for the month of the week provided)

Query parameters

string (date-time)

Start time at which usages must be found

string (date-time)

End time at which usages must be found

anyenum
Allowed:

Responses

Body: application/json, object.

FieldTypeRequiredDescription
apisobjectNo—
apis.<key>objectNo—
apis.<key>.periodicUsagesobjectNo—
apis.<key>.periodicUsages.<key>objectNo—
apis.<key>.periodicUsages.<key>.consumedShipmentinteger (int32)Yes—
apis.<key>.periodicUsages.<key>.consumedShipmentListarray of stringYes—