Demand Forecast Source

The demand forecast source resource.

Basehttps://rest.carbon.ms/demandForecastSource

GET/demandForecastSource

List demand forecast sources

Retrieve a paginated list of demand forecast sources. 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/demandForecastSource

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

Response

[
  {
    "id": "abc123def456",
    "itemId": "xyz789",
    "periodId": "xyz789",
    "sourceType": "string",
    "parentItemId": "xyz789",
    "quantity": 10,
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]

GET/demandForecastSource

Retrieve a demand forecast source

Fetch a single demand forecast source by filtering on `id`.

Query parameters

idstring

Match on the demand forecast source's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/demandForecastSource

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

Response

{
  "id": "abc123def456",
  "itemId": "xyz789",
  "periodId": "xyz789",
  "sourceType": "string",
  "parentItemId": "xyz789",
  "quantity": 10,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

POST/demandForecastSource

Create a demand forecast source

Create a new demand forecast source.

Body parameters

itemIdstringrequired

References item.id

locationIdstring

References location.id

periodIdstringrequired

References period.id

sourceTypedemandForecastSourceTyperequired

jobIdstring

References job.id

salesOrderLineIdstring

References salesOrderLine.id

demandProjectionIdstring

References demandProjection.id

parentItemIdstringrequired

References item.id

quantitynumberrequired

companyIdstringrequired

References company.id

redirectedFromItemIdstring

References item.id

POSThttps://rest.carbon.ms/demandForecastSource

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

Response

{
  "id": "abc123def456",
  "itemId": "xyz789",
  "periodId": "xyz789",
  "sourceType": "string",
  "parentItemId": "xyz789",
  "quantity": 10,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

PATCH/demandForecastSource

Update a demand forecast source

Update an existing demand forecast source, matched on `id`.

Body parameters

itemIdstringrequired

References item.id

locationIdstring

References location.id

periodIdstringrequired

References period.id

sourceTypedemandForecastSourceTyperequired

jobIdstring

References job.id

salesOrderLineIdstring

References salesOrderLine.id

demandProjectionIdstring

References demandProjection.id

parentItemIdstringrequired

References item.id

quantitynumberrequired

companyIdstringrequired

References company.id

redirectedFromItemIdstring

References item.id

PATCHhttps://rest.carbon.ms/demandForecastSource

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

Response

{
  "id": "abc123def456",
  "itemId": "xyz789",
  "periodId": "xyz789",
  "sourceType": "string",
  "parentItemId": "xyz789",
  "quantity": 10,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z"
}

DELETE/demandForecastSource

Delete a demand forecast source

Delete a demand forecast source, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the demand forecast source to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/demandForecastSource

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

204 No Content