POST /shipping-rate-carriers.json

POST /shipping-rate-carriers.json
application/json

Body Required

  • carrierType string | null

    Carrier type

  • dropshipProviderId integer(int32) | null

    Dropship provider

  • externalId string | null

    External

  • filterCarrier boolean | null Required

    Filter carrier

    Default value is true.

  • filterIntegrations string | null Required

    Filter integrations

    Values are all or selected. Default value is all.

  • filterServiceLevels string | null Required

    Filter service levels

    Values are all, selected, or exclude. Default value is all.

  • integrations array[string] | null

    Integrations

  • name string | null

    Name

  • platform string | null Required

    Platform

    Values are shippo, postmen, or manual. Default value is manual.

  • serviceLevels array[string] | null

    Service levels

  • shippingIntegrationId integer(int32) | null

    Shipping integration

  • shippingRateId integer(int32) | null

    Shipping rate

  • shippingRateZoneId integer(int32) | null

    Shipping rate zone

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • carrierType string | null

      Carrier type

    • createdAt string(date-time)

      Created at

    • dropshipProviderId integer(int32) | null

      Dropship provider

    • externalId string | null

      External

    • filterCarrier boolean | null Required

      Filter carrier

      Default value is true.

    • filterIntegrations string | null Required

      Filter integrations

      Values are all or selected. Default value is all.

    • filterServiceLevels string | null Required

      Filter service levels

      Values are all, selected, or exclude. Default value is all.

    • id integer(int32)

      Id

    • integrations array[string] | null

      Integrations

    • name string | null

      Name

    • platform string | null Required

      Platform

      Values are shippo, postmen, or manual. Default value is manual.

    • serviceLevels array[string] | null

      Service levels

    • shippingIntegrationId integer(int32) | null

      Shipping integration

    • shippingRateId integer(int32) | null

      Shipping rate

    • shippingRateZoneId integer(int32) | null

      Shipping rate zone

    • updatedAt string(date-time)

      Updated at

POST /shipping-rate-carriers.json
curl \
 --request POST 'http://api.example.com/v1/shipping-rate-carriers.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"carrierType":"string","dropshipProviderId":42,"externalId":"string","filterCarrier":true,"filterIntegrations":"all","filterServiceLevels":"all","integrations":["string"],"name":"string","platform":"manual","serviceLevels":["string"],"shippingIntegrationId":42,"shippingRateId":42,"shippingRateZoneId":42}'
Request examples
{
  "carrierType": "string",
  "dropshipProviderId": 42,
  "externalId": "string",
  "filterCarrier": true,
  "filterIntegrations": "all",
  "filterServiceLevels": "all",
  "integrations": [
    "string"
  ],
  "name": "string",
  "platform": "manual",
  "serviceLevels": [
    "string"
  ],
  "shippingIntegrationId": 42,
  "shippingRateId": 42,
  "shippingRateZoneId": 42
}
Response examples (200)
{
  "carrierType": "string",
  "createdAt": "2025-05-04T09:42:00Z",
  "dropshipProviderId": 42,
  "externalId": "string",
  "filterCarrier": true,
  "filterIntegrations": "all",
  "filterServiceLevels": "all",
  "id": 42,
  "integrations": [
    "string"
  ],
  "name": "string",
  "platform": "manual",
  "serviceLevels": [
    "string"
  ],
  "shippingIntegrationId": 42,
  "shippingRateId": 42,
  "shippingRateZoneId": 42,
  "updatedAt": "2025-05-04T09:42:00Z"
}