Carbon

Customer Shipping

The customer shipping resource.

Basehttps://rest.carbon.ms/customerShipping
GET/customerShipping

List customer shippings

Retrieve a paginated list of customer shippings. 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/customerShipping
curl --request GET \
  --url 'https://rest.carbon.ms/customerShipping?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "customerId": "xyz789",
    "companyId": "xyz789",
    "shippingCustomerId": "xyz789",
    "shippingCustomerLocationId": "xyz789",
    "shippingCustomerContactId": "xyz789",
    "shippingTermId": "xyz789",
    "shippingMethodId": "xyz789",
    "updatedAt": "2026-01-01T00:00:00Z"
  }
]
GET/customerShipping

Retrieve a customer shipping

Fetch a single customer shipping by filtering on `customerId`.

Query parameters

customerIdstring

Match on the customer shipping's `customerId`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/customerShipping
curl --request GET \
  --url 'https://rest.carbon.ms/customerShipping?customerId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "customerId": "xyz789",
  "companyId": "xyz789",
  "shippingCustomerId": "xyz789",
  "shippingCustomerLocationId": "xyz789",
  "shippingCustomerContactId": "xyz789",
  "shippingTermId": "xyz789",
  "shippingMethodId": "xyz789",
  "updatedAt": "2026-01-01T00:00:00Z"
}
POST/customerShipping

Create a customer shipping

Create a new customer shipping.

Body parameters

shippingCustomerIdstring

References customer.id

shippingCustomerLocationIdstring

References customerLocation.id

shippingCustomerContactIdstring

References customerContact.id

shippingTermIdstring

References shippingTerm.id

shippingMethodIdstring

References shippingMethod.id

companyIdstringrequired

References company.id

incotermstring
incotermLocationstring
POSThttps://rest.carbon.ms/customerShipping
curl --request POST \
  --url https://rest.carbon.ms/customerShipping \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"companyId":"xyz789"}'
Response
{
  "customerId": "xyz789",
  "companyId": "xyz789",
  "shippingCustomerId": "xyz789",
  "shippingCustomerLocationId": "xyz789",
  "shippingCustomerContactId": "xyz789",
  "shippingTermId": "xyz789",
  "shippingMethodId": "xyz789",
  "updatedAt": "2026-01-01T00:00:00Z"
}
PATCH/customerShipping

Update a customer shipping

Update an existing customer shipping, matched on `customerId`.

Body parameters

shippingCustomerIdstring

References customer.id

shippingCustomerLocationIdstring

References customerLocation.id

shippingCustomerContactIdstring

References customerContact.id

shippingTermIdstring

References shippingTerm.id

shippingMethodIdstring

References shippingMethod.id

companyIdstringrequired

References company.id

incotermstring
incotermLocationstring
PATCHhttps://rest.carbon.ms/customerShipping
curl --request PATCH \
  --url 'https://rest.carbon.ms/customerShipping?customerId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"shippingCustomerId":"xyz789"}'
Response
{
  "customerId": "xyz789",
  "companyId": "xyz789",
  "shippingCustomerId": "xyz789",
  "shippingCustomerLocationId": "xyz789",
  "shippingCustomerContactId": "xyz789",
  "shippingTermId": "xyz789",
  "shippingMethodId": "xyz789",
  "updatedAt": "2026-01-01T00:00:00Z"
}
DELETE/customerShipping

Delete a customer shipping

Delete a customer shipping, matched on `customerId`. Returns 204 No Content.

Query parameters

customerIdstring

The `customerId` of the customer shipping to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/customerShipping
curl --request DELETE \
  --url 'https://rest.carbon.ms/customerShipping?customerId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
204 No Content