Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.commodityai.io/llms.txt

Use this file to discover all available pages before exploring further.

Reference data endpoints return IDs and codes used by contract, allocation, shipment, product, quality, and pricing workflows. Use this section before creating or updating standard objects. For example, contracts reference counterparty IDs, product IDs, grade IDs, unit IDs, currency IDs, country IDs, port IDs, packaging type IDs, payment term IDs, and market index IDs.

​
Read-Only Use

This section documents lookup usage only. The underlying application may expose administrative write operations for some tables, but integrations should treat these pages as read-only code sets unless CommodityAI has explicitly enabled write access for that workflow.
Reference Data pages are read-only integration lookups. Do not rely on public write operations for products, grades, attributes, quality templates, currencies, units, ports, or code sets unless CommodityAI explicitly enables them.

​
Common Pattern

Most reference endpoints return an array of records: 
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "US Dollar",
    "code": "USD"
  }
]
Some global code sets support all=true. By default, responses respect company-level reference exclusions. Use all=true when you need the full global set.

​
Endpoint Catalog

Core Code Sets

Countries, currencies, units, ports, exchanges, packaging, and container types.

Product Reference Data

Products, grades, attributes, attribute options, and quality specifications.

Market Indexes

Platts, Fastmarkets, Argus, LME, CME, SGX, and other pricing index references.