POST /channels/{id}/rates.json

Bearer auth

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

application/json

Body Required

errors array[object]
Hide errors attributes Show errors attributes object
- type string
- status number
- title string
days integer
missingRates boolean
unallocatedShipments boolean
totalPrice number
totalShipments integer
shipments array[object]
Hide shipments attributes Show shipments attributes object
- dropshipProvider object
- shipping_rate object
- isDomestic boolean
- fromCountry string
- weight number
- dimensions object
  Hide dimensions attributes Show dimensions attributes object
  
  length number
  
  width number
  
  height number
  
  distanceUnit string
  
  Values are em or in.
  
  massUnit string
  
  Values are kg, g, oz, or lb.
- totalItems integer
- orderValue number
- price number
- provider string
- providerCode string
- providerId string
- days integer
- serviceLevel string
- serviceLevelToken string
- serviceLevelTerms string
- quoteHash string
- integration string
- serviceCode string
- handlingFee integer
- label string
- signatureRequired boolean
- fallback boolean
- freeShipping boolean
- saleItems array[object]
  Hide saleItems attributes Show saleItems attributes object
  
  quantity integer
  
  price number
  
  variant object
- errors array[object]
  Hide errors attributes Show errors attributes object
  
  type string
  
  status number
  
  title string
- alternatives array[object]
  Hide alternatives attributes Show alternatives attributes object
  
  price number
  
  provider string
  
  providerCode string
  
  providerId string
  
  days integer
  
  serviceLevel string
  
  serviceLevelToken string
  
  serviceLevelTerms string
  
  quoteHash string
  
  integration string
  
  serviceCode string
  
  handlingFee integer
  
  label string
  
  signatureRequired boolean
  
  fallback boolean
  
  freeShipping boolean

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- errors array[object]
  
  Hide errors attributes Show errors attributes object
  
  type string
  
  status number
  
  title string
- days integer
- missingRates boolean
- unallocatedShipments boolean
- totalPrice number
- totalShipments integer
- shipments array[object]
  
  Hide shipments attributes Show shipments attributes object
  
  dropshipProvider object
  
  shipping_rate object
  
  isDomestic boolean
  
  fromCountry string
  
  weight number
  
  dimensions object
  
  Hide dimensions attributes Show dimensions attributes object
  
  length number
  
  width number
  
  height number
  
  distanceUnit string
  
  Values are em or in.
  
  massUnit string
  
  Values are kg, g, oz, or lb.
  
  totalItems integer
  
  orderValue number
  
  price number
  
  provider string
  
  providerCode string
  
  providerId string
  
  days integer
  
  serviceLevel string
  
  serviceLevelToken string
  
  serviceLevelTerms string
  
  quoteHash string
  
  integration string
  
  serviceCode string
  
  handlingFee integer
  
  label string
  
  signatureRequired boolean
  
  fallback boolean
  
  freeShipping boolean
  
  saleItems array[object]
  
  Hide saleItems attributes Show saleItems attributes object
  
  quantity integer
  
  price number
  
  variant object
  
  errors array[object]
  
  Hide errors attributes Show errors attributes object
  
  type string
  
  status number
  
  title string
  
  alternatives array[object]
  
  Hide alternatives attributes Show alternatives attributes object
  
  price number
  
  provider string
  
  providerCode string
  
  providerId string
  
  days integer
  
  serviceLevel string
  
  serviceLevelToken string
  
  serviceLevelTerms string
  
  quoteHash string
  
  integration string
  
  serviceCode string
  
  handlingFee integer
  
  label string
  
  signatureRequired boolean
  
  fallback boolean
  
  freeShipping boolean

POST /channels/{id}/rates.json

curl \
 --request POST 'http://api.example.com/v1/channels/{id}/rates.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"errors":[{"type":"string","status":42.0,"title":"string"}],"days":42,"missingRates":true,"unallocatedShipments":true,"totalPrice":42.0,"totalShipments":42,"shipments":[{"dropshipProvider":{},"shipping_rate":{},"isDomestic":true,"fromCountry":"string","weight":42.0,"dimensions":{"length":42.0,"width":42.0,"height":42.0,"distanceUnit":"em","massUnit":"kg"},"totalItems":42,"orderValue":42.0,"price":42.0,"provider":"string","providerCode":"string","providerId":"string","days":42,"serviceLevel":"string","serviceLevelToken":"string","serviceLevelTerms":"string","quoteHash":"string","integration":"string","serviceCode":"string","handlingFee":42,"label":"string","signatureRequired":true,"fallback":true,"freeShipping":true,"saleItems":[{"quantity":42,"price":42.0,"variant":{}}],"errors":[{"type":"string","status":42.0,"title":"string"}],"alternatives":[{"price":42.0,"provider":"string","providerCode":"string","providerId":"string","days":42,"serviceLevel":"string","serviceLevelToken":"string","serviceLevelTerms":"string","quoteHash":"string","integration":"string","serviceCode":"string","handlingFee":42,"label":"string","signatureRequired":true,"fallback":true,"freeShipping":true}]}]}'

