{ "swagger": "2.0", "info": { "description": "The Selling Partner API for Fulfillment Outbound lets you create applications that help a seller fulfill Multi-Channel Fulfillment orders using their inventory in Amazon's fulfillment network. You can get information on both potential and existing fulfillment orders.", "version": "2026-07-04", "title": "The Selling Partner API for Fulfillment Outbound", "contact": { "name": "Selling Partner API Developer Support", "url": "https://sellercentral.amazon.com/gp/mws/contactus.html" }, "license": { "name": "Apache License 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0" } }, "host": "sellingpartnerapi-na.amazon.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/fulfillment/outbound/2026-07-04/previews": { "x-amzn-api-sandbox": { "dynamic": {} }, "post": { "tags": [ "fulfillmentOutbound", "fulfillmentPreviews" ], "description": "Retrieve a list of fulfillment order previews based on shipping criteria that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getOrderPreview", "parameters": [ { "name": "x-amzn-fulfillment-service-id", "in": "header", "description": "The identifier of the fulfillment service used for this operation.", "required": false, "type": "string", "maxLength": 40, "x-example": "FS01-o8vlfw8b1tiu1" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/GetOrderPreviewRequest" }, "description": "The request body schema for the `getOrderPreview` operation.", "x-examples": { "application/json": { "channel": "SHOPIFY", "fulfillmentConfiguration": { "serviceLevel": { "serviceTiers": [ "STANDARD" ] }, "services": { "packaging": { "packagingOption": "UNBRANDED" }, "additional": {} } }, "origin": { "countryCode": "US" }, "destination": { "deliveryAddress": { "name": "Shopper Name", "addressLine1": "1000 Winthrop Ave N", "city": "Seattle", "countryCode": "US", "postalCode": "98103", "stateOrRegion": "WA", "phone": "123-456-7890", "email": "shopper@email.com" } }, "lineItems": [ { "product": { "productIdentifier": { "amazonSku": "BOOK-123-HC" }, "perUnitDeclaredValue": { "currencyCode": "USD", "amount": "14.99" } }, "amount": { "unit": "EACHES", "value": "2.0" } } ] } } } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/GetOrderPreviewResponse" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." }, "x-amzn-fulfillment-service-id": { "type": "string", "description": "The identifier of the fulfillment service associated with this request." } }, "examples": { "application/json": { "plannedShipments": [ { "estimatedShippingWeight": { "unit": "KG", "value": "2.0" }, "items": [ { "productIdentifier": { "amazonSku": "someSku" }, "amount": { "unit": "EACHES", "value": "1.0" } } ], "offers": [ { "fulfillmentConfiguration": { "serviceLevel": { "serviceTier": "STANDARD", "deliveryInterval": { "startTime": "2025-04-21T12:34:56Z", "endTime": "2025-04-22T12:34:56Z" }, "shipInterval": { "startTime": "2025-04-21T10:00:00Z", "endTime": "2025-04-21T14:00:00Z" } }, "services": { "packaging": { "packagingOption": "UNBRANDED" }, "delivery": { "paymentOnDelivery": "ENABLED" }, "additional": {} } }, "estimatedPrice": { "rollupPrices": [ { "type": "MCFTransportationFee", "value": { "currencyCode": "USD", "amount": "4.25" } } ], "totalPrice": { "currencyCode": "USD", "amount": "4.25" } } } ] } ], "constraints": [ { "message": "There is not enough quantity of item xyz.", "type": "ValidationError", "code": "ItemQuantityNotAvailable", "details": [ { "type": "someType", "value": "someValue" } ] } ] } } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "401": { "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "404": { "description": "The resource specified does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "413": { "description": "The request size exceeded the maximum accepted size.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "415": { "description": "The request payload is in an unsupported format.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } } }, "/fulfillment/outbound/2026-07-04/offers": { "x-amzn-api-sandbox": { "dynamic": {} }, "post": { "tags": [ "fulfillmentOutbound", "offers" ], "description": "Retrieve delivery options that include an estimated delivery date and offer expiration, based on criteria that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 5 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getOffers", "parameters": [ { "name": "x-amzn-fulfillment-service-id", "in": "header", "description": "The identifier of the fulfillment service used for this operation.", "required": false, "type": "string", "maxLength": 40, "x-example": "FS01-o8vlfw8b1tiu1" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/GetOffersRequest" }, "description": "The request body schema for the `getOffers` operation.", "x-examples": { "application/json": { "fulfillmentConfiguration": { "serviceLevel": { "serviceTiers": [ "STANDARD", "EXPEDITED" ] } }, "origin": { "countryCode": "US" }, "destination": { "deliveryAddress": { "countryCode": "US", "postalCode": "98103" }, "ipAddress": "192.168.0.1" }, "items": [ { "productIdentifier": { "amazonSku": "FRN-DSK-MCM-WAL-001" } }, { "productIdentifier": { "amazonSku": "FRN-DSK-MCM-CHR-001" } } ] } } } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/GetOffersResponse" }, "examples": { "application/json": { "offerResults": [ { "item": { "productIdentifier": { "amazonSku": "FRN-DSK-MCM-WAL-001" } }, "offers": [ { "fulfillmentConfiguration": { "serviceLevel": { "serviceTier": "STANDARD", "deliveryInterval": { "startTime": "2026-05-02T12:00:00Z", "endTime": "2026-05-03T23:59:00Z" } } }, "expiryTime": "2026-04-30T12:00:00Z" }, { "fulfillmentConfiguration": { "serviceLevel": { "serviceTier": "EXPEDITED", "deliveryInterval": { "startTime": "2026-04-30T18:00:00Z", "endTime": "2026-05-01T18:00:00Z" } } }, "expiryTime": "2026-04-30T12:00:00Z" } ] }, { "item": { "productIdentifier": { "amazonSku": "FRN-DSK-MCM-CHR-001" } }, "offers": [ { "fulfillmentConfiguration": { "serviceLevel": { "serviceTier": "STANDARD", "deliveryInterval": { "startTime": "2026-05-03T12:00:00Z", "endTime": "2026-05-05T23:59:00Z" } } }, "expiryTime": "2026-04-30T12:00:00Z" } ], "constraints": [ { "message": "EXPEDITED delivery unavailable for FRN-DSK-MCM-CHR-001", "type": "ValidationError", "code": "DeliverySLAUnavailable", "details": [ { "type": "serviceTier", "value": "EXPEDITED" }, { "type": "amazonSku", "value": "FRN-DSK-MCM-CHR-001" } ] } ] } ] } }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." }, "x-amzn-fulfillment-service-id": { "type": "string", "description": "The identifier of the fulfillment service associated with this request." } } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "401": { "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "404": { "description": "The resource specified does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "413": { "description": "The request size exceeded the maximum accepted size.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "415": { "description": "The request payload is in an unsupported format.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } } }, "/fulfillment/outbound/2026-07-04/orders/{orderId}/cancel": { "x-amzn-api-sandbox": { "dynamic": {} }, "put": { "tags": [ "fulfillmentOutbound", "fulfillmentOrders" ], "description": "Request that Amazon stop attempting to fulfill a fulfillment order.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "cancelOrder", "parameters": [ { "name": "x-amzn-fulfillment-service-id", "in": "header", "description": "The identifier of the fulfillment service used for this operation.", "required": false, "type": "string", "maxLength": 40, "x-example": "FS01-o8vlfw8b1tiu1" }, { "name": "orderId", "in": "path", "description": "The ID of the order that you want to cancel.", "required": true, "type": "string", "maxLength": 40, "x-example": "order-123" } ], "responses": { "202": { "description": "Success.", "schema": { "$ref": "#/definitions/CancelOrderResponse" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." }, "x-amzn-fulfillment-service-id": { "type": "string", "description": "The identifier of the fulfillment service associated with this request." } }, "examples": { "application/json": {} } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "401": { "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "404": { "description": "The resource specified does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "413": { "description": "The request size exceeded the maximum accepted size.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "415": { "description": "The request payload is in an unsupported format.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } } }, "/fulfillment/outbound/2026-07-04/orders/{orderId}/status": { "x-amzn-api-sandbox-only": true, "x-amzn-api-sandbox": { "dynamic": {} }, "put": { "tags": [ "fulfillmentOutbound", "fulfillmentOrders" ], "description": "Request that Amazon update the status of an order in the sandbox testing environment. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Fulfillment Outbound Dynamic Sandbox Guide](https://developer-docs.amazon.com/sp-api/docs/fulfillment-outbound-dynamic-sandbox-guide) and [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.", "operationId": "updateOrderStatus", "parameters": [ { "name": "x-amzn-fulfillment-service-id", "in": "header", "description": "The identifier of the fulfillment service used for this operation.", "required": false, "type": "string", "maxLength": 40, "x-example": "FS01-o8vlfw8b1tiu1" }, { "name": "orderId", "in": "path", "description": "The ID of the order that you want to update.", "required": true, "type": "string", "maxLength": 40, "x-example": "order-123" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateOrderStatusRequest" }, "description": "The new status of the fulfillment order.", "x-examples": { "application/json": { "status": "PROCESSING" } } } ], "responses": { "204": { "description": "Success.", "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." }, "x-amzn-fulfillment-service-id": { "type": "string", "description": "The identifier of the fulfillment service associated with this request." } } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "401": { "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "404": { "description": "The resource specified does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "413": { "description": "The request size exceeded the maximum accepted size.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "415": { "description": "The request payload is in an unsupported format.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } } }, "/fulfillment/outbound/2026-07-04/orders/{orderId}/packages/{packageId}": { "x-amzn-api-sandbox-only": true, "x-amzn-api-sandbox": { "dynamic": {} }, "put": { "tags": [ "fulfillmentOutbound", "fulfillmentOrders" ], "description": "Update package information for a specific package in a fulfillment order. This is a sandbox-only operation and must be directed to a sandbox endpoint. Refer to [Fulfillment Outbound Dynamic Sandbox Guide](https://developer-docs.amazon.com/sp-api/docs/fulfillment-outbound-dynamic-sandbox-guide) and [Selling Partner API sandbox](https://developer-docs.amazon.com/sp-api/docs/the-selling-partner-api-sandbox) for more information.", "operationId": "updatePackage", "parameters": [ { "name": "x-amzn-fulfillment-service-id", "in": "header", "description": "The identifier of the fulfillment service used for this operation.", "required": false, "type": "string", "maxLength": 40, "x-example": "FS01-o8vlfw8b1tiu1" }, { "name": "orderId", "in": "path", "description": "The ID of the order that contains the package that you want to update.", "required": true, "type": "string", "maxLength": 40, "x-example": "order-123" }, { "name": "packageId", "in": "path", "description": "The ID of the package that you want to update.", "required": true, "type": "string", "x-example": "PKG-abc123def456" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UpdatePackageRequest" }, "description": "The new package information.", "x-examples": { "application/json": { "status": "DELIVERED" } } } ], "responses": { "204": { "description": "Success.", "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." }, "x-amzn-fulfillment-service-id": { "type": "string", "description": "The identifier of the fulfillment service associated with this request." } } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "401": { "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "404": { "description": "The resource specified does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "413": { "description": "The request size exceeded the maximum accepted size.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "415": { "description": "The request payload is in an unsupported format.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } } }, "/fulfillment/outbound/2026-07-04/orders/{orderId}": { "x-amzn-api-sandbox": { "dynamic": {} }, "put": { "tags": [ "fulfillmentOutbound", "fulfillmentOrders" ], "description": "Update and/or request shipment for a fulfillment order with an order hold on it.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "updateOrder", "parameters": [ { "name": "x-amzn-fulfillment-service-id", "in": "header", "description": "The identifier of the fulfillment service used for this operation.", "required": false, "type": "string", "maxLength": 40, "x-example": "FS01-o8vlfw8b1tiu1" }, { "name": "orderId", "in": "path", "description": "The ID of the order that you want to update and/or request shipment of.", "required": true, "type": "string", "maxLength": 40, "x-example": "orderNumberThree" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateOrderRequest" }, "description": "The request body schema for the `updateOrder` operation.", "x-examples": { "application/json": { "fulfillmentConfiguration": { "action": "HOLD" } } } } ], "responses": { "202": { "description": "Success.", "schema": { "$ref": "#/definitions/UpdateOrderResponse" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." }, "x-amzn-fulfillment-service-id": { "type": "string", "description": "The identifier of the fulfillment service associated with this request." } }, "examples": { "application/json": {} } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "401": { "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "404": { "description": "The resource specified does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "413": { "description": "The request size exceeded the maximum accepted size.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "415": { "description": "The request payload is in an unsupported format.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } }, "get": { "tags": [ "fulfillmentOutbound", "fulfillmentOrders" ], "description": "Retrieve a fulfillment order.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getOrder", "parameters": [ { "name": "x-amzn-fulfillment-service-id", "in": "header", "description": "The identifier of the fulfillment service used for this operation.", "required": false, "type": "string", "maxLength": 40, "x-example": "FS01-o8vlfw8b1tiu1" }, { "name": "orderId", "in": "path", "description": "The ID of the order you want to retrieve.", "required": true, "type": "string", "maxLength": 40, "x-example": "orderNumberThree" }, { "name": "shipments", "in": "query", "description": "Whether to include shipment data in the response. Included by default.", "type": "string", "enum": [ "INCLUDE", "EXCLUDE" ], "x-docgen-enum-table-extension": [ { "value": "INCLUDE", "description": "Response schema includes shipments data. This is the default behavior." }, { "value": "EXCLUDE", "description": "Response schema does not include shipments data." } ], "x-example": "EXCLUDE" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/GetOrderResponse" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." }, "x-amzn-fulfillment-service-id": { "type": "string", "description": "The identifier of the fulfillment service associated with this request." } }, "examples": { "application/json": { "order": { "orderId": "ABC123XYZ", "channel": "SHOPIFY", "receiveTime": "2025-04-21T10:30:00Z", "status": "PROCESSING", "statusUpdateTime": "2025-04-21T11:45:00Z", "fulfillmentConfiguration": { "serviceLevel": { "serviceTiers": [ "STANDARD" ] }, "action": "HOLD", "policy": "FILL_ALL_AVAILABLE", "services": { "packaging": { "packagingOption": "UNBRANDED", "packingSlip": { "templateName": "templateName", "templateAttributes": { "orderId": "MyOrder-123", "orderTime": "2026-07-01T10:00:00Z", "orderText": "Thank you for your purchase!" } } }, "additional": {} } }, "origin": { "countryCode": "US" }, "destination": { "deliveryAddress": { "name": "Shopper Name", "addressLine1": "1000 Winthrop Ave N", "city": "Seattle", "countryCode": "US", "postalCode": "98103", "stateOrRegion": "WA", "phone": "123-456-7890", "email": "shopper@email.com" } }, "lineItems": [ { "lineItemId": "someLineItemId", "product": { "productIdentifier": { "amazonSku": "BOOK-123-HC" }, "perUnitDeclaredValue": { "currencyCode": "USD", "amount": "14.99" } }, "amount": { "unit": "EACHES", "value": "1.0" }, "cancelledAmount": { "unit": "EACHES", "value": "0.0" }, "unfulfillableAmount": { "unit": "EACHES", "value": "0.0" }, "fulfillmentConfiguration": { "services": { "packaging": { "packingSlip": { "templateName": "templateName", "templateAttributes": { "orderId": "MyOrder-123", "orderTime": "2026-07-01T10:00:00Z", "orderText": "Thank you for your purchase!" } } }, "delivery": { "paymentOnDelivery": { "perUnitServicePrice": { "currencyCode": "USD", "amount": "14.99" } } } } } } ], "shipments": [ { "amazonShipmentId": "SHIP901234", "amazonFacility": { "facilityId": "FC456" }, "status": "SHIPPED", "shipTime": "2025-04-21T15:00:00Z", "deliveryTime": "2025-04-23T12:00:00Z", "items": [ { "shipmentItemId": "SI001", "productIdentifier": { "amazonSku": "SKU123" }, "lineItemId": "LI789012", "amount": { "value": "1.0", "unit": "EACHES" } } ], "packages": [ { "packageId": "PKG-abc123def456", "status": "DELIVERED", "shipmentItemIds": [ "SI001" ], "tracking": { "carrier": { "carrierCode": "FEDEX", "trackingNumber": "123456789" }, "amazon": { "trackingNumber": "123456789" } } } ] } ], "paymentInformation": { "payments": [ { "paymentId": "PAY-12345", "paymentMethod": "CREDIT_CARD", "paymentTime": "2019-10-13T13:53:49Z" } ] } } } } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "401": { "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "404": { "description": "The resource specified does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "413": { "description": "The request size exceeded the maximum accepted size.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "415": { "description": "The request payload is in an unsupported format.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } } }, "/fulfillment/outbound/2026-07-04/orders": { "x-amzn-api-sandbox": { "dynamic": {} }, "get": { "tags": [ "fulfillmentOutbound", "fulfillmentOrders" ], "description": "Retrieve a list of fulfillment orders that match the criteria you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "listOrders", "parameters": [ { "name": "x-amzn-fulfillment-service-id", "in": "header", "description": "The identifier of the fulfillment service used for this operation.", "required": false, "type": "string", "maxLength": 40, "x-example": "FS01-o8vlfw8b1tiu1" }, { "name": "updatedAfter", "in": "query", "description": "The response includes orders updated after this time. Must be in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.", "type": "string", "format": "date-time", "x-example": "2025-04-01T12:00:00Z" }, { "in": "query", "name": "pageToken", "required": false, "description": "A token that you use to retrieve the next page of results. The response includes `pageToken` when the number of results exceeds the page size. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `pageToken` is `null`.", "type": "string", "x-example": "someToken" }, { "name": "shipments", "in": "query", "description": "Whether to include shipment data in the response. Included by default.", "type": "string", "enum": [ "INCLUDE", "EXCLUDE" ], "x-docgen-enum-table-extension": [ { "value": "INCLUDE", "description": "Response schema includes shipments data. This is the default behavior." }, { "value": "EXCLUDE", "description": "Response schema does not include shipments data." } ], "x-example": "EXCLUDE" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/ListOrdersResponse" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." }, "x-amzn-fulfillment-service-id": { "type": "string", "description": "The identifier of the fulfillment service associated with this request." } }, "examples": { "application/json": { "orders": [ { "orderId": "ABC123XYZ", "channel": "SHOPIFY", "receiveTime": "2025-04-21T10:30:00Z", "status": "PROCESSING", "statusUpdateTime": "2025-04-21T11:45:00Z", "fulfillmentConfiguration": { "serviceLevel": { "serviceTiers": [ "STANDARD" ] }, "action": "HOLD", "services": { "packaging": { "packingSlip": { "templateName": "templateName", "templateAttributes": { "orderId": "MyOrder-123", "orderTime": "2026-07-01T10:00:00Z", "orderText": "Thank you for your purchase!" } } } } }, "origin": { "countryCode": "US" }, "destination": { "deliveryAddress": { "name": "Shopper Name", "addressLine1": "1000 Winthrop Ave N", "city": "Seattle", "countryCode": "US", "postalCode": "98103", "stateOrRegion": "WA", "phone": "123-456-7890", "email": "shopper@email.com" } }, "lineItems": [ { "lineItemId": "someLineItemId", "product": { "productIdentifier": { "amazonSku": "BOOK-123-HC" }, "perUnitDeclaredValue": { "currencyCode": "USD", "amount": "14.99" } }, "amount": { "unit": "EACHES", "value": "1.0" }, "fulfillmentConfiguration": { "services": { "packaging": { "packingSlip": { "templateName": "templateName", "templateAttributes": { "giftMessage": "Happy Birthday!", "lineItemText": "Item 1 of 2" } } }, "delivery": { "paymentOnDelivery": { "perUnitServicePrice": { "currencyCode": "USD", "amount": "14.99" } } } } } } ] }, { "orderId": "DEF456UVW", "channel": "SHOPIFY", "receiveTime": "2025-04-20T15:30:00Z", "status": "COMPLETE", "statusUpdateTime": "2025-04-20T18:45:00Z", "fulfillmentConfiguration": { "serviceLevel": { "serviceTiers": [ "EXPEDITED" ] }, "action": "SHIP", "services": { "packaging": { "packingSlip": { "templateName": "templateName", "templateAttributes": { "orderId": "MyOrder-123", "orderTime": "2026-07-01T10:00:00Z", "orderText": "Thank you for your purchase!" } } } } }, "origin": { "countryCode": "US" }, "destination": { "deliveryAddress": { "name": "Another Shopper", "addressLine1": "500 Pine Street", "city": "San Francisco", "countryCode": "US", "postalCode": "94103", "stateOrRegion": "CA", "phone": "987-654-3210" } }, "lineItems": [ { "lineItemId": "anotherLineItemId", "product": { "productIdentifier": { "amazonSku": "BOOK-123-HC" }, "perUnitDeclaredValue": { "currencyCode": "USD", "amount": "14.99" } }, "amount": { "unit": "EACHES", "value": "2.0" }, "cancelledAmount": { "unit": "EACHES", "value": "0.0" }, "unfulfillableAmount": { "unit": "EACHES", "value": "0.0" }, "fulfillmentConfiguration": { "services": { "packaging": { "packingSlip": { "templateName": "templateName", "templateAttributes": { "giftMessage": "Happy Birthday!", "lineItemText": "Item 1 of 2" } } }, "delivery": { "paymentOnDelivery": { "perUnitServicePrice": { "currencyCode": "USD", "amount": "14.99" } } } } } } ] } ], "pagination": { "nextToken": "token123" } } } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "401": { "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "404": { "description": "The resource specified does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "413": { "description": "The request size exceeded the maximum accepted size.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "415": { "description": "The request payload is in an unsupported format.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } }, "post": { "tags": [ "fulfillmentOutbound", "fulfillmentOrders" ], "description": "Request that Amazon ship items from the seller's inventory in Amazon's fulfillment network to a destination address.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 2 | 30 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "createOrder", "parameters": [ { "name": "x-amzn-fulfillment-service-id", "in": "header", "description": "The identifier of the fulfillment service used for this operation.", "required": false, "type": "string", "maxLength": 40, "x-example": "FS01-o8vlfw8b1tiu1" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/CreateOrderRequest" }, "description": "The request body schema for the `createOrder` operation.", "x-examples": { "application/json": { "orderId": "orderId", "channel": "SHOPIFY", "fulfillmentConfiguration": { "serviceLevel": { "serviceTiers": [ "STANDARD" ] }, "action": "HOLD", "policy": "FILL_ALL_AVAILABLE", "services": { "packaging": { "packagingOption": "UNBRANDED" }, "additional": {} } }, "origin": { "countryCode": "US" }, "destination": { "deliveryAddress": { "name": "Shopper Name", "addressLine1": "1000 Winthrop Ave N", "city": "Seattle", "countryCode": "US", "postalCode": "98103", "stateOrRegion": "WA", "phone": "123-456-7890", "email": "shopper@email.com" } }, "lineItems": [ { "lineItemId": "someLineItemId", "product": { "productIdentifier": { "amazonSku": "BOOK-123-HC" }, "perUnitDeclaredValue": { "currencyCode": "USD", "amount": "14.99" } }, "amount": { "unit": "EACHES", "value": "1.0" }, "fulfillmentConfiguration": { "services": { "packaging": { "packingSlip": { "templateName": "templateName", "templateAttributes": { "orderId": "MyOrder-123", "orderTime": "2026-07-01T10:00:00Z", "orderText": "Thank you for your purchase!" } } }, "delivery": { "paymentOnDelivery": { "perUnitServicePrice": { "currencyCode": "USD", "amount": "14.99" } } } } } } ], "paymentInformation": { "payments": [ { "paymentId": "PAY-12345", "paymentMethod": "CREDIT_CARD", "paymentTime": "2019-10-13T13:53:49Z" } ] } } } } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/CreateOrderResponse" }, "examples": { "application/json": { "order": { "orderId": "ABC123XYZ", "channel": "SHOPIFY", "receiveTime": "2025-04-21T10:30:00Z", "status": "PROCESSING", "statusUpdateTime": "2025-04-21T11:45:00Z", "fulfillmentConfiguration": { "serviceLevel": { "serviceTiers": [ "STANDARD" ] }, "action": "HOLD", "policy": "FILL_ALL_AVAILABLE", "services": { "packaging": { "packagingOption": "UNBRANDED", "packingSlip": { "templateName": "templateName", "templateAttributes": { "orderId": "MyOrder-123", "orderTime": "2026-07-01T10:00:00Z", "orderText": "Thank you for your purchase!" } } }, "additional": {} } }, "origin": { "countryCode": "US" }, "destination": { "deliveryAddress": { "name": "Shopper Name", "addressLine1": "1000 Winthrop Ave N", "city": "Seattle", "countryCode": "US", "postalCode": "98103", "stateOrRegion": "WA", "phone": "123-456-7890", "email": "shopper@email.com" } }, "lineItems": [ { "lineItemId": "someLineItemId", "product": { "productIdentifier": { "amazonSku": "BOOK-123-HC" }, "perUnitDeclaredValue": { "currencyCode": "USD", "amount": "14.99" } }, "amount": { "unit": "EACHES", "value": "1.0" }, "cancelledAmount": { "unit": "EACHES", "value": "0.0" }, "unfulfillableAmount": { "unit": "EACHES", "value": "0.0" }, "fulfillmentConfiguration": { "services": { "packaging": { "packingSlip": { "templateName": "templateName", "templateAttributes": { "orderId": "MyOrder-123", "orderTime": "2026-07-01T10:00:00Z", "orderText": "Thank you for your purchase!" } } }, "delivery": { "paymentOnDelivery": { "perUnitServicePrice": { "currencyCode": "USD", "amount": "14.99" } } } } } } ], "paymentInformation": { "payments": [ { "paymentId": "PAY-12345", "paymentMethod": "CREDIT_CARD", "paymentTime": "2019-10-13T13:53:49Z" } ] } } } }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." }, "x-amzn-fulfillment-service-id": { "type": "string", "description": "The identifier of the fulfillment service associated with this request." } } }, "202": { "description": "Accepted.", "schema": { "$ref": "#/definitions/CreateOrderAcceptedResponse" }, "examples": { "application/json": { "orderId": "ABC123XYZ", "status": "PROCESSING" } }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." }, "x-amzn-fulfillment-service-id": { "type": "string", "description": "The identifier of the fulfillment service associated with this request." } } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "401": { "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "404": { "description": "The resource specified does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "413": { "description": "The request size exceeded the maximum accepted size.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "415": { "description": "The request payload is in an unsupported format.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } } }, "/fulfillment/outbound/2026-07-04/services": { "x-amzn-api-sandbox": { "dynamic": {} } }, "/fulfillment/outbound/2026-07-04/services/{id}": { "x-amzn-api-sandbox": { "dynamic": {} } } }, "definitions": { "Error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred." }, "message": { "type": "string", "description": "A message that describes the error condition." }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue." } }, "description": "Error response returned when the request is unsuccessful." }, "ErrorList": { "type": "object", "description": "A list of error responses returned when a request is unsuccessful.", "required": [ "errors" ], "properties": { "errors": { "type": "array", "description": "array of errors", "items": { "$ref": "#/definitions/Error" } } }, "example": { "errors": [ { "code": "InvalidParameterValue", "message": "The value 'abc' is invalid for EmailAddress.", "details": "The value 'abc' is invalid for EmailAddress." } ] } }, "CancelOrderResponse": { "type": "object", "description": "The response to the `cancelOrder` operation.", "example": {} }, "UpdateOrderResponse": { "type": "object", "description": "The response to the `updateOrder` operation.", "example": {} }, "Decimal": { "type": "string", "description": "A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows [RFC 7159](https://datatracker.ietf.org/doc/html/rfc7159) for number representation.", "example": "1.0" }, "Timestamp": { "description": "Date timestamp in [ISO 8601](https://developer-docs.amazon/sp-api/docs/iso-8601) date time format.", "type": "string", "format": "date-time", "example": "2025-04-21T12:34:56Z" }, "RollupPrice": { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "description": "The type of price." }, "value": { "$ref": "#/definitions/Money", "description": "The total value of a price type." } }, "description": "A component of the total price.", "example": { "type": "MCFTransportationFee", "value": { "currencyCode": "USD", "amount": "4.25" } } }, "EstimatedPrice": { "type": "object", "required": [ "rollupPrices", "totalPrice" ], "properties": { "rollupPrices": { "type": "array", "items": { "$ref": "#/definitions/RollupPrice" }, "description": "A breakdown of the price associated with the delivery preview." }, "totalPrice": { "$ref": "#/definitions/Money", "description": "The total price associated with the delivery preview." } }, "description": "The estimated price information for the fulfillment order.", "example": { "rollupPrices": [ { "type": "MCFTransportationFee", "value": { "currencyCode": "USD", "amount": "4.25" } } ], "totalPrice": { "currencyCode": "USD", "amount": "4.25" } } }, "OfferDestination": { "type": "object", "properties": { "deliveryAddress": { "$ref": "#/definitions/VariablePrecisionAddress" }, "ipAddress": { "$ref": "#/definitions/IpAddress", "description": "The IP address of the customer." } }, "description": "The destination of the fulfillment.", "example": { "ipAddress": "192.168.0.1", "deliveryAddress": { "addressLine1": "1000 Winthrop Ave N", "addressLine2": "Floor 19", "addressLine3": "ATTN: Shopper", "city": "Seattle", "districtOrCounty": "None", "countryCode": "US", "postalCode": "98103", "stateOrRegion": "WA" } } }, "PreviewDestination": { "type": "object", "required": [ "deliveryAddress" ], "properties": { "deliveryAddress": { "$ref": "#/definitions/Address" } }, "description": "The destination of the fulfillment.", "example": { "deliveryAddress": { "name": "Shopper Name", "addressLine1": "1000 Winthrop Ave N", "addressLine2": "Floor 19", "addressLine3": "ATTN: Shopper", "city": "Seattle", "districtOrCounty": "None", "countryCode": "US", "phone": "123-456-7890", "postalCode": "98103", "stateOrRegion": "WA", "email": "shopper@email.com" } } }, "GetOrderPreviewRequest": { "type": "object", "required": [ "lineItems", "destination" ], "properties": { "channel": { "type": "string", "description": "The sales channel for the fulfillment request.", "maxLength": 40, "example": "SHOPIFY" }, "fulfillmentConfiguration": { "$ref": "#/definitions/PreviewFulfillmentConfiguration", "description": "Fulfillment configuration for the preview." }, "origin": { "$ref": "#/definitions/OrderOrigin", "description": "The origin of the fulfillment order." }, "destination": { "$ref": "#/definitions/PreviewDestination", "description": "The destination of the fulfillment." }, "lineItems": { "type": "array", "description": "A list of items to include in the fulfillment preview, including quantity.", "items": { "$ref": "#/definitions/PreviewLineItem" } }, "excludeEstimatedFees": { "type": "boolean", "description": "When `true`, excludes estimated fees from the preview response for latency optimization. Default: `false`." }, "includePaymentOnDelivery": { "type": "boolean", "description": "When `true`, includes payment on delivery information in the preview response. Default: `false`." } }, "description": "The request body schema for `getOrderPreview`.", "example": { "channel": "SHOPIFY", "fulfillmentConfiguration": { "serviceLevel": { "serviceTiers": [ "STANDARD" ] }, "services": { "packaging": { "packagingOption": "UNBRANDED" }, "additional": {} } }, "origin": { "countryCode": "US" }, "destination": { "deliveryAddress": { "name": "Shopper Name", "addressLine1": "1000 Winthrop Ave N", "city": "Seattle", "countryCode": "US", "postalCode": "98103", "stateOrRegion": "WA", "phone": "123-456-7890", "email": "shopper@email.com" } }, "lineItems": [ { "product": { "productIdentifier": { "amazonSku": "someSku" }, "perUnitDeclaredValue": { "currencyCode": "USD", "amount": "3.00" } }, "amount": { "unit": "EACHES", "value": "1.0" } } ], "excludeEstimatedFees": true } }, "CountryCode": { "type": "string", "description": "The two digit country code. In ISO 3166-1 alpha-2 format.", "example": "US", "minLength": 2, "maxLength": 2 }, "ServiceLevel": { "type": "object", "properties": { "serviceTiers": { "type": "array", "description": "The service tiers that are acceptable for this order, listed in order of preference. The first value is the preferred tier and is used for fulfillment if possible. Available values: `STANDARD`, `EXPEDITED`, `PRIORITY` (only available in Canada, India, and Mexico), `SCHEDULED` (only available in Japan). Currently, only the first value in the array is used.", "items": { "type": "string" } }, "deliveryInterval": { "$ref": "#/definitions/TimeInterval", "description": "The time range within which delivery should occur. For `SCHEDULED` service tier orders, this parameter is used to select the scheduled delivery interval (only available in Japan)." } }, "description": "Service level configuration for fulfillment. Available service tiers: `STANDARD`, `EXPEDITED`, `PRIORITY` (only available in Canada, India, and Mexico), `SCHEDULED` (only available in Japan).", "example": { "serviceTiers": [ "STANDARD" ], "deliveryInterval": { "startTime": "2025-04-21T12:34:56Z", "endTime": "2025-04-22T12:34:56Z" } } }, "VariablePrecisionAddress": { "type": "object", "required": [ "countryCode", "postalCode" ], "properties": { "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 must 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": { "$ref": "#/definitions/CountryCode", "description": "The two-digit country code (in ISO 3166-1 alpha-2 format) for the country where the person, business or institution is located." } }, "description": "A physical address with varying degrees of precision. A more precise address can provide more accurate results than country code and postal code alone.", "example": { "addressLine1": "1000 Winthrop Ave N", "addressLine2": "Floor 19", "addressLine3": "ATTN: Shopper", "city": "Seattle", "districtOrCounty": "None", "countryCode": "US", "postalCode": "98103", "stateOrRegion": "WA" } }, "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 must 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": { "$ref": "#/definitions/CountryCode", "description": "The two-digit country code (in ISO 3166-1 alpha-2 format) for the country where the person, business or institution is located." }, "phone": { "type": "string", "description": "The phone number of the person, business, or institution located at the address." }, "email": { "type": "string", "description": "The email of the person, business, or institution located at the address." } }, "description": "A physical address.", "example": { "name": "Shopper Name", "addressLine1": "1000 Winthrop Ave N", "addressLine2": "Floor 19", "addressLine3": "ATTN: Shopper", "city": "Seattle", "districtOrCounty": "None", "countryCode": "US", "phone": "123-456-7890", "postalCode": "98103", "stateOrRegion": "WA", "email": "shopper@email.com" } }, "IpAddress": { "type": "string", "format": "ip", "description": "An IP address.", "example": "192.168.0.1" }, "PreviewLineItem": { "type": "object", "required": [ "product", "amount" ], "properties": { "product": { "$ref": "#/definitions/PreviewProduct" }, "amount": { "$ref": "#/definitions/Amount" } }, "description": "Item information for a fulfillment preview.", "example": { "product": { "productIdentifier": { "amazonSku": "BOOK-123-HC" }, "perUnitDeclaredValue": { "currencyCode": "USD", "amount": "14.99" } }, "amount": { "unit": "EACHES", "value": "2.0" } } }, "PreviewPlannedShipmentItem": { "type": "object", "required": [ "productIdentifier", "amount" ], "properties": { "productIdentifier": { "$ref": "#/definitions/ProductIdentifier" }, "amount": { "$ref": "#/definitions/Amount" } }, "description": "Item information for a fulfillment preview.", "example": { "productIdentifier": { "amazonSku": "BOOK-123-HC" }, "amount": { "unit": "EACHES", "value": "2.0" } } }, "PreviewProduct": { "type": "object", "properties": { "productIdentifier": { "$ref": "#/definitions/ProductIdentifier" }, "perUnitDeclaredValue": { "$ref": "#/definitions/Money", "description": "The monetary value assigned by the seller to each unit." } }, "required": [ "productIdentifier" ], "description": "Product information for the line item." }, "OrderProduct": { "type": "object", "properties": { "productIdentifier": { "$ref": "#/definitions/ProductIdentifier" }, "perUnitDeclaredValue": { "$ref": "#/definitions/Money", "description": "The monetary value assigned by the seller to each unit." } }, "required": [ "productIdentifier" ], "description": "Product information for the line item." }, "ProductIdentifier": { "type": "object", "required": [ "amazonSku" ], "properties": { "amazonSku": { "type": "string", "description": "The Amazon SKU of the item." } }, "description": "The identifier of a product.", "example": { "amazonSku": "someSku" } }, "Amount": { "type": "object", "required": [ "value" ], "properties": { "unit": { "type": "string", "description": "The unit of measure for the amount. Possible values: `EACHES`." }, "value": { "$ref": "#/definitions/Decimal", "description": "The amount of a product in the associated unit of measurement." } }, "description": "A quantity based on the specified unit of measurement.", "example": { "unit": "EACHES", "value": "1.0" } }, "Money": { "type": "object", "required": [ "currencyCode", "amount" ], "properties": { "currencyCode": { "type": "string", "description": "Three-digit currency code in ISO 4217 format." }, "amount": { "$ref": "#/definitions/Decimal" } }, "description": "An amount of money, including units in the form of currency.", "example": { "currencyCode": "USD", "amount": "2.50" } }, "PreviewServices": { "type": "object", "properties": { "packaging": { "$ref": "#/definitions/PreviewPackagingService", "description": "The packaging settings for the fulfillment preview." }, "additional": { "$ref": "#/definitions/AdditionalServices", "description": "Additional services for the fulfillment preview." } }, "description": "Services for a fulfillment preview request. Does not include delivery settings.", "example": { "packaging": { "packagingOption": "UNBRANDED" }, "additional": {} } }, "PreviewOfferServices": { "type": "object", "properties": { "packaging": { "$ref": "#/definitions/PreviewPackagingService", "description": "The packaging settings for this offer." }, "delivery": { "$ref": "#/definitions/PreviewDeliveryService", "description": "Delivery service settings for this offer." }, "additional": { "$ref": "#/definitions/AdditionalServices", "description": "Additional services for this offer." } }, "description": "Services for a preview offer response. Includes delivery settings (for example, `paymentOnDelivery`).", "example": { "packaging": { "packagingOption": "UNBRANDED" }, "delivery": { "paymentOnDelivery": "ENABLED" }, "additional": {} } }, "PackagingService": { "type": "object", "description": "Specify packaging requirements.", "properties": { "packagingOption": { "type": "string", "description": "The packaging option to use for fulfillment. Possible values: `UNBRANDED`, `ANY`." }, "overbox": { "type": "string", "description": "Whether to require an overbox for the shipment. Possible values: `REQUIRED`, `NOT_REQUIRED`." }, "packingSlip": { "$ref": "#/definitions/OrderPackingSlip", "description": "Packing slip settings. Applying any settings requires that the order has a printed slip." } }, "example": { "packagingOption": "UNBRANDED", "overbox": "NOT_REQUIRED", "packingSlip": { "templateName": "templateName", "templateAttributes": { "orderId": "MyOrder-123", "orderTime": "2026-07-01T10:00:00Z", "orderText": "Thank you for your purchase!" } } } }, "PreviewPackagingService": { "type": "object", "description": "Packaging requirements for a fulfillment preview.", "properties": { "packagingOption": { "type": "string", "description": "The packaging option to use for fulfillment. Possible values: `UNBRANDED`, `ANY`." }, "overbox": { "type": "string", "description": "Whether to require an overbox for the shipment. Possible values: `REQUIRED`, `NOT_REQUIRED`." } }, "example": { "packagingOption": "UNBRANDED", "overbox": "NOT_REQUIRED" } }, "PreviewDeliveryService": { "type": "object", "description": "Delivery settings for a fulfillment preview.", "properties": { "paymentOnDelivery": { "type": "string", "description": "Indicates whether to include payment on delivery pricing in the preview. Only present when `includePaymentOnDelivery` is `true` on the request. Possible values: `ENABLED`, `DISABLED`." } }, "example": { "paymentOnDelivery": "ENABLED" } }, "DeliveryService": { "type": "object", "description": "Specify delivery settings.", "properties": {} }, "PaymentInformation": { "type": "object", "description": "Payment information for the order. Currently only available in India.", "properties": { "payments": { "type": "array", "description": "A list of payments associated with the order.", "items": { "$ref": "#/definitions/Payment" } } }, "example": { "payments": [ { "paymentId": "PAY-12345", "paymentMethod": "CREDIT_CARD", "paymentTime": "2019-10-13T13:53:49Z" } ] } }, "Payment": { "type": "object", "description": "Payment details.", "properties": { "paymentId": { "type": "string", "description": "The payment identifier." }, "paymentMethod": { "type": "string", "description": "The payment method." }, "paymentTime": { "type": "string", "format": "date-time", "description": "The time of the payment in ISO 8601 format." } }, "example": { "paymentId": "PAY-12345", "paymentMethod": "CREDIT_CARD", "paymentTime": "2019-10-13T13:53:49Z" } }, "AdditionalServices": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Request additional services", "example": {} }, "GetOrderPreviewResponse": { "type": "object", "required": [ "plannedShipments" ], "properties": { "plannedShipments": { "type": "array", "description": "An array of planned shipment information.", "items": { "$ref": "#/definitions/PreviewPlannedShipment" } }, "constraints": { "type": "array", "description": "An array of constraints that may affect the fulfillment order.", "items": { "$ref": "#/definitions/Constraint" } } }, "description": "The response schema for `getOrderPreview`.", "example": { "plannedShipments": [ { "estimatedShippingWeight": { "unit": "KG", "value": "2.0" }, "items": [ { "productIdentifier": { "amazonSku": "someSku" }, "amount": { "unit": "EACHES", "value": "1.0" } } ], "offers": [ { "fulfillmentConfiguration": { "serviceLevel": { "serviceTier": "STANDARD", "deliveryInterval": { "startTime": "2025-04-21T12:34:56Z", "endTime": "2025-04-22T12:34:56Z" } }, "services": { "packaging": { "packagingOption": "UNBRANDED" }, "delivery": { "paymentOnDelivery": "ENABLED" }, "additional": {} } }, "estimatedPrice": { "rollupPrices": [ { "type": "MCFTransportationFee", "value": { "currencyCode": "USD", "amount": "4.25" } } ], "totalPrice": { "currencyCode": "USD", "amount": "4.25" } } } ] } ], "constraints": [ { "message": "There is not enough quantity of item xyz.", "type": "ValidationError", "code": "ItemQuantityNotAvailable", "details": [ { "type": "someType", "value": "someValue" } ] } ] } }, "PreviewPlannedShipment": { "type": "object", "required": [ "items" ], "properties": { "estimatedShippingWeight": { "$ref": "#/definitions/Weight", "description": "The estimated shipping weight of the planned shipment." }, "items": { "type": "array", "description": "The items in this planned shipment. These can be a subset of lineItems from the request depending on how shipments are planned.", "items": { "$ref": "#/definitions/PreviewPlannedShipmentItem" } }, "offers": { "type": "array", "description": "An array of offers for this planned shipment.", "items": { "$ref": "#/definitions/PreviewDeliveryOffer" } } }, "description": "A group of items to be delivered together.", "example": { "estimatedShippingWeight": { "unit": "KG", "value": "2.0" }, "items": [ { "productIdentifier": { "amazonSku": "someSku" }, "amount": { "unit": "EACHES", "value": "1.0" } } ], "offers": [ { "fulfillmentConfiguration": { "serviceLevel": { "serviceTier": "STANDARD", "deliveryInterval": { "startTime": "2025-04-21T12:34:56Z", "endTime": "2025-04-22T12:34:56Z" }, "shipInterval": { "startTime": "2025-04-21T10:00:00Z", "endTime": "2025-04-21T14:00:00Z" } }, "services": { "packaging": { "packagingOption": "UNBRANDED" }, "delivery": { "paymentOnDelivery": "ENABLED" }, "additional": {} } }, "estimatedPrice": { "rollupPrices": [ { "type": "MCFTransportationFee", "value": { "currencyCode": "USD", "amount": "4.25" } } ], "totalPrice": { "currencyCode": "USD", "amount": "4.25" } } } ] } }, "Weight": { "type": "object", "required": [ "unit", "value" ], "properties": { "unit": { "type": "string", "description": "The unit of weight. Possible values: `KG`, `KILOGRAMS`, `LB`, `POUNDS`." }, "value": { "$ref": "#/definitions/Decimal", "description": "The weight value." } }, "description": "The weight.", "example": { "unit": "KG", "value": "2.0" } }, "PreviewDeliveryOffer": { "type": "object", "properties": { "estimatedPrice": { "description": "The estimated fees for the offer.", "$ref": "#/definitions/EstimatedPrice" }, "fulfillmentConfiguration": { "$ref": "#/definitions/PreviewOfferFulfillmentConfiguration", "description": "Fulfillment configuration for the offer." } }, "description": "An available offer for delivery of a group of items.", "example": { "fulfillmentConfiguration": { "serviceLevel": { "serviceTier": "STANDARD", "deliveryInterval": { "startTime": "2025-05-01T16:00:00Z", "endTime": "2025-05-02T01:00:00Z" }, "shipInterval": { "startTime": "2025-05-01T10:00:00Z", "endTime": "2025-05-01T14:00:00Z" } }, "services": { "packaging": { "packagingOption": "UNBRANDED" }, "delivery": { "paymentOnDelivery": "ENABLED" }, "additional": {} } }, "estimatedPrice": { "rollupPrices": [ { "type": "MCFTransportationFee", "value": { "currencyCode": "USD", "amount": "4.25" } } ], "totalPrice": { "currencyCode": "USD", "amount": "4.25" } } } }, "TimeInterval": { "type": "object", "required": [ "startTime", "endTime" ], "properties": { "startTime": { "$ref": "#/definitions/Timestamp", "description": "The earliest point in a date range in ISO 8601 date-time format." }, "endTime": { "$ref": "#/definitions/Timestamp", "description": "The latest point in a date range in ISO 8601 date-time format." } }, "description": "The time range within which an event (for example, a delivery) will occur.", "example": { "startTime": "2025-04-21T12:34:56Z", "endTime": "2025-04-22T12:34:56Z" } }, "Constraint": { "type": "object", "required": [ "message", "type", "code" ], "properties": { "message": { "type": "string", "description": "A human-readable description of the constraint.", "example": "The requested id is not available for purchase." }, "type": { "type": "string", "description": "The type of constraint.", "example": "ValidationError" }, "code": { "type": "string", "description": "The constraint code.", "example": "ItemQuantityNotAvailable" }, "details": { "type": "array", "description": "Array of constraint details", "items": { "$ref": "#/definitions/ConstraintDetail" } } }, "description": "A constraint that may affect a fulfillment order.", "example": { "message": "There is not enough of quantity xyz.", "type": "ValidationError", "code": "ItemQuantityNotAvailable", "details": [ { "type": "someType", "value": "someValue" } ] } }, "ConstraintDetail": { "type": "object", "description": "Additional information about a constraint violation, providing the specific type of detail and its corresponding value that caused the violation.", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "description": "The type of the constraint detail.", "example": "someDetail" }, "value": { "type": "string", "description": "The value of the constraint detail.", "example": "someValue" } }, "example": { "type": "someType", "value": "someValue" } }, "CreateOrderRequest": { "type": "object", "required": [ "orderId", "lineItems", "destination" ], "properties": { "orderId": { "type": "string", "description": "A fulfillment order identifier that the seller creates to track their fulfillment order. The `orderId` 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.", "example": "some-fulfillment-order-id" }, "channel": { "type": "string", "description": "The sales channel of the fulfillment order.", "maxLength": 40, "example": "SHOPIFY" }, "fulfillmentConfiguration": { "$ref": "#/definitions/OrderFulfillmentConfiguration", "description": "The fulfillment configuration of the order." }, "origin": { "$ref": "#/definitions/OrderOrigin", "description": "The origin of the fulfillment order." }, "destination": { "$ref": "#/definitions/OrderDestination", "description": "The destination of the fulfillment order." }, "lineItems": { "type": "array", "description": "A list of items to include in the fulfillment order, including quantity.", "items": { "$ref": "#/definitions/CreateOrderLineItem" } }, "paymentInformation": { "$ref": "#/definitions/PaymentInformation", "description": "Payment information for the order. Currently only available in India." } }, "description": "The request body schema for `createOrder`.", "example": { "orderId": "someorderId", "channel": "SHOPIFY", "fulfillmentConfiguration": { "serviceLevel": { "serviceTiers": [ "STANDARD" ], "deliveryInterval": { "startTime": "2025-04-21T12:34:56Z", "endTime": "2025-04-22T12:34:56Z" } }, "action": "HOLD", "policy": "FILL_ALL_AVAILABLE", "services": { "packaging": { "packagingOption": "UNBRANDED", "packingSlip": { "templateName": "templateName", "templateAttributes": { "orderId": "MyOrder-123", "orderTime": "2026-07-01T10:00:00Z", "orderText": "Thank you for your purchase!" } } }, "additional": {} } }, "origin": { "countryCode": "US" }, "destination": { "deliveryAddress": { "name": "Shopper Name", "addressLine1": "1000 Winthrop Ave N", "city": "Seattle", "countryCode": "US", "postalCode": "98103", "stateOrRegion": "WA", "phone": "123-456-7890", "email": "shopper@email.com" } }, "lineItems": [ { "lineItemId": "someLineItemId", "product": { "productIdentifier": { "amazonSku": "BOOK-123-HC" }, "perUnitDeclaredValue": { "currencyCode": "USD", "amount": "14.99" } }, "amount": { "unit": "EACHES", "value": "1.0" }, "fulfillmentConfiguration": { "services": { "packaging": { "packingSlip": { "templateName": "templateName", "templateAttributes": { "giftMessage": "Happy Birthday!", "lineItemText": "Item 1 of 2" } } }, "delivery": { "paymentOnDelivery": { "perUnitServicePrice": { "currencyCode": "USD", "amount": "14.99" } } } } } } ], "paymentInformation": { "payments": [ { "paymentId": "PAY-12345", "paymentMethod": "CREDIT_CARD", "paymentTime": "2019-10-13T13:53:49Z" } ] } } }, "CreateOrderResponse": { "type": "object", "required": [ "order" ], "properties": { "order": { "$ref": "#/definitions/FulfillmentOrder" } }, "description": "The response schema for the `createOrder` operation.", "example": { "order": { "orderId": "ABC123XYZ", "receiveTime": "2025-04-21T10:30:00Z", "status": "PROCESSING", "statusUpdateTime": "2025-04-21T11:45:00Z", "fulfillmentConfiguration": { "serviceLevel": { "serviceTiers": [ "STANDARD" ] }, "action": "HOLD", "policy": "FILL_ALL_AVAILABLE", "services": { "packaging": { "packagingOption": "UNBRANDED", "packingSlip": { "templateName": "templateName", "templateAttributes": { "orderId": "MyOrder-123", "orderTime": "2026-07-01T10:00:00Z", "orderText": "Thank you for your purchase!" } } }, "additional": {} } }, "origin": { "countryCode": "US" }, "destination": { "deliveryAddress": { "name": "Shopper Name", "addressLine1": "1000 Winthrop Ave N", "city": "Seattle", "countryCode": "US", "postalCode": "98103", "stateOrRegion": "WA", "phone": "123-456-7890", "email": "shopper@email.com" } }, "lineItems": [ { "lineItemId": "someLineItemId", "product": { "productIdentifier": { "amazonSku": "BOOK-123-HC" }, "perUnitDeclaredValue": { "currencyCode": "USD", "amount": "14.99" } }, "amount": { "unit": "EACHES", "value": "1.0" }, "cancelledAmount": { "unit": "EACHES", "value": "0.0" }, "unfulfillableAmount": { "unit": "EACHES", "value": "0.0" }, "fulfillmentConfiguration": { "services": { "packaging": { "packingSlip": { "templateName": "templateName", "templateAttributes": { "giftMessage": "Happy Birthday!", "lineItemText": "Item 1 of 2" } } }, "delivery": { "paymentOnDelivery": { "perUnitServicePrice": { "currencyCode": "USD", "amount": "14.99" } } } } } } ], "paymentInformation": { "payments": [ { "paymentId": "PAY-12345", "paymentMethod": "CREDIT_CARD", "paymentTime": "2019-10-13T13:53:49Z" } ] } } } }, "CreateOrderAcceptedResponse": { "type": "object", "required": [ "orderId", "status" ], "properties": { "orderId": { "type": "string", "description": "The fulfillment order identifier." }, "status": { "type": "string", "description": "The current status of the fulfillment order." } }, "description": "The response schema for the `createOrder` operation when the request is accepted for async processing.", "example": { "orderId": "ABC123XYZ", "status": "PROCESSING" } }, "OrderServices": { "type": "object", "properties": { "packaging": { "$ref": "#/definitions/PackagingService", "description": "The packaging settings for the fulfillment order." }, "delivery": { "$ref": "#/definitions/DeliveryService", "description": "Delivery settings for the fulfillment order." }, "additional": { "$ref": "#/definitions/AdditionalServices", "description": "Additional services for the fulfillment order." } }, "description": "Services selected for a fulfillment order.", "example": { "packaging": { "packagingOption": "UNBRANDED", "packingSlip": { "templateName": "templateName", "templateAttributes": { "orderId": "MyOrder-123", "orderTime": "2026-07-01T10:00:00Z", "orderText": "Thank you for your purchase!" } } }, "additional": {} } }, "CreateOrderLineItem": { "type": "object", "required": [ "lineItemId", "product", "amount" ], "properties": { "lineItemId": { "type": "string", "description": "The line item identifier for the fulfillment order.", "example": "someLineItemId" }, "product": { "$ref": "#/definitions/OrderProduct" }, "amount": { "$ref": "#/definitions/Amount" }, "fulfillmentConfiguration": { "$ref": "#/definitions/LineItemFulfillmentConfiguration", "description": "Fulfillment configuration for the line item." } }, "description": "Line item information for a create order request.", "example": { "lineItemId": "someLineItemId", "product": { "productIdentifier": { "amazonSku": "BOOK-123-HC" }, "perUnitDeclaredValue": { "currencyCode": "USD", "amount": "14.99" } }, "amount": { "unit": "EACHES", "value": "1.0" }, "fulfillmentConfiguration": { "services": { "packaging": { "packingSlip": { "templateName": "templateName", "templateAttributes": { "orderId": "MyOrder-123", "orderTime": "2026-07-01T10:00:00Z", "orderText": "Thank you for your purchase!" } } }, "delivery": { "paymentOnDelivery": { "perUnitServicePrice": { "currencyCode": "USD", "amount": "14.99" } } } } } } }, "OrderLineItem": { "type": "object", "required": [ "lineItemId", "product", "amount" ], "properties": { "lineItemId": { "type": "string", "description": "The line item identifier for the fulfillment order.", "example": "someLineItemId" }, "product": { "$ref": "#/definitions/OrderProduct" }, "amount": { "$ref": "#/definitions/Amount" }, "cancelledAmount": { "$ref": "#/definitions/Amount" }, "unfulfillableAmount": { "$ref": "#/definitions/Amount" }, "fulfillmentConfiguration": { "$ref": "#/definitions/LineItemFulfillmentConfiguration", "description": "The fulfillment configuration of the line item." } }, "description": "Line Item information for a fulfillment order.", "example": { "lineItemId": "someLineItemId", "product": { "productIdentifier": { "amazonSku": "BOOK-123-HC" }, "perUnitDeclaredValue": { "currencyCode": "USD", "amount": "14.99" } }, "amount": { "unit": "EACHES", "value": "1.0" }, "fulfillmentConfiguration": { "services": { "packaging": { "packingSlip": { "templateName": "templateName", "templateAttributes": { "orderId": "MyOrder-123", "orderTime": "2026-07-01T10:00:00Z", "orderText": "Thank you for your purchase!" } } }, "delivery": { "paymentOnDelivery": { "perUnitServicePrice": { "currencyCode": "USD", "amount": "14.99" } } } } } } }, "OrderOrigin": { "type": "object", "required": [ "countryCode" ], "properties": { "countryCode": { "$ref": "#/definitions/CountryCode", "description": "The two-digit country code (in ISO 3166-1 alpha-2 format) for the country where the items ship from." } }, "description": "The origin of the fulfillment.", "example": { "countryCode": "US" } }, "OrderDestination": { "type": "object", "required": [ "deliveryAddress" ], "properties": { "deliveryAddress": { "$ref": "#/definitions/Address" }, "deliveryNotes": { "type": "string", "description": "Delivery notes for the fulfillment order.", "example": "Please beware of dogs." }, "dropOffLocation": { "description": "Drop-off location for the fulfillment order.", "$ref": "#/definitions/OrderDropOffLocation" } }, "description": "The destination of the fulfillment order.", "example": { "deliveryAddress": { "name": "Shopper Name", "addressLine1": "1000 Winthrop Ave N", "addressLine2": "Floor 19", "addressLine3": "ATTN: Shopper", "city": "Seattle", "districtOrCounty": "None", "countryCode": "US", "phone": "123-456-7890", "postalCode": "98103", "stateOrRegion": "WA", "email": "shopper@email.com" }, "deliveryNotes": "Please beware of dogs.", "dropOffLocation": { "type": "FALLBACK_NEIGHBOR_DELIVERY", "attributes": { "neighborName": "neighborName", "houseNumber": "houseNumber" } } } }, "OrderPackingSlip": { "type": "object", "properties": { "templateName": { "type": "string", "description": "The template name for the packing slip.", "example": "templateName" }, "templateAttributes": { "$ref": "#/definitions/OrderPackingSlipTemplateAttributes" } }, "example": { "templateName": "templateName", "templateAttributes": { "orderId": "MyOrder-123", "orderTime": "2026-07-01T10:00:00Z", "orderText": "Thank you for your purchase!" } }, "description": "Packing slip settings." }, "OrderPackingSlipTemplateAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Packing slip template attributes.", "example": { "orderId": "MyOrder-123", "orderTime": "2026-07-01T10:00:00Z", "orderText": "Thank you for your purchase!" } }, "OrderLineItemPaymentOnDelivery": { "type": "object", "properties": { "perUnitServicePrice": { "$ref": "#/definitions/Money" } }, "example": { "perUnitServicePrice": { "currencyCode": "USD", "amount": "14.99" } }, "description": "Payment on delivery settings. Currently only available in India." }, "OrderDropOffLocation": { "type": "object", "description": "Drop-off location for the fulfillment order.", "properties": { "type": { "$ref": "#/definitions/OrderDropOffLocationType", "description": "Specifies the preferred location to leave the package at the destination address. Possible values: `FRONT_DOOR`, `DELIVERY_BOX`, `GAS_METER_BOX`, `BICYCLE_BASKET`, `GARAGE`, `RECEPTIONIST`, `FALLBACK_NEIGHBOR_DELIVERY`, `DO_NOT_LEAVE_UNATTENDED`, `LOCKER`" }, "attributes": { "$ref": "#/definitions/OrderDropOffLocationAttributes", "description": "Drop-off location attributes." } }, "example": { "type": "FALLBACK_NEIGHBOR_DELIVERY", "attributes": { "neighborName": "neighborName", "houseNumber": "houseNumber" } } }, "OrderDropOffLocationAttributes": { "type": "object", "additionalProperties": {}, "description": "Drop-off location attributes." }, "OrderDropOffLocationType": { "type": "string", "description": "Specifies the preferred location to leave the package at the destination address. Possible values: `FRONT_DOOR`, `DELIVERY_BOX`, `GAS_METER_BOX`, `BICYCLE_BASKET`, `GARAGE`, `RECEPTIONIST`, `FALLBACK_NEIGHBOR_DELIVERY`, `DO_NOT_LEAVE_UNATTENDED`, `LOCKER`.", "example": "FRONT_DOOR" }, "OrderLineItemServices": { "type": "object", "properties": { "packaging": { "$ref": "#/definitions/OrderLineItemPackagingService" }, "delivery": { "$ref": "#/definitions/OrderLineItemDeliveryService" } }, "description": "Services selected for a line item.", "example": { "packaging": { "packingSlip": { "templateName": "templateName", "templateAttributes": { "orderId": "MyOrder-123", "orderTime": "2026-07-01T10:00:00Z", "orderText": "Thank you for your purchase!" } } }, "delivery": { "paymentOnDelivery": { "perUnitServicePrice": { "currencyCode": "USD", "amount": "14.99" } } } } }, "OrderLineItemPackagingService": { "type": "object", "properties": { "packingSlip": { "$ref": "#/definitions/OrderPackingSlip", "description": "Line item packing slip settings. Applying any settings requires that the item has a printed slip." } }, "description": "Packaging settings for the line item." }, "OrderLineItemDeliveryService": { "type": "object", "properties": { "paymentOnDelivery": { "$ref": "#/definitions/OrderLineItemPaymentOnDelivery", "description": "Payment On Delivery costs. Currently only available in India." } }, "description": "Delivery settings for the line item.", "example": { "paymentOnDelivery": { "perUnitServicePrice": { "currencyCode": "USD", "amount": "14.99" } } } }, "OrderFulfillmentAction": { "type": "string", "description": "Specifies whether the fulfillment order should ship now or have an order hold put on it.", "x-docgen-enum-table-extension": [ { "value": "SHIP", "description": "Default value. The fulfillment order ships now." }, { "value": "HOLD", "description": "An order hold is put on the fulfillment order." } ], "example": "HOLD" }, "OrderFulfillmentPolicy": { "type": "string", "description": "The policy value specified when you submitted the `createOrder` request.", "x-docgen-enum-table-extension": [ { "value": "FILL_OR_KILL", "description": "Default value. If an item in a fulfillment order is determined to be unfulfillable before any shipment in the order has acquired the status of Processing (the process of picking units from inventory has begun), then the entire order is considered unfulfillable. However, if an item in a fulfillment order is determined to be unfulfillable after a shipment in the order has acquired the status of Processing, Amazon cancels as much of the fulfillment order as possible. See the Shipment object for shipment status definitions." }, { "value": "FILL_ALL", "description": "All fulfillable items in the fulfillment order are shipped. The fulfillment order remains in a processing state until all items are either shipped by Amazon or cancelled by the seller." }, { "value": "FILL_ALL_AVAILABLE", "description": "All fulfillable items in the fulfillment order are shipped. All unfulfillable items in the order are cancelled." } ] }, "GetOffersRequest": { "type": "object", "required": [ "items", "origin" ], "properties": { "fulfillmentConfiguration": { "$ref": "#/definitions/OfferFulfillmentConfiguration", "description": "The fulfillment configuration of the offers request." }, "origin": { "$ref": "#/definitions/OrderOrigin", "description": "The origin of the fulfillment order." }, "destination": { "$ref": "#/definitions/OfferDestination", "description": "The destination of the fulfillment." }, "items": { "type": "array", "description": "A list of items for which to get offers.", "items": { "$ref": "#/definitions/OfferItem" } } }, "description": "The request body schema for `getOffers`.", "example": { "fulfillmentConfiguration": { "serviceLevel": { "serviceTiers": [ "STANDARD", "EXPEDITED" ] } }, "origin": { "countryCode": "US" }, "destination": { "deliveryAddress": { "countryCode": "US", "postalCode": "98103" }, "ipAddress": "192.168.0.1" }, "items": [ { "productIdentifier": { "amazonSku": "FRN-DSK-MCM-WAL-001" } }, { "productIdentifier": { "amazonSku": "FRN-DSK-MCM-CHR-001" } } ] } }, "GetOffersResponse": { "type": "object", "properties": { "offerResults": { "type": "array", "description": "Per-item offer results. Each entry contains the item, its available offers, and any constraints that prevented offers.", "items": { "$ref": "#/definitions/OfferResult" } } }, "description": "The response schema for `getOffers`.", "example": { "offerResults": [ { "item": { "productIdentifier": { "amazonSku": "FRN-DSK-MCM-WAL-001" } }, "offers": [ { "fulfillmentConfiguration": { "serviceLevel": { "serviceTier": "STANDARD", "deliveryInterval": { "startTime": "2026-05-02T12:00:00Z", "endTime": "2026-05-03T23:59:00Z" } } }, "expiryTime": "2026-04-30T12:00:00Z" }, { "fulfillmentConfiguration": { "serviceLevel": { "serviceTier": "EXPEDITED", "deliveryInterval": { "startTime": "2026-04-30T18:00:00Z", "endTime": "2026-05-01T18:00:00Z" } } }, "expiryTime": "2026-04-30T12:00:00Z" } ] }, { "item": { "productIdentifier": { "amazonSku": "FRN-DSK-MCM-CHR-001" } }, "offers": [ { "fulfillmentConfiguration": { "serviceLevel": { "serviceTier": "STANDARD", "deliveryInterval": { "startTime": "2026-05-03T12:00:00Z", "endTime": "2026-05-05T23:59:00Z" } } }, "expiryTime": "2026-04-30T12:00:00Z" } ], "constraints": [ { "message": "EXPEDITED delivery unavailable for FRN-DSK-MCM-CHR-001", "type": "ValidationError", "code": "DeliverySLAUnavailable", "details": [ { "type": "serviceTier", "value": "EXPEDITED" }, { "type": "amazonSku", "value": "FRN-DSK-MCM-CHR-001" } ] } ] } ] } }, "OfferOption": { "type": "object", "properties": { "expiryTime": { "$ref": "#/definitions/Timestamp", "description": "The time at which this offer expires. This does not represent the efficacy or validity window of the order itself." }, "fulfillmentConfiguration": { "$ref": "#/definitions/OfferOptionFulfillmentConfiguration", "description": "Fulfillment configuration for the offer." } }, "description": "An available offer for delivery of a product.", "example": { "fulfillmentConfiguration": { "serviceLevel": { "serviceTier": "STANDARD", "deliveryInterval": { "startTime": "2026-05-02T12:00:00Z", "endTime": "2026-05-03T23:59:00Z" } } }, "expiryTime": "2026-04-30T12:00:00Z" } }, "UpdateOrderRequest": { "type": "object", "properties": { "fulfillmentConfiguration": { "$ref": "#/definitions/UpdateOrderFulfillmentConfiguration", "description": "Fulfillment configuration to update." } }, "description": "The request body schema for the `updateOrder` operation.", "example": { "fulfillmentConfiguration": { "action": "SHIP" } } }, "OrderStatus": { "type": "string", "description": "The current status of the fulfillment order. Possible values: `PROCESSING`, `COMPLETE`, `COMPLETE_PARTIAL`, `CANCELLED`, `UNFULFILLABLE`, `INVALID`.", "example": "PROCESSING" }, "GetOrderResponse": { "type": "object", "required": [ "order" ], "properties": { "order": { "$ref": "#/definitions/FulfillmentOrder" } }, "description": "The response schema for `getOrder`.", "example": { "order": { "orderId": "ABC123XYZ", "receiveTime": "2025-04-21T10:30:00Z", "status": "PROCESSING", "statusUpdateTime": "2025-04-21T11:45:00Z", "fulfillmentConfiguration": { "serviceLevel": { "serviceTiers": [ "STANDARD" ] }, "action": "HOLD", "policy": "FILL_ALL_AVAILABLE", "services": { "packaging": { "packagingOption": "UNBRANDED", "packingSlip": { "templateName": "templateName", "templateAttributes": { "orderId": "MyOrder-123", "orderTime": "2026-07-01T10:00:00Z", "orderText": "Thank you for your purchase!" } } }, "additional": {} } }, "origin": { "countryCode": "US" }, "destination": { "deliveryAddress": { "name": "Shopper Name", "addressLine1": "1000 Winthrop Ave N", "city": "Seattle", "countryCode": "US", "postalCode": "98103", "stateOrRegion": "WA", "phone": "123-456-7890", "email": "shopper@email.com" } }, "lineItems": [ { "lineItemId": "someLineItemId", "product": { "productIdentifier": { "amazonSku": "BOOK-123-HC" }, "perUnitDeclaredValue": { "currencyCode": "USD", "amount": "14.99" } }, "amount": { "unit": "EACHES", "value": "1.0" }, "cancelledAmount": { "unit": "EACHES", "value": "0.0" }, "unfulfillableAmount": { "unit": "EACHES", "value": "0.0" }, "fulfillmentConfiguration": { "services": { "packaging": { "packingSlip": { "templateName": "templateName", "templateAttributes": { "giftMessage": "Happy Birthday!", "lineItemText": "Item 1 of 2" } } }, "delivery": { "paymentOnDelivery": { "perUnitServicePrice": { "currencyCode": "USD", "amount": "14.99" } } } } } } ], "shipments": [ { "amazonShipmentId": "SHIP901234", "amazonFacility": { "facilityId": "FC456" }, "status": "SHIPPED", "shipTime": "2025-04-21T15:00:00Z", "deliveryTime": "2025-04-23T12:00:00Z", "items": [ { "shipmentItemId": "SI001", "productIdentifier": { "amazonSku": "SKU123" }, "lineItemId": "LI789012", "amount": { "value": "1.0", "unit": "EACHES" } } ], "packages": [ { "packageId": "PKG-abc123def456", "status": "DELIVERED", "shipmentItemIds": [ "SI001" ], "tracking": { "carrier": { "carrierCode": "FEDEX", "trackingNumber": "123456789" }, "amazon": { "trackingNumber": "123456789" } } } ] } ], "paymentInformation": { "payments": [ { "paymentId": "PAY-12345", "paymentMethod": "CREDIT_CARD", "paymentTime": "2019-10-13T13:53:49Z" } ] } } } }, "AmazonFacility": { "type": "object", "description": "The Amazon facility from which the shipment is sent.", "required": [ "facilityId" ], "properties": { "facilityId": { "type": "string", "description": "An identifier for the Amazon facility from which the shipment is sent.", "maxLength": 40, "example": "FC123" }, "address": { "$ref": "#/definitions/Address", "description": "The facility address from which the shipment originated." } }, "example": { "facilityId": "FC123", "address": { "name": "FC123", "addressLine1": "940 W Bethel Road", "city": "Coppell", "stateOrRegion": "TX", "postalCode": "75019-4424", "countryCode": "US" } } }, "Shipment": { "type": "object", "required": [ "amazonShipmentId", "amazonFacility", "items", "status" ], "properties": { "amazonShipmentId": { "type": "string", "description": "A shipment identifier assigned by Amazon." }, "amazonFacility": { "$ref": "#/definitions/AmazonFacility" }, "status": { "$ref": "#/definitions/ShipmentStatus" }, "shipTime": { "description": "The meaning of `shipTime` depends on the current status of the shipment:\n\n* Processing - `shipTime` is the estimated time that the shipment will leave the Amazon fulfillment center.\n* Shipped - `shipTime` is the date that the shipment left the Amazon fulfillment center.\n\nIf a shipment includes more than one package, `shipTime` applies to all of the packages in the shipment. If the shipment status is `CANCELLED`, `shipTime` is not returned. The value must be in ISO 8601 date time format.", "$ref": "#/definitions/Timestamp" }, "deliveryTime": { "description": "The estimated delivery date and time of the shipment, in ISO 8601 date time format. Note that this value can change over time. If a shipment includes more than one package, `deliveryTime` applies to all of the packages in the shipment. If the shipment has been cancelled, `deliveryTime` is not returned.", "$ref": "#/definitions/Timestamp" }, "shippingNotes": { "type": "array", "description": "Provides additional insight into shipment timeline. Primarily used to communicate that actual delivery dates aren't available.", "items": { "type": "string" } }, "items": { "type": "array", "items": { "$ref": "#/definitions/ShipmentItem" }, "description": "An array of fulfillment shipment item information." }, "packages": { "type": "array", "items": { "$ref": "#/definitions/Package" }, "description": "An array of fulfillment shipment package information." }, "serviceLevel": { "$ref": "#/definitions/ShipmentServiceLevel", "description": "The actualized service level for this shipment." } }, "description": "Delivery and item information for a shipment in a fulfillment order.", "example": { "amazonShipmentId": "123456", "amazonFacility": { "facilityId": "ABC123" }, "status": "PROCESSING", "shipTime": "2025-04-21T12:34:56Z", "deliveryTime": "2025-04-23T12:34:56Z", "serviceLevel": { "serviceTier": "STANDARD" }, "items": [ { "shipmentItemId": "SI001", "productIdentifier": { "amazonSku": "SKU123" }, "lineItemId": "item1", "amount": { "value": "1.0" } } ], "packages": [ { "packageId": "PKG-abc123def456", "status": "DELIVERED", "shipmentItemIds": [ "SI001" ], "tracking": { "carrier": { "carrierCode": "AMZL", "trackingNumber": "Tracking123" }, "amazon": { "trackingNumber": "Tracking123" } } } ] } }, "ShipmentStatus": { "type": "string", "description": "The current status of the shipment. Possible values: `PROCESSING`, `SHIPPED`, `CANCELLED`.", "x-docgen-enum-table-extension": [ { "value": "PROCESSING", "description": "The process of picking units from inventory has begun." }, { "value": "SHIPPED", "description": "All packages in the shipment have left the fulfillment center." }, { "value": "CANCELLED", "description": "The shipment was cancelled using the `cancelOrder` operation." } ], "example": "PROCESSING" }, "ShipmentServiceLevel": { "type": "object", "properties": { "serviceTier": { "type": "string", "description": "The service tier used for this shipment. Possible values: `STANDARD`, `EXPEDITED`, `PRIORITY` (only available in Canada, India, and Mexico), `SCHEDULED` (only available in Japan)." } }, "description": "The service level for a shipment in a fulfillment order.", "example": { "serviceTier": "STANDARD" } }, "Package": { "type": "object", "required": [ "packageId" ], "properties": { "packageId": { "type": "string", "description": "Identifies a package in a shipment.", "maxLength": 40 }, "deliveryTime": { "description": "The estimated delivery date and time of the package, in ISO 8601 date time format.", "$ref": "#/definitions/Timestamp" }, "status": { "$ref": "#/definitions/ShipmentPackageStatus" }, "tracking": { "$ref": "#/definitions/Tracking", "description": "Tracking information for the package." }, "shipmentItemIds": { "type": "array", "items": { "type": "string" }, "description": "The shipment item identifiers contained in this package." } }, "description": "Package information for a shipment in a fulfillment order.", "example": { "packageId": "PKG-abc123def456", "status": "DELIVERED", "shipmentItemIds": [ "SI001" ], "tracking": { "carrier": { "carrierCode": "AMZL", "trackingNumber": "Tracking123", "trackingUrl": "https://www.swiship.com/track?id=SampleTrackingNumber1" }, "amazon": { "trackingNumber": "Tracking123", "trackingUrl": "https://www.swiship.com/track?id=SampleTrackingNumber1" }, "dropOffLocation": { "type": "FRONT_DOOR", "attributes": {} }, "proofOfDelivery": { "deliveryPhotoUrl": "https://example.com/delivery-photo.jpg", "receivedBy": "John Smith" } }, "deliveryTime": "2025-04-21T12:34:56Z" } }, "UpdatePackageRequest": { "type": "object", "required": [ "status" ], "properties": { "status": { "$ref": "#/definitions/ShipmentPackageStatus" }, "deliveryTime": { "description": "The estimated delivery date and time of the package, in ISO 8601 date time format.", "$ref": "#/definitions/Timestamp" }, "tracking": { "$ref": "#/definitions/Tracking", "description": "Tracking information for the package." } }, "description": "Package information to update for a specific package in a fulfillment order.", "example": { "status": "DELIVERED", "deliveryTime": "2025-04-21T12:34:56Z", "tracking": { "carrier": { "trackingNumber": "1Z50V7420354708051", "carrierCode": "UPS", "trackingUrl": "https://www.swiship.com/track?id=SampleTrackingNumber1" }, "amazon": { "trackingNumber": "1Z50V7420354708051", "trackingUrl": "https://www.swiship.com/track?id=SampleTrackingNumber1" } } } }, "ShipmentPackageStatus": { "type": "string", "description": "The current status of a package. Possible values: `PROCESSING`, `IN_TRANSIT`, `DELAYED`, `OUT_FOR_DELIVERY`, `DELIVERED`, `UNDELIVERABLE`, `EXPIRED`.", "example": "DELIVERED" }, "ShipmentItem": { "type": "object", "required": [ "amount", "lineItemId", "productIdentifier" ], "properties": { "productIdentifier": { "$ref": "#/definitions/ProductIdentifier" }, "lineItemId": { "type": "string", "description": "The fulfillment order item identifier that the seller created and submitted with a call to the `createOrder` operation." }, "amount": { "$ref": "#/definitions/Amount" }, "packageId": { "type": "string", "description": "An identifier for the package that contains the item quantity.", "maxLength": 40 }, "unitIdentifiers": { "description": "The manufacturer lot codes of the shipped items.", "$ref": "#/definitions/UnitIdentifiers" }, "shipmentItemId": { "type": "string", "description": "A unique identifier for the shipment item." } }, "description": "Item information for a shipment in a fulfillment order.", "example": { "productIdentifier": { "amazonSku": "product123" }, "lineItemId": "lineItem1", "amount": { "unit": "EACHES", "value": "1.0" }, "packageId": "PKG-abc123def456", "unitIdentifiers": { "SKU": [ "ABC123", "XYZ789" ], "ASIN": [ "B01234567", "B07654321" ], "UPC": [ "012345678901", "987654321098" ] }, "shipmentItemId": "SI001" } }, "UnitIdentifiers": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string", "description": "The value of the unit identifiers." } }, "description": "A map of unit identifier types to lists of identifier values", "example": { "SKU": [ "ABC123", "XYZ789" ], "ASIN": [ "B01234567", "B07654321" ], "UPC": [ "012345678901", "987654321098" ] } }, "FulfillmentOrder": { "type": "object", "required": [ "orderId", "receiveTime", "lineItems" ], "properties": { "orderId": { "type": "string", "description": "The fulfillment order identifier submitted with the `createOrder` operation." }, "channel": { "type": "string", "description": "The sales channel for the fulfillment order.", "maxLength": 40, "example": "SHOPIFY" }, "receiveTime": { "$ref": "#/definitions/Timestamp", "description": "The date and time that the fulfillment order was received." }, "status": { "$ref": "#/definitions/OrderStatus", "description": "The current status of the fulfillment order." }, "statusUpdateTime": { "$ref": "#/definitions/Timestamp", "description": "The date and time that the status of the fulfillment order last changed. Must be in ISO 8601 format." }, "fulfillmentConfiguration": { "$ref": "#/definitions/OrderResponseFulfillmentConfiguration", "description": "Fulfillment configuration for the order." }, "origin": { "$ref": "#/definitions/OrderOrigin", "description": "The origin for the fulfillment order." }, "destination": { "$ref": "#/definitions/OrderDestination", "description": "The destination for the fulfillment order." }, "lineItems": { "type": "array", "description": "A list of items in the fulfillment order.", "items": { "$ref": "#/definitions/OrderLineItem" } }, "shipments": { "type": "array", "items": { "$ref": "#/definitions/Shipment" }, "description": "An array of fulfillment shipment information." }, "paymentInformation": { "$ref": "#/definitions/PaymentInformation", "description": "Payment information for the order. Currently only available in India." } }, "description": "General information about a fulfillment order, including its status.", "example": { "orderId": "ABC123XYZ", "channel": "SHOPIFY", "receiveTime": "2025-04-21T10:30:00Z", "status": "PROCESSING", "statusUpdateTime": "2025-04-21T11:45:00Z", "fulfillmentConfiguration": { "serviceLevel": { "serviceTiers": [ "STANDARD" ], "deliveryInterval": { "startTime": "2025-04-21T12:34:56Z", "endTime": "2025-04-22T12:34:56Z" } }, "action": "HOLD", "policy": "FILL_ALL_AVAILABLE", "services": { "packaging": { "packagingOption": "UNBRANDED", "packingSlip": { "templateName": "templateName", "templateAttributes": { "orderId": "MyOrder-123", "orderTime": "2026-07-01T10:00:00Z", "orderText": "Thank you for your purchase!" } } }, "additional": {} } }, "origin": { "countryCode": "US" }, "destination": { "deliveryAddress": { "name": "Shopper Name", "addressLine1": "1000 Winthrop Ave N", "city": "Seattle", "countryCode": "US", "postalCode": "98103", "stateOrRegion": "WA", "phone": "123-456-7890", "email": "shopper@email.com" } }, "lineItems": [ { "lineItemId": "someLineItemId", "product": { "productIdentifier": { "amazonSku": "BOOK-123-HC" }, "perUnitDeclaredValue": { "currencyCode": "USD", "amount": "14.99" } }, "amount": { "unit": "EACHES", "value": "1.0" }, "fulfillmentConfiguration": { "services": { "packaging": { "packingSlip": { "templateName": "templateName", "templateAttributes": { "giftMessage": "Happy Birthday!", "lineItemText": "Item 1 of 2" } } }, "delivery": { "paymentOnDelivery": { "perUnitServicePrice": { "currencyCode": "USD", "amount": "14.99" } } } } } } ], "shipments": [ { "amazonShipmentId": "SHIP901234", "amazonFacility": { "facilityId": "FC456" }, "status": "SHIPPED", "shipTime": "2025-04-21T15:00:00Z", "deliveryTime": "2025-04-23T12:00:00Z", "items": [ { "shipmentItemId": "SI001", "productIdentifier": { "amazonSku": "SKU123" }, "lineItemId": "LI789012", "amount": { "value": "1.0", "unit": "EACHES" } } ], "packages": [ { "packageId": "PKG-abc123def456", "status": "DELIVERED", "shipmentItemIds": [ "SI001" ], "tracking": { "carrier": { "carrierCode": "FEDEX", "trackingNumber": "123456789" }, "amazon": { "trackingNumber": "123456789" } } } ] } ], "paymentInformation": { "payments": [ { "paymentId": "PAY-12345", "paymentMethod": "CREDIT_CARD", "paymentTime": "2019-10-13T13:53:49Z" } ] } } }, "ListOrdersResponse": { "type": "object", "required": [ "orders" ], "properties": { "orders": { "type": "array", "description": "A list of fulfillment orders.", "items": { "$ref": "#/definitions/FulfillmentOrder" } }, "pagination": { "$ref": "#/definitions/Pagination" } }, "description": "The response schema for the `listOrders` operation." }, "Pagination": { "type": "object", "properties": { "nextToken": { "type": "string", "description": "A token that can be used to fetch the next page of results." } }, "description": "A token that you use to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the page size. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is `null`." }, "UpdateOrderStatusRequest": { "type": "object", "description": "The request body schema for the `updateOrderStatus` operation.", "properties": { "status": { "$ref": "#/definitions/OrderStatus", "description": "The status of the fulfillment order to apply." } }, "required": [ "status" ], "example": { "status": "PROCESSING" } }, "AmazonTracking": { "type": "object", "description": "Amazon tracking information for a package.", "properties": { "trackingNumber": { "type": "string", "description": "The amazon tracking number that can be used to obtain tracking and delivery information." }, "trackingUrl": { "type": "string", "description": "Represents the tracking URL where amazon tracking information is shown." } }, "example": { "trackingNumber": "1Z50V7420354708051", "trackingUrl": "https://www.swiship.com/track?id=SampleTrackingNumber1" } }, "CarrierTracking": { "type": "object", "description": "Carrier tracking information for a package.", "required": [ "carrierCode" ], "properties": { "trackingNumber": { "type": "string", "description": "The tracking number, if provided, can be used to obtain tracking and delivery information." }, "carrierCode": { "type": "string", "description": "Identifies the carrier who delivers the shipment to the recipient." }, "trackingUrl": { "type": "string", "description": "Represents the tracking URL where package tracking information is shown." } }, "example": { "trackingNumber": "1Z50V7420354708051", "carrierCode": "UPS", "trackingUrl": "https://www.swiship.com/track?id=SampleTrackingNumber1" } }, "PreviewServiceLevel": { "type": "object", "properties": { "serviceTiers": { "type": "array", "description": "The service tiers to retrieve offers for. Available values: `STANDARD`, `EXPEDITED`, `PRIORITY` (only available in Canada, India, and Mexico), `SCHEDULED` (only available in Japan). Multiple values can be provided to receive offers across different tiers.", "items": { "type": "string" } } }, "description": "Service level configuration for data-plane requests (`getOffers`, `getOrderPreview`). Specifies the tiers for which to get offers or previews.", "example": { "serviceTiers": [ "STANDARD", "EXPEDITED" ] } }, "PreviewOfferServiceLevel": { "type": "object", "properties": { "serviceTier": { "type": "string", "description": "The service tier for this offer. Possible values: `STANDARD`, `EXPEDITED`, `PRIORITY` (only available in Canada, India, and Mexico), `SCHEDULED` (only available in Japan)." }, "deliveryInterval": { "$ref": "#/definitions/TimeInterval", "description": "The delivery interval for this offer." }, "shipInterval": { "$ref": "#/definitions/TimeInterval", "description": "The time range within which the shipment is expected to be sent from the fulfillment center." } }, "description": "Service configuration for a preview offer.", "example": { "serviceTier": "STANDARD", "deliveryInterval": { "startTime": "2025-04-21T12:34:56Z", "endTime": "2025-04-22T12:34:56Z" }, "shipInterval": { "startTime": "2025-04-21T10:00:00Z", "endTime": "2025-04-21T14:00:00Z" } } }, "Tracking": { "type": "object", "properties": { "carrier": { "$ref": "#/definitions/CarrierTracking" }, "amazon": { "$ref": "#/definitions/AmazonTracking" }, "dropOffLocation": { "description": "The drop off location for a package.", "$ref": "#/definitions/OrderDropOffLocation" }, "proofOfDelivery": { "description": "Proof of delivery information for the package.", "$ref": "#/definitions/ProofOfDelivery" } }, "description": "Tracking information for a package.", "example": { "carrier": { "carrierCode": "UPS", "trackingNumber": "1Z50V7420354708051", "trackingUrl": "https://www.swiship.com/track?id=SampleTrackingNumber1" }, "amazon": { "trackingNumber": "1Z50V7420354708051", "trackingUrl": "https://www.swiship.com/track?id=SampleTrackingNumber1" }, "dropOffLocation": { "type": "FRONT_DOOR", "attributes": {} }, "proofOfDelivery": { "deliveryPhotoUrl": "https://example.com/delivery-photo.jpg", "receivedBy": "John Smith" } } }, "ProofOfDelivery": { "type": "object", "properties": { "deliveryPhotoUrl": { "type": "string", "description": "URL of the delivery photo." }, "receivedBy": { "type": "string", "description": "The name of the person who received the package." } }, "description": "Proof of delivery information for a package.", "example": { "deliveryPhotoUrl": "https://example.com/delivery-photo.jpg", "receivedBy": "John Smith" } }, "OfferItem": { "type": "object", "properties": { "productIdentifier": { "$ref": "#/definitions/ProductIdentifier" } }, "description": "Item information for a getOffers request.", "example": { "productIdentifier": { "amazonSku": "FRN-DSK-MCM-WAL-001" } } }, "OfferResult": { "type": "object", "properties": { "item": { "$ref": "#/definitions/OfferItem", "description": "The item this result is for." }, "offers": { "type": "array", "description": "Available delivery offers for this item.", "items": { "$ref": "#/definitions/OfferOption" } }, "constraints": { "type": "array", "description": "Constraints that prevented offers for this item.", "items": { "$ref": "#/definitions/Constraint" } } }, "description": "Per-item offer results including available offers and any constraints.", "example": { "item": { "productIdentifier": { "amazonSku": "FRN-DSK-MCM-WAL-001" } }, "offers": [ { "fulfillmentConfiguration": { "serviceLevel": { "serviceTier": "STANDARD", "deliveryInterval": { "startTime": "2026-05-02T12:00:00Z", "endTime": "2026-05-03T23:59:00Z" } } }, "expiryTime": "2026-04-30T12:00:00Z" } ] } }, "LineItemFulfillmentConfiguration": { "type": "object", "properties": { "services": { "$ref": "#/definitions/OrderLineItemServices", "description": "Services for the line item." } }, "description": "Fulfillment service configuration for a line item.", "example": { "services": { "packaging": { "packingSlip": { "templateName": "templateName", "templateAttributes": { "giftMessage": "Happy Birthday!", "lineItemText": "Item 1 of 2" } } }, "delivery": { "paymentOnDelivery": { "perUnitServicePrice": { "currencyCode": "USD", "amount": "14.99" } } } } } }, "PreviewOfferFulfillmentConfiguration": { "type": "object", "properties": { "serviceLevel": { "$ref": "#/definitions/PreviewOfferServiceLevel" }, "services": { "$ref": "#/definitions/PreviewOfferServices", "description": "Services for the offer." } }, "description": "Fulfillment configuration for a preview offer.", "example": { "serviceLevel": { "serviceTier": "STANDARD", "deliveryInterval": { "startTime": "2025-04-21T12:34:56Z", "endTime": "2025-04-22T12:34:56Z" }, "shipInterval": { "startTime": "2025-04-21T10:00:00Z", "endTime": "2025-04-21T14:00:00Z" } }, "services": { "packaging": { "packagingOption": "UNBRANDED" }, "delivery": { "paymentOnDelivery": "ENABLED" }, "additional": {} } } }, "OfferOptionFulfillmentConfiguration": { "type": "object", "properties": { "serviceLevel": { "$ref": "#/definitions/OfferServiceLevel" } }, "description": "Fulfillment configuration for a `getOffers` response offer. Contains only service level (no services).", "example": { "serviceLevel": { "serviceTier": "STANDARD", "deliveryInterval": { "startTime": "2026-05-02T12:00:00Z", "endTime": "2026-05-03T23:59:00Z" } } } }, "OfferServiceLevel": { "type": "object", "properties": { "serviceTier": { "type": "string", "description": "The service tier for this offer. Possible values: `STANDARD`, `EXPEDITED`, `PRIORITY` (only available in Canada, India, and Mexico), `SCHEDULED` (only available in Japan)." }, "deliveryInterval": { "$ref": "#/definitions/TimeInterval", "description": "The delivery interval for this offer." } }, "description": "Service level configuration for a `getOffers` response offer.", "example": { "serviceTier": "STANDARD", "deliveryInterval": { "startTime": "2026-05-02T12:00:00Z", "endTime": "2026-05-03T23:59:00Z" } } }, "OfferFulfillmentConfiguration": { "type": "object", "properties": { "serviceLevel": { "$ref": "#/definitions/PreviewServiceLevel" } }, "description": "Fulfillment configuration for offers request.", "example": { "serviceLevel": { "serviceTiers": [ "STANDARD" ] } } }, "PreviewFulfillmentConfiguration": { "type": "object", "properties": { "serviceLevel": { "$ref": "#/definitions/PreviewServiceLevel" }, "services": { "$ref": "#/definitions/PreviewServices", "description": "Services for the preview." } }, "description": "Fulfillment configuration for preview request.", "example": { "serviceLevel": { "serviceTiers": [ "STANDARD" ] }, "services": { "packaging": { "packagingOption": "UNBRANDED" }, "additional": {} } } }, "OrderFulfillmentConfiguration": { "type": "object", "properties": { "serviceLevel": { "$ref": "#/definitions/ServiceLevel", "description": "Set of service settings that determine the service contract for an order or item." }, "action": { "$ref": "#/definitions/OrderFulfillmentAction", "description": "Specifies whether the fulfillment order should ship now or have an order hold put on it." }, "policy": { "$ref": "#/definitions/OrderFulfillmentPolicy", "description": "The policy for the fulfillment order." }, "services": { "$ref": "#/definitions/OrderServices", "description": "Services for the order." } }, "description": "Fulfillment configuration for an order request.", "example": { "serviceLevel": { "serviceTiers": [ "STANDARD" ], "deliveryInterval": { "startTime": "2025-04-21T12:34:56Z", "endTime": "2025-04-22T12:34:56Z" } }, "action": "HOLD", "policy": "FILL_ALL_AVAILABLE", "services": { "packaging": { "packagingOption": "UNBRANDED", "packingSlip": { "templateName": "templateName", "templateAttributes": { "orderId": "MyOrder-123", "orderTime": "2026-07-01T10:00:00Z", "orderText": "Thank you for your purchase!" } } }, "additional": {} } } }, "OrderResponseFulfillmentConfiguration": { "type": "object", "properties": { "serviceLevel": { "$ref": "#/definitions/ServiceLevel", "description": "Set of service settings that indicate the service contract for an order or item." }, "action": { "$ref": "#/definitions/OrderFulfillmentAction", "description": "Specifies whether the fulfillment order should ship now or have an order hold put on it." }, "policy": { "$ref": "#/definitions/OrderFulfillmentPolicy", "description": "The policy for the fulfillment order." }, "services": { "$ref": "#/definitions/OrderServices", "description": "Services for the order." } }, "description": "Fulfillment configuration in order response.", "example": { "serviceLevel": { "serviceTiers": [ "STANDARD" ], "deliveryInterval": { "startTime": "2025-04-21T12:34:56Z", "endTime": "2025-04-22T12:34:56Z" } }, "action": "HOLD", "policy": "FILL_ALL_AVAILABLE", "services": { "packaging": { "packagingOption": "UNBRANDED", "packingSlip": { "templateName": "templateName", "templateAttributes": { "orderId": "MyOrder-123", "orderTime": "2026-07-01T10:00:00Z", "orderText": "Thank you for your purchase!" } } }, "additional": {} } } }, "UpdateOrderFulfillmentConfiguration": { "type": "object", "properties": { "action": { "$ref": "#/definitions/OrderFulfillmentAction", "description": "Specifies whether the fulfillment order should ship now or have an order hold put on it." } }, "description": "Fulfillment configuration for update order request. Only action can be updated.", "example": { "action": "SHIP" } } } }