ExternalFulfillmentReturns V2024_09_11

class sp_api.api.ExternalFulfillmentReturnsV20240911(marketplace: ~sp_api.base.marketplaces.Marketplaces = Marketplaces.US, *, refresh_token=None, account='default', credentials=None, restricted_data_token=None, proxies=None, verify=True, timeout=None, version=None, credential_providers=None, auth_token_client_class=<class 'sp_api.auth.access_token_client.AccessTokenClient'>)

External Fulfillment Returns API (version 2024-09-11).

list_returns(self, **kwargs) → ApiResponse

Get a list of return items dropped for the seller in the specified node, and in the specified status. Returns can be further filtered based on their creation date/time

Examples

literal blocks:

ExternalFulfillmentReturnsV20240911().list_returns()

Parameters:

**kwargs

Returns:

ApiResponse

get_return(self, returnId, **kwargs) → ApiResponse

Get a single return item with the specified id.

Examples

literal blocks:

ExternalFulfillmentReturnsV20240911().get_return("value")

Parameters:

• returnId –

  required

• **kwargs

Returns:

ApiResponse

process_return_item(self, returnId, **kwargs) → ApiResponse

Process a return by grading. Determine the item condition and update the quantities for each item condition.

Examples

literal blocks:

ExternalFulfillmentReturnsV20240911().process_return_item("value")

Parameters:

• returnId –

  required

• **kwargs

Returns:

ApiResponse

list_returns_get(self, **kwargs) → ApiResponse

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

Examples

literal blocks:

ExternalFulfillmentReturnsV20240911().list_returns_get()

Parameters:

• returnLocationId (key) – object | The SmartConnect location ID of the location from which you want to retrieve return items.

• rmaId (key) – object | The RMA ID of the return items you want to list.

• status (key) – object | The status of return items you want to list. You can retrieve all new return items with the CREATED status.

• reverseTrackingId (key) – object | The reverse tracking ID of the return items you want to list.

• createdSince (key) – object | Return items created after the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.

• createdUntil (key) – object | Return items created before the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.

• lastUpdatedSince (key) – object | Return items updated after the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. If you supply this parameter, you must also supply returnLocationId and status.

• lastUpdatedUntil (key) – object | Return items whose most recent update is before the specified date are included in the response. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format. If you supply this parameter, you must also supply returnLocationId and status.

• lastUpdatedAfter (key) – object | DEPRECATED. Use the createdSince parameter.

• lastUpdatedBefore (key) – object | DEPRECATED. Use the createdUntil parameter.

• maxResults (key) – object | The number of return items you want to include in the response. Default: 10 Maximum: 100

• nextToken (key) – object | 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.

Returns:

ApiResponse

get_return_get(self, returnId, **kwargs) → ApiResponse

Retrieve the return item with the specified ID.

Examples

literal blocks:

ExternalFulfillmentReturnsV20240911().get_return_get("value")

Parameters:

returnId – object | required The ID of the return item you want.

Returns:

ApiResponse