GetShippingLabelResponse

The base response type for the POST /post-order/v2/return/{returnId}/get_shipping_label method.

Call that uses GetShippingLabelResponse:

/post-order/v2/return/{returnId}/get_shipping_label GET

Fields

carrier ( string )

labelContent ( string )

labelCost ( Amount )

labelFormat ( ShippingLabelFormatEnum )

labelPrintStatus ( LabelPrintStatusEnum )

labelURL ( string )

trackingNumber ( string )

carrier ( string ) [0..?]

This field shows the shipping carrier that will be used to ship the return or replacement item. The ShippingCarrierEnum type contains some popular shipping carriers for the US, UK, Germany, Canada, and Australia, but it is not a complete list.

See the Field Index to learn which calls use carrier.

labelContent ( string ) [0..?]

This field is the base64-encoded binary representation of the return shipping label.

See the Field Index to learn which calls use labelContent.

labelCost ( Amount ) [0..?]

This container shows the cost of the shipping label. This amount may not be available if the labelPrintStatus value is EXPIRED, FAILED, or UNKNOWN.

See the Field Index to learn which calls use labelCost.

labelFormat ( ShippingLabelFormatEnum ) [0..?]

This enumeration value indicates the file format used for the printable shipping label.

See the Field Index to learn which calls use labelFormat.

labelPrintStatus ( LabelPrintStatusEnum ) [0..?]

This enumeration value indicates the current status of the shipping label. Read the descriptions for the individual enumeration values for more information about what each status value indicates.

See the Field Index to learn which calls use labelPrintStatus.

labelURL ( string ) [0..?]

This string value is the URL of the page where the shipping label can be downloaded and printed. This field is returned if it exists for the shipping label.

See the Field Index to learn which calls use labelURL.

trackingNumber ( string ) [0..?]

This value is the tracking number of the shipment. Most carriers provide shipment tracking, so this field will generally be returned if a shipping label is available for the order line item.

See the Field Index to learn which calls use trackingNumber.