Interface FulfillmentOutboundApiModelGetFulfillmentPreviewRequest

The request body schema for the getFulfillmentPreview operation.

Export

GetFulfillmentPreviewRequest

interface FulfillmentOutboundApiModelGetFulfillmentPreviewRequest {
    address: FulfillmentOutboundApiModelAddress;
    featureConstraints?: FulfillmentOutboundApiModelFeatureSettings[];
    includeCODFulfillmentPreview?: boolean;
    includeDeliveryWindows?: boolean;
    items: FulfillmentOutboundApiModelGetFulfillmentPreviewItem[];
    marketplaceId?: string;
    shippingSpeedCategories?: (
        | FulfillmentOutboundApiModelShippingSpeedCategory
        | "Standard"
        | "Expedited"
        | "Priority"
        | "ScheduledDelivery"
    )[];
}

Properties

address featureConstraints? includeCODFulfillmentPreview? includeDeliveryWindows? items marketplaceId? shippingSpeedCategories?

Properties

address

address: FulfillmentOutboundApiModelAddress

Memberof

GetFulfillmentPreviewRequest

OptionalfeatureConstraints

featureConstraints?: FulfillmentOutboundApiModelFeatureSettings[]

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

Memberof

GetFulfillmentPreviewRequest

OptionalincludeCODFulfillmentPreview

includeCODFulfillmentPreview?: boolean

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.

Memberof

GetFulfillmentPreviewRequest

OptionalincludeDeliveryWindows

includeDeliveryWindows?: boolean

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.

Memberof

GetFulfillmentPreviewRequest

items

items: FulfillmentOutboundApiModelGetFulfillmentPreviewItem[]

An array of fulfillment preview item information.

Memberof

GetFulfillmentPreviewRequest

OptionalmarketplaceId

marketplaceId?: string

The marketplace the fulfillment order is placed against.

Memberof

GetFulfillmentPreviewRequest

OptionalshippingSpeedCategories

shippingSpeedCategories?: (
    | FulfillmentOutboundApiModelShippingSpeedCategory
    | "Standard"
    | "Expedited"
    | "Priority"
    | "ScheduledDelivery"
)[]

ShippingSpeedCategory List

Memberof

GetFulfillmentPreviewRequest

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR