Sales Order Shipment

The sales order shipment resource.

Basehttps://rest.carbon.ms/salesOrderShipment

GET/salesOrderShipment

List sales order shipments

Retrieve a paginated list of sales order 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/salesOrderShipment

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

Response

[
  {
    "id": "abc123def456",
    "dropShipment": true,
    "companyId": "xyz789",
    "locationId": "xyz789",
    "shippingMethodId": "xyz789",
    "shippingTermId": "xyz789",
    "receiptRequestedDate": "2026-01-01",
    "receiptPromisedDate": "2026-01-01"
  }
]

GET/salesOrderShipment

Retrieve a sales order shipment

Fetch a single sales order shipment by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/salesOrderShipment

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

Response

{
  "id": "abc123def456",
  "dropShipment": true,
  "companyId": "xyz789",
  "locationId": "xyz789",
  "shippingMethodId": "xyz789",
  "shippingTermId": "xyz789",
  "receiptRequestedDate": "2026-01-01",
  "receiptPromisedDate": "2026-01-01"
}

POST/salesOrderShipment

Create a sales order shipment

Create a new sales order shipment.

Body parameters

locationIdstring

References location.id

shippingMethodIdstring

References shippingMethod.id

shippingTermIdstring

References shippingTerm.id

receiptRequestedDatedate

receiptPromisedDatedate

deliveryDatedate

notesstring

trackingNumberstring

dropShipmentbooleanrequired

customerIdstring

References customer.id

customerLocationIdstring

References customerLocation.id

supplierIdstring

supplierLocationIdstring

companyIdstringrequired

References company.id

customFieldsobject

assigneestring

References user.id

shippingCostnumber

incotermstring

incotermLocationstring

POSThttps://rest.carbon.ms/salesOrderShipment

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

Response

{
  "id": "abc123def456",
  "dropShipment": true,
  "companyId": "xyz789",
  "locationId": "xyz789",
  "shippingMethodId": "xyz789",
  "shippingTermId": "xyz789",
  "receiptRequestedDate": "2026-01-01",
  "receiptPromisedDate": "2026-01-01"
}

PATCH/salesOrderShipment

Update a sales order shipment

Update an existing sales order shipment, matched on `id`.

Body parameters

locationIdstring

References location.id

shippingMethodIdstring

References shippingMethod.id

shippingTermIdstring

References shippingTerm.id

receiptRequestedDatedate

receiptPromisedDatedate

deliveryDatedate

notesstring

trackingNumberstring

dropShipmentbooleanrequired

customerIdstring

References customer.id

customerLocationIdstring

References customerLocation.id

supplierIdstring

supplierLocationIdstring

companyIdstringrequired

References company.id

customFieldsobject

assigneestring

References user.id

shippingCostnumber

incotermstring

incotermLocationstring

PATCHhttps://rest.carbon.ms/salesOrderShipment

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

Response

{
  "id": "abc123def456",
  "dropShipment": true,
  "companyId": "xyz789",
  "locationId": "xyz789",
  "shippingMethodId": "xyz789",
  "shippingTermId": "xyz789",
  "receiptRequestedDate": "2026-01-01",
  "receiptPromisedDate": "2026-01-01"
}

DELETE/salesOrderShipment

Delete a sales order shipment

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/salesOrderShipment

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

204 No Content