Supply Forecast

The supply forecast resource.

Basehttps://rest.carbon.ms/supplyForecast

GET/supplyForecast

List supply forecasts

Retrieve a paginated list of supply forecasts. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/supplyForecast

curl --request GET \
  --url 'https://rest.carbon.ms/supplyForecast?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "itemId": "xyz789",
    "locationId": "xyz789",
    "periodId": "xyz789",
    "forecastQuantity": 10,
    "companyId": "xyz789",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "updatedAt": "2026-01-01T00:00:00Z"
  }
]

GET/supplyForecast

Retrieve a supply forecast

Fetch a single supply forecast by filtering on `itemId`.

Query parameters

itemIdstring

Match on the supply forecast's `itemId`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/supplyForecast

curl --request GET \
  --url 'https://rest.carbon.ms/supplyForecast?itemId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "itemId": "xyz789",
  "locationId": "xyz789",
  "periodId": "xyz789",
  "forecastQuantity": 10,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z"
}

POST/supplyForecast

Create a supply forecast

Create a new supply forecast.

Body parameters

forecastQuantitynumberrequired

forecastMethodstring

confidencenumber

notesstring

companyIdstringrequired

References company.id

sourceTypesupplySourceType

POSThttps://rest.carbon.ms/supplyForecast

curl --request POST \
  --url https://rest.carbon.ms/supplyForecast \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"forecastQuantity":10,"companyId":"xyz789"}'

Response

{
  "itemId": "xyz789",
  "locationId": "xyz789",
  "periodId": "xyz789",
  "forecastQuantity": 10,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z"
}

PATCH/supplyForecast

Update a supply forecast

Update an existing supply forecast, matched on `itemId`.

Body parameters

forecastQuantitynumberrequired

forecastMethodstring

confidencenumber

notesstring

companyIdstringrequired

References company.id

sourceTypesupplySourceType

PATCHhttps://rest.carbon.ms/supplyForecast

curl --request PATCH \
  --url 'https://rest.carbon.ms/supplyForecast?itemId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"forecastQuantity":10}'

Response

{
  "itemId": "xyz789",
  "locationId": "xyz789",
  "periodId": "xyz789",
  "forecastQuantity": 10,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z"
}

DELETE/supplyForecast

Delete a supply forecast

Delete a supply forecast, matched on `itemId`. Returns 204 No Content.

Query parameters

itemIdstring

The `itemId` of the supply forecast to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/supplyForecast

curl --request DELETE \
  --url 'https://rest.carbon.ms/supplyForecast?itemId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content