Sign in

v1

latestOpenAPI 3.0.0Apache License 2.02026-07-263171,5614.1 MB
External Fulfillment Returns v2024-09-11

getReturn

Retrieve the return item with the specified ID.

get/externalFulfillment/2024-09-11/returns/{returnId}

Path parameters

returnIdstring required

The ID of the return item you want.

Response

Success.

idstring required

The return item's ID.

returnLocationIdstring

The SmartConnect identifier for where the return item was dropped for delivery.

merchantSkustring

The seller's identifier for the SKU.

returnType'CUSTOMER' | 'REJECT' required

The type of return.

returnSubType'NORMAL' | 'REPLACEMENT' | 'EXCHANGE'

The sub-type of return.

numberOfUnitsinteger

The total number of units in the return.

status'CREATED' | 'CARRIER_NOTIFIED_TO_PICK_UP_FROM_CUSTOMER' | 'CARRIER_OUT_FOR_PICK_UP_FROM_CUSTOMER' | 'CUSTOMER_CANCELLED_PICK_UP' | 'CUSTOMER_RESCHEDULED_PICK_UP' | 'PICKED_FROM_CUSTOMER' | 'IN_TRANSIT' | 'OUT_FOR_DELIVERY' | 'DELIVERED' | 'REPLANNED' | 'CUSTOMER_DROPPED_OFF' | 'PARTIALLY_PROCESSED' | 'PROCESSED' | 'REJECTED' | 'CANCELLED' required

The current status of the return.

fulfillmentLocationIdstring required

The ID of the location that fulfilled the order.

creationDateTimestring date-time

Defines a date and time according to ISO8601.

lastUpdatedDateTimestring date-time required

Defines a date and time according to ISO8601.

packageDeliveryMode'WITH_OTP' | 'WITHOUT_OTP'

The package delivery mode. This indicates whether the return was delivered to the seller with or without a one-time password (OTP).

Example response

{
  "marketplaceChannelDetails": {
    "exchangeOrderId": "6cb83006-0597-4bc1-82ab-715b33eb6cf1"
  }
}