Request examples

{
  "errors": [
    {
      "type": "string",
      "status": 42.0,
      "title": "string"
    }
  ],
  "days": 42,
  "missingRates": true,
  "unallocatedShipments": true,
  "totalPrice": 42.0,
  "totalShipments": 42,
  "shipments": [
    {
      "dropshipProvider": {},
      "shipping_rate": {},
      "isDomestic": true,
      "fromCountry": "string",
      "weight": 42.0,
      "dimensions": {
        "length": 42.0,
        "width": 42.0,
        "height": 42.0,
        "distanceUnit": "em",
        "massUnit": "kg"
      },
      "totalItems": 42,
      "orderValue": 42.0,
      "price": 42.0,
      "provider": "string",
      "providerCode": "string",
      "providerId": "string",
      "days": 42,
      "serviceLevel": "string",
      "serviceLevelToken": "string",
      "serviceLevelTerms": "string",
      "quoteHash": "string",
      "integration": "string",
      "serviceCode": "string",
      "handlingFee": 42,
      "label": "string",
      "signatureRequired": true,
      "fallback": true,
      "freeShipping": true,
      "saleItems": [
        {
          "quantity": 42,
          "price": 42.0,
          "variant": {}
        }
      ],
      "errors": [
        {
          "type": "string",
          "status": 42.0,
          "title": "string"
        }
      ],
      "alternatives": [
        {
          "price": 42.0,
          "provider": "string",
          "providerCode": "string",
          "providerId": "string",
          "days": 42,
          "serviceLevel": "string",
          "serviceLevelToken": "string",
          "serviceLevelTerms": "string",
          "quoteHash": "string",
          "integration": "string",
          "serviceCode": "string",
          "handlingFee": 42,
          "label": "string",
          "signatureRequired": true,
          "fallback": true,
          "freeShipping": true
        }
      ]
    }
  ]
}

Response examples (200)

{
  "errors": [
    {
      "type": "string",
      "status": 42.0,
      "title": "string"
    }
  ],
  "days": 42,
  "missingRates": true,
  "unallocatedShipments": true,
  "totalPrice": 42.0,
  "totalShipments": 42,
  "shipments": [
    {
      "dropshipProvider": {},
      "shipping_rate": {},
      "isDomestic": true,
      "fromCountry": "string",
      "weight": 42.0,
      "dimensions": {
        "length": 42.0,
        "width": 42.0,
        "height": 42.0,
        "distanceUnit": "em",
        "massUnit": "kg"
      },
      "totalItems": 42,
      "orderValue": 42.0,
      "price": 42.0,
      "provider": "string",
      "providerCode": "string",
      "providerId": "string",
      "days": 42,
      "serviceLevel": "string",
      "serviceLevelToken": "string",
      "serviceLevelTerms": "string",
      "quoteHash": "string",
      "integration": "string",
      "serviceCode": "string",
      "handlingFee": 42,
      "label": "string",
      "signatureRequired": true,
      "fallback": true,
      "freeShipping": true,
      "saleItems": [
        {
          "quantity": 42,
          "price": 42.0,
          "variant": {}
        }
      ],
      "errors": [
        {
          "type": "string",
          "status": 42.0,
          "title": "string"
        }
      ],
      "alternatives": [
        {
          "price": 42.0,
          "provider": "string",
          "providerCode": "string",
          "providerId": "string",
          "days": 42,
          "serviceLevel": "string",
          "serviceLevelToken": "string",
          "serviceLevelTerms": "string",
          "quoteHash": "string",
          "integration": "string",
          "serviceCode": "string",
          "handlingFee": 42,
          "label": "string",
          "signatureRequired": true,
          "fallback": true,
          "freeShipping": true
        }
      ]
    }
  ]
}