Lists all deliveries for the buyer

GET /api/public/buyer/v1/deliveries

Lists all deliveries for the buyer

cURL

curl --request GET \
  --url https://app.chemcloud.com.au/api/public/buyer/v1/deliveries \
  --header 'X-API-KEY: <api-key>'

200

[
  {
    "id": "99999a99-b888-777c-666d-55555555555e",
    "url": "https://app.chemcloud.com.au/buyer/deliveries/99999a99-b888-777c-666d-55555555555e",
    "order_id": "99999a99-b888-777c-666d-55555555555e",
    "reference": "DEL-001",
    "status": "requested",
    "fulfilment_entity": "chemcloud",
    "required_date": "2025-12-31",
    "estimated_time_of_departure": "2025-12-31T23:13:11.862Z",
    "estimated_time_of_arrival": "2025-12-31T23:13:11.862Z",
    "actual_time_of_departure": "2025-12-31T23:13:11.862Z",
    "estimated_port_arrival_date": "2025-12-31T23:13:11.862Z",
    "actual_port_arrival_date": "2025-12-31T23:13:11.862Z",
    "delivered_at": "2025-12-31T23:13:11.862Z",
    "tracking_number": "TRACK-001",
    "tracking_url": "https://tracking.example.com/TRACK-001",
    "container_number": "CONT-001",
    "order_attributes": {
      "purchase_order_reference": "PO-001",
      "supplier_order_reference": "SO-001"
    },
    "additional_data": {
      "product": {
        "buyer_product_display_name": "Sodium Hydroxide 50%"
      },
      "supplier": {
        "supplier_name": "Supplier Co"
      }
    },
    "created_at": "2025-12-31T23:13:11.862Z",
    "updated_at": "2025-12-31T23:13:11.862Z"
  }
]

Authorizations

X-API-KEY · string · header · required

Query Parameters

created_at_from · string

Filter deliveries created on or after this date (YYYY-MM-DD)

created_at_to · string

Filter deliveries created on or before this date (YYYY-MM-DD)

status[] · enum<string>[]

Filter by delivery status

Available options: requested, confirmed, shipped, in_port, delivered

Response

200 - application/json

Deliveries retrieved

id · string<uuid>

Example:

"99999a99-b888-777c-666d-55555555555e"

url · string

Example:

"https://app.chemcloud.com.au/buyer/deliveries/99999a99-b888-777c-666d-55555555555e"

order_id · string<uuid>

Example:

"99999a99-b888-777c-666d-55555555555e"

reference · string | null

Example:

"DEL-001"

status · enum<string>

Available options: requested, confirmed, shipped, in_port, delivered

Example:

"requested"

fulfilment_entity · enum<string>

Available options: chemcloud, supplier

Example:

"chemcloud"

required_date · string<date> | null

Example:

"2025-12-31"

estimated_time_of_departure · string<date-time> | null

Example:

"2025-12-31T23:13:11.862Z"

estimated_time_of_arrival · string<date-time> | null

Example:

"2025-12-31T23:13:11.862Z"

actual_time_of_departure · string<date-time> | null

Example:

"2025-12-31T23:13:11.862Z"

estimated_port_arrival_date · string<date-time> | null

Example:

"2025-12-31T23:13:11.862Z"

actual_port_arrival_date · string<date-time> | null

Example:

"2025-12-31T23:13:11.862Z"

delivered_at · string<date-time> | null

Example:

"2025-12-31T23:13:11.862Z"

tracking_number · string | null

Example:

"TRACK-001"

tracking_url · string | null

Example:

"https://tracking.example.com/TRACK-001"

container_number · string | null

Example:

"CONT-001"

order_attributes · object

Show child attributes

additional_data · object

Show child attributes

created_at · string<date-time>

Example:

"2025-12-31T23:13:11.862Z"

updated_at · string<date-time>

Example:

"2025-12-31T23:13:11.862Z"