Item

The item resource.

Basehttps://rest.carbon.ms/item

GET/item

List items

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

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

Response

[
  {
    "id": "abc123def456",
    "readableId": "xyz789",
    "name": "Example",
    "type": "string",
    "replenishmentSystem": "string",
    "itemTrackingType": "string",
    "active": true,
    "createdBy": "string"
  }
]

GET/item

Retrieve a item

Fetch a single item by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/item

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

Response

{
  "id": "abc123def456",
  "readableId": "xyz789",
  "name": "Example",
  "type": "string",
  "replenishmentSystem": "string",
  "itemTrackingType": "string",
  "active": true,
  "createdBy": "string"
}

POST/item

Create a item

Create a new item.

Body parameters

readableIdstringrequired

namestringrequired

descriptionstring

typeitemTyperequired

replenishmentSystemitemReplenishmentSystemrequired

defaultMethodTypemethodType

itemTrackingTypeitemTrackingTyperequired

unitOfMeasureCodestring

activebooleanrequired

companyIdstring

References company.id

assigneestring

References user.id

modelUploadIdstring

References modelUpload.id

thumbnailPathstring

notesobject

trackingMethodstring

embeddingstring

revisionstring

readableIdWithRevisionstring

sourcingTypesourcingTyperequired

mpnstring

revisionStatusitemRevisionStatusrequired

changeOrderIdstring

References changeOrder.id

POSThttps://rest.carbon.ms/item

curl --request POST \
  --url https://rest.carbon.ms/item \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"readableId":"xyz789","name":"Example","description":"string","type":"string","replenishmentSystem":"string","itemTrackingType":"string","active":true,"sourcingType":"string","revisionStatus":"string"}'

Response

{
  "id": "abc123def456",
  "readableId": "xyz789",
  "name": "Example",
  "type": "string",
  "replenishmentSystem": "string",
  "itemTrackingType": "string",
  "active": true,
  "createdBy": "string"
}

PATCH/item

Update a item

Update an existing item, matched on `id`.

Body parameters

readableIdstringrequired

namestringrequired

descriptionstring

typeitemTyperequired

replenishmentSystemitemReplenishmentSystemrequired

defaultMethodTypemethodType

itemTrackingTypeitemTrackingTyperequired

unitOfMeasureCodestring

activebooleanrequired

companyIdstring

References company.id

assigneestring

References user.id

modelUploadIdstring

References modelUpload.id

thumbnailPathstring

notesobject

trackingMethodstring

embeddingstring

revisionstring

readableIdWithRevisionstring

sourcingTypesourcingTyperequired

mpnstring

revisionStatusitemRevisionStatusrequired

changeOrderIdstring

References changeOrder.id

PATCHhttps://rest.carbon.ms/item

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

Response

{
  "id": "abc123def456",
  "readableId": "xyz789",
  "name": "Example",
  "type": "string",
  "replenishmentSystem": "string",
  "itemTrackingType": "string",
  "active": true,
  "createdBy": "string"
}

DELETE/item

Delete a item

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/item

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

204 No Content