Skip to main content
POST
Records a goods receipt

Authorizations

X-API-KEY
string
header
required

Body

application/json
delivery_id
string<uuid>
required
Example:

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

received_at
string<date-time> | null
Example:

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

quantity
number | null
Example:

100

measurement_unit_id
string<uuid> | null
Example:

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

batch_number
string | null
Example:

"BATCH-9"

manufactured_on
string<date> | null
Example:

"2025-12-31"

expires_on
string<date> | null
Example:

"2025-12-31"

invoice_number
string | null
Example:

"INV-001"

invoice_date
string<date> | null
Example:

"2025-12-31"

meets_spec
boolean | null
Example:

true

customer_reference
string | null
Example:

"ERP-GR-001"

comment
string | null
Example:

"Received in good order"

draft
boolean | null

Defaults to false (confirmed) when omitted

Example:

false

shipment_id
string<uuid> | null
Example:

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

shipment_container_id
string<uuid> | null
Example:

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

Response

201 - application/json

Goods receipt recorded (confirmed by default)

id
string<uuid>
Example:

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

url
string
Example:

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

delivery_id
string<uuid>
Example:

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

reference
string
Example:

"GR-001"

batch_number
string | null
Example:

"BATCH-9"

quantity
string | null
Example:

"100.0"

measurement_unit
string | null
Example:

"kg"

received_at
string<date-time> | null
Example:

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

manufactured_on
string<date> | null
Example:

"2025-12-31"

expires_on
string<date> | null
Example:

"2025-12-31"

invoice_number
string | null
Example:

"INV-001"

invoice_date
string<date> | null
Example:

"2025-12-31"

customer_reference
string | null
Example:

"ERP-GR-001"

comment
string | null
Example:

"Received in good order"

meets_spec
boolean | null
Example:

true

status
enum<string>
Available options:
Draft,
Confirmed
Example:

"Confirmed"

coa_present
boolean
Example:

false

delivery_attributes
object
order_attributes
object
additional_data
object
created_at
string<date-time>
Example:

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

updated_at
string<date-time>
Example:

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