eBay Post-Order APIVersion 2.7.2
 

Provide Inquiry Shipment Info

POST /post-order/v2/inquiry/{inquiryId}/provide_shipment_info

This method can be used to provide shipment tracking and other information about the shipment of an order line item that had an INR inquiry filed against it.

Input

See also Samples.

Resource URI (production)

POST https://api.ebay.com/post-order/v2/inquiry/{inquiryId}/provide_shipment_info

URI parameters

Parameter Type Required? Meaning
inquiryId string Required The unique ID of the inquiry for which to provide shipment information. The inquiry ID value is passed in as part of the call URI.


HTTP request headers

All requests made to eBay REST operations require you to provide the authorization HTTP header for authentication.
See HTTP request headers for details.



Authorization

This call uses standard authorization tokens. See Making a Call for details.

Payload model

The following lists all fields that could be included in the request.

{ /* ShipmentInfoRequest */
"proofOfShipmentUploaded": boolean,
"sellerComments":
    { /* Text */
    "content": string,
    "language": string,
    "translatedFromContent": string,
    "translatedFromLanguage": string
    },
"shippedWithTracking": boolean,
"shippingCarrierName": string,
"shippingDate":
    { /* DateTime */
    "formattedValue": string,
    "value": datetime
    },
"trackingNumber": string
}

Request field descriptions



Input Container/Field Type Occurrence Meaning
proofOfShipmentUploaded boolean Conditional 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.
sellerComments Text Optional This container is used if the seller wants to add a note or explanation about shipment tracking.
sellerComments.content string Conditional This field displays the actual textual content in the language specified in the language field. This field is always used for containers using the Text type.
sellerComments.language string Conditional This two-letter code indicates the language used to display the content in the content field. The language will default to the language used on the eBay site if a specific language is not specified through the Accept-Language HTTP header. This field is always used for containers using the Text type.

The full list of language enumeration values are defined in the LanguageEnum type definition.

Applicable values: See LanguageEnum
sellerComments
  .translatedFromContent
string Conditional If language translation/localization is required, this field displays the actual textual content in the language specified in the translatedFromLanguage field. If language translation was not required, this field is not applicable.
sellerComments
  .translatedFromLanguage
string Conditional If language translation/localization is required, this two-letter code indicates the language used to display the content in the translatedFromContent field. If language translation was not required, this field is not applicable.

The full list of language enumeration values are defined in the LanguageEnum type definition.

Applicable values: See LanguageEnum
shippedWithTracking boolean Optional 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.
shippingCarrierName string Conditional 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.
shippingDate DateTime Conditional 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).
shippingDate.formattedValue string Optional Reserved for future use.
shippingDate.value datetime Conditional This timestamp indicates the date and time when an action or event occurred.

The timestamp is formatted as an ISO 8601 string, which is based on the 24-hour Coordinated Universal Time (UTC) clock.

Format: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].[sss]Z
Example: 2022-03-20T00:00:00.000Z
trackingNumber string Conditional 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.

Output

See also Samples.

Payload model

This call has no response payload.

null



Samples

New to making API calls? Please see Making a Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Basic Call

Seller provides shipment information to the buyer.

Description

Seller provides shipment information to the buyer after the buyer has created an INR inquiry for an order line item.

Input

The seller passes in the inquiry ID value as a path parameter to identify the INR inquiry for which shipment information is being provided. In the case of this particular INR inquiry, the seller has sent the line item to the buyer and is providing shipment tracking information to the buyer through the shippingCarrierName and trackingNumber fields.

URL format. See also the non-wrapped version of this URL.

POST https://api.ebay.com/post-order/v2/inquiry/5********8/provide_shipment_info
{ 
  "shippingCarrierName": "FedEx",
  "shippingDate":
  { 
    "value": "2015-09-05T20:18:17.000Z"
  },
  "shippedWithTracking": "true",
  "trackingNumber": "1*********7"
  "proofOfShipmentUploaded": "false",
  "sellerComments":
  { 
    "content": "I have shipped this item. Here are the shipment tracking details."
  }
}

Output

There is no output payload with this response. A successful call contains an HTTP status code of 200.

JSON format.



Change History

Change Date Description