Orders

Shipping Rates

post/v1/Orders({ID})/ShippingRates

Request

Base URL: https://api.channeladvisor.com
URL: https://api.channeladvisor.com/v1/Orders({ID})/ShippingRates
Auth: OAuth 2 (authorization code, authorization URL https://api.channeladvisor.com/oauth2/authorize, token URL https://api.channeladvisor.com/oauth2/token; implicit, authorization URL https://api.channeladvisor.com/oauth2/authorize, scopes: orders, inventory) and HTTP bearer

Path parameters

IDnumber required

The unique identifier of Order

Request body

ShippingLabelPartnerAccountIDsnumber[]

PackageIDnumber nullable

ApplyDeliverByDateboolean nullable

DeliverByDateUtcstring date-time nullable

DeliveryConfirmation'Default' | 'SignatureRequired' | 'AdultSignatureRequired' | 'NoDeliveryConfirmation'

DistributionCenterIDnumber nullable

InsuredAmountnumber nullable

LabelFormat'PDF' | 'ZPL'

The format of the shipping label. Only PDF and ZPL are supported. Defaults to PDF.

ShipDateUtcstring date-time nullable

MeasurementUnit'Centimeter' | 'Inch'

Heightnumber nullable

Lengthnumber nullable

Widthnumber nullable

WeightUnit'Gram' | 'Pound'

Weightnumber nullable

PurchaseCheapestRateboolean nullable

ShippingLabelRequestIDstring nullable

SourceCompanyNamestring nullable

SourceTitlestring nullable

SourceFirstNamestring nullable

SourceLastNamestring nullable

SourceAddressLine1string nullable

SourceAddressLine2string nullable

SourceCitystring nullable

SourceStateOrProvincestring nullable

SourcePostalCodestring nullable

SourceCountryCodestring nullable

SourceEmailAddressstring nullable

SourcePhoneNumberstring nullable

DestinationCompanyNamestring nullable

DestinationTitlestring nullable

DestinationFirstNamestring nullable

DestinationLastNamestring nullable

DestinationAddressLine1string nullable

DestinationAddressLine2string nullable

DestinationCitystring nullable

DestinationStateOrProvincestring nullable

DestinationPostalCodestring nullable

DestinationCountryCodestring nullable

DestinationEmailAddressstring nullable

DestinationPhoneNumberstring nullable

IsCommercialAddressboolean nullable

IncludeCustomsboolean nullable

ExportReason'MERCHANDISE' | 'DOCUMENTS'

CertificateNumberstring nullable

CustomsCommentsstring nullable

EelPfcstring nullable

FromCustomsReferencestring nullable

ImporterCustomsReferencestring nullable

InsuredNumberstring nullable

LicenseNumberstring nullable

ManufacturedCountryCodestring nullable

Example request

{
  "Items": [
    {
      "FulfillmentItemID": 0,
      "OrderItemID": 0,
      "Sku": "string",
      "Quantity": 0,
      "Description": "string",
      "UnitWeight": 0
    }
  ]
}

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.