eBay Post-Order APIVersion 2.7.3
 

Mark Return Shipped

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

This method can be used on behalf of a buyer to mark a return item as shipped, or can be used on behalf of a seller to mark a 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 eBay-assigned ID of the return. The returnId value is required as part of the call URI to identify the return request 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": string,
"carrierName": string,
"carrierUsed": string,
"comments":
    { /* Text */
    "content": string,
    "language": string,
    "translatedFromContent": string,
    "translatedFromLanguage": string
    },
"shippedDate":
    { /* DateTime */
    "formattedValue": string,
    "value": datetime
    },
"trackingNumber": string
}

Request field descriptions



Input Container/Field Type Occurrence Meaning
carrierEnum string Conditional This field is used to specify 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.

This field must be used in conjunction with the trackingNumber field if using the POST /post-order/v2/return/{returnId}/mark_as_shipped method to provide tracking information.

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

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

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

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

Applicable values: See LanguageEnum
shippedDate DateTime Conditional This container is used to mark the date and time when the item was shipped, and is needed if the buyer or seller are only marking the return/replacement item as 'shipped' without providing shipment tracking information.
shippedDate.formattedValue string Optional Reserved for future use.
shippedDate.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 shipment tracking number of the package. This field is required.

This field must be used in conjunction with the carrierEnum field if using the POST /post-order/v2/return/{returnId}/mark_as_shipped method to provide tracking information.

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: 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/5********9/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