getFulfillmentPreview - Amazon SP API

Returns a list of fulfillment order previews based on shipping criteria that you specify.

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

Body Params application/json

The request body schema for the `getFulfillmentPreview` operation.

marketplaceId

string

optional

The marketplace the fulfillment order is placed against.

address

object (Address)

required

Shipping address that represents the origin or destination location.

Example:

{"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"}

addressLine1

string

required

First line of the address text.

addressLine2

string

optional

Optional second line of the address text.

addressLine3

string

optional

Optional third line of the address text.

city

string

optional

Optional city where this address is located.

countryCode

string

required

Two-digit, ISO 3166-1 alpha-2 formatted country code where this address is located.

county

string

optional

Optional county where this address is located.

Example:

Washington

district

string

optional

Optional district where this address is located.

name

string

required

Name of the person, business, or institution at this address.

phoneNumber

string

optional

Optional E.164-formatted phone number for an available contact at this address.

Example:

+14155552671

postalCode

string

optional

Optional postal code where this address is located.

stateOrRegion

string

required

State or region where this address is located. Note that this is contextual to the specified country code.

items

array[object (GetFulfillmentPreviewItem) {4}]

required

An array of fulfillment preview item information.

sellerSku

string

required

The seller SKU of the item.

<= 50 characters

quantity

integer <int32>

required

The item quantity.

perUnitDeclaredValue

object (Money)

optional

The currency type and amount.

sellerFulfillmentOrderItemId

string

required

A fulfillment order item identifier that the seller creates to track items in the fulfillment preview.

<= 50 characters

shippingSpeedCategories

array[string]

optional

ShippingSpeedCategory List

Allowed values:

StandardExpeditedPriorityScheduledDelivery

includeCODFulfillmentPreview

boolean

optional

When true, returns all fulfillment order previews both for COD and not for COD. Otherwise, returns only fulfillment order previews that are not for COD.

includeDeliveryWindows

boolean

optional

When true, returns the ScheduledDeliveryInfo response object, which contains the available delivery windows for a Scheduled Delivery. The ScheduledDeliveryInfo response object can only be returned for fulfillment order previews with ShippingSpeedCategories = ScheduledDelivery.

featureConstraints

array[object (FeatureSettings) {2}]

optional

A list of features and their fulfillment policies to apply to the order.

featureName

string

optional

The name of the feature.

featureFulfillmentPolicy

enum<string>

optional

Specifies the policy to use when fulfilling an order.

Allowed values:

RequiredNotRequired

Example

{
    "marketplaceId": "string",
    "address": {
        "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"
    },
    "items": [
        {
            "sellerSku": "string",
            "quantity": 0,
            "perUnitDeclaredValue": {
                "currencyCode": "string",
                "amount": "string"
            },
            "sellerFulfillmentOrderItemId": "string"
        }
    ],
    "shippingSpeedCategories": [
        "Standard"
    ],
    "includeCODFulfillmentPreview": true,
    "includeDeliveryWindows": true,
    "featureConstraints": [
        {
            "featureName": "string",
            "featureFulfillmentPolicy": "Required"
        }
    ]
}

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

payload

object (GetFulfillmentPreviewResult)

optional

A list of fulfillment order previews, including estimated shipping weights, estimated shipping fees, and estimated ship dates and arrival dates.

fulfillmentPreviews

array[object (FulfillmentPreview) {11}]

optional

An array of fulfillment preview 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": {
        "fulfillmentPreviews": [
            {
                "shippingSpeedCategory": "Standard",
                "scheduledDeliveryInfo": {
                    "deliveryTimeZone": "string",
                    "deliveryWindows": [
                        {
                            "startDate": "2019-08-24T14:15:22Z",
                            "endDate": "2019-08-24T14:15:22Z"
                        }
                    ]
                },
                "isFulfillable": true,
                "isCODCapable": true,
                "estimatedShippingWeight": {
                    "value": 11,
                    "unit": "Grams"
                },
                "estimatedFees": [
                    {
                        "name": "FBAPerUnitFulfillmentFee",
                        "amount": {
                            "currencyCode": "string",
                            "amount": "string"
                        }
                    }
                ],
                "fulfillmentPreviewShipments": [
                    {
                        "earliestShipDate": "2019-08-24T14:15:22Z",
                        "latestShipDate": "2019-08-24T14:15:22Z",
                        "earliestArrivalDate": "2019-08-24T14:15:22Z",
                        "latestArrivalDate": "2019-08-24T14:15:22Z",
                        "shippingNotes": [
                            "string"
                        ],
                        "fulfillmentPreviewItems": [
                            {
                                "sellerSku": "string",
                                "quantity": 0,
                                "sellerFulfillmentOrderItemId": "string",
                                "estimatedShippingWeight": {
                                    "value": 11,
                                    "unit": "Grams"
                                },
                                "shippingWeightCalculationMethod": "Package"
                            }
                        ]
                    }
                ],
                "unfulfillablePreviewItems": [
                    {
                        "sellerSku": "string",
                        "quantity": 0,
                        "sellerFulfillmentOrderItemId": "string",
                        "itemUnfulfillableReasons": [
                            "string"
                        ]
                    }
                ],
                "orderUnfulfillableReasons": [
                    "string"
                ],
                "marketplaceId": "string",
                "featureConstraints": [
                    {
                        "featureName": "string",
                        "featureFulfillmentPolicy": "Required"
                    }
                ]
            }
        ]
    },
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429429

🔴500Server Error

🔴503Service Unavailable