Interface CreateFulfillmentOrderRequest

The request body schema for the createFulfillmentOrder operation.

Export

CreateFulfillmentOrderRequest

interface CreateFulfillmentOrderRequest {
    codSettings?: CODSettings;
    deliveryWindow?: DeliveryWindow;
    destinationAddress: Address;
    displayableOrderComment: string;
    displayableOrderDate: string;
    displayableOrderId: string;
    featureConstraints?: FeatureSettings[];
    fulfillmentAction?: FulfillmentAction;
    fulfillmentPolicy?: FulfillmentPolicy;
    items: CreateFulfillmentOrderItem[];
    marketplaceId?: string;
    notificationEmails?: string[];
    paymentInformation?: PaymentInformation[];
    sellerFulfillmentOrderId: string;
    shipFromCountryCode?: string;
    shippingSpeedCategory: ShippingSpeedCategory;
}

Properties

codSettings? deliveryWindow? destinationAddress displayableOrderComment displayableOrderDate displayableOrderId featureConstraints? fulfillmentAction? fulfillmentPolicy? items marketplaceId? notificationEmails? paymentInformation? sellerFulfillmentOrderId shipFromCountryCode? shippingSpeedCategory

Properties

Optional codSettings

codSettings?: CODSettings

Memberof

CreateFulfillmentOrderRequest

Optional deliveryWindow

deliveryWindow?: DeliveryWindow

Memberof

CreateFulfillmentOrderRequest

destinationAddress

destinationAddress: Address

Memberof

CreateFulfillmentOrderRequest

displayableOrderComment

displayableOrderComment: string

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

Memberof

CreateFulfillmentOrderRequest

displayableOrderDate

displayableOrderDate: string

Memberof

CreateFulfillmentOrderRequest

displayableOrderId

displayableOrderId: string

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.

Memberof

CreateFulfillmentOrderRequest

Optional featureConstraints

featureConstraints?: FeatureSettings[]

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

Memberof

CreateFulfillmentOrderRequest

Optional fulfillmentAction

fulfillmentAction?: FulfillmentAction

Memberof

CreateFulfillmentOrderRequest

Optional fulfillmentPolicy

fulfillmentPolicy?: FulfillmentPolicy

Memberof

CreateFulfillmentOrderRequest

items

items: CreateFulfillmentOrderItem[]

An array of item information for creating a fulfillment order.

Memberof

CreateFulfillmentOrderRequest

Optional marketplaceId

marketplaceId?: string

The marketplace the fulfillment order is placed against.

Memberof

CreateFulfillmentOrderRequest

Optional notificationEmails

notificationEmails?: string[]

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.

Memberof

CreateFulfillmentOrderRequest

Optional paymentInformation

paymentInformation?: PaymentInformation[]

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

Memberof

CreateFulfillmentOrderRequest

sellerFulfillmentOrderId

sellerFulfillmentOrderId: string

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.

Memberof

CreateFulfillmentOrderRequest

Optional shipFromCountryCode

shipFromCountryCode?: string

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

Memberof

CreateFulfillmentOrderRequest

shippingSpeedCategory

shippingSpeedCategory: ShippingSpeedCategory

Memberof

CreateFulfillmentOrderRequest

Settings

Member Visibility

Theme

On This Page

codSettingsdeliveryWindowdestinationAddressdisplayableOrderCommentdisplayableOrderDatedisplayableOrderIdfeatureConstraintsfulfillmentActionfulfillmentPolicyitemsmarketplaceIdnotificationEmailspaymentInformationsellerFulfillmentOrderIdshipFromCountryCodeshippingSpeedCategory