GetFulfillmentPreviewRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-seller-central/main/json-schema/amazon-seller-central-get-fulfillment-preview-request-schema.json",
  "title": "GetFulfillmentPreviewRequest",
  "description": "The request body schema for the `getFulfillmentPreview` operation.",
  "x-generated": "2026-09-24",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/amazon-seller-central-fbaoutbound-api-openapi.yml#/components/schemas/GetFulfillmentPreviewRequest",
  "type": "object",
  "required": [
    "address",
    "items"
  ],
  "properties": {
    "marketplaceId": {
      "type": "string",
      "description": "The marketplace the fulfillment order is placed against."
    },
    "address": {
      "description": "The destination address for the fulfillment order preview.",
      "$ref": "#/$defs/Address"
    },
    "items": {
      "description": "Identifying information and quantity information for the items in the fulfillment order preview. Maximum of 100 line items with a maximum of 250 units per order. ",
      "$ref": "#/$defs/GetFulfillmentPreviewItemList"
    },
    "shippingSpeedCategories": {
      "description": "A list of shipping methods used for creating fulfillment order previews.\n\nPossible values:\n\n* `Standard`: Standard shipping method.\n* `Expedited`: Expedited shipping method.\n* `Priority`: Priority shipping method.\n* `ScheduledDelivery`: Scheduled Delivery shipping method.\n**Note:** Shipping method service level agreements vary by marketplace. Sellers should see the Seller Central website in their marketplace for shipping method service level agreements and fulfillment fees.",
      "$ref": "#/$defs/ShippingSpeedCategoryList"
    },
    "includeCODFulfillmentPreview": {
      "type": "boolean",
      "description": "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": {
      "type": "boolean",
      "description": "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` equal to `ScheduledDelivery`."
    },
    "featureConstraints": {
      "type": "array",
      "description": "A list of features and their fulfillment policies to apply to the order.",
      "items": {
        "$ref": "#/$defs/FeatureSettings"
      }
    }
  },
  "$defs": {
    "Address": {
      "type": "object",
      "required": [
        "addressLine1",
        "countryCode",
        "name",
        "postalCode"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the person, business or institution at the address."
        },
        "addressLine1": {
          "type": "string",
          "description": "The first line of the address."
        },
        "addressLine2": {
          "type": "string",
          "description": "Additional address information, if required."
        },
        "addressLine3": {
          "type": "string",
          "description": "Additional address information, if required."
        },
        "city": {
          "type": "string",
          "description": "The city where the person, business, or institution is located. This property is required in all countries except Japan. It should not be used in Japan."
        },
        "districtOrCounty": {
          "type": "string",
          "description": "The district or county where the person, business, or institution is located."
        },
        "stateOrRegion": {
          "type": "string",
          "description": "The state or region where the person, business or institution is located."
        },
        "postalCode": {
          "type": "string",
          "description": "The postal code of the address."
        },
        "countryCode": {
          "type": "string",
          "description": "The two digit country code. In ISO 3166-1 alpha-2 format."
        },
        "phone": {
          "type": "string",
          "description": "The phone number of the person, business, or institution located at the address."
        }
      },
      "description": "A physical address."
    },
    "Decimal": {
      "type": "string",
      "description": "A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation."
    },
    "FeatureSettings": {
      "type": "object",
      "properties": {
        "featureName": {
          "type": "string",
          "description": "The name of the feature. Valid feature names are:\n\n- `BLOCK_AMZL`: Blocks orders from being shipped using Amazon Logistics (AMZL).\n  - Note: Using this feature will incur additional fee surcharges on MCF orders and may increase the risk of unfulfilled or delayed deliveries if alternative carriers are unavailable. Using `BLOCK_AMZL` in an order request will take precedence over your Seller Central account setting.\n- `BLANK_BOX`: Ships orders in non-Amazon branded packaging (blank boxes).\n- `OVERBOX`: Requires items to be shipped in an overbox rather than in their original product packaging.\n- `PACKING_SLIP`: Requires a packing slip to be included with the order.\n- `SIGNATURE_CONFIRMATION`: Requires a signature from the recipient upon delivery. \n  - Note: Using signature confirmation features will incur additional fees on MCF orders and are currently supported only in the US marketplace."
        },
        "featureFulfillmentPolicy": {
          "type": "string",
          "description": "Specifies the policy to use when fulfilling an order.",
          "enum": [
            "Required",
            "NotRequired"
          ],
          "x-docgen-enum-table-extension": [
            {
              "value": "Required",
              "description": "If the offer can't be shipped with the selected feature, reject the order."
            },
            {
              "value": "NotRequired",
              "description": "The feature is not required for shipping."
            }
          ]
        }
      },
      "description": "Feature settings allows you to apply fulfillment features to an order. To block an order from being shipped using Amazon Logistics (AMZL) and an AMZL tracking number, set `featureName` to `BLOCK_AMZL` and `featureFulfillmentPolicy` to `Required`. Blocking AMZL will incur an additional fee surcharge on your MCF orders and increase the risk of some of your orders being unfulfilled or delivered late if there are no alternative carriers available. Using `BLOCK_AMZL` in an order request will take precedence over your Seller Central account setting. To ship in non-Amazon branded packaging (blank boxes), set `featureName` to `BLANK_BOX`. To require items to be shipped in an overbox rather than in their original product packaging, set `featureName` to `OVERBOX`. To require a packing slip to be included with the order, set `featureName` to `PACKING_SLIP`. To require a signature from the recipient upon delivery, set `featureName` to `SIGNATURE_CONFIRMATION`. Note that using signature confirmation features will incur additional fees on MCF orders and are currently supported only in the US marketplace. To ensure all items in an order are delivered together, set `featureName` to `DELIVER_TOGETHER`."
    },
    "GetFulfillmentPreviewItem": {
      "type": "object",
      "required": [
        "quantity",
        "sellerFulfillmentOrderItemId",
        "sellerSku"
      ],
      "properties": {
        "sellerSku": {
          "type": "string",
          "description": "The seller SKU of the item.",
          "maxLength": 50
        },
        "quantity": {
          "$ref": "#/$defs/Quantity"
        },
        "perUnitDeclaredValue": {
          "description": "The monetary value assigned by the seller to this item. This is a required field if this order is an export order or an India MCF order.",
          "$ref": "#/$defs/Money"
        },
        "sellerFulfillmentOrderItemId": {
          "type": "string",
          "description": "A fulfillment order item identifier that the seller creates to track items in the fulfillment preview.",
          "maxLength": 50
        }
      },
      "description": "Item information for a fulfillment order preview."
    },
    "GetFulfillmentPreviewItemList": {
      "type": "array",
      "description": "An array of fulfillment preview item information.",
      "items": {
        "$ref": "#/$defs/GetFulfillmentPreviewItem"
      }
    },
    "Money": {
      "type": "object",
      "required": [
        "currencyCode",
        "value"
      ],
      "properties": {
        "currencyCode": {
          "type": "string",
          "description": "Three digit currency code in ISO 4217 format."
        },
        "value": {
          "$ref": "#/$defs/Decimal"
        }
      },
      "description": "An amount of money, including units in the form of currency."
    },
    "Quantity": {
      "type": "integer",
      "format": "int32",
      "description": "The item quantity."
    },
    "ShippingSpeedCategory": {
      "type": "string",
      "description": "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`.\nNote: Shipping method service level agreements vary by marketplace. Sellers should refer to the [Seller Central](https://developer-docs.amazon.com/sp-api/docs/seller-central-urls) website in their marketplace for shipping method service level agreements and fulfillment fees.",
      "enum": [
        "Standard",
        "Expedited",
        "Priority",
        "ScheduledDelivery"
      ],
      "x-docgen-enum-table-extension": [
        {
          "value": "Standard",
          "description": "Standard shipping method."
        },
        {
          "value": "Expedited",
          "description": "Expedited shipping method."
        },
        {
          "value": "Priority",
          "description": "Priority shipping method."
        },
        {
          "value": "ScheduledDelivery",
          "description": "Scheduled Delivery shipping method. This is only available in the JP marketplace."
        }
      ]
    },
    "ShippingSpeedCategoryList": {
      "description": "List of shipping speed categories.",
      "type": "array",
      "items": {
        "$ref": "#/$defs/ShippingSpeedCategory"
      }
    }
  }
}