Item Serial Sequence

The item serial sequence resource.

Basehttps://rest.carbon.ms/itemSerialSequence

GET/itemSerialSequence

List item serial sequences

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

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

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "itemId": "xyz789",
    "next": 0,
    "size": 0,
    "step": 0,
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]

GET/itemSerialSequence

Retrieve a item serial sequence

Fetch a single item serial sequence by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/itemSerialSequence

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "itemId": "xyz789",
  "next": 0,
  "size": 0,
  "step": 0,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

POST/itemSerialSequence

Create a item serial sequence

Create a new item serial sequence.

Body parameters

itemIdstringrequired

References item.id

prefixstring

suffixstring

nextnumberrequired

sizenumberrequired

stepnumberrequired

POSThttps://rest.carbon.ms/itemSerialSequence

curl --request POST \
  --url https://rest.carbon.ms/itemSerialSequence \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"itemId":"xyz789","next":0,"size":0,"step":0}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "itemId": "xyz789",
  "next": 0,
  "size": 0,
  "step": 0,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

PATCH/itemSerialSequence

Update a item serial sequence

Update an existing item serial sequence, matched on `id`.

Body parameters

itemIdstringrequired

References item.id

prefixstring

suffixstring

nextnumberrequired

sizenumberrequired

stepnumberrequired

PATCHhttps://rest.carbon.ms/itemSerialSequence

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "itemId": "xyz789",
  "next": 0,
  "size": 0,
  "step": 0,
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

DELETE/itemSerialSequence

Delete a item serial sequence

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/itemSerialSequence

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

204 No Content