Item Planning

The item planning resource.

Basehttps://rest.carbon.ms/itemPlanning

GET/itemPlanning

List item plannings

Retrieve a paginated list of item plannings. 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/itemPlanning

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

Response

[
  {
    "itemId": "xyz789",
    "locationId": "xyz789",
    "reorderingPolicy": "string",
    "critical": true,
    "demandAccumulationPeriod": 0,
    "demandAccumulationIncludesInventory": true,
    "reorderPoint": 0,
    "reorderQuantity": 10
  }
]

GET/itemPlanning

Retrieve a item planning

Fetch a single item planning by filtering on `itemId`.

Query parameters

itemIdstring

Match on the item planning's `itemId`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/itemPlanning

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

Response

{
  "itemId": "xyz789",
  "locationId": "xyz789",
  "reorderingPolicy": "string",
  "critical": true,
  "demandAccumulationPeriod": 0,
  "demandAccumulationIncludesInventory": true,
  "reorderPoint": 0,
  "reorderQuantity": 10
}

POST/itemPlanning

Create a item planning

Create a new item planning.

Body parameters

itemIdstringrequired

References item.id

locationIdstringrequired

References location.id

reorderingPolicyitemReorderingPolicyrequired

criticalbooleanrequired

demandAccumulationPeriodnumberrequired

demandAccumulationIncludesInventorybooleanrequired

reorderPointnumberrequired

reorderQuantitynumberrequired

minimumOrderQuantitynumberrequired

maximumOrderQuantitynumberrequired

orderMultiplenumberrequired

companyIdstringrequired

References company.id

customFieldsobject

tagsarray

maximumInventoryQuantitynumberrequired

demandAccumulationSafetyStocknumberrequired

POSThttps://rest.carbon.ms/itemPlanning

curl --request POST \
  --url https://rest.carbon.ms/itemPlanning \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"itemId":"xyz789","locationId":"xyz789","reorderingPolicy":"string","critical":true,"demandAccumulationPeriod":0,"demandAccumulationIncludesInventory":true,"reorderPoint":0,"reorderQuantity":10,"minimumOrderQuantity":10,"maximumOrderQuantity":10,"orderMultiple":0,"companyId":"xyz789","maximumInventoryQuantity":10,"demandAccumulationSafetyStock":0}'

Response

{
  "itemId": "xyz789",
  "locationId": "xyz789",
  "reorderingPolicy": "string",
  "critical": true,
  "demandAccumulationPeriod": 0,
  "demandAccumulationIncludesInventory": true,
  "reorderPoint": 0,
  "reorderQuantity": 10
}

PATCH/itemPlanning

Update a item planning

Update an existing item planning, matched on `itemId`.

Body parameters

itemIdstringrequired

References item.id

locationIdstringrequired

References location.id

reorderingPolicyitemReorderingPolicyrequired

criticalbooleanrequired

demandAccumulationPeriodnumberrequired

demandAccumulationIncludesInventorybooleanrequired

reorderPointnumberrequired

reorderQuantitynumberrequired

minimumOrderQuantitynumberrequired

maximumOrderQuantitynumberrequired

orderMultiplenumberrequired

companyIdstringrequired

References company.id

customFieldsobject

tagsarray

maximumInventoryQuantitynumberrequired

demandAccumulationSafetyStocknumberrequired

PATCHhttps://rest.carbon.ms/itemPlanning

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

Response

{
  "itemId": "xyz789",
  "locationId": "xyz789",
  "reorderingPolicy": "string",
  "critical": true,
  "demandAccumulationPeriod": 0,
  "demandAccumulationIncludesInventory": true,
  "reorderPoint": 0,
  "reorderQuantity": 10
}

DELETE/itemPlanning

Delete a item planning

Delete a item planning, matched on `itemId`. Returns 204 No Content.

Query parameters

itemIdstring

The `itemId` of the item planning to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/itemPlanning

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

204 No Content