getFulfillmentOrder

Returns the fulfillment order indicated by the specified order identifier.

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.

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 `getFulfillmentOrder` operation.

payload

object (GetFulfillmentOrderResult)

optional

The request for the getFulfillmentOrder operation.

fulfillmentOrder

object (FulfillmentOrder)

required

General information about a fulfillment order, including its status.

fulfillmentOrderItems

array[object (FulfillmentOrderItem) {14}]

required

An array of fulfillment order item information.

fulfillmentShipments

array[object (FulfillmentShipment) {8}]

optional

An array of fulfillment shipment information.

returnItems

array[object (ReturnItem) {11}]

required

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

returnAuthorizations

array[object (ReturnAuthorization) {5}]

required

An array of return authorization information.

paymentInformation

array[object (PaymentInformation) {3}]

optional

An array of various payment attributes related to this fulfillment order.

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": {
        "fulfillmentOrder": {
            "sellerFulfillmentOrderId": "string",
            "marketplaceId": "string",
            "displayableOrderId": "string",
            "displayableOrderDate": "2019-08-24T14:15:22Z",
            "displayableOrderComment": "string",
            "shippingSpeedCategory": "Standard",
            "deliveryWindow": {
                "startDate": "2019-08-24T14:15:22Z",
                "endDate": "2019-08-24T14:15:22Z"
            },
            "destinationAddress": {
                "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"
            },
            "fulfillmentAction": "Ship",
            "fulfillmentPolicy": "FillOrKill",
            "codSettings": {
                "isCodRequired": true,
                "codCharge": {
                    "currencyCode": "string",
                    "amount": "string"
                },
                "codChargeTax": {
                    "currencyCode": "string",
                    "amount": "string"
                },
                "shippingCharge": {
                    "currencyCode": "string",
                    "amount": "string"
                },
                "shippingChargeTax": {
                    "currencyCode": "string",
                    "amount": "string"
                }
            },
            "receivedDate": "2019-08-24T14:15:22Z",
            "fulfillmentOrderStatus": "New",
            "statusUpdatedDate": "2019-08-24T14:15:22Z",
            "notificationEmails": [
                "string"
            ],
            "featureConstraints": [
                {
                    "featureName": "string",
                    "featureFulfillmentPolicy": "Required"
                }
            ]
        },
        "fulfillmentOrderItems": [
            {
                "sellerSku": "string",
                "sellerFulfillmentOrderItemId": "string",
                "quantity": 0,
                "giftMessage": "string",
                "displayableComment": "string",
                "fulfillmentNetworkSku": "string",
                "orderItemDisposition": "string",
                "cancelledQuantity": 0,
                "unfulfillableQuantity": 0,
                "estimatedShipDate": "2019-08-24T14:15:22Z",
                "estimatedArrivalDate": "2019-08-24T14:15:22Z",
                "perUnitPrice": {
                    "currencyCode": "string",
                    "amount": "string"
                },
                "perUnitTax": {
                    "currencyCode": "string",
                    "amount": "string"
                },
                "perUnitDeclaredValue": {
                    "currencyCode": "string",
                    "amount": "string"
                }
            }
        ],
        "fulfillmentShipments": [
            {
                "amazonShipmentId": "string",
                "fulfillmentCenterId": "string",
                "fulfillmentShipmentStatus": "PENDING",
                "shippingDate": "2019-08-24T14:15:22Z",
                "estimatedArrivalDate": "2019-08-24T14:15:22Z",
                "shippingNotes": [
                    "string"
                ],
                "fulfillmentShipmentItem": [
                    {
                        "sellerSku": "string",
                        "sellerFulfillmentOrderItemId": "string",
                        "quantity": 0,
                        "packageNumber": 0,
                        "serialNumber": "string",
                        "manufacturerLotCodes": [
                            "string"
                        ]
                    }
                ],
                "fulfillmentShipmentPackage": [
                    {
                        "packageNumber": 0,
                        "carrierCode": "string",
                        "trackingNumber": "string",
                        "estimatedArrivalDate": "2019-08-24T14:15:22Z",
                        "lockerDetails": {
                            "lockerNumber": "string",
                            "lockerAccessCode": "string"
                        },
                        "deliveryInformation": {
                            "deliveryDocumentList": [
                                {
                                    "documentType": "string",
                                    "url": "string"
                                }
                            ],
                            "dropOffLocation": {
                                "type": "FRONT_DOOR",
                                "attributes": {
                                    "property1": "string",
                                    "property2": "string"
                                }
                            }
                        }
                    }
                ]
            }
        ],
        "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"
            }
        ],
        "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"
            }
        ],
        "paymentInformation": [
            {
                "paymentTransactionId": "string",
                "paymentMode": "string",
                "paymentDate": "2019-08-24T14:15:22Z"
            }
        ]
    },
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429429

🔴500Server Error

🔴503Service Unavailable

Request

Request samples

Responses