eBay Post-Order APIVersion 2

Provide Inquiry Shipment Info

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

Provides 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.

Note: This is the value that was returned by the POST /post-order/v2/inquiry/ call in an HTTP location code: /post-order/v2/inquiry/{INQUIRYID}, in which INQUIRYID identifies the newly created inquiry.


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 */
    "value": datetime
    },
"trackingNumber": string
}

Request field descriptions



Input Container/Field Type Occurrence Meaning
proofOfShipmentUploaded boolean Optional A value of true in this field indicates that the seller has already uploaded shipment tracking information to 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 optional container allows the seller to provide more information to the buyer about shipment of the order line item.
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.

Applicable values are from LanguageEnum:See language.
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.

Applicable values are from LanguageEnum:See translatedFromLanguage.
shippedWithTracking boolean Optional A value of true in this field indicates that the shipping carrier has shipped the package with 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 required unless shipment tracking information has already been uploaded to the eBay system (proofOfShipmentUploaded=true).
shippingDate DateTime Conditional A timestamp indicating when the order line item was shipped. This field is required unless shipment tracking information has already been uploaded to the eBay system (proofOfShipmentUploaded=true).
shippingDate.value datetime Conditional This field is a timestamp for when an event or action occurred or is going to occur in the near future. It is intended for consumption by a caller's code for further computation, transformation, or comparison, and not for the end user. It uses the ISO 8601 date and time format with the 24-hour clock and Universal Coordinated Time (UTC). Following is the format template, and an example of a timestamp in this format:

Format: YYYY-MM-DDTHH:MM:SS.SSSZ

Example: 2004-08-04T19:09:02.768Z

This field is always used for containers using the DateTime type.
trackingNumber string Conditional The shipping carrier's identifier for tracking this shipment. This field is required unless shipment tracking information has already been uploaded to the eBay system (proofOfShipmentUploaded=true).

Output

See also Samples.

Payload model

This call has no response payload.



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/5002619698/provide_shipment_info
{ 
  "shippingCarrierName": "FedEx",
  "shippingDate":
  { 
    "value": "2015-09-05T20:18:17.000Z"
  },
  "shippedWithTracking": "true",
  "trackingNumber": "12141098967"
  "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