eBay Post-Order APIVersion 2.6

GetShippingLabelResponse

This type defines the response payload for the POST /post-order/v2/return/{returnId}/get_shipping_label call. This response payload will only be returned if a valid shipping label exists and was found for the specified Return ID.

Call that uses GetShippingLabelResponse:

Fields



carrier ( token ) [0..?]
Indicates the shipping carrier that will be used to ship the return item. ShippingCarrierEnum 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 dollar value indicates 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 ( token ) [0..?]
The format of file containing the shipping label.
See the Field Index to learn which calls use labelFormat.

labelPrintStatus ( token ) [0..?]
Indicates the current status of the print shipping label operation.
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 return 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.