eBay Post-Order APIVersion 2.7.2
 

ShipmentInfoRequest

Base request type for the POST /post-order/v2/inquiry/{inquiryId}/provide_shipment_info method, which is used to provide shipment information about an order line item that is on its way to the buyer.

Call that uses ShipmentInfoRequest:

Fields



proofOfShipmentUploaded ( boolean ) [0..?]
This boolean field should be included and set to true if shipment tracking information for the order line item is already available in the eBay system. If this field is included in the request and set to true, no other shipment tracking fields are necessary, although they can still be provided by the seller.
See the Field Index to learn which calls use proofOfShipmentUploaded.

sellerComments ( Text ) [0..?]
This container is used if the seller wants to add a note or explanation about shipment tracking.
See the Field Index to learn which calls use sellerComments.

shippedWithTracking ( boolean ) [0..?]
This field can be included and set to true if the shipping carrier used to ship the package uses tracking information. Most, but not all shipping carriers provide shipment tracking numbers.
See the Field Index to learn which calls use shippedWithTracking.

shippingCarrierName ( string ) [0..?]
The seller provides the name of the shipping carrier in this field. This field is conditionally required unless shipment tracking information has already been uploaded to the eBay system (proofOfShipmentUploaded=true). A list of shipping carrier enumeration values can be found in the ShippingCarrierEnum type definition.
See the Field Index to learn which calls use shippingCarrierName.

shippingDate ( DateTime ) [0..?]
The timestamp in this container indicates when the order line item was shipped. This field is conditionally required unless shipment tracking information has already been uploaded to the eBay system (proofOfShipmentUploaded=true).
See the Field Index to learn which calls use shippingDate.

trackingNumber ( string ) [0..?]
The seller provides the shipping carrier's tracking number in this field. This field is conditionally required unless shipment tracking information has already been uploaded to the eBay system (proofOfShipmentUploaded=true).

The accuracy of this tracking number cannot be verified by eBay, so the seller should make sure that the number is accurate.
See the Field Index to learn which calls use trackingNumber.