Item Replenishment

The item replenishment resource.

Basehttps://rest.carbon.ms/itemReplenishment

GET/itemReplenishment

List item replenishments

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

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

Response

[
  {
    "itemId": "xyz789",
    "conversionFactor": 0,
    "purchasingBlocked": true,
    "manufacturingBlocked": true,
    "requiresConfiguration": true,
    "companyId": "xyz789",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]

GET/itemReplenishment

Retrieve a item replenishment

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

Query parameters

itemIdstring

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

GEThttps://rest.carbon.ms/itemReplenishment

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

Response

{
  "itemId": "xyz789",
  "conversionFactor": 0,
  "purchasingBlocked": true,
  "manufacturingBlocked": true,
  "requiresConfiguration": true,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

POST/itemReplenishment

Create a item replenishment

Create a new item replenishment.

Body parameters

preferredSupplierIdstring

References supplier.id

purchasingUnitOfMeasureCodestring

conversionFactornumberrequired

purchasingBlockedbooleanrequired

manufacturingBlockedbooleanrequired

requiresConfigurationbooleanrequired

lotSizenumber

companyIdstringrequired

References company.id

customFieldsobject

scrapPercentagenumberrequired

tagsarray

leadTimenumberrequired

POSThttps://rest.carbon.ms/itemReplenishment

curl --request POST \
  --url https://rest.carbon.ms/itemReplenishment \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"conversionFactor":0,"purchasingBlocked":true,"manufacturingBlocked":true,"requiresConfiguration":true,"companyId":"xyz789","scrapPercentage":0,"leadTime":0}'

Response

{
  "itemId": "xyz789",
  "conversionFactor": 0,
  "purchasingBlocked": true,
  "manufacturingBlocked": true,
  "requiresConfiguration": true,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

PATCH/itemReplenishment

Update a item replenishment

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

Body parameters

preferredSupplierIdstring

References supplier.id

purchasingUnitOfMeasureCodestring

conversionFactornumberrequired

purchasingBlockedbooleanrequired

manufacturingBlockedbooleanrequired

requiresConfigurationbooleanrequired

lotSizenumber

companyIdstringrequired

References company.id

customFieldsobject

scrapPercentagenumberrequired

tagsarray

leadTimenumberrequired

PATCHhttps://rest.carbon.ms/itemReplenishment

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

Response

{
  "itemId": "xyz789",
  "conversionFactor": 0,
  "purchasingBlocked": true,
  "manufacturingBlocked": true,
  "requiresConfiguration": true,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

DELETE/itemReplenishment

Delete a item replenishment

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

Query parameters

itemIdstring

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

DELETEhttps://rest.carbon.ms/itemReplenishment

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

204 No Content