createFulfillmentReturn - Amazon SP API

Creates a fulfillment return.

Usage Plan:

Rate (requests per second)	Burst
2	30

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

Request

Path Params

sellerFulfillmentOrderId

string

required

An identifier assigned by the seller to the fulfillment order at the time it was created. The seller uses their own records to find the correct SellerFulfillmentOrderId value based on the buyer's request to return items.

Body Params application/json

The `createFulfillmentReturn` operation creates a fulfillment return for items that were fulfilled using the `createFulfillmentOrder` operation. For calls to `createFulfillmentReturn`, you must include `ReturnReasonCode` values returned by a previous call to the `listReturnReasonCodes` operation.

items

array[object (CreateReturnItem) {5}]

required

An array of items to be returned.

sellerReturnItemId

string

required

An identifier assigned by the seller to the return item.

<= 80 characters

sellerFulfillmentOrderItemId

string

required

The identifier assigned to the item by the seller when the fulfillment order was created.

amazonShipmentId

string

required

The identifier for the shipment that is associated with the return item.

returnReasonCode

string

required

The return reason code assigned to the return item by the seller.

returnComment

string

optional

An optional comment about the return item.

<= 1000 characters

Example

{
    "items": [
        {
            "sellerReturnItemId": "string",
            "sellerFulfillmentOrderItemId": "string",
            "amazonShipmentId": "string",
            "returnReasonCode": "string",
            "returnComment": "string"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success.

Headers

x-amzn-RateLimit-Limit

string

optional

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

optional

Unique request reference identifier.

Body

The response schema for the `createFulfillmentReturn` operation.

payload

object (CreateFulfillmentReturnResult)

optional

The result for the createFulfillmentReturn operation.

returnItems

array[object (ReturnItem) {11}]

optional

An array of items that Amazon accepted for return. Returns empty if no items were accepted for return.

invalidReturnItems

array[object (InvalidReturnItem) {3}]

optional

An array of invalid return item information.

returnAuthorizations

array[object (ReturnAuthorization) {5}]

optional

An array of return authorization information.

errors

array[object (Error) {3}]

optional

A list of error responses that are returned when a request is unsuccessful.

code

string

required

An error code that identifies the type of error that occurred.

message

string

required

A message that describes the error condition.

details

string

optional

Additional details that can help the caller understand or fix the issue.

Example

{
    "payload": {
        "returnItems": [
            {
                "sellerReturnItemId": "string",
                "sellerFulfillmentOrderItemId": "string",
                "amazonShipmentId": "string",
                "sellerReturnReasonCode": "string",
                "returnComment": "string",
                "amazonReturnReasonCode": "string",
                "status": "New",
                "statusChangedDate": "2019-08-24T14:15:22Z",
                "returnAuthorizationId": "string",
                "returnReceivedCondition": "Sellable",
                "fulfillmentCenterId": "string"
            }
        ],
        "invalidReturnItems": [
            {
                "sellerReturnItemId": "string",
                "sellerFulfillmentOrderItemId": "string",
                "invalidItemReason": {
                    "invalidItemReasonCode": "InvalidValues",
                    "description": "string"
                }
            }
        ],
        "returnAuthorizations": [
            {
                "returnAuthorizationId": "string",
                "fulfillmentCenterId": "string",
                "returnToAddress": {
                    "addressLine1": "address_1",
                    "addressLine2": "address_2",
                    "addressLine3": "address_3",
                    "city": "Seattle",
                    "countryCode": "US",
                    "county": "Washington",
                    "district": "District1",
                    "name": "address_name",
                    "phoneNumber": "+14155552671",
                    "postalCode": "123456",
                    "stateOrRegion": "Washington"
                },
                "amazonRmaId": "string",
                "rmaPageURL": "string"
            }
        ]
    },
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429429

🔴500Server Error

🔴503Service Unavailable