Quote Shipment

The quote shipment resource.

Basehttps://rest.carbon.ms/quoteShipment

GET/quoteShipment

List quote shipments

Retrieve a paginated list of quote shipments. 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/quoteShipment

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

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "locationId": "xyz789",
    "shippingMethodId": "xyz789",
    "shippingTermId": "xyz789",
    "receiptRequestedDate": "2026-01-01",
    "updatedBy": "string",
    "updatedAt": "2026-01-01T00:00:00Z"
  }
]

GET/quoteShipment

Retrieve a quote shipment

Fetch a single quote shipment by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/quoteShipment

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "locationId": "xyz789",
  "shippingMethodId": "xyz789",
  "shippingTermId": "xyz789",
  "receiptRequestedDate": "2026-01-01",
  "updatedBy": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}

POST/quoteShipment

Create a quote shipment

Create a new quote shipment.

Body parameters

locationIdstring

References location.id

shippingMethodIdstring

References shippingMethod.id

shippingTermIdstring

References shippingTerm.id

receiptRequestedDatedate

companyIdstringrequired

References company.id

shippingCostnumber

incotermstring

incotermLocationstring

POSThttps://rest.carbon.ms/quoteShipment

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "locationId": "xyz789",
  "shippingMethodId": "xyz789",
  "shippingTermId": "xyz789",
  "receiptRequestedDate": "2026-01-01",
  "updatedBy": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}

PATCH/quoteShipment

Update a quote shipment

Update an existing quote shipment, matched on `id`.

Body parameters

locationIdstring

References location.id

shippingMethodIdstring

References shippingMethod.id

shippingTermIdstring

References shippingTerm.id

receiptRequestedDatedate

companyIdstringrequired

References company.id

shippingCostnumber

incotermstring

incotermLocationstring

PATCHhttps://rest.carbon.ms/quoteShipment

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "locationId": "xyz789",
  "shippingMethodId": "xyz789",
  "shippingTermId": "xyz789",
  "receiptRequestedDate": "2026-01-01",
  "updatedBy": "string",
  "updatedAt": "2026-01-01T00:00:00Z"
}

DELETE/quoteShipment

Delete a quote shipment

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/quoteShipment

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

204 No Content