Orders

Purchase Label

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

Request

  • Base URL: https://api.channeladvisor.com
  • URL: https://api.channeladvisor.com/v1/Orders({ID})/PurchaseLabel
  • 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

RateIDstring uuid
LabelFormat'PDF' | 'ZPL'

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

ShippingLabelRequestIDstring nullable

Response

Success

Changes

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