eBay Post-Order APIVersion 2

Mark Return Shipped

POST /post-order/v2/return/{returnId}/mark_as_shipped

This call allows a buyer or seller to mark a return or replacement item as 'shipped'.

Input

See also Samples.

Resource URI (production)

POST https://api.ebay.com/post-order/v2/return/{returnId}/mark_as_shipped

URI parameters

Parameter Type Required? Meaning
returnId string Required The unique identifier of the return. The returnId value is required to identify the return for which an item is being marked as 'shipped'.


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.

{ /* MarkAsShippedRequest */
"carrierEnum": token,
"carrierName": string,
"carrierUsed": string,
"comments":
    { /* Text */
    "content": string,
    "language": string,
    "translatedFromContent": string,
    "translatedFromLanguage": string
    },
"shippedDate":
    { /* DateTime */
    "value": datetime
    },
"trackingNumber": string
}

Request field descriptions



Input Container/Field Type Occurrence Meaning
carrierEnum token Optional 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.

Applicable values: See ShippingCarrierEnum
carrierName string Optional 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.
carrierUsed string Optional This string value indicates the shipping carrier used to ship the item.
comments Text Optional This optional container is used to provide any related comments about marking the item as shipped.
comments.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.
comments.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.
comments.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.
comments
  .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.
shippedDate DateTime Optional This timestamp indicates when the item was actually shipped.
shippedDate.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 Required The shipment tracking number of the package. This field is required.

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: Mark an Item as Shipped

A buyer or seller marks a return or replacement item as shipped.

Description

This operation confirms that the buyer has shipped a return item, or that the seller has shipped a replacement item.

Input

The returnId parameter is required to identify the return request for which the item is being marked as shipped. This call has no request payload.

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

POST https://api.ebay.com/post-order/v2/return/5000116809/mark_as_shipped

Output

A successful call returns an HTTP code of 200; there is no payload for the response.

JSON format.



Change History

Change Date Description