Assembly Instruction Step Material

The assembly instruction step material resource.

Basehttps://rest.carbon.ms/assemblyInstructionStepMaterial

GET/assemblyInstructionStepMaterial

List assembly instruction step materials

Retrieve a paginated list of assembly instruction step materials. 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/assemblyInstructionStepMaterial

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

Response

[
  {
    "id": "abc123def456",
    "stepId": "xyz789",
    "itemId": "xyz789",
    "sortOrder": 0,
    "companyId": "xyz789",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "quantity": 10
  }
]

GET/assemblyInstructionStepMaterial

Retrieve a assembly instruction step material

Fetch a single assembly instruction step material by filtering on `id`.

Query parameters

idstring

Match on the assembly instruction step material's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/assemblyInstructionStepMaterial

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

Response

{
  "id": "abc123def456",
  "stepId": "xyz789",
  "itemId": "xyz789",
  "sortOrder": 0,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "quantity": 10
}

POST/assemblyInstructionStepMaterial

Create a assembly instruction step material

Create a new assembly instruction step material.

Body parameters

stepIdstringrequired

References assemblyInstructionStep.id

itemIdstringrequired

References item.id

quantitynumber

sortOrdernumberrequired

companyIdstringrequired

References company.id

POSThttps://rest.carbon.ms/assemblyInstructionStepMaterial

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

Response

{
  "id": "abc123def456",
  "stepId": "xyz789",
  "itemId": "xyz789",
  "sortOrder": 0,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "quantity": 10
}

PATCH/assemblyInstructionStepMaterial

Update a assembly instruction step material

Update an existing assembly instruction step material, matched on `id`.

Body parameters

stepIdstringrequired

References assemblyInstructionStep.id

itemIdstringrequired

References item.id

quantitynumber

sortOrdernumberrequired

companyIdstringrequired

References company.id

PATCHhttps://rest.carbon.ms/assemblyInstructionStepMaterial

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

Response

{
  "id": "abc123def456",
  "stepId": "xyz789",
  "itemId": "xyz789",
  "sortOrder": 0,
  "companyId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "quantity": 10
}

DELETE/assemblyInstructionStepMaterial

Delete a assembly instruction step material

Delete a assembly instruction step material, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the assembly instruction step material to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/assemblyInstructionStepMaterial

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

204 No Content