Lists all goods receipts for the buyer

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

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://app.chemcloud.com.au/api/public/buyer/v1/goods_receipts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

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::Get.new(url)
request["X-API-KEY"] = '<api-key>'

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",
    "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,
    "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"
  }
]

GET

api

public

buyer

goods_receipts

Lists all goods receipts for the buyer

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

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://app.chemcloud.com.au/api/public/buyer/v1/goods_receipts"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

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::Get.new(url)
request["X-API-KEY"] = '<api-key>'

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",
    "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,
    "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

X-API-KEY

string

header

required

Query Parameters

delivery_id

string

Filter receipts to a single delivery

draft

boolean

Filter by draft (true) or confirmed (false) status

created_at_from

string

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

created_at_to

string

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

Response

200 - application/json

Goods receipts retrieved

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

Show child attributes

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"

Shows a delivery Records a goods receipt