Sales Rfq Line

The sales rfq line resource.

Basehttps://rest.carbon.ms/salesRfqLine

GET/salesRfqLine

List sales rfq lines

Retrieve a paginated list of sales rfq lines. 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/salesRfqLine

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

Response

[
  {
    "id": "abc123def456",
    "salesRfqId": "xyz789",
    "unitOfMeasureCode": "string",
    "order": 0,
    "companyId": "xyz789",
    "createdBy": "string",
    "customerPartId": "xyz789",
    "itemId": "xyz789"
  }
]

GET/salesRfqLine

Retrieve a sales rfq line

Fetch a single sales rfq line by filtering on `id`.

Query parameters

idstring

Match on the sales rfq line's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/salesRfqLine

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

Response

{
  "id": "abc123def456",
  "salesRfqId": "xyz789",
  "unitOfMeasureCode": "string",
  "order": 0,
  "companyId": "xyz789",
  "createdBy": "string",
  "customerPartId": "xyz789",
  "itemId": "xyz789"
}

POST/salesRfqLine

Create a sales rfq line

Create a new sales rfq line.

Body parameters

salesRfqIdstringrequired

References salesRfq.id

itemIdstring

References item.id

descriptionstring

quantityarray

unitOfMeasureCodestringrequired

ordernumberrequired

internalNotesobject

externalNotesobject

companyIdstringrequired

References company.id

customFieldsobject

modelUploadIdstring

References modelUpload.id

customerPartIdstringrequired

customerPartRevisionstring

tagsarray

POSThttps://rest.carbon.ms/salesRfqLine

curl --request POST \
  --url https://rest.carbon.ms/salesRfqLine \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"salesRfqId":"xyz789","description":"string","unitOfMeasureCode":"string","order":0,"companyId":"xyz789","customerPartId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "salesRfqId": "xyz789",
  "unitOfMeasureCode": "string",
  "order": 0,
  "companyId": "xyz789",
  "createdBy": "string",
  "customerPartId": "xyz789",
  "itemId": "xyz789"
}

PATCH/salesRfqLine

Update a sales rfq line

Update an existing sales rfq line, matched on `id`.

Body parameters

salesRfqIdstringrequired

References salesRfq.id

itemIdstring

References item.id

descriptionstring

quantityarray

unitOfMeasureCodestringrequired

ordernumberrequired

internalNotesobject

externalNotesobject

companyIdstringrequired

References company.id

customFieldsobject

modelUploadIdstring

References modelUpload.id

customerPartIdstringrequired

customerPartRevisionstring

tagsarray

PATCHhttps://rest.carbon.ms/salesRfqLine

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

Response

{
  "id": "abc123def456",
  "salesRfqId": "xyz789",
  "unitOfMeasureCode": "string",
  "order": 0,
  "companyId": "xyz789",
  "createdBy": "string",
  "customerPartId": "xyz789",
  "itemId": "xyz789"
}

DELETE/salesRfqLine

Delete a sales rfq line

Delete a sales rfq line, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the sales rfq line to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/salesRfqLine

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

204 No Content