Quote Material Step

The quote material step resource.

Basehttps://rest.carbon.ms/quoteMaterialStep

GET/quoteMaterialStep

List quote material steps

Retrieve a paginated list of quote material steps. 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/quoteMaterialStep

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

Response

[
  {
    "quoteMaterialId": "xyz789",
    "quoteOperationStepId": "xyz789"
  }
]

GET/quoteMaterialStep

Retrieve a quote material step

Fetch a single quote material step by filtering on `quoteMaterialId`.

Query parameters

quoteMaterialIdstring

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

GEThttps://rest.carbon.ms/quoteMaterialStep

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

Response

{
  "quoteMaterialId": "xyz789",
  "quoteOperationStepId": "xyz789"
}

POST/quoteMaterialStep

Create a quote material step

Create a new quote material step.

POSThttps://rest.carbon.ms/quoteMaterialStep

curl --request POST \
  --url https://rest.carbon.ms/quoteMaterialStep \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"quoteMaterialId":"xyz789"}'

Response

{
  "quoteMaterialId": "xyz789",
  "quoteOperationStepId": "xyz789"
}

PATCH/quoteMaterialStep

Update a quote material step

Update an existing quote material step, matched on `quoteMaterialId`.

PATCHhttps://rest.carbon.ms/quoteMaterialStep

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

Response

{
  "quoteMaterialId": "xyz789",
  "quoteOperationStepId": "xyz789"
}

DELETE/quoteMaterialStep

Delete a quote material step

Delete a quote material step, matched on `quoteMaterialId`. Returns 204 No Content.

Query parameters

quoteMaterialIdstring

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

DELETEhttps://rest.carbon.ms/quoteMaterialStep

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

204 No Content