Records a goods receipt
curl --request POST \
--url https://app.chemcloud.com.au/api/public/buyer/v1/goods_receipts \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"delivery_id": "99999a99-b888-777c-666d-55555555555e",
"received_at": "2025-12-31T23:13:11.862Z",
"quantity": 100,
"measurement_unit_id": "99999a99-b888-777c-666d-55555555555e",
"batch_number": "BATCH-9",
"manufactured_on": "2025-12-31",
"expires_on": "2025-12-31",
"invoice_number": "INV-001",
"invoice_date": "2025-12-31",
"meets_spec": true,
"customer_reference": "ERP-GR-001",
"comment": "Received in good order",
"draft": false,
"shipment_id": "99999a99-b888-777c-666d-55555555555e",
"shipment_container_id": "99999a99-b888-777c-666d-55555555555e",
"country_of_origin_id": "99999a99-b888-777c-666d-55555555555e"
}
'import requests
url = "https://app.chemcloud.com.au/api/public/buyer/v1/goods_receipts"
payload = {
"delivery_id": "99999a99-b888-777c-666d-55555555555e",
"received_at": "2025-12-31T23:13:11.862Z",
"quantity": 100,
"measurement_unit_id": "99999a99-b888-777c-666d-55555555555e",
"batch_number": "BATCH-9",
"manufactured_on": "2025-12-31",
"expires_on": "2025-12-31",
"invoice_number": "INV-001",
"invoice_date": "2025-12-31",
"meets_spec": True,
"customer_reference": "ERP-GR-001",
"comment": "Received in good order",
"draft": False,
"shipment_id": "99999a99-b888-777c-666d-55555555555e",
"shipment_container_id": "99999a99-b888-777c-666d-55555555555e",
"country_of_origin_id": "99999a99-b888-777c-666d-55555555555e"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
delivery_id: '99999a99-b888-777c-666d-55555555555e',
received_at: '2025-12-31T23:13:11.862Z',
quantity: 100,
measurement_unit_id: '99999a99-b888-777c-666d-55555555555e',
batch_number: 'BATCH-9',
manufactured_on: '2025-12-31',
expires_on: '2025-12-31',
invoice_number: 'INV-001',
invoice_date: '2025-12-31',
meets_spec: true,
customer_reference: 'ERP-GR-001',
comment: 'Received in good order',
draft: false,
shipment_id: '99999a99-b888-777c-666d-55555555555e',
shipment_container_id: '99999a99-b888-777c-666d-55555555555e',
country_of_origin_id: '99999a99-b888-777c-666d-55555555555e'
})
};
fetch('https://app.chemcloud.com.au/api/public/buyer/v1/goods_receipts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.chemcloud.com.au/api/public/buyer/v1/goods_receipts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'delivery_id' => '99999a99-b888-777c-666d-55555555555e',
'received_at' => '2025-12-31T23:13:11.862Z',
'quantity' => 100,
'measurement_unit_id' => '99999a99-b888-777c-666d-55555555555e',
'batch_number' => 'BATCH-9',
'manufactured_on' => '2025-12-31',
'expires_on' => '2025-12-31',
'invoice_number' => 'INV-001',
'invoice_date' => '2025-12-31',
'meets_spec' => true,
'customer_reference' => 'ERP-GR-001',
'comment' => 'Received in good order',
'draft' => false,
'shipment_id' => '99999a99-b888-777c-666d-55555555555e',
'shipment_container_id' => '99999a99-b888-777c-666d-55555555555e',
'country_of_origin_id' => '99999a99-b888-777c-666d-55555555555e'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.chemcloud.com.au/api/public/buyer/v1/goods_receipts"
payload := strings.NewReader("{\n \"delivery_id\": \"99999a99-b888-777c-666d-55555555555e\",\n \"received_at\": \"2025-12-31T23:13:11.862Z\",\n \"quantity\": 100,\n \"measurement_unit_id\": \"99999a99-b888-777c-666d-55555555555e\",\n \"batch_number\": \"BATCH-9\",\n \"manufactured_on\": \"2025-12-31\",\n \"expires_on\": \"2025-12-31\",\n \"invoice_number\": \"INV-001\",\n \"invoice_date\": \"2025-12-31\",\n \"meets_spec\": true,\n \"customer_reference\": \"ERP-GR-001\",\n \"comment\": \"Received in good order\",\n \"draft\": false,\n \"shipment_id\": \"99999a99-b888-777c-666d-55555555555e\",\n \"shipment_container_id\": \"99999a99-b888-777c-666d-55555555555e\",\n \"country_of_origin_id\": \"99999a99-b888-777c-666d-55555555555e\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.chemcloud.com.au/api/public/buyer/v1/goods_receipts")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"delivery_id\": \"99999a99-b888-777c-666d-55555555555e\",\n \"received_at\": \"2025-12-31T23:13:11.862Z\",\n \"quantity\": 100,\n \"measurement_unit_id\": \"99999a99-b888-777c-666d-55555555555e\",\n \"batch_number\": \"BATCH-9\",\n \"manufactured_on\": \"2025-12-31\",\n \"expires_on\": \"2025-12-31\",\n \"invoice_number\": \"INV-001\",\n \"invoice_date\": \"2025-12-31\",\n \"meets_spec\": true,\n \"customer_reference\": \"ERP-GR-001\",\n \"comment\": \"Received in good order\",\n \"draft\": false,\n \"shipment_id\": \"99999a99-b888-777c-666d-55555555555e\",\n \"shipment_container_id\": \"99999a99-b888-777c-666d-55555555555e\",\n \"country_of_origin_id\": \"99999a99-b888-777c-666d-55555555555e\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.chemcloud.com.au/api/public/buyer/v1/goods_receipts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"delivery_id\": \"99999a99-b888-777c-666d-55555555555e\",\n \"received_at\": \"2025-12-31T23:13:11.862Z\",\n \"quantity\": 100,\n \"measurement_unit_id\": \"99999a99-b888-777c-666d-55555555555e\",\n \"batch_number\": \"BATCH-9\",\n \"manufactured_on\": \"2025-12-31\",\n \"expires_on\": \"2025-12-31\",\n \"invoice_number\": \"INV-001\",\n \"invoice_date\": \"2025-12-31\",\n \"meets_spec\": true,\n \"customer_reference\": \"ERP-GR-001\",\n \"comment\": \"Received in good order\",\n \"draft\": false,\n \"shipment_id\": \"99999a99-b888-777c-666d-55555555555e\",\n \"shipment_container_id\": \"99999a99-b888-777c-666d-55555555555e\",\n \"country_of_origin_id\": \"99999a99-b888-777c-666d-55555555555e\"\n}"
response = http.request(request)
puts response.read_body{
"id": "99999a99-b888-777c-666d-55555555555e",
"url": "https://app.chemcloud.com.au/buyer/goods_receipts/99999a99-b888-777c-666d-55555555555e",
"delivery_id": "99999a99-b888-777c-666d-55555555555e",
"shipment_id": "99999a99-b888-777c-666d-55555555555e",
"shipment_container_id": "99999a99-b888-777c-666d-55555555555e",
"reference": "GR-001",
"batch_number": "BATCH-9",
"quantity": "100.0",
"measurement_unit": "kg",
"received_at": "2025-12-31T23:13:11.862Z",
"manufactured_on": "2025-12-31",
"expires_on": "2025-12-31",
"invoice_number": "INV-001",
"invoice_date": "2025-12-31",
"customer_reference": "ERP-GR-001",
"comment": "Received in good order",
"meets_spec": true,
"country_of_origin": "New Zealand",
"status": "Confirmed",
"coa_present": false,
"delivery_attributes": {
"delivery_reference": "DEL-001"
},
"order_attributes": {
"purchase_order_reference": "PO-001"
},
"additional_data": {
"product": {
"product_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"
}Goods Receipts
Records a goods receipt
POST
/
api
/
public
/
buyer
/
v1
/
goods_receipts
Records a goods receipt
curl --request POST \
--url https://app.chemcloud.com.au/api/public/buyer/v1/goods_receipts \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"delivery_id": "99999a99-b888-777c-666d-55555555555e",
"received_at": "2025-12-31T23:13:11.862Z",
"quantity": 100,
"measurement_unit_id": "99999a99-b888-777c-666d-55555555555e",
"batch_number": "BATCH-9",
"manufactured_on": "2025-12-31",
"expires_on": "2025-12-31",
"invoice_number": "INV-001",
"invoice_date": "2025-12-31",
"meets_spec": true,
"customer_reference": "ERP-GR-001",
"comment": "Received in good order",
"draft": false,
"shipment_id": "99999a99-b888-777c-666d-55555555555e",
"shipment_container_id": "99999a99-b888-777c-666d-55555555555e",
"country_of_origin_id": "99999a99-b888-777c-666d-55555555555e"
}
'import requests
url = "https://app.chemcloud.com.au/api/public/buyer/v1/goods_receipts"
payload = {
"delivery_id": "99999a99-b888-777c-666d-55555555555e",
"received_at": "2025-12-31T23:13:11.862Z",
"quantity": 100,
"measurement_unit_id": "99999a99-b888-777c-666d-55555555555e",
"batch_number": "BATCH-9",
"manufactured_on": "2025-12-31",
"expires_on": "2025-12-31",
"invoice_number": "INV-001",
"invoice_date": "2025-12-31",
"meets_spec": True,
"customer_reference": "ERP-GR-001",
"comment": "Received in good order",
"draft": False,
"shipment_id": "99999a99-b888-777c-666d-55555555555e",
"shipment_container_id": "99999a99-b888-777c-666d-55555555555e",
"country_of_origin_id": "99999a99-b888-777c-666d-55555555555e"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
delivery_id: '99999a99-b888-777c-666d-55555555555e',
received_at: '2025-12-31T23:13:11.862Z',
quantity: 100,
measurement_unit_id: '99999a99-b888-777c-666d-55555555555e',
batch_number: 'BATCH-9',
manufactured_on: '2025-12-31',
expires_on: '2025-12-31',
invoice_number: 'INV-001',
invoice_date: '2025-12-31',
meets_spec: true,
customer_reference: 'ERP-GR-001',
comment: 'Received in good order',
draft: false,
shipment_id: '99999a99-b888-777c-666d-55555555555e',
shipment_container_id: '99999a99-b888-777c-666d-55555555555e',
country_of_origin_id: '99999a99-b888-777c-666d-55555555555e'
})
};
fetch('https://app.chemcloud.com.au/api/public/buyer/v1/goods_receipts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.chemcloud.com.au/api/public/buyer/v1/goods_receipts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'delivery_id' => '99999a99-b888-777c-666d-55555555555e',
'received_at' => '2025-12-31T23:13:11.862Z',
'quantity' => 100,
'measurement_unit_id' => '99999a99-b888-777c-666d-55555555555e',
'batch_number' => 'BATCH-9',
'manufactured_on' => '2025-12-31',
'expires_on' => '2025-12-31',
'invoice_number' => 'INV-001',
'invoice_date' => '2025-12-31',
'meets_spec' => true,
'customer_reference' => 'ERP-GR-001',
'comment' => 'Received in good order',
'draft' => false,
'shipment_id' => '99999a99-b888-777c-666d-55555555555e',
'shipment_container_id' => '99999a99-b888-777c-666d-55555555555e',
'country_of_origin_id' => '99999a99-b888-777c-666d-55555555555e'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.chemcloud.com.au/api/public/buyer/v1/goods_receipts"
payload := strings.NewReader("{\n \"delivery_id\": \"99999a99-b888-777c-666d-55555555555e\",\n \"received_at\": \"2025-12-31T23:13:11.862Z\",\n \"quantity\": 100,\n \"measurement_unit_id\": \"99999a99-b888-777c-666d-55555555555e\",\n \"batch_number\": \"BATCH-9\",\n \"manufactured_on\": \"2025-12-31\",\n \"expires_on\": \"2025-12-31\",\n \"invoice_number\": \"INV-001\",\n \"invoice_date\": \"2025-12-31\",\n \"meets_spec\": true,\n \"customer_reference\": \"ERP-GR-001\",\n \"comment\": \"Received in good order\",\n \"draft\": false,\n \"shipment_id\": \"99999a99-b888-777c-666d-55555555555e\",\n \"shipment_container_id\": \"99999a99-b888-777c-666d-55555555555e\",\n \"country_of_origin_id\": \"99999a99-b888-777c-666d-55555555555e\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.chemcloud.com.au/api/public/buyer/v1/goods_receipts")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"delivery_id\": \"99999a99-b888-777c-666d-55555555555e\",\n \"received_at\": \"2025-12-31T23:13:11.862Z\",\n \"quantity\": 100,\n \"measurement_unit_id\": \"99999a99-b888-777c-666d-55555555555e\",\n \"batch_number\": \"BATCH-9\",\n \"manufactured_on\": \"2025-12-31\",\n \"expires_on\": \"2025-12-31\",\n \"invoice_number\": \"INV-001\",\n \"invoice_date\": \"2025-12-31\",\n \"meets_spec\": true,\n \"customer_reference\": \"ERP-GR-001\",\n \"comment\": \"Received in good order\",\n \"draft\": false,\n \"shipment_id\": \"99999a99-b888-777c-666d-55555555555e\",\n \"shipment_container_id\": \"99999a99-b888-777c-666d-55555555555e\",\n \"country_of_origin_id\": \"99999a99-b888-777c-666d-55555555555e\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.chemcloud.com.au/api/public/buyer/v1/goods_receipts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"delivery_id\": \"99999a99-b888-777c-666d-55555555555e\",\n \"received_at\": \"2025-12-31T23:13:11.862Z\",\n \"quantity\": 100,\n \"measurement_unit_id\": \"99999a99-b888-777c-666d-55555555555e\",\n \"batch_number\": \"BATCH-9\",\n \"manufactured_on\": \"2025-12-31\",\n \"expires_on\": \"2025-12-31\",\n \"invoice_number\": \"INV-001\",\n \"invoice_date\": \"2025-12-31\",\n \"meets_spec\": true,\n \"customer_reference\": \"ERP-GR-001\",\n \"comment\": \"Received in good order\",\n \"draft\": false,\n \"shipment_id\": \"99999a99-b888-777c-666d-55555555555e\",\n \"shipment_container_id\": \"99999a99-b888-777c-666d-55555555555e\",\n \"country_of_origin_id\": \"99999a99-b888-777c-666d-55555555555e\"\n}"
response = http.request(request)
puts response.read_body{
"id": "99999a99-b888-777c-666d-55555555555e",
"url": "https://app.chemcloud.com.au/buyer/goods_receipts/99999a99-b888-777c-666d-55555555555e",
"delivery_id": "99999a99-b888-777c-666d-55555555555e",
"shipment_id": "99999a99-b888-777c-666d-55555555555e",
"shipment_container_id": "99999a99-b888-777c-666d-55555555555e",
"reference": "GR-001",
"batch_number": "BATCH-9",
"quantity": "100.0",
"measurement_unit": "kg",
"received_at": "2025-12-31T23:13:11.862Z",
"manufactured_on": "2025-12-31",
"expires_on": "2025-12-31",
"invoice_number": "INV-001",
"invoice_date": "2025-12-31",
"customer_reference": "ERP-GR-001",
"comment": "Received in good order",
"meets_spec": true,
"country_of_origin": "New Zealand",
"status": "Confirmed",
"coa_present": false,
"delivery_attributes": {
"delivery_reference": "DEL-001"
},
"order_attributes": {
"purchase_order_reference": "PO-001"
},
"additional_data": {
"product": {
"product_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
Body
application/json
Example:
"99999a99-b888-777c-666d-55555555555e"
Example:
"2025-12-31T23:13:11.862Z"
Example:
100
Example:
"99999a99-b888-777c-666d-55555555555e"
Example:
"BATCH-9"
Example:
"2025-12-31"
Example:
"2025-12-31"
Example:
"INV-001"
Example:
"2025-12-31"
Example:
true
Example:
"ERP-GR-001"
Example:
"Received in good order"
Defaults to false (confirmed) when omitted
Example:
false
Example:
"99999a99-b888-777c-666d-55555555555e"
Example:
"99999a99-b888-777c-666d-55555555555e"
AddressRegion id of the country the product was manufactured in
Example:
"99999a99-b888-777c-666d-55555555555e"
Response
201 - application/json
Goods receipt recorded (confirmed by default)
Example:
"99999a99-b888-777c-666d-55555555555e"
Example:
"https://app.chemcloud.com.au/buyer/goods_receipts/99999a99-b888-777c-666d-55555555555e"
Example:
"99999a99-b888-777c-666d-55555555555e"
Example:
"99999a99-b888-777c-666d-55555555555e"
Example:
"99999a99-b888-777c-666d-55555555555e"
Example:
"GR-001"
Example:
"BATCH-9"
Example:
"100.0"
Example:
"kg"
Example:
"2025-12-31T23:13:11.862Z"
Example:
"2025-12-31"
Example:
"2025-12-31"
Example:
"INV-001"
Example:
"2025-12-31"
Example:
"ERP-GR-001"
Example:
"Received in good order"
Example:
true
Example:
"New Zealand"
Available options:
Draft, Confirmed, In Transit Example:
"Confirmed"
Example:
false
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
"2025-12-31T23:13:11.862Z"
Example:
"2025-12-31T23:13:11.862Z"
Was this page helpful?