Shipments

List upcoming shipments

Get a list of upcoming shipments for the authenticated partner

post/api/v1/shipments/upcoming

Request

  • Base URL: https://api.wyndly.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.wyndly.com/api/v1/shipments/upcoming
  • Auth: none declared. Required headers: x-api-key

Headers

x-api-keystring required

API Key

Request body

status'queued' | 'processing' | 'shipped' | 'in_transit' | 'out_for_delivery' | 'delivered' | 'failed' | 'returned'

Valid shipment statuses (legacy shipments table)

patient_idinteger nullable

Filter by patient ID

estimated_ship_date_fromstring nullable

Filter by estimated ship date (from, YYYY-MM-DD)

estimated_ship_date_tostring nullable

Filter by estimated ship date (to, YYYY-MM-DD)

limitinteger

Results per page (max 100)

offsetinteger

Number of results to skip

Response

Successful Response

totalinteger required

Total number of matching shipments

limitinteger required

Results per page

offsetinteger required

Number of results skipped

Changes

No recorded changes to this operation across all 1 revision of this API.