updateFulfillmentOrder - Amazon SP API

Rate (requests per second)	Burst
2	30

Request

Path Params

sellerFulfillmentOrderId

string

required

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

<= 40 characters

Body Params application/json

The request body schema for the `updateFulfillmentOrder` operation.

marketplaceId

string

optional

The marketplace the fulfillment order is placed against.

displayableOrderId

string

optional

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.

<= 40 characters

displayableOrderDate

string <date-time>

optional

Date timestamp

displayableOrderComment

string

optional

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

<= 750 characters

shippingSpeedCategory

enum<string>

optional

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

destinationAddress

object (Address)

optional

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.

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

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 (UpdateFulfillmentOrderItem) {10}]

optional

An array of fulfillment order item information for updating a fulfillment order.

sellerSku

string

optional

The seller SKU of the item.

sellerFulfillmentOrderItemId

string

required

Identifies the fulfillment order item to update. Created with a previous call to the createFulfillmentOrder operation.

<= 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.

orderItemDisposition

string

optional

Indicates whether the item is sellable or unsellable.

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.

Example

{
    "marketplaceId": "string",
    "displayableOrderId": "string",
    "displayableOrderDate": "2019-08-24T14:15:22Z",
    "displayableOrderComment": "string",
    "shippingSpeedCategory": "Standard",
    "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",
    "shipFromCountryCode": "string",
    "notificationEmails": [
        "string"
    ],
    "featureConstraints": [
        {
            "featureName": "string",
            "featureFulfillmentPolicy": "Required"
        }
    ],
    "items": [
        {
            "sellerSku": "string",
            "sellerFulfillmentOrderItemId": "string",
            "quantity": 0,
            "giftMessage": "string",
            "displayableComment": "string",
            "fulfillmentNetworkSku": "string",
            "orderItemDisposition": "string",
            "perUnitDeclaredValue": {
                "currencyCode": "string",
                "amount": "string"
            },
            "perUnitPrice": {
                "currencyCode": "string",
                "amount": "string"
            },
            "perUnitTax": {
                "currencyCode": "string",
                "amount": "string"
            }
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PUT 'https://sandbox.sellingpartnerapi-na.amazon.com/fba/outbound/2020-07-01/fulfillmentOrders/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "marketplaceId": "string",
    "displayableOrderId": "string",
    "displayableOrderDate": "2019-08-24T14:15:22Z",
    "displayableOrderComment": "string",
    "shippingSpeedCategory": "Standard",
    "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",
    "shipFromCountryCode": "string",
    "notificationEmails": [
        "string"
    ],
    "featureConstraints": [
        {
            "featureName": "string",
            "featureFulfillmentPolicy": "Required"
        }
    ],
    "items": [
        {
            "sellerSku": "string",
            "sellerFulfillmentOrderItemId": "string",
            "quantity": 0,
            "giftMessage": "string",
            "displayableComment": "string",
            "fulfillmentNetworkSku": "string",
            "orderItemDisposition": "string",
            "perUnitDeclaredValue": {
                "currencyCode": "string",
                "amount": "string"
            },
            "perUnitPrice": {
                "currencyCode": "string",
                "amount": "string"
            },
            "perUnitTax": {
                "currencyCode": "string",
                "amount": "string"
            }
        }
    ]
}'

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 `updateFulfillmentOrder` 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