Supplier Shipping

The supplier shipping resource.

Basehttps://rest.carbon.ms/supplierShipping

GET/supplierShipping

List supplier shippings

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

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

Response

[
  {
    "supplierId": "xyz789",
    "companyId": "xyz789",
    "shippingSupplierId": "xyz789",
    "shippingSupplierLocationId": "xyz789",
    "shippingSupplierContactId": "xyz789",
    "shippingTermId": "xyz789",
    "shippingMethodId": "xyz789",
    "updatedAt": "2026-01-01T00:00:00Z"
  }
]

GET/supplierShipping

Retrieve a supplier shipping

Fetch a single supplier shipping by filtering on `supplierId`.

Query parameters

supplierIdstring

Match on the supplier shipping's `supplierId`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/supplierShipping

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

Response

{
  "supplierId": "xyz789",
  "companyId": "xyz789",
  "shippingSupplierId": "xyz789",
  "shippingSupplierLocationId": "xyz789",
  "shippingSupplierContactId": "xyz789",
  "shippingTermId": "xyz789",
  "shippingMethodId": "xyz789",
  "updatedAt": "2026-01-01T00:00:00Z"
}

POST/supplierShipping

Create a supplier shipping

Create a new supplier shipping.

Body parameters

shippingSupplierIdstring

References supplier.id

shippingSupplierLocationIdstring

References supplierLocation.id

shippingSupplierContactIdstring

References supplierContact.id

shippingTermIdstring

References shippingTerm.id

shippingMethodIdstring

References shippingMethod.id

companyIdstringrequired

References company.id

customFieldsobject

tagsarray

incotermstring

incotermLocationstring

POSThttps://rest.carbon.ms/supplierShipping

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

Response

{
  "supplierId": "xyz789",
  "companyId": "xyz789",
  "shippingSupplierId": "xyz789",
  "shippingSupplierLocationId": "xyz789",
  "shippingSupplierContactId": "xyz789",
  "shippingTermId": "xyz789",
  "shippingMethodId": "xyz789",
  "updatedAt": "2026-01-01T00:00:00Z"
}

PATCH/supplierShipping

Update a supplier shipping

Update an existing supplier shipping, matched on `supplierId`.

Body parameters

shippingSupplierIdstring

References supplier.id

shippingSupplierLocationIdstring

References supplierLocation.id

shippingSupplierContactIdstring

References supplierContact.id

shippingTermIdstring

References shippingTerm.id

shippingMethodIdstring

References shippingMethod.id

companyIdstringrequired

References company.id

customFieldsobject

tagsarray

incotermstring

incotermLocationstring

PATCHhttps://rest.carbon.ms/supplierShipping

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

Response

{
  "supplierId": "xyz789",
  "companyId": "xyz789",
  "shippingSupplierId": "xyz789",
  "shippingSupplierLocationId": "xyz789",
  "shippingSupplierContactId": "xyz789",
  "shippingTermId": "xyz789",
  "shippingMethodId": "xyz789",
  "updatedAt": "2026-01-01T00:00:00Z"
}

DELETE/supplierShipping

Delete a supplier shipping

Delete a supplier shipping, matched on `supplierId`. Returns 204 No Content.

Query parameters

supplierIdstring

The `supplierId` of the supplier shipping to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/supplierShipping

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

204 No Content