createFulfillmentOrder - Amazon SP API

Requests that Amazon ship items from the seller's inventory in Amazon's fulfillment network to a destination address.

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

marketplaceId

string

optional

The marketplace the fulfillment order is placed against.

sellerFulfillmentOrderId

string

required

A fulfillment order identifier that the seller creates to track their fulfillment order. The SellerFulfillmentOrderId must be unique for each fulfillment order that a seller creates. If the seller's system already creates unique order identifiers, then these might be good values for them to use.

<= 40 characters

displayableOrderId

string

required

A fulfillment order identifier that the seller creates. This value displays as the order identifier in recipient-facing materials such as the outbound shipment packing slip. The value of DisplayableOrderId should match the order identifier that the seller provides to the recipient. The seller can use the SellerFulfillmentOrderId for this value or they can specify an alternate value if they want the recipient to reference an alternate order identifier.

The value must be an alpha-numeric or ISO 8859-1 compliant string from one to 40 characters in length. Cannot contain two spaces in a row. Leading and trailing white space is removed.

<= 40 characters

displayableOrderDate

string <date-time>

required

Date timestamp

displayableOrderComment

string

required

Order-specific text that appears in recipient-facing materials such as the outbound shipment packing slip.

<= 750 characters

shippingSpeedCategory

enum<string>

required

The shipping method used for the fulfillment order. When this value is ScheduledDelivery, choose Ship for the fulfillmentAction. Hold is not a valid fulfillmentAction value when the shippingSpeedCategory value is ScheduledDelivery.
Note: Shipping method service level agreements vary by marketplace. Sellers should refer to the Seller Central website in their marketplace for shipping method service level agreements and fulfillment fees.

Allowed values:

StandardExpeditedPriorityScheduledDelivery

deliveryWindow

object (DeliveryWindow)

optional

The time range within which a Scheduled Delivery fulfillment order should be delivered. This is only available in the JP marketplace.

startDate

string <date-time>

required

Date timestamp

endDate

string <date-time>

required

Date timestamp

destinationAddress

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.

deliveryPreferences

object (DeliveryPreferences)

optional

The delivery preferences applied to the destination address. These preferences are applied when possible and are best effort.
This feature is currently supported only in the JP marketplace and not applicable for other marketplaces.
For eligible orders, the default delivery preference will be to deliver the package unattended at the front door, unless you specify otherwise.

deliveryInstructions

string

optional

Additional delivery instructions. For example, this could be instructions on how to enter a building, nearby landmark or navigation instructions, 'Beware of dogs', etc.

<= 250 characters

dropOffLocation

object (DropOffLocation)

optional

The preferred location to leave packages at the destination address.

fulfillmentAction

enum<string>

optional

Specifies whether the fulfillment order should ship now or have an order hold put on it.

Allowed values:

ShipHold

fulfillmentPolicy

enum<string>

optional

The FulfillmentPolicy value specified when you submitted the createFulfillmentOrder operation.

Allowed values:

FillOrKillFillAllFillAllAvailable

codSettings

object (CODSettings)

optional

The COD (Cash On Delivery) charges that you associate with a COD fulfillment order.

isCodRequired

boolean

required

When true, this fulfillment order requires a COD (Cash On Delivery) payment.

codCharge

object (Money)

optional

The currency type and amount.

codChargeTax

object (Money)

optional

The currency type and amount.

shippingCharge

object (Money)

optional

The currency type and amount.

shippingChargeTax

object (Money)

optional

The currency type and amount.

shipFromCountryCode

string

optional

The two-character country code for the country from which the fulfillment order ships. Must be in ISO 3166-1 alpha-2 format.

notificationEmails

array[string]

optional

A list of email addresses that the seller provides that are used by Amazon to send ship-complete notifications to recipients on behalf of the seller.

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

items

array[object (CreateFulfillmentOrderItem) {9}]

required

An array of item information for creating a fulfillment order.

sellerSku

string

required

The seller SKU of the item.

<= 50 characters

sellerFulfillmentOrderItemId

string

required

A fulfillment order item identifier that the seller creates to track fulfillment order items. Used to disambiguate multiple fulfillment items that have the same SellerSKU. For example, the seller might assign different SellerFulfillmentOrderItemId values to two items in a fulfillment order that share the same SellerSKU but have different GiftMessage values.

<= 50 characters

quantity

integer <int32>

required

The item quantity.

giftMessage

string

optional

A message to the gift recipient, if applicable.

<= 512 characters

displayableComment

string

optional

Item-specific text that displays in recipient-facing materials such as the outbound shipment packing slip.

<= 250 characters

fulfillmentNetworkSku

string

optional

Amazon's fulfillment network SKU of the item.

perUnitDeclaredValue

object (Money)

optional

The currency type and amount.

perUnitPrice

object (Money)

optional

The currency type and amount.

perUnitTax

object (Money)

optional

The currency type and amount.

paymentInformation

array[object (PaymentInformation) {3}]

optional

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

paymentTransactionId

string

required

The transaction identifier of this payment.

paymentMode

string

required

The transaction mode of this payment.

paymentDate

string <date-time>

required

Date timestamp

Example

{
    "marketplaceId": {{MARKET_USA}},
    "sellerFulfillmentOrderId": "1TestOrder",
    "displayableOrderId": "1TestOrder",
    "displayableOrderDate": "2019-08-24T14:15:22.123Z",
    "displayableOrderComment": "string",
    "shippingSpeedCategory": "Standard",
    "destinationAddress": {
        "addressLine1": "1234 Elm Street",
        "addressLine2": "Apt 56B",
        "addressLine3": "Building 4",
        "city": "Seattle",
        "countryCode": "US",
        "county": "King",
        "district": "Downtown",
        "name": "John Doe",
        "phoneNumber": "+14155552671",
        "postalCode": "98101",
        "stateOrRegion": "WA"
    },
    "deliveryPreferences": null,
    "fulfillmentAction": "Ship",
    "fulfillmentPolicy": "FillOrKill",
    "codSettings": null,
    "shipFromCountryCode": "US",
    "notificationEmails": null,
    "featureConstraints": null,
    "items": [
        {
            "sellerSku": "123ABC",
            "sellerFulfillmentOrderItemId": "123OrderID",
            "quantity": 1,
            "giftMessage": "string",
            "displayableComment": "string",
            "fulfillmentNetworkSku": "123NetworkSKU",
            "perUnitDeclaredValue": {
                "currencyCode": "USD",
                "value": "2.0"
            },
            "perUnitPrice": {
                "currencyCode": "USD",
                "value": "2.0"
            },
            "perUnitTax": {
                "currencyCode": "USD",
                "value": "0.75"
            }
        }
    ],
    "paymentInformation": null
}

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

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

{
    "errors": [
        {
            "code": "string",
            "message": "string",
            "details": "string"
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429429

🔴500Server Error

🔴503Service Unavailable