v1

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

listReturns

Retrieve a list of return items. You can filter results by location, RMA ID, status, or time.

get/externalFulfillment/2024-09-11/returns

Query parameters

returnLocationIdstring

The SmartConnect location ID of the location from which you want to retrieve return items.

rmaIdstring

The RMA ID of the return items you want to list.

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'

The status of return items you want to list. You can retrieve all new return items with the CREATED status.

reverseTrackingIdstring

The reverse tracking ID of the return items you want to list.

createdSincestring date-time

Return items created after the specified date are included in the response. In ISO 8601 date-time format.

createdUntilstring date-time

Return items created before the specified date are included in the response. In ISO 8601 date-time format.

lastUpdatedSincestring date-time

Return items updated after the specified date are included in the response. In ISO 8601 date-time format. If you supply this parameter, you must also supply returnLocationId and status.

lastUpdatedUntilstring date-time

Return items whose most recent update is before the specified date are included in the response. In ISO 8601 date-time format. If you supply this parameter, you must also supply returnLocationId and status.

lastUpdatedAfterstring date-time

DEPRECATED. Use the createdSince parameter.

lastUpdatedBeforestring date-time

DEPRECATED. Use the createdUntil parameter.

maxResultsinteger

The number of return items you want to include in the response.

Default: 10

Maximum: 100

nextTokenstring

A token that you use to retrieve the next page of results. The response includes nextToken when there are multiple pages of results. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until nextToken is null. Note that this operation can return empty pages.

Response

Success. The response contains a list of return items.

nextTokenstring

A token that you use to retrieve the next page of results. The response includes nextToken when there are multiple pages of results. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until nextToken is null. Note that this operation can return empty pages.

Example response

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