Carbon

Fulfillment

The fulfillment resource.

Basehttps://rest.carbon.ms/fulfillment
GET/fulfillment

List fulfillments

Retrieve a paginated list of fulfillments. 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/fulfillment
curl --request GET \
  --url 'https://rest.carbon.ms/fulfillment?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "salesOrderLineId": "xyz789",
    "type": "string",
    "quantity": 10,
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z",
    "createdBy": "string",
    "jobId": "xyz789"
  }
]
GET/fulfillment

Retrieve a fulfillment

Fetch a single fulfillment by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/fulfillment
curl --request GET \
  --url 'https://rest.carbon.ms/fulfillment?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "salesOrderLineId": "xyz789",
  "type": "string",
  "quantity": 10,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "jobId": "xyz789"
}
POST/fulfillment

Create a fulfillment

Create a new fulfillment.

Body parameters

salesOrderLineIdstringrequired

References salesOrderLine.id

typefulfillmentTyperequired
quantitynumberrequired
jobIdstring

References job.id

companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/fulfillment
curl --request POST \
  --url https://rest.carbon.ms/fulfillment \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"salesOrderLineId":"xyz789","type":"string","quantity":10,"companyId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "salesOrderLineId": "xyz789",
  "type": "string",
  "quantity": 10,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "jobId": "xyz789"
}
PATCH/fulfillment

Update a fulfillment

Update an existing fulfillment, matched on `id`.

Body parameters

salesOrderLineIdstringrequired

References salesOrderLine.id

typefulfillmentTyperequired
quantitynumberrequired
jobIdstring

References job.id

companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/fulfillment
curl --request PATCH \
  --url 'https://rest.carbon.ms/fulfillment?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"salesOrderLineId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "salesOrderLineId": "xyz789",
  "type": "string",
  "quantity": 10,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "jobId": "xyz789"
}
DELETE/fulfillment

Delete a fulfillment

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

Query parameters

idstring

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

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