Shipment

The shipment resource.

Basehttps://rest.carbon.ms/shipment

GET/shipment

List shipments

Retrieve a paginated list of 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/shipment

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

Response

[
  {
    "id": "abc123def456",
    "shipmentId": "xyz789",
    "status": "string",
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z",
    "createdBy": "string",
    "locationId": "xyz789",
    "sourceDocument": "string"
  }
]

GET/shipment

Retrieve a shipment

Fetch a single shipment by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/shipment

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

Response

{
  "id": "abc123def456",
  "shipmentId": "xyz789",
  "status": "string",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "locationId": "xyz789",
  "sourceDocument": "string"
}

POST/shipment

Create a shipment

Create a new shipment.

Body parameters

shipmentIdstringrequired

locationIdstring

References location.id

sourceDocumentshipmentSourceDocument

sourceDocumentIdstring

sourceDocumentReadableIdstring

shippingMethodIdstring

References shippingMethod.id

trackingNumberstring

customerIdstring

References customer.id

statusshipmentStatusrequired

postingDatedate

postedBystring

References user.id

invoicedboolean

assigneestring

References user.id

internalNotesobject

externalNotesobject

opportunityIdstring

References opportunity.id

companyIdstringrequired

References company.id

tagsarray

customFieldsobject

supplierIdstring

References supplier.id

supplierInteractionIdstring

References supplierInteraction.id

externalDocumentIdstring

POSThttps://rest.carbon.ms/shipment

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

Response

{
  "id": "abc123def456",
  "shipmentId": "xyz789",
  "status": "string",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "locationId": "xyz789",
  "sourceDocument": "string"
}

PATCH/shipment

Update a shipment

Update an existing shipment, matched on `id`.

Body parameters

shipmentIdstringrequired

locationIdstring

References location.id

sourceDocumentshipmentSourceDocument

sourceDocumentIdstring

sourceDocumentReadableIdstring

shippingMethodIdstring

References shippingMethod.id

trackingNumberstring

customerIdstring

References customer.id

statusshipmentStatusrequired

postingDatedate

postedBystring

References user.id

invoicedboolean

assigneestring

References user.id

internalNotesobject

externalNotesobject

opportunityIdstring

References opportunity.id

companyIdstringrequired

References company.id

tagsarray

customFieldsobject

supplierIdstring

References supplier.id

supplierInteractionIdstring

References supplierInteraction.id

externalDocumentIdstring

PATCHhttps://rest.carbon.ms/shipment

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

Response

{
  "id": "abc123def456",
  "shipmentId": "xyz789",
  "status": "string",
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "locationId": "xyz789",
  "sourceDocument": "string"
}

DELETE/shipment

Delete a shipment

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

Query parameters

idstring

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

DELETEhttps://rest.carbon.ms/shipment

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

204 No Content