Shows an order

GET /api/public/buyer/v1/orders/{id}

Shows an order

cURL

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

200

{
  "id": "99999a99-b888-777c-666d-55555555555e",
  "url": "https://app.chemcloud.com.au/buyer/orders/99999a99-b888-777c-666d-55555555555e",
  "supplier_profile_id": "99999a99-b888-777c-666d-55555555555e",
  "buyer_product_approval_id": "99999a99-b888-777c-666d-55555555555e",
  "price_type": "ex_stock",
  "quantity": 10,
  "price_per_uom": 100,
  "tax_amount": 100,
  "tax_percentage": 10,
  "price_total": 1100,
  "currency": "AUD",
  "profile_connection_relationship": "direct",
  "order_reference": "ORD-001",
  "order_status": "order_placed",
  "purchase_order_reference": "PO-001",
  "supplier_order_reference": "SO-001",
  "order_type": {
    "id": "99999a99-b888-777c-666d-55555555555e",
    "type_of": "spot"
  },
  "resource_values": [
    {
      "provider": "cin7_core",
      "value": "99999a99-b888-777c-666d-55555555555e"
    }
  ],
  "tracking_type": "delivery",
  "additional_data": {
    "product": {
      "buyer_product_display_name": "Sodium Hydroxide 50%"
    },
    "supplier": {
      "supplier_name": "Supplier Co"
    }
  },
  "placed_at": "2025-12-31T23:13:11.862Z",
  "created_at": "2025-12-31T23:13:11.862Z",
  "updated_at": "2025-12-31T23:13:11.862Z",
  "delivery_site": {
    "id": "99999a99-b888-777c-666d-55555555555e",
    "site_name": "Main Warehouse",
    "address": {
      "street": "123 Main St",
      "city": "Sydney",
      "state": "NSW",
      "postcode": "2000",
      "country": "Australia",
      "full_address": "123 Main St, Sydney, NSW, 2000, Australia"
    }
  }
}

Authorizations

X-API-KEY · string · header · required

Path Parameters

id · string · required

Response

200

application/json

Order found

id · string<uuid>

Example:

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

url · string

Example:

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

supplier_profile_id · string<uuid>

Example:

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

buyer_product_approval_id · string<uuid>

Example:

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

price_type · enum<string>

Available options: ex_stock, indent, hot_deal, excess_stock, full_container

Example:

"ex_stock"

quantity · number

Quantity of packs in the order

Example:

10

price_per_uom · number

Price per unit of measure

Example:

100

tax_amount · number

Example:

100

tax_percentage · number

Example:

10

price_total · number

Total price of the order

Example:

1100

currency · string

Currency of the order

Example:

"AUD"

profile_connection_relationship · string | null

Relationship between buyer and supplier

Example:

"direct"

order_reference · string | null

ChemCloud user-friendly reference for the order

Example:

"ORD-001"

order_status · enum<string>

Status of the order

Available options: quote_selected, order_placed, order_confirmed, in_transit, in_warehouse, shipped, in_port, delivered

Example:

"order_placed"

purchase_order_reference · string | null

Purchase order reference number

Example:

"PO-001"

supplier_order_reference · string | null

Supplier order reference number

Example:

"SO-001"

order_type · object

Type of order, i.e. whether it is coming locally or from overseas

Show child attributes

resource_values · object[]

Show child attributes

tracking_type · string | null

Example:

"delivery"

additional_data · object

Show child attributes

placed_at · string<date-time> | null

Example:

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

created_at · string<date-time>

Example:

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

updated_at · string<date-time>

Example:

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

delivery_site · object

Show child attributes