eBay Post-Order APIVersion 2

ProvideLabelRequest

This is the root request container of the POST /post-order/v2/return/{returnId}/add_shipping_label call.

Call that uses ProvideLabelRequest:

Fields



carrierEnum ( token ) [0..?]
Indicates the shipping carrier used to ship the return or replacement item. ShippingCarrierEnum contains some popular shipping carriers for the US, UK, Germany, Canada, and Australia, but it is not a complete list. Buyer/sellers can call GeteBayDetails of the Trading API to get a complete list of shipping carrier enum values. When using GeteBayDetails, 'ShippingCarrierDetails' should be passed in as a DetailName value, and the values that can be passed in as a carrierEnum value are shown in the ShippingServiceDetails.ShippingCarrier fields.
See the Field Index to learn which calls use carrierEnum.

carrierName ( string ) [0..?]
This field is used to show the name of the shipping carrier. This field is only needed if the carrierEnum value is 'OTHER' or if it is missing.
See the Field Index to learn which calls use carrierName.

comments ( Text ) [0..?]
This optional container can be used to write any applicable comments about the shipping label.
See the Field Index to learn which calls use comments.

fileId ( string ) [0..?]
The unique ID of a file attached to the return request.
See the Field Index to learn which calls use fileId.

forwardShippingLabelProvided ( boolean ) [0..?]
This field should be provided and set to true if the seller has already provided the buyer with a return shipping label. This field is generally provided if the labelAction value is set to MARK_AS_SENT.
See the Field Index to learn which calls use forwardShippingLabelProvided.

labelAction ( LabelActionEnum ) [0..?]
This required field indicates what action is being taken with the POST /post-order/v2/return/{returnId}/add_shipping_label call. Based on what value is supplied here, the noLabelReason, forwardShippingLabelProvided, and labelId fields may become conditionally required.
See the Field Index to learn which calls use labelAction.

labelId ( string ) [0..?]
This field is required if the labelAction value is set to UPLOAD_LABEL and the seller is providing their own shipping label to the buyer (they are not using an eBay shipping label). The labelId value should equal the shipment tracking number of the shipping label the seller is providing to the buyer.
See the Field Index to learn which calls use labelId.

labelSentDate ( DateTime ) [0..?]
This timestamp indicates when the label was sent to the buyer or seller.
See the Field Index to learn which calls use labelSentDate.

This field is conditionally required if the labelAction value is set to NO_LABEL. If no shipping label is being provided, the seller must state the reason why through this field.
See the Field Index to learn which calls use noLabelReason.

returnLabelCost ( Amount ) [0..?]
The cost of the return shipping label.
See the Field Index to learn which calls use returnLabelCost.

trackingNumber ( string ) [0..?]
The tracking number on the shipping label.
See the Field Index to learn which calls use trackingNumber.