Carbon

Shipping Method

The shipping method resource.

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

List shipping methods

Retrieve a paginated list of shipping methods. 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/shippingMethod
curl --request GET \
  --url 'https://rest.carbon.ms/shippingMethod?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'
Response
[
  {
    "id": "abc123def456",
    "name": "Example",
    "carrier": "string",
    "active": true,
    "companyId": "xyz789",
    "createdAt": "2026-01-01T00:00:00Z",
    "createdBy": "string",
    "carrierAccountId": "xyz789"
  }
]
GET/shippingMethod

Retrieve a shipping method

Fetch a single shipping method by filtering on `id`.

Query parameters

idstring

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

GEThttps://rest.carbon.ms/shippingMethod
curl --request GET \
  --url 'https://rest.carbon.ms/shippingMethod?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "carrier": "string",
  "active": true,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "carrierAccountId": "xyz789"
}
POST/shippingMethod

Create a shipping method

Create a new shipping method.

Body parameters

namestringrequired
carriershippingCarrierrequired
carrierAccountIdstring

References account.id

trackingUrlstring
activebooleanrequired
companyIdstringrequired

References company.id

customFieldsobject
tagsarray
POSThttps://rest.carbon.ms/shippingMethod
curl --request POST \
  --url https://rest.carbon.ms/shippingMethod \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example","carrier":"string","active":true,"companyId":"xyz789"}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "carrier": "string",
  "active": true,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "carrierAccountId": "xyz789"
}
PATCH/shippingMethod

Update a shipping method

Update an existing shipping method, matched on `id`.

Body parameters

namestringrequired
carriershippingCarrierrequired
carrierAccountIdstring

References account.id

trackingUrlstring
activebooleanrequired
companyIdstringrequired

References company.id

customFieldsobject
tagsarray
PATCHhttps://rest.carbon.ms/shippingMethod
curl --request PATCH \
  --url 'https://rest.carbon.ms/shippingMethod?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example"}'
Response
{
  "id": "abc123def456",
  "name": "Example",
  "carrier": "string",
  "active": true,
  "companyId": "xyz789",
  "createdAt": "2026-01-01T00:00:00Z",
  "createdBy": "string",
  "carrierAccountId": "xyz789"
}
DELETE/shippingMethod

Delete a shipping method

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

Query parameters

idstring

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

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