{ "swagger": "2.0", "info": { "title": "The Selling Partner API for Amazon External Fulfillment Shipments Processing", "description": "You can use the External Fulfillment Shipments API to retrieve, manage, and track shipments processed through Amazon's external fulfillment network. Use this API to get shipment details, monitor status changes, and access fulfillment requirements.", "version": "2024-09-11", "contact": { "name": "Selling Partner API Developer Support", "url": "https://sellercentral.amazon.com/gp/mws/contactus.html", "email": "marketplaceapitest@amazon.com" }, "license": { "name": "Amazon Software License", "url": "https://aws.amazon.com/asl/" } }, "host": "sellingpartnerapi-na.amazon.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/externalFulfillment/2024-09-11/shipments": { "get": { "tags": [ "shipmentRetrieval" ], "description": "Get a list of shipments created for the seller in the status you specify. Shipments can be further filtered based on the fulfillment node or the time of the shipments' last update.", "operationId": "getShipments", "parameters": [ { "name": "locationId", "in": "query", "description": "The Amazon channel location identifier for the shipments you want to retrieve.", "required": false, "type": "string", "maxLength": 36, "x-example": "ABCD" }, { "name": "marketplaceId", "in": "query", "description": "The marketplace ID associated with the location. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).", "required": false, "type": "string", "x-example": "A21TJRUUN4KGV" }, { "name": "channelName", "in": "query", "description": "The channel name associated with the location.", "required": false, "type": "string", "x-example": "FBA", "maxLength": 10 }, { "name": "status", "in": "query", "description": "The status of shipment you want to include in the response. To retrieve all new shipments, set this value to `ACCEPTED`.", "required": true, "type": "string", "x-example": "CONFIRMED", "enum": [ "CREATED", "ACCEPTED", "CONFIRMED", "PACKAGE_CREATED", "PICKUP_SLOT_RETRIEVED", "INVOICE_GENERATED", "SHIPLABEL_GENERATED", "CANCELLED", "SHIPPED", "DELIVERED" ], "x-docgen-enum-table-extension": [ { "value": "CREATED", "description": "The order is newly created, but there is not enough inventory to accept it automatically." }, { "value": "ACCEPTED", "description": "The order is newly created and is accepted." }, { "value": "CONFIRMED", "description": "The order is confirmed by the seller." }, { "value": "PACKAGE_CREATED", "description": "The order's package is created by the seller." }, { "value": "PICKUP_SLOT_RETRIEVED", "description": "The order's pickup slots are retrieved by the seller." }, { "value": "INVOICE_GENERATED", "description": "The order's invoice is generated by the seller." }, { "value": "SHIPLABEL_GENERATED", "description": "The order's shipping label is generated by the seller." }, { "value": "CANCELLED", "description": "The order is cancelled." }, { "value": "SHIPPED", "description": "The order is shipped." }, { "value": "DELIVERED", "description": "The order is delivered." } ] }, { "name": "lastUpdatedAfter", "in": "query", "description": "The response includes shipments whose latest update is after the specified time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.", "required": false, "type": "string", "format": "date-time", "x-example": "2020-06-08T17:23:58Z" }, { "name": "lastUpdatedBefore", "in": "query", "description": "The response includes shipments whose latest update is before the specified time. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.", "required": false, "type": "string", "format": "date-time", "x-example": "2020-06-08T17:23:58Z" }, { "name": "maxResults", "in": "query", "description": "The maximum number of shipments to include in the response.", "required": false, "type": "integer", "minimum": 1, "maximum": 100, "x-example": 10 }, { "name": "paginationToken", "in": "query", "description": "A token that you use to retrieve the next page of results. The response includes `nextToken` when there are multiple pages of results. 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. Note that this operation can return empty pages.", "required": false, "type": "string", "x-example": "eyJsYXN0VXBkYXRlZFRpbWVzdGFtcCI6eyJzIjpLL" } ], "responses": { "200": { "description": "Success. The response contains a list of shipments.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "examples": { "application/json": { "pagination": { "nextToken": "eyJsYXN0VXBkYXRlZFRpbWVzdGFtcCI6eyJzIjpu" }, "shipments": [ { "locationId": "ABCD", "marketplaceAttributes": { "channelName": "FBA", "marketplaceId": "A21TJRUUN4KGV", "merchantId": "ABCDEFGH", "customAttributes": [ "PRIME" ] }, "charges": [ { "baseCharge": { "baseAmount": { "value": 160, "currencyCode": "INR" }, "discountAmount": { "value": 30, "currencyCode": "INR" }, "netAmount": { "value": 130, "currencyCode": "INR" } }, "taxBreakup": [ { "type": "IGST", "rate": 0.18, "charge": { "baseAmount": { "value": 33, "currencyCode": "INR" }, "discountAmount": { "value": 11, "currencyCode": "INR" }, "netAmount": { "value": 22, "currencyCode": "INR" } } } ], "totalCharge": { "baseAmount": { "value": 193, "currencyCode": "INR" }, "discountAmount": { "value": 41, "currencyCode": "INR" }, "netAmount": { "value": 152, "currencyCode": "INR" } }, "totalTax": { "type": "TOTAL", "rate": 0.18, "charge": { "baseAmount": { "value": 33, "currencyCode": "INR" }, "discountAmount": { "value": 11, "currencyCode": "INR" }, "netAmount": { "value": 22, "currencyCode": "INR" } } }, "chargeType": "total" }, { "baseCharge": { "baseAmount": { "value": 40, "currencyCode": "INR" }, "discountAmount": { "value": 10, "currencyCode": "INR" }, "netAmount": { "value": 30, "currencyCode": "INR" } }, "taxBreakup": [ { "type": "IGST", "rate": 0.25, "charge": { "baseAmount": { "value": 10, "currencyCode": "INR" }, "discountAmount": { "value": 5, "currencyCode": "INR" }, "netAmount": { "value": 5, "currencyCode": "INR" } } } ], "totalCharge": { "baseAmount": { "value": 50, "currencyCode": "INR" }, "discountAmount": { "value": 15, "currencyCode": "INR" }, "netAmount": { "value": 35, "currencyCode": "INR" } }, "totalTax": { "type": "TOTAL", "rate": 0.25, "charge": { "baseAmount": { "value": 10, "currencyCode": "INR" }, "discountAmount": { "value": 5, "currencyCode": "INR" }, "netAmount": { "value": 5, "currencyCode": "INR" } } }, "chargeType": "shipping" } ], "creationDateTime": "2020-06-08T17:23:58Z", "id": "Dg79mc6BT", "lastUpdatedDateTime": "2020-06-08T22:10:15Z", "earliestPackDateTime": "2020-06-09T14:00:00Z", "lineItems": [ { "shipmentLineItemId": "1", "merchantSku": "1002400773021", "numberOfUnits": 2, "complianceAttributes": { "serialNumberRequirement": "DISALLOWED", "hazmatLabelsRequirement": "DISALLOWED", "hazmatLabelRequirement": "DISALLOWED", "countryOfOriginRequirement": "DISALLOWED", "itemValueRequirement": "DISALLOWED" }, "giftAttributes": { "giftWrapRequirement": "DISALLOWED", "giftMessagePresence": "ABSENT" }, "charges": [ { "baseCharge": { "baseAmount": { "value": 100, "currencyCode": "INR" }, "discountAmount": { "value": 20, "currencyCode": "INR" }, "netAmount": { "value": 80, "currencyCode": "INR" } }, "taxBreakup": [ { "type": "IGST", "rate": 0.18, "charge": { "baseAmount": { "value": 18, "currencyCode": "INR" }, "discountAmount": { "value": 6, "currencyCode": "INR" }, "netAmount": { "value": 12, "currencyCode": "INR" } } } ], "totalCharge": { "baseAmount": { "value": 118, "currencyCode": "INR" }, "discountAmount": { "value": 26, "currencyCode": "INR" }, "netAmount": { "value": 92, "currencyCode": "INR" } }, "totalTax": { "type": "TOTAL", "rate": 0.18, "charge": { "baseAmount": { "value": 18, "currencyCode": "INR" }, "discountAmount": { "value": 6, "currencyCode": "INR" }, "netAmount": { "value": 12, "currencyCode": "INR" } } }, "chargeType": "product" }, { "baseCharge": { "baseAmount": { "value": 20, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 20, "currencyCode": "INR" } }, "taxBreakup": [ { "type": "IGST", "rate": 0.25, "charge": { "baseAmount": { "value": 5, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 5, "currencyCode": "INR" } } } ], "totalCharge": { "baseAmount": { "value": 25, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 25, "currencyCode": "INR" } }, "totalTax": { "type": "IGST", "rate": 0.25, "charge": { "baseAmount": { "value": 5, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 5, "currencyCode": "INR" } } }, "chargeType": "gift_wrap" } ], "hsnCode": "HSN0001" }, { "shipmentLineItemId": "2", "merchantSku": "1002400773022", "numberOfUnits": 2, "complianceAttributes": { "serialNumberRequirement": "DISALLOWED", "hazmatLabelsRequirement": "DISALLOWED", "hazmatLabelRequirement": "DISALLOWED", "countryOfOriginRequirement": "DISALLOWED", "itemValueRequirement": "DISALLOWED" }, "giftAttributes": { "giftWrapRequirement": "DISALLOWED", "giftMessagePresence": "ABSENT" }, "charges": [ { "baseCharge": { "baseAmount": { "value": 100, "currencyCode": "INR" }, "discountAmount": { "value": 20, "currencyCode": "INR" }, "netAmount": { "value": 80, "currencyCode": "INR" } }, "taxBreakup": [ { "type": "IGST", "rate": 0.18, "charge": { "baseAmount": { "value": 18, "currencyCode": "INR" }, "discountAmount": { "value": 6, "currencyCode": "INR" }, "netAmount": { "value": 12, "currencyCode": "INR" } } } ], "totalCharge": { "baseAmount": { "value": 118, "currencyCode": "INR" }, "discountAmount": { "value": 26, "currencyCode": "INR" }, "netAmount": { "value": 92, "currencyCode": "INR" } }, "totalTax": { "type": "TOTAL", "rate": 0.18, "charge": { "baseAmount": { "value": 18, "currencyCode": "INR" }, "discountAmount": { "value": 6, "currencyCode": "INR" }, "netAmount": { "value": 12, "currencyCode": "INR" } } }, "chargeType": "product" }, { "baseCharge": { "baseAmount": { "value": 20, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 20, "currencyCode": "INR" } }, "taxBreakup": [ { "type": "IGST", "rate": 0.25, "charge": { "baseAmount": { "value": 5, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 5, "currencyCode": "INR" } } } ], "totalCharge": { "baseAmount": { "value": 25, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 25, "currencyCode": "INR" } }, "totalTax": { "type": "IGST", "rate": 0.25, "charge": { "baseAmount": { "value": 5, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 5, "currencyCode": "INR" } } }, "chargeType": "gift_wrap" } ], "hsnCode": "HSN0002" } ], "shipmentInfo": { "numberOfUnits": 4, "priority": "LOW", "shipmentType": "NEW", "buyerOrderId": "407-7727827-8514700", "orderStatesEligibleForRejection": [ "ACCEPTED", "CONFIRMED", "PACKAGE_CREATED", "PICKUP_SLOT_RETRIEVED" ], "orderPlacedTimestamp": 1604923992000, "processingSource": "INTERNAL_PLATFORM" }, "shipmentRequirements": { "pSlip": { "requirement": "REQUIRED", "status": "GENERATED" }, "invoice": { "requirement": "REQUIRED", "status": "AVAILABLE" } }, "invoiceInfo": { "invoiceId": "IN-ABCD-124", "creationDateTime": "2020-06-08T17:23:58Z" }, "partyInfoList": [ { "partyId": "95930", "partyType": "SHIP_TO_PARTY", "address": { "name": "ABC", "addressLine1": "1st Main Rd", "addressLine2": "Milk Colony", "addressLine3": "Subramanyanagar,2 State, Rajajinagar", "city": "Bengaluru", "state": "Karnataka", "district": "Bengaluru", "municipality": "BBMP", "postalCode": "560055", "countryCode": "IN", "phoneNumber": "080 49019010", "addressType": "HOME", "copyEmails": [ "ccedEmail@gmail.com" ], "email": "email@gmail.com" }, "taxInfo": { "type": "VAT", "address": { "name": "ABC", "addressLine1": "1st Main Rd", "addressLine2": "Milk Colony", "addressLine3": "Subramanyanagar,2 State, Rajajinagar", "city": "Bengaluru", "state": "Karnataka", "district": "Bengaluru", "municipality": "BBMP", "postalCode": "560055", "countryCode": "IN", "phoneNumber": "080 49019010", "addressType": "HOME", "copyEmails": [ "ccedEmail@gmail.com" ], "email": "email@gmail.com" }, "number": "IE1234567T", "messages": "additional tax information" } } ], "packages": [ { "id": "001", "dimensions": { "length": { "value": 20, "dimensionUnit": "CM" }, "width": { "value": 20, "dimensionUnit": "CM" }, "height": { "value": 20, "dimensionUnit": "CM" } }, "weight": { "value": 300, "weightUnit": "G" }, "hazmatLabels": [], "packageLineItems": [ { "packageLineItemId": "1", "quantity": 1, "serialNumbers": [] }, { "packageLineItemId": "2", "quantity": 1, "serialNumbers": [] } ], "trackingDetails": { "trackingId": "TBA303940590400", "carrier": "AMZL", "shippingService": "ATS_STANDARD" } } ], "shippingInfo": { "recommendedShipMethod": "ATS_STANDARD", "expectedShippingDateTime": "2020-06-09T14:00:00Z", "expectedShippingDateTimeInUTC": "2020-06-09T14:00:00Z", "shipToAddress": { "name": "ABC", "addressLine1": "1st Main Rd", "addressLine2": "Milk Colony", "addressLine3": "Subramanyanagar,2 State, Rajajinagar", "city": "Bengaluru", "state": "Karnataka", "district": "Bengaluru", "municipality": "BBMP", "postalCode": "560055", "countryCode": "IN", "phoneNumber": "080 49019010" } }, "status": "CONFIRMED", "subStatus": "OUT_FOR_DELIVERY", "reason": "OutForDelivery" }, { "locationId": "ABCD", "marketplaceAttributes": { "channelName": "FBA", "marketplaceId": "A21TJRUUN4KGV", "merchantId": "ABCDEFGH", "customAttributes": [ "PRIME" ] }, "charges": [ { "baseCharge": { "baseAmount": { "value": 160, "currencyCode": "INR" }, "discountAmount": { "value": 30, "currencyCode": "INR" }, "netAmount": { "value": 130, "currencyCode": "INR" } }, "taxBreakup": [ { "type": "IGST", "rate": 0.18, "charge": { "baseAmount": { "value": 33, "currencyCode": "INR" }, "discountAmount": { "value": 11, "currencyCode": "INR" }, "netAmount": { "value": 22, "currencyCode": "INR" } } } ], "totalCharge": { "baseAmount": { "value": 193, "currencyCode": "INR" }, "discountAmount": { "value": 41, "currencyCode": "INR" }, "netAmount": { "value": 152, "currencyCode": "INR" } }, "totalTax": { "type": "TOTAL", "rate": 0.18, "charge": { "baseAmount": { "value": 33, "currencyCode": "INR" }, "discountAmount": { "value": 11, "currencyCode": "INR" }, "netAmount": { "value": 22, "currencyCode": "INR" } } }, "chargeType": "total" }, { "baseCharge": { "baseAmount": { "value": 40, "currencyCode": "INR" }, "discountAmount": { "value": 10, "currencyCode": "INR" }, "netAmount": { "value": 30, "currencyCode": "INR" } }, "taxBreakup": [ { "type": "IGST", "rate": 0.25, "charge": { "baseAmount": { "value": 10, "currencyCode": "INR" }, "discountAmount": { "value": 5, "currencyCode": "INR" }, "netAmount": { "value": 5, "currencyCode": "INR" } } } ], "totalCharge": { "baseAmount": { "value": 50, "currencyCode": "INR" }, "discountAmount": { "value": 15, "currencyCode": "INR" }, "netAmount": { "value": 35, "currencyCode": "INR" } }, "totalTax": { "type": "TOTAL", "rate": 0.25, "charge": { "baseAmount": { "value": 10, "currencyCode": "INR" }, "discountAmount": { "value": 5, "currencyCode": "INR" }, "netAmount": { "value": 5, "currencyCode": "INR" } } }, "chargeType": "shipping" } ], "creationDateTime": "2020-06-08T11:13:58Z", "id": "D1px1063T", "lastUpdatedDateTime": "2020-06-08T12:00:15Z", "earliestPackDateTime": "2020-06-09T14:00:00Z", "lineItems": [ { "shipmentLineItemId": "1", "merchantSku": "1002400773021", "numberOfUnits": 2, "complianceAttributes": { "serialNumberRequirement": "DISALLOWED", "hazmatLabelsRequirement": "DISALLOWED", "hazmatLabelRequirement": "DISALLOWED", "countryOfOriginRequirement": "DISALLOWED", "itemValueRequirement": "DISALLOWED" }, "giftAttributes": { "giftWrapRequirement": "DISALLOWED", "giftMessagePresence": "ABSENT" }, "charges": [ { "baseCharge": { "baseAmount": { "value": 100, "currencyCode": "INR" }, "discountAmount": { "value": 20, "currencyCode": "INR" }, "netAmount": { "value": 80, "currencyCode": "INR" } }, "taxBreakup": [ { "type": "IGST", "rate": 0.18, "charge": { "baseAmount": { "value": 18, "currencyCode": "INR" }, "discountAmount": { "value": 6, "currencyCode": "INR" }, "netAmount": { "value": 12, "currencyCode": "INR" } } } ], "totalCharge": { "baseAmount": { "value": 118, "currencyCode": "INR" }, "discountAmount": { "value": 26, "currencyCode": "INR" }, "netAmount": { "value": 92, "currencyCode": "INR" } }, "totalTax": { "type": "TOTAL", "rate": 0.18, "charge": { "baseAmount": { "value": 18, "currencyCode": "INR" }, "discountAmount": { "value": 6, "currencyCode": "INR" }, "netAmount": { "value": 12, "currencyCode": "INR" } } }, "chargeType": "product" }, { "baseCharge": { "baseAmount": { "value": 20, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 20, "currencyCode": "INR" } }, "taxBreakup": [ { "type": "IGST", "rate": 0.25, "charge": { "baseAmount": { "value": 5, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 5, "currencyCode": "INR" } } } ], "totalCharge": { "baseAmount": { "value": 25, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 25, "currencyCode": "INR" } }, "totalTax": { "type": "IGST", "rate": 0.25, "charge": { "baseAmount": { "value": 5, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 5, "currencyCode": "INR" } } }, "chargeType": "gift_wrap" } ], "hsnCode": "HSN0001" }, { "shipmentLineItemId": "2", "merchantSku": "1002400773022", "numberOfUnits": 2, "complianceAttributes": { "serialNumberRequirement": "DISALLOWED", "hazmatLabelsRequirement": "DISALLOWED", "hazmatLabelRequirement": "DISALLOWED", "countryOfOriginRequirement": "DISALLOWED", "itemValueRequirement": "DISALLOWED" }, "giftAttributes": { "giftWrapRequirement": "DISALLOWED", "giftMessagePresence": "ABSENT" }, "charges": [ { "baseCharge": { "baseAmount": { "value": 100, "currencyCode": "INR" }, "discountAmount": { "value": 20, "currencyCode": "INR" }, "netAmount": { "value": 80, "currencyCode": "INR" } }, "taxBreakup": [ { "type": "IGST", "rate": 0.18, "charge": { "baseAmount": { "value": 18, "currencyCode": "INR" }, "discountAmount": { "value": 6, "currencyCode": "INR" }, "netAmount": { "value": 12, "currencyCode": "INR" } } } ], "totalCharge": { "baseAmount": { "value": 118, "currencyCode": "INR" }, "discountAmount": { "value": 26, "currencyCode": "INR" }, "netAmount": { "value": 92, "currencyCode": "INR" } }, "totalTax": { "type": "TOTAL", "rate": 0.18, "charge": { "baseAmount": { "value": 18, "currencyCode": "INR" }, "discountAmount": { "value": 6, "currencyCode": "INR" }, "netAmount": { "value": 12, "currencyCode": "INR" } } }, "chargeType": "product" }, { "baseCharge": { "baseAmount": { "value": 20, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 20, "currencyCode": "INR" } }, "taxBreakup": [ { "type": "IGST", "rate": 0.25, "charge": { "baseAmount": { "value": 5, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 5, "currencyCode": "INR" } } } ], "totalCharge": { "baseAmount": { "value": 25, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 25, "currencyCode": "INR" } }, "totalTax": { "type": "IGST", "rate": 0.25, "charge": { "baseAmount": { "value": 5, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 5, "currencyCode": "INR" } } }, "chargeType": "gift_wrap" } ], "hsnCode": "HSN0002" } ], "shipmentInfo": { "numberOfUnits": 4, "priority": "LOW", "shipmentType": "NEW", "buyerOrderId": "407-7727827-8514700", "orderStatesEligibleForRejection": [ "ACCEPTED", "CONFIRMED", "PACKAGE_CREATED", "PICKUP_SLOT_RETRIEVED" ], "orderPlacedTimestamp": 1604923992000, "processingSource": "INTERNAL_PLATFORM" }, "invoiceInfo": { "invoiceId": "IN-ABCD-124", "creationDateTime": "2020-06-08T17:23:58Z" }, "shipmentRequirements": { "pSlip": { "requirement": "REQUIRED", "status": "GENERATED" }, "invoice": { "requirement": "REQUIRED", "status": "AVAILABLE" } }, "partyInfoList": [ { "partyId": "95930", "partyType": "SHIP_TO_PARTY", "address": { "name": "ABC", "addressLine1": "1st Main Rd", "addressLine2": "Milk Colony", "addressLine3": "Subramanyanagar,2 State, Rajajinagar", "city": "Bengaluru", "state": "Karnataka", "district": "Bengaluru", "municipality": "BBMP", "postalCode": "560055", "countryCode": "IN", "phoneNumber": "080 49019010", "addressType": "HOME", "copyEmails": [ "ccedEmail@gmail.com" ], "email": "email@gmail.com" }, "taxInfo": { "type": "VAT", "address": { "name": "ABC", "addressLine1": "1st Main Rd", "addressLine2": "Milk Colony", "addressLine3": "Subramanyanagar,2 State, Rajajinagar", "city": "Bengaluru", "state": "Karnataka", "district": "Bengaluru", "municipality": "BBMP", "postalCode": "560055", "countryCode": "IN", "phoneNumber": "080 49019010", "addressType": "HOME", "copyEmails": [ "ccedEmail@gmail.com" ], "email": "email@gmail.com" }, "number": "IE1234567T", "messages": "additional tax information" } } ], "packages": [ { "id": "001", "dimensions": { "length": { "value": 10, "dimensionUnit": "CM" }, "width": { "value": 10, "dimensionUnit": "CM" }, "height": { "value": 10, "dimensionUnit": "CM" } }, "weight": { "value": 200, "weightUnit": "G" }, "hazmatLabels": [], "packageLineItems": [ { "packageLineItemId": "1", "quantity": 1, "serialNumbers": [] }, { "packageLineItemId": "2", "quantity": 1, "serialNumbers": [] } ], "trackingDetails": { "trackingId": "TBA303940590400", "carrier": "AMZL", "shippingService": "ATS_STANDARD" } } ], "shippingInfo": { "recommendedShipMethod": "ATS_STANDARD", "expectedShippingDateTime": "2020-06-09T14:00:00Z", "expectedShippingDateTimeInUTC": "2020-06-09T14:00:00Z", "shipToAddress": { "name": "ABC", "addressLine1": "1st Main Rd", "addressLine2": "Milk Colony", "addressLine3": "Subramanyanagar,2 State, Rajajinagar", "city": "Bengaluru", "state": "Karnataka", "district": "Bengaluru", "municipality": "BBMP", "postalCode": "560055", "countryCode": "IN", "phoneNumber": "080 49019010" } }, "status": "CONFIRMED", "subStatus": "OUT_FOR_DELIVERY", "reason": "OutForDelivery" } ] } }, "schema": { "$ref": "#/definitions/ShipmentsResponse" } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "409": { "description": "The resource specified conflicts with the current state", "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } } } }, "post": { "tags": [ "sandboxShipments" ], "description": "Creates a sandbox shipment to simulate order creation in the test environment. This operation is available only in the sandbox environment. The shipment is created with the specified configuration including shipping type and order type.", "operationId": "createSandboxShipment", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CreateSandboxShipmentRequest" }, "description": "The request body for creating a sandbox shipment." } ], "responses": { "201": { "description": "Successfully created a sandbox shipment.", "schema": { "$ref": "#/definitions/CreateSandboxShipmentResponse" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "examples": { "application/json": { "shipmentId": "D39CwZpdj" } } }, "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." } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "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." } } } }, "x-amzn-api-sandbox-only": true }, "x-amzn-api-sandbox": { "dynamic": {} } }, "/externalFulfillment/2024-09-11/shipments/{shipmentId}": { "patch": { "tags": [ "sandboxShipments" ], "description": "Updates a sandbox shipment on marketplace behalf. Supports status changes, invoice availability, and transport capacity updates.", "operationId": "updateSandboxShipment", "parameters": [ { "name": "shipmentId", "in": "path", "description": "The unique identifier of the shipment to update.", "type": "string", "required": true, "x-example": "D39CwZpdj" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateSandboxShipmentRequest" }, "description": "The request body for updating a sandbox shipment." } ], "responses": { "204": { "description": "Success.", "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "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." } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "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." } } } }, "x-amzn-api-sandbox-only": true }, "get": { "tags": [ "shipmentRetrieval" ], "description": "Get a single shipment with the ID you specify.", "operationId": "getShipment", "parameters": [ { "name": "shipmentId", "in": "path", "description": "The ID of the shipment you want to retrieve.", "type": "string", "required": true, "x-example": "D1px1063T" } ], "responses": { "200": { "description": "Success.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "examples": { "application/json": { "id": "D1px1063T", "locationId": "ABCD", "marketplaceAttributes": { "channelName": "FBA", "marketplaceId": "A21TJRUUN4KGV", "merchantId": "ABCDEFGH", "customAttributes": [ "PRIME" ] }, "shipmentInfo": { "numberOfUnits": 4, "priority": "LOW", "shipmentType": "NEW", "buyerOrderId": "407-7727827-8514700", "orderStatesEligibleForRejection": [ "ACCEPTED", "CONFIRMED", "PACKAGE_CREATED", "PICKUP_SLOT_RETRIEVED" ], "orderPlacedTimestamp": 1604923992000, "processingSource": "INTERNAL_PLATFORM", "originalShipmentInfo": { "id": "DNkXsJZJX", "locationId": "ABCD", "marketplaceAttributes": { "channelName": "FBA", "marketplaceId": "A21TJRUUN4KGV", "merchantId": "ABCDEFGH", "customAttributes": [ "PRIME" ] }, "originalLineItems": [ { "replacingSku": "1002400773021", "originalSku": "4222400773321", "charges": [ { "baseCharge": { "baseAmount": { "value": 100, "currencyCode": "INR" }, "discountAmount": { "value": 20, "currencyCode": "INR" }, "netAmount": { "value": 80, "currencyCode": "INR" } }, "taxBreakup": [ { "type": "IGST", "rate": 0.18, "charge": { "baseAmount": { "value": 18, "currencyCode": "INR" }, "discountAmount": { "value": 6, "currencyCode": "INR" }, "netAmount": { "value": 12, "currencyCode": "INR" } } } ], "totalCharge": { "baseAmount": { "value": 118, "currencyCode": "INR" }, "discountAmount": { "value": 26, "currencyCode": "INR" }, "netAmount": { "value": 92, "currencyCode": "INR" } }, "totalTax": { "type": "TOTAL", "rate": 0.18, "charge": { "baseAmount": { "value": 18, "currencyCode": "INR" }, "discountAmount": { "value": 6, "currencyCode": "INR" }, "netAmount": { "value": 12, "currencyCode": "INR" } } }, "chargeType": "product" }, { "baseCharge": { "baseAmount": { "value": 20, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 20, "currencyCode": "INR" } }, "taxBreakup": [ { "type": "IGST", "rate": 0.25, "charge": { "baseAmount": { "value": 5, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 5, "currencyCode": "INR" } } } ], "totalCharge": { "baseAmount": { "value": 25, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 25, "currencyCode": "INR" } }, "totalTax": { "type": "IGST", "rate": 0.25, "charge": { "baseAmount": { "value": 5, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 5, "currencyCode": "INR" } } }, "chargeType": "gift_wrap" } ] } ] } }, "shipmentRequirements": { "pSlip": { "requirement": "REQUIRED", "status": "GENERATED" }, "invoice": { "requirement": "REQUIRED", "status": "PENDING" } }, "invoiceInfo": { "invoiceId": "IN-ABCD-124", "creationDateTime": "2021-05-12T17:32:28Z" }, "partyInfoList": [ { "partyId": "95930", "partyType": "SHIP_TO_PARTY", "address": { "name": "ABC", "addressLine1": "1st Main Rd", "addressLine2": "Milk Colony", "addressLine3": "Subramanyanagar,2 State, Rajajinagar", "city": "Bengaluru", "state": "Karnataka", "district": "Bengaluru", "municipality": "BBMP", "postalCode": "560055", "countryCode": "IN", "phoneNumber": "080 49019010", "addressType": "HOME", "copyEmails": [ "ccedEmail@gmail.com" ], "email": "email@gmail.com" }, "taxInfo": { "type": "VAT", "address": { "name": "ABC", "addressLine1": "1st Main Rd", "addressLine2": "Milk Colony", "addressLine3": "Subramanyanagar,2 State, Rajajinagar", "city": "Bengaluru", "state": "Karnataka", "district": "Bengaluru", "municipality": "BBMP", "postalCode": "560055", "countryCode": "IN", "phoneNumber": "080 49019010", "addressType": "HOME", "copyEmails": [ "ccedEmail@gmail.com" ], "email": "email@gmail.com" }, "number": "IE1234567T", "messages": "additional tax information" } } ], "charges": [ { "baseCharge": { "baseAmount": { "value": 160, "currencyCode": "INR" }, "discountAmount": { "value": 30, "currencyCode": "INR" }, "netAmount": { "value": 130, "currencyCode": "INR" } }, "taxBreakup": [ { "type": "IGST", "rate": 0.18, "charge": { "baseAmount": { "value": 33, "currencyCode": "INR" }, "discountAmount": { "value": 11, "currencyCode": "INR" }, "netAmount": { "value": 22, "currencyCode": "INR" } } } ], "totalCharge": { "baseAmount": { "value": 193, "currencyCode": "INR" }, "discountAmount": { "value": 41, "currencyCode": "INR" }, "netAmount": { "value": 152, "currencyCode": "INR" } }, "totalTax": { "type": "TOTAL", "rate": 0.18, "charge": { "baseAmount": { "value": 33, "currencyCode": "INR" }, "discountAmount": { "value": 11, "currencyCode": "INR" }, "netAmount": { "value": 22, "currencyCode": "INR" } } }, "chargeType": "total" }, { "baseCharge": { "baseAmount": { "value": 40, "currencyCode": "INR" }, "discountAmount": { "value": 10, "currencyCode": "INR" }, "netAmount": { "value": 30, "currencyCode": "INR" } }, "taxBreakup": [ { "type": "IGST", "rate": 0.25, "charge": { "baseAmount": { "value": 10, "currencyCode": "INR" }, "discountAmount": { "value": 5, "currencyCode": "INR" }, "netAmount": { "value": 5, "currencyCode": "INR" } } } ], "totalCharge": { "baseAmount": { "value": 50, "currencyCode": "INR" }, "discountAmount": { "value": 15, "currencyCode": "INR" }, "netAmount": { "value": 35, "currencyCode": "INR" } }, "totalTax": { "type": "TOTAL", "rate": 0.25, "charge": { "baseAmount": { "value": 10, "currencyCode": "INR" }, "discountAmount": { "value": 5, "currencyCode": "INR" }, "netAmount": { "value": 5, "currencyCode": "INR" } } }, "chargeType": "shipping" } ], "status": "ACCEPTED", "subStatus": "OUT_FOR_DELIVERY", "reason": "OutForDelivery", "lineItems": [ { "shipmentLineItemId": "1", "merchantSku": "1002400773021", "numberOfUnits": 2, "complianceAttributes": { "serialNumberRequirement": "REQUIRED", "hazmatLabelsRequirement": "REQUIRED", "hazmatLabelRequirement": "REQUIRED", "countryOfOriginRequirement": "REQUIRED", "itemValueRequirement": "REQUIRED" }, "serialNumbers": [ "serialNumber1" ], "pieceType": "SINGLE", "hazmatLabels": [ "hazmatLabel1" ], "giftAttributes": { "giftWrapRequirement": "REQUIRED", "giftWrapLabel": "Wrapped gift", "giftMessagePresence": "PRESENT", "giftMessage": { "format": "PDF", "content": "iVBORwMKGgoAAAANSUhEUgAAAywAAATCCAMAAABouZLTAAAABlBMVEUAAAD///+l2Z/dAAAACXBIWXMAAB84AAAfOAGTPyf1AAAfLklEQVR42u3dCXajShZAQb2u2v+WX3+XNTBkMgkQoIhz+ndZlsCWucpEA0TcgCn+5y4AsYBYQCwgFhALiAUQC4gFxAJiAbGAWEAsgFhALCAWEAuIBcQCiAXEAmIBsYBYQCwgFkAsIBYQC4gFxAJiAbEAYgGxgFhALCAWEAsgFhALiAXEAmIBsYBYALGAWEAsIBYQC1zaX3fBeaW7YCVhZAHTMDANY4vpw6cninGGH9LIAqZhIBYQC4gFxAKIBcQCYgGxgFhALCAWQCwgFhALiAXEAmIB9vkM/s9nnGPuDTq3KFw0/4doLODt5SGWFft4bI358/85Z8OM/jEEnhflwm28s8xw0C0OEku8Nur0CL6rvDUeqCrXiCmjf94aS8qxha71w0f1Qbd2te4kofOgeLJpmBnPrqnct+0s3uc5XFhh8P1dSmz/mJe1X+aWnd8le9fJ3GMLO90OfoTuxh+Worj1ZdZaiQmL3fR+L/1ozz6j/th7v07scixbB9m7aDJZaCBuy7epjM0Tz0orE0ejjLPHku1f+zGwZ2ucb06YC89aFean2Xr+4HlXx6256NcfIIbm5r3Lvm4va8pmtvs9ku+Vd8ZYor3pxXPrbXSSjT9YtobU3yfSGvPR1u0fs+loXbOxzMfFr60h+3uRvXWcfxJ2rEFjhVaisnufrX2qzX+PA0zD8reO1zZ/n0Q8voqcdNe2rpnN0SeetWR/tJ++DrqbcuMpgE2eLTtaxAfYwY9bc5YWE4fkZw1ZeqIkynd1DAzxeb3nEKb9GvMfkH92xuP3OajmBRG3zP2TXWXmdvod/On7DtVrRm3f9+r7J9O3m/FWMor7eJHd3cYVB+gs78L2Z9F7+nvav/l9cpUxfM1ccbs6VyprbVKjNeXWf/6j7FAePJZ485o54Sn4uGAo03+tCSlk1NvYdKc6F75+stVZYU78ruMo/CEXT+SuI+J3n2va7sOkjT2nb6Dr7+HH3MHr/vtvsP90uFiysA8/eu3lL+DGNU9jOnsLW6uWDeYVnd9l0pxsm1z+95keKr9GzLrjY9lYOzrcZOa31JKxQi1xxLttixnF/z7xSwy+BPjfff74E76eHp48QOTguJH9Vqav44K15L97O++beXlrj8KA3/ni9U6to92J6/48f2LLHzIKL1ZFv/t4Xiua343nFDj6Edyv0B53e2uM5/caT222X0R73fKEO/2x7Psx4/pR/Fb70ojBRcfC3yiKk46Yc4NY53789XfjP2IMzkQL14ry7WPyPRu1lUXt54odRvAzj1FZuCDb7+irvUa83kqnXOkL3u7CAQamoY9+R3Yq+FdLdX5wXWK5liy+p/rNx9xuLb3PYsXmtUT1B8voxL7dS5iO7nLZalacl7R38ncZQSqfvZlZQoiFvTeVmFxJrP7DD84Q62veIOk/9mavlkMUtrDobEIxY6rT/F71A74xtFVPfPdz58qNjwvXm3hdqfB6wPT3E0y7ok+0X2oH5dZ/b1hWRoYYuE372q1Xq6K0nOr70Sa/Syurg0rnk7IxYcI5871hKZZvjWWX3aGYuFGu/ZbGTX7jybHYZ2HJUwcb7D4f398v+ePG+GXj3+L22bcFffiDLX8/cF/v/AuXjtQ6cPRWB3Z962HoykzDmPvYc7u/Y3L/Vj68h32YaVhudXQFNhmpv3G2+nf/u/qNibAJ0nEGly9kGgYfHVnah2VtHFC1fNjWzjFeO0dg7V3t8ejWW1gUDgdbGJkq77Wdfc4lxLLutDZ/9sryVjq88fO9rJ1jvJaOwPo8MGs0N/rszaG7h4PttlI9mOu1juLKyfZZ2sdKzd6hIZqHba3cPCcfXrWx+KHlVg/m6iiufHKfJXpzn+J74IZuHpN37hvXnnwci+LhMeTCp3bw353VrPoaZlQ/5Oxcfnx0GrbqswXbL8uQwvljWfM9qwMH1TOy8OFp2MGGKEVw3Vh2OrxqmIbx8Vg2ezTPlY5/aLjhALHkjE1xcFfidXjVaLyBb/4LiEMHc73qUVxZ0YYHrIj2qYULB7eJxkFUm/vY7SOwNo+VEKWr9xYfrQV0V1I4mGtzNZucHXHD6aOfcrefcKtPCJjd7PKMRRz+JzxBLD6DD2fbwYfL2PAt+t7Bi1iust8JpmEgFhALiAXEAmIBxAJiAbGAWOB0nIAVvEUfTMPgM+OPaRgYWUAsIBYQC4gFxAKIBcQCYgGxgFhALCAWQCwgFhALiAXEAmIBxAJiAbGAWEAsIBYQCyAWEAuIBcQCYgGxgFgAsYBYQCwgFhALiAUQC4gFxAJiAbGAWEAsgFhALCAWEAuIBcQCiAXEAmIBsYBYQCwgFkAsIBYQC4gFxAJiAbEAYgGxgFhALCAWEAsgFhALiAXEAmIBsYBYALHA0WJJdyrX9HfrFfy2E+5pTi9i/Tii9WX0LwTTsFKN7mPEUp11ZakYuzKIZXgkMbAglsrAEkYRxAJi2YFnwxBLfxZW2pvXClew+YuSv+FohfNb9UXJjMpIYmjBNGxqkp4hw8jSm3C98jC2YJ9laAB5pJHSwDQMxLLW7r19FMTy7n4MiKU7sPSHFvv3iGXa0KIVLmCtp47br9Pnc3xp/hPEAqZhgFhALCAWEAuIBcQCYgHEAmIBsYBY4Iy2O27Y8/MsUbw8Zi2jyVs/uUIszRDi31evLfvx4bC49Y9mUT+8Re9IZKt99NIhNfhgLPn4BEvec/GZYuyzDLVSmSblwJiQG31UPwe/94mUPXyIpT1nipGtY6cJUB5uy0ytiKWWRbx161vxc5wrfrTTpsvnRpaFG+cndrXt3vPRHfyhEWXvR/F8/Te2Xku0/53l+2Cfn4izxVJ6CH89NdZ9UP85D+WCgyN3t8ns7jcNHX+pss7edl654LWWbDxCZPfCVhnhiFBiGZrbbPfk8eNp6uy8EvO6YMkyW898Fy+4b/TPS5q/4fPfkY2uUiD2WUpzrxx6JB+ai809OHLjaersXjDjB26u85FZVC/4t5K4P8mQU37EcKQpscyvZfVd7fbT1DMnOOV19p757lyQ3TnVyDAVSx4G+IpYHtOgkRFjjeehsrAbscq++npPSRhTxDL+aF965S3rG+C9ndUegKdspOV1RncRYcNns1juW1Xl5cmNX0187+XxCQNLdmZoZlffZu2njv89b7pkpjXz2ePs3XrB807hdH58MJbf7fa1Cfa2x87WuXRjLT9JPS0XgXCQWDq1NPcRSg/kudJWHLfpuaRyOEYsc16KzBWf1XrkEjuuEzv468rbTltn9fkFOEMs3efB6jsw059gql9zwpO85XX2FtlfR+sSb/MSyzvjR04KZ6PBy3DCWUeWWHijXPuak5c0YWgZmWYKViwblrP8mah4bZuZnZ2hGFxtdZ3NRdYv6M3CGiedjU0eQjiMP7F+FdnZSYnivytbT0zb0gq7QVHYlSgcd6m6zuobKFsXPN4uGr3lRfOnaK0nhn8iTmK9tz09t6DuQ2zrqdru07a9D29VP2PY+052Cq1cJXq3qa+z9znG8gW1hQ48IxC1n4hvjMUp7xELsNcOPogFxAKIBcQCYgGxgFhALCAWQCwgFtjXuqec+PnP5Hdmbv6xDp8b4bCxPE5nEiMf+xjtrckGz1Gsez7TeD2gNz6zmFF6qC8fHyWj/c03RgcHYOGo+yyf2zY/d6AIh6gQy9pbVBamVLnWtlY7qEpuvjE7nItY3p7ZPf6bg4/DMXDjVXZZzMFY1xZHd+l/3Ttcyv0kk0Mb9MChJxrnEK4e5qKwgtLRKspftg9B0fzH6+dIUX6bzU/t/TsdireXEf/NeponkLwfkT8m7yvl40hgMf5l/zTdcf89niuesWZMw/ojQQ4OERlvtfLccB9fLRr4ovxlPr8c2g/JCddBLBNryQnxLNnsorTXc5uzXefQ/pO9IHbewS+e2/t332Hd8z3+ri1mLiMaN6t+adhgl1j+bXmTnk999xTFufUKYONY2oNLrHg+uvzRXIcG2N3qZyvO0r5Ddt/pkgsibK9j8KD1aUDh+LFMO1124xWTRacBH30++s0VwPbTsPrOxboP9RE3uyNcKJbXCxntVziydeKTXL7wkd17u/gcNJbcMrrWMwX5/jJqX3pRnn1HlpHNbeEpimdku+IKDEtsF0v5rcXxbn2tE0fmbf7riM+XgLL25a1zqsjRN7WZ4n2ZVU+TF915zGtby+Z54rrvH+62VLg0m5cMvn24voK8Fb5Vud3z/cX3i/tvrCzdBrHMGlRsO4gF7LMAYgGxgFhALCAWEAsgFhALiAXEAifhzF/wgVic+YtLc+Yv2H2fxZm/EMv7W5QzfyGW8szu8V9n/uJSnPmr9KUzf1HgzF/O/MXu0zBn/kIsc2px5i/EMnVbcuYvxDKpFmf+QixLBhdn/uJanPkLPhSLM39hGvbuvrkzfyGW4Yd3Z/5CLAODyAbROfMX1xxZnPkLsczfupz5i+tw5q/y7Zz5iw1jceYvxAJstYMPYgGxAGIBsYBYQCwgFhALIBYQC4gFPmu1A1a0Ptnh3Zlc0AZn/mof8R5Mw4YD3OwjhD6byLX2WTarxZEoudwOvo+nYwd/8cyp8/H59n7N+KfoXx+iz/bCWh+GdyQjTraD39vdbx3I4udf2bukcWbw9lbf/jLbFcXrkMd5PwayWDjZNKwXTWte1jvTUPuIldE76l1UFxytxSqFM8dS2aPpztLeWIwzoXKNfZbXsfBqx7NvHi2vuslHeUdowvXg1CPLgucH4PIjy7t1/Oy0185bpCK+PJbs7PvXT/NlzsVVpmGxzg0jjCJcOpZc8YZO84Ud/O0HKTh8LP2zp1TfiTL8NrLqOye9+4xrxOI9Wohl0g5HNlvpnVOrOEa8TsIVrfN73eqn+eqeDgy23huIVTsp7mP03nVcPoNW732Vjbcax8DC4lY7gxgcMhYwDQPEAmIBsYBYQCwgFhALIBYQC4gFxAJn8/cUP2XrXcnwGRu/RX/4+N9RXVZ0Fh231kdi2h9hERHniqV25q/O4cKbn18pbeWF7xSOCp5xKy8fzrXP0j3zVxauUYu0/51sHtg1q4XCOXfwVzyaROEjylrhQrEUPyu/7uLhIrFsNMyYhHHBWDqnKsp1cnCwMK49smy3jRtYuFwsJmGI5QC7LXCxkWWLWgwsXHMaZmxBLPZYEMsag8mGQ4tWuEosudJErH0rhfAd07BVxxbZcJVYittybLYuOG0sKz7uN8ej7JzDBc4bS+HMX28PLa1TgWmFz9nhY8X1T0oWAsryQnysmAvFsilnwUMsM5NRC2LZ/XkDuHYsDiCGWIwuiAWuw7GOQSwgFhALiAXEAt/jwCcz6r4J8/gLxsjyIZu9BOS1JT47srTeGDzw2P3GK/CNVTTe9uIlfc4WSzS32miem+u2wSq2WQEcdRr2zofntcL1d/BjjVSaragGO/jGFb5oZHns52d/zz8fX70OQVE9B/hQK+0FRnlBOfTMQ/Oi3kLS0MVrErPBqb0b2/PPZRnFA7Nk95AU2TweRdQ27OiOK60Fttf1u8j2gS6il0fvx3supLM0TMP2mDINH43yd4OMziGPah1nTF3Xb37R7Sr6lzR/vOdCJvzkiGWTPfoJV8qp8U1aV94WPZkQnjrgsDv4s85tn2udzLV1ifGDc8Qyd6CyWfMRB3kj5YztP9Izx3xzLHO2frVgGrb2TMyr/Hx9LDNqyZujvvLVscypJbXChWLpbPpTSphWS2b8qN/oeYnX6dk1ltY5utbY9PLNWnLJguF4I0tjc28+wL++HA5u6tjy61ZZ8OMSAwsTNtk1N5J8vle3dYKvKPzj+e3WG12aZ/bqv5WyeePHvwdX0T+NWGHB/Z+i+gMjlnVzOc6mleX3/8MyK78oeaRN8jWuhJ0UTr3PAmI55nTTn5qD7bMcSjqyGGKZudsiFcQC9llALCAWEAsgFhALiAXEAmIBsYBYALGAWEAsIBYQC4gFxAKIBcQCYgGxgFhALIBYQCwgFhALiAXEAmIBxAJiAbGAWEAsIBZALCAWEAuIBcQCYgGxAGIBsYBYQCwgFgAAgJVEuA/ADj6IBcQCYgGxgFgAsYBYQCwgFhALiAXEAogFxAJiAbGAWEAsgFhALCAWEAuIBcQCYgHEAmKBzf11F7CpvP9/dC6Y+/X0GxhZuFg83a9z5HqzFyAWsM8CYgGxgFgAsYBYOIuofB0j15u9gA1+dGcrZlO5dl1ZiyO3rsbIAmIBsYBYQCwgFhALbCsq/7/agjf4kb3Owqa6r37k2Eaeu238RhYQC4gFxAJiAbEAYuGYTvTahYPs8Vk5tx6fZwHTMBALiAUQC4gFxMLVeZ0FJkbSe51l7PMs1Rtunp2RBcQCYgGxgFhALCAWoMNxw9jW2PlZJn8spfb6y36vtxhZQCwgFhALiAXEAmIBOnyehX2Mnp+lKyd+P7K9AiMLjESTYgH7LGCf5UNjcYzNeCvvNYr6yD727qT2NbK6qrGfZeAgvcsW+sYK21fyzsGrxZJv3Sbrm2FO31qy+9WSG3ZvtnihS1f47r0qlsuF8rhZPP6R/QEiSt8aE42faOINs3O7/s0WLPS9FWrlkvssme+2cn9gze634vGfORtNtKY2uex2udJCF69QK5cdWWLJnzUb20rkyEYy+dH8cb3IJZvu83bt9S1d6OIVbtbK6H7SY0cxpi4gR74WS++vXt+Mxu71QhHtb0V/JjbjL7H0duss9N0VxqfGlly2m7hgAd81Dds0wv1vPjgviu1+z8Jo6mmwK07DNq5m8k5+HDDaN2ZMWhHL0pH9sIPYJivUyvdNw2JGGLHxtr37wPPGCj0RZp9l943ivDMzA4tYuttCPv8Tq2aVW2yquVcbJmH2Wfr77a/t4iBjQG6x0Lkr3KyVqS+PRO2nG13A5pH/uczDSMz4RgxfYcEFvU0wlm7ssepC566w00qs//fJytej6xxdwOab8heMLKV3C0b53bwx/H6p4WWOb9WL3wy5fKEzV2jn/itjab3pqz+3aNQykEbOWWb93fQjP8tQEcsWunSFaef+i3fwI8qvUrfegZmjpzWctMzBJY7fLsemErMXumSFWvneWG7l93RkZ38wi/PizDnL/Nk2n5tn5bYxtGNd3Ed9b6EzV+iJsG+PpbDB3D8DGDFQy7+3/8esWtrPyczesIdWt3ihc1aoFbEM7IlE3AaeUln4XOSiz57kyOrW/UBLcYV27sd8wVPH3WfwW3P16N38sQk1N6UYW+a73xvfs958hTn/jl3095n6/4sXsJ1vfSPlq43+J3bj3c1l8jPQ01tZsNB3V7jZeD78dc5dUPUFGNOw1f9ocYgfKa69Qvssl5+/7TSNzw/EiWnY3jWttenG3q3E6G+Zt5vxx8hy7GmhccXI8vndgHj3djO/N+1nGXoAX7rQxSvk60eWLGw2k97rmgsfnnPRIqf9FnMXahwxsqy455HD2+AWH97tvnUg11hq7L3CN/8eOfz/B9zFvHAsGeVtvnPIlpx6u6nfK40BQ7eb9EvMXejiFe73oFV/uXThGOnDX9MnWeUneAobWeuvVHoDYwxsZjEwI2od7zWm3C7H/+jzF/rmCkdnfQd54N9/yz11LDn5Huxsf5Pfl754Dhax/I8cKy90/gpzw43yxLFcdRrWPAZyDH679zheHaqGlhmDH9PKZX/hpQtdvEJuCx8BYYPhf7UTwuy/5XpREsQCYoGP8EZKdto7HtuHGb3C1H0dn2cB0zAQC4gFxAKIBcQCe/E6C/sYPapX7bwrtcvfPrybkQXEAmIBsYBYQCyAWOBdf3wGn4+K1Y+Z6fMsXNSJji8rFhALiAXEAmIBscD3cKxjMLKAWEAsIBYQC4gFEAuIBcQCYgGxgFhALIBYQCwgFhALiAXEAogFxAJiAbGAWEAsIBZALCAWEAuIBcQCYgGxAGKBFf1dYyHpfuQ4Njvzo5EF9hxZOP6j4tfYcJpjZAGxgFhALCAWuIBTPRtWeKooZ10hhm/k9SIGt781nqvMnXvJ1maes64QpR84Sr9EfCIeTx2/vzFudh/+OdtfJ3pfxrwrRGmT7IYREXGEX48j3Ydnf1Hy53FkcAgoXyHS9sr37eDn2PadMwPIf2waXC+W8T2LNHwglunbfnTjUQvfGMvsocUci2/cwZ+yx96/QsaEW3ydbI/D2bvjWhfXri6WK1JLb6ramqD++zKqF1cvNw274oOo3ZbRXb8Yurh6uVgOvunPfPbYqDJlDy/GL65eLpaLP5AaWpqbf8bIxdXLxWIi9r2PH+Hh5qtHFrWMTMR6I0Xl4urlYrnk3JzyzGr04urlYrHb8kX3SMaUi6uXi8VE7GvumuLGX7m4erlYTMRMxL5zIuYz+IaW4j0SUy+uXi6W844SaSK2wv2Z3zxIXyKWWHwFtajFNMxuyxv3Sfn4A5WLq5eL5VKzMLst5Y2/eI9VLq5eLpaLDi1qKT18eEbsgrHEW1cwESuNFDHx4urlYjlsK/nWFejPqjp3WuXi6uViueYei47m3jXf+ozY+WOJsT/S6BXU0h8ppn20pXr5Nf09fyrvz8HSDr6hZIKzHeu4vTsZ/VFj7ApRfSfHwGIO9GTFxq1E70eJ6sXVy4+wjWyy4DMdRX+tU07cColldSH5LbG0DmaU5Z+scTdVrv7pWlIs38KE8MCxeNcxiAXEAmIBsYBYQCyAWEAsIBYQC4gFxAJiAcQCYgGxgFhALHB5f90Fh+JwBkYWEAuIBRALiAW2tMqzYQ6juALPgxlZQCwgFkAsIBYQC4gFxAJiAbEAYgGxgFhALCAWEAsgFhALiAXEAmIBsYBYALGAWEAsIBYQC4gFEAuIBcQCYgGxgFhALIBYQCwgFhALiAXEAmIBxAJiAbGAWEAsIBZALCAWEAuIBcQCYgEAANhFhPvgGNJdsNY2bQcfjCxwDkYWEAuIBcQCYgGxgFgAsYBYYFN/V1nK7/ua4t8/4nFJVK5w6135ef3n1W69hRRv2Lx+58KBKw//DMM//MRV3Hq/1+gNo3c/3Hq/flQW2F9j/x4buKOmXGHuzzDl1yzet7fSMvt/sv5KjSxgGgZiAbGAWACxgFhALCAWEAuIBRALiAXEAmIBsYBYQCyAWEAsIBYQC4gFxAKIBcQCYgGxgFhALCAWQCwgFhALiAXEAmIBsQBiAbGAWEAsIBYQCyAWEAuIBcQCYgGxgFgAsYBYQCwgFhALiAXE4i4AsYBYQCwgFhALiAUQC4gFxAJiAbGAWEAsgFhALCAWEAuIBcQCiAXEAmIBsYBYQCwgFkAsIBYQC4gFxAJiAbEAYgGxgFhALCAWEAsgFhALiAXEAmIBsYBYALGAWEAsIBYQC4gFEAuIBcQCYgGxgFhALIBYQCwgFhALiAXEAmIBxAJiAbGAWEAsIBZALCAWEAuIBcQCYgGxAGIBsYBYQCwgFhALiMVdAGIBsYBYQCwgFhALIBYQC4gFxAJiAbGAWACxgFhALCAWEAuIBRALiAXEAmIBsYBYQCxASYT7AIwsIBYQC4gFxAJiAcQCYgGxgFhALCAWEAsgFhALiAXEAmf1112wjfz5j4+hiuV7tvafzT1fl8VYDc8b/fe/XLLKGI4tWxdm90cS56Z8Bn9ow71vva//e26bzW+Xb9T/7qS1xtCmn/8WH5WvjGT2WT7XSmfji9cw8/x2NkeU0o26o860AW0gpXits/FVpr+ZWI41Dpc35ilb6uStOce/k/2vwhRBLGecpb653eZgrI2RKzyHsK8/7uzhTbP972hcHJ2xJno3uk+SmtfJ1sWNJwTuF0VnZZXd/+h8dSveorQCjCxbhDLyEJ/37TXiMQ3q3yjvM7DndSJa86iIRmXPL1bc/+ivALFsUksOjzq956u6N8oo7kvk76W5JFPEctBJWM7cvejcKMrX60zm7s9nRXUutc6TEl6FEcu2O/dZzaQcU+FGsXjzRiwX2HHJekxzp1H3NDKGx6y3hxYDi1i2n4qVW6nvjMeGkSKW08jiE8orPPJnjNYSrX/G9J+isALEsmIVudeNirOuGLha5YX8mU9FIJZtZ2LZf4Ir5tyovoqYUEvlpfuY9DsYWMSy6Yyr+3ic3Zfps7UL3b9RtvZvcnGkz8uy8cbk9lfs8MDpvh6auHR2HqI7r+m+P775KZR8vbvldZ1HXtla4H2Hov0ZltJeRvXzLDk8zthjEcuXJDv7yYRlt8I0DIwsYGQBsYBYQCyAWEAsIBYQC4gFxAJiAcQCYgGxgFhALCAWEAsgFhALiAXEAmIBsQBiAbGAWEAsIBYQC4gFEAuIBcQCYgGxgFgAsYBYQCwgFhALiAXEAogFxAJiAbGAWEAsIBZALCAWEAuIBcQCYgHEAmIBsYBYQCwgFhALIBYQC4gFxAJiAbEAYgGxgFhALCAWEAuIBRALiAXEAmIBsYBYQCyAWEAsIBYQC4gFxAKIBcQCYgGxgFhALCAWQCwgFhALiAXEAmIBsQBiAbGAWEAsIBYQCyAWEAuIBcQCYgGxgFgAsYBYQCwgFhALiAUQC4gFxAJiAbGAWEAsgFhALCAWEAuIBcQCYgHEAmIBsYBYQCwgFkAsIBYQC4gFxAJiAbEAYgGxgFhALCAWEAsgFhALiAXEAmIBsYBYALGAWEAsIBYQC4gFxAKIBcQCYgGxgFhALIBYQCwgFhALiAXEAmIByv4PwWms3AV97VoAAAAASUVORK5CYII=" } }, "charges": [ { "baseCharge": { "baseAmount": { "value": 100, "currencyCode": "INR" }, "discountAmount": { "value": 20, "currencyCode": "INR" }, "netAmount": { "value": 80, "currencyCode": "INR" } }, "taxBreakup": [ { "type": "IGST", "rate": 0.18, "charge": { "baseAmount": { "value": 18, "currencyCode": "INR" }, "discountAmount": { "value": 6, "currencyCode": "INR" }, "netAmount": { "value": 12, "currencyCode": "INR" } } } ], "totalCharge": { "baseAmount": { "value": 118, "currencyCode": "INR" }, "discountAmount": { "value": 26, "currencyCode": "INR" }, "netAmount": { "value": 92, "currencyCode": "INR" } }, "totalTax": { "type": "TOTAL", "rate": 0.18, "charge": { "baseAmount": { "value": 18, "currencyCode": "INR" }, "discountAmount": { "value": 6, "currencyCode": "INR" }, "netAmount": { "value": 12, "currencyCode": "INR" } } }, "chargeType": "product" }, { "baseCharge": { "baseAmount": { "value": 20, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 20, "currencyCode": "INR" } }, "taxBreakup": [ { "type": "IGST", "rate": 0.25, "charge": { "baseAmount": { "value": 5, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 5, "currencyCode": "INR" } } } ], "totalCharge": { "baseAmount": { "value": 25, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 25, "currencyCode": "INR" } }, "totalTax": { "type": "IGST", "rate": 0.25, "charge": { "baseAmount": { "value": 5, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 5, "currencyCode": "INR" } } }, "chargeType": "gift_wrap" } ], "cancellations": [ { "cancelledQuantity": 1, "cancelledTimestamp": "2020-06-08T12:00:15Z", "cancellationType": "MARKETPLACE_CANCELLED", "cancellationReason": "customer cancelled" } ], "hsnCode": "HSN0001", "recommendedCountryOfOrigin": "IN", "countryOfOrigin": "IN", "recommendedCurrencyCode": "INR", "itemValue": { "value": 10, "currencyCode": "INR" } }, { "shipmentLineItemId": "2", "merchantSku": "1002400773022", "numberOfUnits": 2, "complianceAttributes": { "serialNumberRequirement": "DISALLOWED", "hazmatLabelsRequirement": "DISALLOWED", "hazmatLabelRequirement": "DISALLOWED", "countryOfOriginRequirement": "DISALLOWED", "itemValueRequirement": "DISALLOWED" }, "giftAttributes": { "giftWrapRequirement": "DISALLOWED", "giftMessagePresence": "ABSENT" }, "charges": [ { "baseCharge": { "baseAmount": { "value": 100, "currencyCode": "INR" }, "discountAmount": { "value": 20, "currencyCode": "INR" }, "netAmount": { "value": 80, "currencyCode": "INR" } }, "taxBreakup": [ { "type": "IGST", "rate": 0.18, "charge": { "baseAmount": { "value": 18, "currencyCode": "INR" }, "discountAmount": { "value": 6, "currencyCode": "INR" }, "netAmount": { "value": 12, "currencyCode": "INR" } } } ], "totalCharge": { "baseAmount": { "value": 118, "currencyCode": "INR" }, "discountAmount": { "value": 26, "currencyCode": "INR" }, "netAmount": { "value": 92, "currencyCode": "INR" } }, "totalTax": { "type": "TOTAL", "rate": 0.18, "charge": { "baseAmount": { "value": 18, "currencyCode": "INR" }, "discountAmount": { "value": 6, "currencyCode": "INR" }, "netAmount": { "value": 12, "currencyCode": "INR" } } }, "chargeType": "product" }, { "baseCharge": { "baseAmount": { "value": 20, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 20, "currencyCode": "INR" } }, "taxBreakup": [ { "type": "IGST", "rate": 0.25, "charge": { "baseAmount": { "value": 5, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 5, "currencyCode": "INR" } } } ], "totalCharge": { "baseAmount": { "value": 25, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 25, "currencyCode": "INR" } }, "totalTax": { "type": "IGST", "rate": 0.25, "charge": { "baseAmount": { "value": 5, "currencyCode": "INR" }, "discountAmount": { "value": 0, "currencyCode": "INR" }, "netAmount": { "value": 5, "currencyCode": "INR" } } }, "chargeType": "gift_wrap" } ], "hsnCode": "HSN0002" } ], "shippingInfo": { "recommendedShipMethod": "ATS_STANDARD", "expectedShippingDateTime": "2020-06-09T08:30:00Z", "expectedShippingDateTimeInUTC": "2020-06-09T08:30:00Z", "shippingType": "Marketplace", "recommendedPackages": [ { "dimensions": { "length": { "value": 16, "dimensionUnit": "CM" }, "width": { "value": 12, "dimensionUnit": "CM" }, "height": { "value": 14, "dimensionUnit": "CM" } }, "weight": { "value": 2, "weightUnit": "KG" }, "lineItems": [ { "lineItemId": "1" } ] } ], "shipToAddress": { "name": "ABC", "addressLine1": "1st Main Rd", "addressLine2": "Milk Colony", "addressLine3": "Subramanyanagar,2 State, Rajajinagar", "city": "Bengaluru", "state": "Karnataka", "district": "Bengaluru", "municipality": "BBMP", "postalCode": "560055", "countryCode": "IN", "phoneNumber": "080 49019010", "addressType": "HOME", "copyEmails": [ "ccedEmail@gmail.com" ], "email": "email@gmail.com" } }, "packages": [ { "id": "001", "dimensions": { "length": { "value": 10, "dimensionUnit": "CM" }, "width": { "value": 10, "dimensionUnit": "CM" }, "height": { "value": 10, "dimensionUnit": "CM" } }, "weight": { "value": 200, "weightUnit": "G" }, "hazmatLabels": [], "packageLineItems": [ { "packageLineItemId": "1", "quantity": 1, "pieces": 1, "countryOfOrigin": "IN", "itemValue": { "value": 10, "currencyCode": "INR" }, "serialNumbers": [] }, { "packageLineItemId": "2", "quantity": 1, "serialNumbers": [] } ], "status": "SHIPPED", "trackingDetails": { "trackingId": "TBA303940590400", "carrier": "AMZL", "shippingService": "ATS_STANDARD" } } ], "creationDateTime": "2020-06-08T11:13:58Z", "lastUpdatedDateTime": "2020-06-08T12:00:15Z", "earliestPackDateTime": "2020-06-09T14:00:00Z" } }, "schema": { "$ref": "#/definitions/Shipment" } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "409": { "description": "The resource specified conflicts with the current state", "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } } } }, "post": { "tags": [ "shipmentProcessing" ], "description": "Confirm or reject the specified shipment.", "operationId": "processShipment", "parameters": [ { "name": "shipmentId", "in": "path", "description": "The ID of the shipment you want to confirm or reject.", "type": "string", "required": true }, { "name": "operation", "in": "query", "description": "The status of the shipment.", "type": "string", "enum": [ "CONFIRM", "REJECT" ], "x-docgen-enum-table-extension": [ { "value": "CONFIRM", "description": "Confirm the shipment." }, { "value": "REJECT", "description": "Reject the shipment." } ], "required": true }, { "in": "body", "name": "body", "description": "Information about the shipment and its line items.", "required": false, "schema": { "$ref": "#/definitions/ShipmentAcknowledgementRequest" } } ], "responses": { "204": { "description": "Success.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "examples": { "application/json": {} } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "409": { "description": "The resource specified conflicts with the current state", "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "422": { "description": "Unprocessable Entity. Unable to process the contained instructions", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } } } }, "x-amzn-api-sandbox": { "dynamic": {} } }, "/externalFulfillment/2024-09-11/shipments/{shipmentId}/packages": { "post": { "tags": [ "shipmentProcessing" ], "description": "Provide details about the packages in the specified shipment.", "operationId": "createPackages", "parameters": [ { "name": "shipmentId", "in": "path", "description": "The ID of the shipment.", "type": "string", "required": true }, { "in": "body", "name": "body", "description": "A list of packages in the shipment.", "required": true, "schema": { "$ref": "#/definitions/Packages" } } ], "responses": { "204": { "description": "Success.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "examples": { "application/json": {} } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "409": { "description": "The resource specified conflicts with the current state", "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "422": { "description": "Unprocessable Entity. Unable to process the contained instructions", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } } } }, "x-amzn-api-sandbox": { "dynamic": {} } }, "/externalFulfillment/2024-09-11/shipments/{shipmentId}/packages/{packageId}": { "put": { "tags": [ "shipmentProcessing" ], "description": "Updates the details about the packages that will be used to fulfill the specified shipment.", "operationId": "updatePackage", "parameters": [ { "name": "shipmentId", "in": "path", "description": "The ID of the shipment to which the package belongs.", "type": "string", "required": true }, { "name": "packageId", "in": "path", "description": "The ID of the package whose information you want to update.", "type": "string", "required": true }, { "in": "body", "name": "body", "description": "The body of the request.", "required": true, "schema": { "$ref": "#/definitions/Package" } } ], "responses": { "204": { "description": "Success.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "examples": { "application/json": {} } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "409": { "description": "The resource specified conflicts with the current state", "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "422": { "description": "Unprocessable Entity. Unable to process the contained instructions", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } } } }, "patch": { "tags": [ "shipmentProcessing" ], "description": "Updates the status of the packages.", "operationId": "updatePackageStatus", "parameters": [ { "name": "shipmentId", "in": "path", "description": "The ID of the shipment to which the package belongs.", "type": "string", "required": true }, { "name": "packageId", "in": "path", "description": "The ID of the package whose status you want to update.", "type": "string", "required": true }, { "in": "query", "name": "status", "type": "string", "enum": [ "SHIPPED" ], "x-docgen-enum-table-extension": [ { "value": "SHIPPED", "description": "The package is shipped." } ], "description": "**This field is only used for the Seller Flex program**. For the Self Delivery program, package statuses are defined in the body parameter.", "required": false }, { "in": "body", "name": "body", "description": "The body of the request.", "required": false, "schema": { "$ref": "#/definitions/PackageDeliveryStatus" } } ], "responses": { "204": { "description": "Success.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "examples": { "application/json": {} } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "409": { "description": "The resource specified conflicts with the current state", "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "422": { "description": "Unprocessable Entity. Unable to process the contained instructions", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } } } }, "x-amzn-api-sandbox": { "dynamic": {} } }, "/externalFulfillment/2024-09-11/shipments/{shipmentId}/shippingOptions": { "get": { "tags": [ "shipmentProcessing" ], "description": "Get a list of shipping options for a package in a shipment given the shipment's marketplace and channel. If the marketplace and channel have a pre-determined shipping option, then this operation returns an empty response.", "operationId": "retrieveShippingOptions", "parameters": [ { "name": "shipmentId", "in": "path", "description": "The ID of the shipment to which the package belongs.", "type": "string", "required": true }, { "name": "packageId", "in": "query", "description": "The ID of the package for which you want to retrieve shipping options.", "type": "string", "required": true } ], "responses": { "200": { "description": "Success.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "examples": { "application/json": { "shippingOptions": [ { "shippingOptionId": "FF9FCL", "shipBy": "MARKETPLACE", "pickupWindow": { "startTime": 1612433142, "endTime": 1612434142 }, "timeSlot": { "startTime": 1612933142, "endTime": 1612494142, "handoverMethod": "PICKUP" } } ], "recommendedShippingOption": { "shippingOptionId": "FF9FCL", "shipBy": "MARKETPLACE", "pickupWindow": { "startTime": 1612433142, "endTime": 1612434142 }, "timeSlot": { "startTime": 1612933142, "endTime": 1612494142, "handoverMethod": "PICKUP" } } } }, "schema": { "$ref": "#/definitions/ShippingOptionsResponse" } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "409": { "description": "The resource specified conflicts with the current state", "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "422": { "description": "Unprocessable Entity. Unable to process the contained instructions", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } } } }, "x-amzn-api-sandbox": { "dynamic": {} } }, "/externalFulfillment/2024-09-11/shipments/{shipmentId}/invoice": { "post": { "tags": [ "shipmentProcessing" ], "description": "Get invoices for the shipment you specify.", "operationId": "generateInvoice", "parameters": [ { "name": "shipmentId", "in": "path", "description": "The ID of the shipment whose invoice you want.", "type": "string", "required": true } ], "responses": { "200": { "description": "Success.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "examples": { "application/json": { "document": { "format": "PDF", "content": "iVBORw0KKgoAAAANSUhEUgAAAywAAATCCAMAAABouZLTAAAABlBMVEUAAAD///+l2Z/dAAAACXBIWXMAAB84AAAfOAGTPyf1AAAfLklEQVR42u3dCXajShZAQb2u2v+WX3+XNTBkMgkQoIhz+ndZlsCWucpEA0TcgCn+5y4AsYBYQCwgFhALiAUQC4gFxAJiAbGAWEAsgFhALCAWEAuIBcQCiAXEAmIBsYBYQCwgFkAsIBYQC4gFxAJiAbEAYgGxgFhALCAWEAsgFhALiAXEAmIBsYBYALGAWEAsIBYQC1zaX3fBeaW7YCVhZAHTMDANY4vpw6cninGGH9LIAqZhIBYQC4gFxAKIBcQCYgGxgFhALCAWQCwgFhALiAXEAmIB9vkM/s9nnGPuDTq3KFw0/4doLODt5SGWFft4bI358/85Z8OM/jEEnhflwm28s8xw0C0OEku8Nur0CL6rvDUeqCrXiCmjf94aS8qxha71w0f1Qbd2te4kofOgeLJpmBnPrqnct+0s3uc5XFhh8P1dSmz/mJe1X+aWnd8le9fJ3GMLO90OfoTuxh+Worj1ZdZaiQmL3fR+L/1ozz6j/th7v07scixbB9m7aDJZaCBuy7epjM0Tz0orE0ejjLPHku1f+zGwZ2ucb06YC89aFean2Xr+4HlXx6256NcfIIbm5r3Lvm4va8pmtvs9ku+Vd8ZYor3pxXPrbXSSjT9YtobU3yfSGvPR1u0fs+loXbOxzMfFr60h+3uRvXWcfxJ2rEFjhVaisnufrX2qzX+PA0zD8reO1zZ/n0Q8voqcdNe2rpnN0SeetWR/tJ++DrqbcuMpgE2eLTtaxAfYwY9bc5YWE4fkZw1ZeqIkynd1DAzxeb3nEKb9GvMfkH92xuP3OajmBRG3zP2TXWXmdvod/On7DtVrRm3f9+r7J9O3m/FWMor7eJHd3cYVB+gs78L2Z9F7+nvav/l9cpUxfM1ccbs6VyprbVKjNeXWf/6j7FAePJZ485o54Sn4uGAo03+tCSlk1NvYdKc6F75+stVZYU78ruMo/CEXT+SuI+J3n2va7sOkjT2nb6Dr7+HH3MHr/vtvsP90uFiysA8/eu3lL+DGNU9jOnsLW6uWDeYVnd9l0pxsm1z+95keKr9GzLrjY9lYOzrcZOa31JKxQi1xxLttixnF/z7xSwy+BPjfff74E76eHp48QOTguJH9Vqav44K15L97O++beXlrj8KA3/ni9U6to92J6/48f2LLHzIKL1ZFv/t4Xiua343nFDj6Edyv0B53e2uM5/caT222X0R73fKEO/2x7Psx4/pR/Fb70ojBRcfC3yiKk46Yc4NY53789XfjP2IMzkQL14ry7WPyPRu1lUXt54odRvAzj1FZuCDb7+irvUa83kqnXOkL3u7CAQamoY9+R3Yq+FdLdX5wXWK5liy+p/rNx9xuLb3PYsXmtUT1B8voxL7dS5iO7nLZalacl7R38ncZQSqfvZlZQoiFvTeVmFxJrP7DD84Q62veIOk/9mavlkMUtrDobEIxY6rT/F71A74xtFVPfPdz58qNjwvXm3hdqfB6wPT3E0y7ok+0X2oH5dZ/b1hWRoYYuE372q1Xq6K0nOr70Sa/Syurg0rnk7IxYcI5871hKZZvjWWX3aGYuFGu/ZbGTX7jybHYZ2HJUwcb7D4f398v+ePG+GXj3+L22bcFffiDLX8/cF/v/AuXjtQ6cPRWB3Z962HoykzDmPvYc7u/Y3L/Vj68h32YaVhudXQFNhmpv3G2+nf/u/qNibAJ0nEGly9kGgYfHVnah2VtHFC1fNjWzjFeO0dg7V3t8ejWW1gUDgdbGJkq77Wdfc4lxLLutDZ/9sryVjq88fO9rJ1jvJaOwPo8MGs0N/rszaG7h4PttlI9mOu1juLKyfZZ2sdKzd6hIZqHba3cPCcfXrWx+KHlVg/m6iiufHKfJXpzn+J74IZuHpN37hvXnnwci+LhMeTCp3bw353VrPoaZlQ/5Oxcfnx0GrbqswXbL8uQwvljWfM9qwMH1TOy8OFp2MGGKEVw3Vh2OrxqmIbx8Vg2ezTPlY5/aLjhALHkjE1xcFfidXjVaLyBb/4LiEMHc73qUVxZ0YYHrIj2qYULB7eJxkFUm/vY7SOwNo+VEKWr9xYfrQV0V1I4mGtzNZucHXHD6aOfcrefcKtPCJjd7PKMRRz+JzxBLD6DD2fbwYfL2PAt+t7Bi1iust8JpmEgFhALiAXEAmIBxAJiAbGAWOB0nIAVvEUfTMPgM+OPaRgYWUAsIBYQC4gFxAKIBcQCYgGxgFhALCAWQCwgFhALiAXEAmIBxAJiAbGAWEAsIBYQCyAWEAuIBcQCYgGxgFgAsYBYQCwgFhALiAUQC4gFxAJiAbGAWEAsgFhALCAWEAuIBcQCiAXEAmIBsYBYQCwgFkAsIBYQC4gFxAJiAbEAYgGxgFhALCAWEAsgFhALiAXEAmIBsYBYALHA0WJJdyrX9HfrFfy2E+5pTi9i/Tii9WX0LwTTsFKN7mPEUp11ZakYuzKIZXgkMbAglsrAEkYRxAJi2YFnwxBLfxZW2pvXClew+YuSv+FohfNb9UXJjMpIYmjBNGxqkp4hw8jSm3C98jC2YJ9laAB5pJHSwDQMxLLW7r19FMTy7n4MiKU7sPSHFvv3iGXa0KIVLmCtp47br9Pnc3xp/hPEAqZhgFhALCAWEAuIBcQCYgHEAmIBsYBY4Iy2O27Y8/MsUbw8Zi2jyVs/uUIszRDi31evLfvx4bC49Y9mUT+8Re9IZKt99NIhNfhgLPn4BEvec/GZYuyzDLVSmSblwJiQG31UPwe/94mUPXyIpT1nipGtY6cJUB5uy0ytiKWWRbx161vxc5wrfrTTpsvnRpaFG+cndrXt3vPRHfyhEWXvR/F8/Te2Xku0/53l+2Cfn4izxVJ6CH89NdZ9UP85D+WCgyN3t8ns7jcNHX+pss7edl654LWWbDxCZPfCVhnhiFBiGZrbbPfk8eNp6uy8EvO6YMkyW898Fy+4b/TPS5q/4fPfkY2uUiD2WUpzrxx6JB+ai809OHLjaersXjDjB26u85FZVC/4t5K4P8mQU37EcKQpscyvZfVd7fbT1DMnOOV19p757lyQ3TnVyDAVSx4G+IpYHtOgkRFjjeehsrAbscq++npPSRhTxDL+aF965S3rG+C9ndUegKdspOV1RncRYcNns1juW1Xl5cmNX0187+XxCQNLdmZoZlffZu2njv89b7pkpjXz2ePs3XrB807hdH58MJbf7fa1Cfa2x87WuXRjLT9JPS0XgXCQWDq1NPcRSg/kudJWHLfpuaRyOEYsc16KzBWf1XrkEjuuEzv468rbTltn9fkFOEMs3efB6jsw059gql9zwpO85XX2FtlfR+sSb/MSyzvjR04KZ6PBy3DCWUeWWHijXPuak5c0YWgZmWYKViwblrP8mah4bZuZnZ2hGFxtdZ3NRdYv6M3CGiedjU0eQjiMP7F+FdnZSYnivytbT0zb0gq7QVHYlSgcd6m6zuobKFsXPN4uGr3lRfOnaK0nhn8iTmK9tz09t6DuQ2zrqdru07a9D29VP2PY+052Cq1cJXq3qa+z9znG8gW1hQ48IxC1n4hvjMUp7xELsNcOPogFxAKIBcQCYgGxgFhALCAWQCwgFtjXuqec+PnP5Hdmbv6xDp8b4bCxPE5nEiMf+xjtrckGz1Gsez7TeD2gNz6zmFF6qC8fHyWj/c03RgcHYOGo+yyf2zY/d6AIh6gQy9pbVBamVLnWtlY7qEpuvjE7nItY3p7ZPf6bg4/DMXDjVXZZzMFY1xZHd+l/3Ttcyv0kk0Mb9MChJxrnEK4e5qKwgtLRKspftg9B0fzH6+dIUX6bzU/t/TsdireXEf/NeponkLwfkT8m7yvl40hgMf5l/zTdcf89niuesWZMw/ojQQ4OERlvtfLccB9fLRr4ovxlPr8c2g/JCddBLBNryQnxLNnsorTXc5uzXefQ/pO9IHbewS+e2/t332Hd8z3+ri1mLiMaN6t+adhgl1j+bXmTnk999xTFufUKYONY2oNLrHg+uvzRXIcG2N3qZyvO0r5Ddt/pkgsibK9j8KD1aUDh+LFMO1124xWTRacBH30++s0VwPbTsPrOxboP9RE3uyNcKJbXCxntVziydeKTXL7wkd17u/gcNJbcMrrWMwX5/jJqX3pRnn1HlpHNbeEpimdku+IKDEtsF0v5rcXxbn2tE0fmbf7riM+XgLL25a1zqsjRN7WZ4n2ZVU+TF915zGtby+Z54rrvH+62VLg0m5cMvn24voK8Fb5Vud3z/cX3i/tvrCzdBrHMGlRsO4gF7LMAYgGxgFhALCAWEAsgFhALiAXEAifhzF/wgVic+YtLc+Yv2H2fxZm/EMv7W5QzfyGW8szu8V9n/uJSnPmr9KUzf1HgzF/O/MXu0zBn/kIsc2px5i/EMnVbcuYvxDKpFmf+QixLBhdn/uJanPkLPhSLM39hGvbuvrkzfyGW4Yd3Z/5CLAODyAbROfMX1xxZnPkLsczfupz5i+tw5q/y7Zz5iw1jceYvxAJstYMPYgGxAGIBsYBYQCwgFhALIBYQC4gFPmu1A1a0Ptnh3Zlc0AZn/mof8R5Mw4YD3OwjhD6byLX2WTarxZEoudwOvo+nYwd/8cyp8/H59n7N+KfoXx+iz/bCWh+GdyQjTraD39vdbx3I4udf2bukcWbw9lbf/jLbFcXrkMd5PwayWDjZNKwXTWte1jvTUPuIldE76l1UFxytxSqFM8dS2aPpztLeWIwzoXKNfZbXsfBqx7NvHi2vuslHeUdowvXg1CPLgucH4PIjy7t1/Oy0185bpCK+PJbs7PvXT/NlzsVVpmGxzg0jjCJcOpZc8YZO84Ud/O0HKTh8LP2zp1TfiTL8NrLqOye9+4xrxOI9Wohl0g5HNlvpnVOrOEa8TsIVrfN73eqn+eqeDgy23huIVTsp7mP03nVcPoNW732Vjbcax8DC4lY7gxgcMhYwDQPEAmIBsYBYQCwgFhALIBYQC4gFxAJn8/cUP2XrXcnwGRu/RX/4+N9RXVZ0Fh231kdi2h9hERHniqV25q/O4cKbn18pbeWF7xSOCp5xKy8fzrXP0j3zVxauUYu0/51sHtg1q4XCOXfwVzyaROEjylrhQrEUPyu/7uLhIrFsNMyYhHHBWDqnKsp1cnCwMK49smy3jRtYuFwsJmGI5QC7LXCxkWWLWgwsXHMaZmxBLPZYEMsag8mGQ4tWuEosudJErH0rhfAd07BVxxbZcJVYittybLYuOG0sKz7uN8ej7JzDBc4bS+HMX28PLa1TgWmFz9nhY8X1T0oWAsryQnysmAvFsilnwUMsM5NRC2LZ/XkDuHYsDiCGWIwuiAWuw7GOQSwgFhALiAXEAt/jwCcz6r4J8/gLxsjyIZu9BOS1JT47srTeGDzw2P3GK/CNVTTe9uIlfc4WSzS32miem+u2wSq2WQEcdRr2zofntcL1d/BjjVSaragGO/jGFb5oZHns52d/zz8fX70OQVE9B/hQK+0FRnlBOfTMQ/Oi3kLS0MVrErPBqb0b2/PPZRnFA7Nk95AU2TweRdQ27OiOK60Fttf1u8j2gS6il0fvx3supLM0TMP2mDINH43yd4OMziGPah1nTF3Xb37R7Sr6lzR/vOdCJvzkiGWTPfoJV8qp8U1aV94WPZkQnjrgsDv4s85tn2udzLV1ifGDc8Qyd6CyWfMRB3kj5YztP9Izx3xzLHO2frVgGrb2TMyr/Hx9LDNqyZujvvLVscypJbXChWLpbPpTSphWS2b8qN/oeYnX6dk1ltY5utbY9PLNWnLJguF4I0tjc28+wL++HA5u6tjy61ZZ8OMSAwsTNtk1N5J8vle3dYKvKPzj+e3WG12aZ/bqv5WyeePHvwdX0T+NWGHB/Z+i+gMjlnVzOc6mleX3/8MyK78oeaRN8jWuhJ0UTr3PAmI55nTTn5qD7bMcSjqyGGKZudsiFcQC9llALCAWEAsgFhALiAXEAmIBsYBYALGAWEAsIBYQC4gFxAKIBcQCYgGxgFhALIBYQCwgFhALiAXEAmIBxAJiAbGAWEAsIBZALCAWEAuIBcQCYgGxAGIBsYBYQCwgFgAAgJVEuA/ADj6IBcQCYgGxgFgAsYBYQCwgFhALiAXEAogFxAJiAbGAWEAsgFhALCAWEAuIBcQCYgHEAmKBzf11F7CpvP9/dC6Y+/X0GxhZuFg83a9z5HqzFyAWsM8CYgGxgFgAsYBYOIuofB0j15u9gA1+dGcrZlO5dl1ZiyO3rsbIAmIBsYBYQCwgFhALbCsq/7/agjf4kb3Owqa6r37k2Eaeu238RhYQC4gFxAJiAbEAYuGYTvTahYPs8Vk5tx6fZwHTMBALiAUQC4gFxMLVeZ0FJkbSe51l7PMs1Rtunp2RBcQCYgGxgFhALCAWoMNxw9jW2PlZJn8spfb6y36vtxhZQCwgFhALiAXEAmIBOnyehX2Mnp+lKyd+P7K9AiMLjESTYgH7LGCf5UNjcYzNeCvvNYr6yD727qT2NbK6qrGfZeAgvcsW+sYK21fyzsGrxZJv3Sbrm2FO31qy+9WSG3ZvtnihS1f47r0qlsuF8rhZPP6R/QEiSt8aE42faOINs3O7/s0WLPS9FWrlkvssme+2cn9gze634vGfORtNtKY2uex2udJCF69QK5cdWWLJnzUb20rkyEYy+dH8cb3IJZvu83bt9S1d6OIVbtbK6H7SY0cxpi4gR74WS++vXt+Mxu71QhHtb0V/JjbjL7H0duss9N0VxqfGlly2m7hgAd81Dds0wv1vPjgviu1+z8Jo6mmwK07DNq5m8k5+HDDaN2ZMWhHL0pH9sIPYJivUyvdNw2JGGLHxtr37wPPGCj0RZp9l943ivDMzA4tYuttCPv8Tq2aVW2yquVcbJmH2Wfr77a/t4iBjQG6x0Lkr3KyVqS+PRO2nG13A5pH/uczDSMz4RgxfYcEFvU0wlm7ssepC566w00qs//fJytej6xxdwOab8heMLKV3C0b53bwx/H6p4WWOb9WL3wy5fKEzV2jn/itjab3pqz+3aNQykEbOWWb93fQjP8tQEcsWunSFaef+i3fwI8qvUrfegZmjpzWctMzBJY7fLsemErMXumSFWvneWG7l93RkZ38wi/PizDnL/Nk2n5tn5bYxtGNd3Ed9b6EzV+iJsG+PpbDB3D8DGDFQy7+3/8esWtrPyczesIdWt3ihc1aoFbEM7IlE3AaeUln4XOSiz57kyOrW/UBLcYV27sd8wVPH3WfwW3P16N38sQk1N6UYW+a73xvfs958hTn/jl3095n6/4sXsJ1vfSPlq43+J3bj3c1l8jPQ01tZsNB3V7jZeD78dc5dUPUFGNOw1f9ocYgfKa69Qvssl5+/7TSNzw/EiWnY3jWttenG3q3E6G+Zt5vxx8hy7GmhccXI8vndgHj3djO/N+1nGXoAX7rQxSvk60eWLGw2k97rmgsfnnPRIqf9FnMXahwxsqy455HD2+AWH97tvnUg11hq7L3CN/8eOfz/B9zFvHAsGeVtvnPIlpx6u6nfK40BQ7eb9EvMXejiFe73oFV/uXThGOnDX9MnWeUneAobWeuvVHoDYwxsZjEwI2od7zWm3C7H/+jzF/rmCkdnfQd54N9/yz11LDn5Huxsf5Pfl754Dhax/I8cKy90/gpzw43yxLFcdRrWPAZyDH679zheHaqGlhmDH9PKZX/hpQtdvEJuCx8BYYPhf7UTwuy/5XpREsQCYoGP8EZKdto7HtuHGb3C1H0dn2cB0zAQC4gFxAKIBcQCe/E6C/sYPapX7bwrtcvfPrybkQXEAmIBsYBYQCyAWOBdf3wGn4+K1Y+Z6fMsXNSJji8rFhALiAXEAmIBscD3cKxjMLKAWEAsIBYQC4gFEAuIBcQCYgGxgFhALIBYQCwgFhALiAXEAogFxAJiAbGAWEAsIBZALCAWEAuIBcQCYgGxAGKBFf1dYyHpfuQ4Njvzo5EF9hxZOP6j4tfYcJpjZAGxgFhALCAWuIBTPRtWeKooZ10hhm/k9SIGt781nqvMnXvJ1maes64QpR84Sr9EfCIeTx2/vzFudh/+OdtfJ3pfxrwrRGmT7IYREXGEX48j3Ydnf1Hy53FkcAgoXyHS9sr37eDn2PadMwPIf2waXC+W8T2LNHwglunbfnTjUQvfGMvsocUci2/cwZ+yx96/QsaEW3ydbI/D2bvjWhfXri6WK1JLb6ramqD++zKqF1cvNw274oOo3ZbRXb8Yurh6uVgOvunPfPbYqDJlDy/GL65eLpaLP5AaWpqbf8bIxdXLxWIi9r2PH+Hh5qtHFrWMTMR6I0Xl4urlYrnk3JzyzGr04urlYrHb8kX3SMaUi6uXi8VE7GvumuLGX7m4erlYTMRMxL5zIuYz+IaW4j0SUy+uXi6W844SaSK2wv2Z3zxIXyKWWHwFtajFNMxuyxv3Sfn4A5WLq5eL5VKzMLst5Y2/eI9VLq5eLpaLDi1qKT18eEbsgrHEW1cwESuNFDHx4urlYjlsK/nWFejPqjp3WuXi6uViueYei47m3jXf+ozY+WOJsT/S6BXU0h8ppn20pXr5Nf09fyrvz8HSDr6hZIKzHeu4vTsZ/VFj7ApRfSfHwGIO9GTFxq1E70eJ6sXVy4+wjWyy4DMdRX+tU07cColldSH5LbG0DmaU5Z+scTdVrv7pWlIs38KE8MCxeNcxiAXEAmIBsYBYQCyAWEAsIBYQC4gFxAJiAcQCYgGxgFhALHB5f90Fh+JwBkYWEAuIBRALiAW2tMqzYQ6juALPgxlZQCwgFkAsIBYQC4gFxAJiAbEAYgGxgFhALCAWEAsgFhALiAXEAmIBsYBYALGAWEAsIBYQC4gFEAuIBcQCYgGxgFhALIBYQCwgFhALiAXEAmIBxAJiAbGAWEAsIBZALCAWEAuIBcQCYgEAANhFhPvgGNJdsNY2bQcfjCxwDkYWEAuIBcQCYgGxgFgAsYBYYFN/V1nK7/ua4t8/4nFJVK5w6135ef3n1W69hRRv2Lx+58KBKw//DMM//MRV3Hq/1+gNo3c/3Hq/flQW2F9j/x4buKOmXGHuzzDl1yzet7fSMvt/sv5KjSxgGgZiAbGAWACxgFhALCAWEAuIBRALiAXEAmIBsYBYQCyAWEAsIBYQC4gFxAKIBcQCYgGxgFhALCAWQCwgFhALiAXEAmIBsQBiAbGAWEAsIBYQCyAWEAuIBcQCYgGxgFgAsYBYQCwgFhALiAXE4i4AsYBYQCwgFhALiAUQC4gFxAJiAbGAWEAsgFhALCAWEAuIBcQCiAXEAmIBsYBYQCwgFkAsIBYQC4gFxAJiAbEAYgGxgFhALCAWEAsgFhALiAXEAmIBsYBYALGAWEAsIBYQC4gFEAuIBcQCYgGxgFhALIBYQCwgFhALiAXEAmIBxAJiAbGAWEAsIBZALCAWEAuIBcQCYgGxAGIBsYBYQCwgFhALiMVdAGIBsYBYQCwgFhALIBYQC4gFxAJiAbGAWACxgFhALCAWEAuIBRALiAXEAmIBsYBYQCxASYT7AIwsIBYQC4gFxAJiAcQCYgGxgFhALCAWEAsgFhALiAXEAmf1112wjfz5j4+hiuV7tvafzT1fl8VYDc8b/fe/XLLKGI4tWxdm90cS56Z8Bn9ow71vva//e26bzW+Xb9T/7qS1xtCmn/8WH5WvjGT2WT7XSmfji9cw8/x2NkeU0o26o860AW0gpXits/FVpr+ZWI41Dpc35ilb6uStOce/k/2vwhRBLGecpb653eZgrI2RKzyHsK8/7uzhTbP972hcHJ2xJno3uk+SmtfJ1sWNJwTuF0VnZZXd/+h8dSveorQCjCxbhDLyEJ/37TXiMQ3q3yjvM7DndSJa86iIRmXPL1bc/+ivALFsUksOjzq956u6N8oo7kvk76W5JFPEctBJWM7cvejcKMrX60zm7s9nRXUutc6TEl6FEcu2O/dZzaQcU+FGsXjzRiwX2HHJekxzp1H3NDKGx6y3hxYDi1i2n4qVW6nvjMeGkSKW08jiE8orPPJnjNYSrX/G9J+isALEsmIVudeNirOuGLha5YX8mU9FIJZtZ2LZf4Ir5tyovoqYUEvlpfuY9DsYWMSy6Yyr+3ic3Zfps7UL3b9RtvZvcnGkz8uy8cbk9lfs8MDpvh6auHR2HqI7r+m+P775KZR8vbvldZ1HXtla4H2Hov0ZltJeRvXzLDk8zthjEcuXJDv7yYRlt8I0DIwsYGQBsYBYQCyAWEAsIBYQC4gFxAJiAcQCYgGxgFhALCAWEAsgFhALiAXEAmIBsQBiAbGAWEAsIBYQC4gFEAuIBcQCYgGxgFgAsYBYQCwgFhALiAXEAogFxAJiAbGAWEAsIBZALCAWEAuIBcQCYgHEAmIBsYBYQCwgFhALIBYQC4gFxAJiAbEAYgGxgFhALCAWEAuIBRALiAXEAmIBsYBYQCyAWEAsIBYQC4gFxAKIBcQCYgGxgFhALCAWQCwgFhALiAXEAmIBsQBiAbGAWEAsIBYQCyAWEAuIBcQCYgGxgFgAsYBYQCwgFhALiAUQC4gFxAJiAbGAWEAsgFhALCAWEAuIBcQCYgHEAmIBsYBYQCwgFkAsIBYQC4gFxAJiAbEAYgGxgFhALCAWEAsgFhALiAXEAmIBsYBYALGAWEAsIBYQC4gFxAKIBcQCYgGxgFhALIBYQCwgFhALiAXEAmIByv4PwWms3AV97VoAAAAASUVORK5CYII=" } } }, "schema": { "$ref": "#/definitions/InvoiceResponse" } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "409": { "description": "The resource specified conflicts with the current state", "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "422": { "description": "Unprocessable Entity. Unable to process the contained instructions", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } } } }, "get": { "tags": [ "shipmentProcessing" ], "description": "Retrieve invoices for the shipment you specify.", "operationId": "retrieveInvoice", "parameters": [ { "name": "shipmentId", "in": "path", "description": "The ID of the shipment whose invoice you want to retrieve.", "type": "string", "required": true } ], "responses": { "200": { "description": "Success.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "examples": { "application/json": { "document": { "format": "PDF", "content": "iVBLRw0KGgoAAAANSUhEUgAAAywAAATCCAMAAABouZLTAAAABlBMVEUAAAD///+l2Z/dAAAACXBIWXMAAB84AAAfOAGTPyf1AAAfLklEQVR42u3dCXajShZAQb2u2v+WX3+XNTBkMgkQoIhz+ndZlsCWucpEA0TcgCn+5y4AsYBYQCwgFhALiAUQC4gFxAJiAbGAWEAsgFhALCAWEAuIBcQCiAXEAmIBsYBYQCwgFkAsIBYQC4gFxAJiAbEAYgGxgFhALCAWEAsgFhALiAXEAmIBsYBYALGAWEAsIBYQC1zaX3fBeaW7YCVhZAHTMDANY4vpw6cninGGH9LIAqZhIBYQC4gFxAKIBcQCYgGxgFhALCAWQCwgFhALiAXEAmIB9vkM/s9nnGPuDTq3KFw0/4doLODt5SGWFft4bI358/85Z8OM/jEEnhflwm28s8xw0C0OEku8Nur0CL6rvDUeqCrXiCmjf94aS8qxha71w0f1Qbd2te4kofOgeLJpmBnPrqnct+0s3uc5XFhh8P1dSmz/mJe1X+aWnd8le9fJ3GMLO90OfoTuxh+Worj1ZdZaiQmL3fR+L/1ozz6j/th7v07scixbB9m7aDJZaCBuy7epjM0Tz0orE0ejjLPHku1f+zGwZ2ucb06YC89aFean2Xr+4HlXx6256NcfIIbm5r3Lvm4va8pmtvs9ku+Vd8ZYor3pxXPrbXSSjT9YtobU3yfSGvPR1u0fs+loXbOxzMfFr60h+3uRvXWcfxJ2rEFjhVaisnufrX2qzX+PA0zD8reO1zZ/n0Q8voqcdNe2rpnN0SeetWR/tJ++DrqbcuMpgE2eLTtaxAfYwY9bc5YWE4fkZw1ZeqIkynd1DAzxeb3nEKb9GvMfkH92xuP3OajmBRG3zP2TXWXmdvod/On7DtVrRm3f9+r7J9O3m/FWMor7eJHd3cYVB+gs78L2Z9F7+nvav/l9cpUxfM1ccbs6VyprbVKjNeXWf/6j7FAePJZ485o54Sn4uGAo03+tCSlk1NvYdKc6F75+stVZYU78ruMo/CEXT+SuI+J3n2va7sOkjT2nb6Dr7+HH3MHr/vtvsP90uFiysA8/eu3lL+DGNU9jOnsLW6uWDeYVnd9l0pxsm1z+95keKr9GzLrjY9lYOzrcZOa31JKxQi1xxLttixnF/z7xSwy+BPjfff74E76eHp48QOTguJH9Vqav44K15L97O++beXlrj8KA3/ni9U6to92J6/48f2LLHzIKL1ZFv/t4Xiua343nFDj6Edyv0B53e2uM5/caT222X0R73fKEO/2x7Psx4/pR/Fb70ojBRcfC3yiKk46Yc4NY53789XfjP2IMzkQL14ry7WPyPRu1lUXt54odRvAzj1FZuCDb7+irvUa83kqnXOkL3u7CAQamoY9+R3Yq+FdLdX5wXWK5liy+p/rNx9xuLb3PYsXmtUT1B8voxL7dS5iO7nLZalacl7R38ncZQSqfvZlZQoiFvTeVmFxJrP7DD84Q62veIOk/9mavlkMUtrDobEIxY6rT/F71A74xtFVPfPdz58qNjwvXm3hdqfB6wPT3E0y7ok+0X2oH5dZ/b1hWRoYYuE372q1Xq6K0nOr70Sa/Syurg0rnk7IxYcI5871hKZZvjWWX3aGYuFGu/ZbGTX7jybHYZ2HJUwcb7D4f398v+ePG+GXj3+L22bcFffiDLX8/cF/v/AuXjtQ6cPRWB3Z962HoykzDmPvYc7u/Y3L/Vj68h32YaVhudXQFNhmpv3G2+nf/u/qNibAJ0nEGly9kGgYfHVnah2VtHFC1fNjWzjFeO0dg7V3t8ejWW1gUDgdbGJkq77Wdfc4lxLLutDZ/9sryVjq88fO9rJ1jvJaOwPo8MGs0N/rszaG7h4PttlI9mOu1juLKyfZZ2sdKzd6hIZqHba3cPCcfXrWx+KHlVg/m6iiufHKfJXpzn+J74IZuHpN37hvXnnwci+LhMeTCp3bw353VrPoaZlQ/5Oxcfnx0GrbqswXbL8uQwvljWfM9qwMH1TOy8OFp2MGGKEVw3Vh2OrxqmIbx8Vg2ezTPlY5/aLjhALHkjE1xcFfidXjVaLyBb/4LiEMHc73qUVxZ0YYHrIj2qYULB7eJxkFUm/vY7SOwNo+VEKWr9xYfrQV0V1I4mGtzNZucHXHD6aOfcrefcKtPCJjd7PKMRRz+JzxBLD6DD2fbwYfL2PAt+t7Bi1iust8JpmEgFhALiAXEAmIBxAJiAbGAWOB0nIAVvEUfTMPgM+OPaRgYWUAsIBYQC4gFxAKIBcQCYgGxgFhALCAWQCwgFhALiAXEAmIBxAJiAbGAWEAsIBYQCyAWEAuIBcQCYgGxgFgAsYBYQCwgFhALiAUQC4gFxAJiAbGAWEAsgFhALCAWEAuIBcQCiAXEAmIBsYBYQCwgFkAsIBYQC4gFxAJiAbEAYgGxgFhALCAWEAsgFhALiAXEAmIBsYBYALHA0WJJdyrX9HfrFfy2E+5pTi9i/Tii9WX0LwTTsFKN7mPEUp11ZakYuzKIZXgkMbAglsrAEkYRxAJi2YFnwxBLfxZW2pvXClew+YuSv+FohfNb9UXJjMpIYmjBNGxqkp4hw8jSm3C98jC2YJ9laAB5pJHSwDQMxLLW7r19FMTy7n4MiKU7sPSHFvv3iGXa0KIVLmCtp47br9Pnc3xp/hPEAqZhgFhALCAWEAuIBcQCYgHEAmIBsYBY4Iy2O27Y8/MsUbw8Zi2jyVs/uUIszRDi31evLfvx4bC49Y9mUT+8Re9IZKt99NIhNfhgLPn4BEvec/GZYuyzDLVSmSblwJiQG31UPwe/94mUPXyIpT1nipGtY6cJUB5uy0ytiKWWRbx161vxc5wrfrTTpsvnRpaFG+cndrXt3vPRHfyhEWXvR/F8/Te2Xku0/53l+2Cfn4izxVJ6CH89NdZ9UP85D+WCgyN3t8ns7jcNHX+pss7edl654LWWbDxCZPfCVhnhiFBiGZrbbPfk8eNp6uy8EvO6YMkyW898Fy+4b/TPS5q/4fPfkY2uUiD2WUpzrxx6JB+ai809OHLjaersXjDjB26u85FZVC/4t5K4P8mQU37EcKQpscyvZfVd7fbT1DMnOOV19p757lyQ3TnVyDAVSx4G+IpYHtOgkRFjjeehsrAbscq++npPSRhTxDL+aF965S3rG+C9ndUegKdspOV1RncRYcNns1juW1Xl5cmNX0187+XxCQNLdmZoZlffZu2njv89b7pkpjXz2ePs3XrB807hdH58MJbf7fa1Cfa2x87WuXRjLT9JPS0XgXCQWDq1NPcRSg/kudJWHLfpuaRyOEYsc16KzBWf1XrkEjuuEzv468rbTltn9fkFOEMs3efB6jsw059gql9zwpO85XX2FtlfR+sSb/MSyzvjR04KZ6PBy3DCWUeWWHijXPuak5c0YWgZmWYKViwblrP8mah4bZuZnZ2hGFxtdZ3NRdYv6M3CGiedjU0eQjiMP7F+FdnZSYnivytbT0zb0gq7QVHYlSgcd6m6zuobKFsXPN4uGr3lRfOnaK0nhn8iTmK9tz09t6DuQ2zrqdru07a9D29VP2PY+052Cq1cJXq3qa+z9znG8gW1hQ48IxC1n4hvjMUp7xELsNcOPogFxAKIBcQCYgGxgFhALCAWQCwgFtjXuqec+PnP5Hdmbv6xDp8b4bCxPE5nEiMf+xjtrckGz1Gsez7TeD2gNz6zmFF6qC8fHyWj/c03RgcHYOGo+yyf2zY/d6AIh6gQy9pbVBamVLnWtlY7qEpuvjE7nItY3p7ZPf6bg4/DMXDjVXZZzMFY1xZHd+l/3Ttcyv0kk0Mb9MChJxrnEK4e5qKwgtLRKspftg9B0fzH6+dIUX6bzU/t/TsdireXEf/NeponkLwfkT8m7yvl40hgMf5l/zTdcf89niuesWZMw/ojQQ4OERlvtfLccB9fLRr4ovxlPr8c2g/JCddBLBNryQnxLNnsorTXc5uzXefQ/pO9IHbewS+e2/t332Hd8z3+ri1mLiMaN6t+adhgl1j+bXmTnk999xTFufUKYONY2oNLrHg+uvzRXIcG2N3qZyvO0r5Ddt/pkgsibK9j8KD1aUDh+LFMO1124xWTRacBH30++s0VwPbTsPrOxboP9RE3uyNcKJbXCxntVziydeKTXL7wkd17u/gcNJbcMrrWMwX5/jJqX3pRnn1HlpHNbeEpimdku+IKDEtsF0v5rcXxbn2tE0fmbf7riM+XgLL25a1zqsjRN7WZ4n2ZVU+TF915zGtby+Z54rrvH+62VLg0m5cMvn24voK8Fb5Vud3z/cX3i/tvrCzdBrHMGlRsO4gF7LMAYgGxgFhALCAWEAsgFhALiAXEAifhzF/wgVic+YtLc+Yv2H2fxZm/EMv7W5QzfyGW8szu8V9n/uJSnPmr9KUzf1HgzF/O/MXu0zBn/kIsc2px5i/EMnVbcuYvxDKpFmf+QixLBhdn/uJanPkLPhSLM39hGvbuvrkzfyGW4Yd3Z/5CLAODyAbROfMX1xxZnPkLsczfupz5i+tw5q/y7Zz5iw1jceYvxAJstYMPYgGxAGIBsYBYQCwgFhALIBYQC4gFPmu1A1a0Ptnh3Zlc0AZn/mof8R5Mw4YD3OwjhD6byLX2WTarxZEoudwOvo+nYwd/8cyp8/H59n7N+KfoXx+iz/bCWh+GdyQjTraD39vdbx3I4udf2bukcWbw9lbf/jLbFcXrkMd5PwayWDjZNKwXTWte1jvTUPuIldE76l1UFxytxSqFM8dS2aPpztLeWIwzoXKNfZbXsfBqx7NvHi2vuslHeUdowvXg1CPLgucH4PIjy7t1/Oy0185bpCK+PJbs7PvXT/NlzsVVpmGxzg0jjCJcOpZc8YZO84Ud/O0HKTh8LP2zp1TfiTL8NrLqOye9+4xrxOI9Wohl0g5HNlvpnVOrOEa8TsIVrfN73eqn+eqeDgy23huIVTsp7mP03nVcPoNW732Vjbcax8DC4lY7gxgcMhYwDQPEAmIBsYBYQCwgFhALIBYQC4gFxAJn8/cUP2XrXcnwGRu/RX/4+N9RXVZ0Fh231kdi2h9hERHniqV25q/O4cKbn18pbeWF7xSOCp5xKy8fzrXP0j3zVxauUYu0/51sHtg1q4XCOXfwVzyaROEjylrhQrEUPyu/7uLhIrFsNMyYhHHBWDqnKsp1cnCwMK49smy3jRtYuFwsJmGI5QC7LXCxkWWLWgwsXHMaZmxBLPZYEMsag8mGQ4tWuEosudJErH0rhfAd07BVxxbZcJVYittybLYuOG0sKz7uN8ej7JzDBc4bS+HMX28PLa1TgWmFz9nhY8X1T0oWAsryQnysmAvFsilnwUMsM5NRC2LZ/XkDuHYsDiCGWIwuiAWuw7GOQSwgFhALiAXEAt/jwCcz6r4J8/gLxsjyIZu9BOS1JT47srTeGDzw2P3GK/CNVTTe9uIlfc4WSzS32miem+u2wSq2WQEcdRr2zofntcL1d/BjjVSaragGO/jGFb5oZHns52d/zz8fX70OQVE9B/hQK+0FRnlBOfTMQ/Oi3kLS0MVrErPBqb0b2/PPZRnFA7Nk95AU2TweRdQ27OiOK60Fttf1u8j2gS6il0fvx3supLM0TMP2mDINH43yd4OMziGPah1nTF3Xb37R7Sr6lzR/vOdCJvzkiGWTPfoJV8qp8U1aV94WPZkQnjrgsDv4s85tn2udzLV1ifGDc8Qyd6CyWfMRB3kj5YztP9Izx3xzLHO2frVgGrb2TMyr/Hx9LDNqyZujvvLVscypJbXChWLpbPpTSphWS2b8qN/oeYnX6dk1ltY5utbY9PLNWnLJguF4I0tjc28+wL++HA5u6tjy61ZZ8OMSAwsTNtk1N5J8vle3dYKvKPzj+e3WG12aZ/bqv5WyeePHvwdX0T+NWGHB/Z+i+gMjlnVzOc6mleX3/8MyK78oeaRN8jWuhJ0UTr3PAmI55nTTn5qD7bMcSjqyGGKZudsiFcQC9llALCAWEAsgFhALiAXEAmIBsYBYALGAWEAsIBYQC4gFxAKIBcQCYgGxgFhALIBYQCwgFhALiAXEAmIBxAJiAbGAWEAsIBZALCAWEAuIBcQCYgGxAGIBsYBYQCwgFgAAgJVEuA/ADj6IBcQCYgGxgFgAsYBYQCwgFhALiAXEAogFxAJiAbGAWEAsgFhALCAWEAuIBcQCYgHEAmKBzf11F7CpvP9/dC6Y+/X0GxhZuFg83a9z5HqzFyAWsM8CYgGxgFgAsYBYOIuofB0j15u9gA1+dGcrZlO5dl1ZiyO3rsbIAmIBsYBYQCwgFhALbCsq/7/agjf4kb3Owqa6r37k2Eaeu238RhYQC4gFxAJiAbEAYuGYTvTahYPs8Vk5tx6fZwHTMBALiAUQC4gFxMLVeZ0FJkbSe51l7PMs1Rtunp2RBcQCYgGxgFhALCAWoMNxw9jW2PlZJn8spfb6y36vtxhZQCwgFhALiAXEAmIBOnyehX2Mnp+lKyd+P7K9AiMLjESTYgH7LGCf5UNjcYzNeCvvNYr6yD727qT2NbK6qrGfZeAgvcsW+sYK21fyzsGrxZJv3Sbrm2FO31qy+9WSG3ZvtnihS1f47r0qlsuF8rhZPP6R/QEiSt8aE42faOINs3O7/s0WLPS9FWrlkvssme+2cn9gze634vGfORtNtKY2uex2udJCF69QK5cdWWLJnzUb20rkyEYy+dH8cb3IJZvu83bt9S1d6OIVbtbK6H7SY0cxpi4gR74WS++vXt+Mxu71QhHtb0V/JjbjL7H0duss9N0VxqfGlly2m7hgAd81Dds0wv1vPjgviu1+z8Jo6mmwK07DNq5m8k5+HDDaN2ZMWhHL0pH9sIPYJivUyvdNw2JGGLHxtr37wPPGCj0RZp9l943ivDMzA4tYuttCPv8Tq2aVW2yquVcbJmH2Wfr77a/t4iBjQG6x0Lkr3KyVqS+PRO2nG13A5pH/uczDSMz4RgxfYcEFvU0wlm7ssepC566w00qs//fJytej6xxdwOab8heMLKV3C0b53bwx/H6p4WWOb9WL3wy5fKEzV2jn/itjab3pqz+3aNQykEbOWWb93fQjP8tQEcsWunSFaef+i3fwI8qvUrfegZmjpzWctMzBJY7fLsemErMXumSFWvneWG7l93RkZ38wi/PizDnL/Nk2n5tn5bYxtGNd3Ed9b6EzV+iJsG+PpbDB3D8DGDFQy7+3/8esWtrPyczesIdWt3ihc1aoFbEM7IlE3AaeUln4XOSiz57kyOrW/UBLcYV27sd8wVPH3WfwW3P16N38sQk1N6UYW+a73xvfs958hTn/jl3095n6/4sXsJ1vfSPlq43+J3bj3c1l8jPQ01tZsNB3V7jZeD78dc5dUPUFGNOw1f9ocYgfKa69Qvssl5+/7TSNzw/EiWnY3jWttenG3q3E6G+Zt5vxx8hy7GmhccXI8vndgHj3djO/N+1nGXoAX7rQxSvk60eWLGw2k97rmgsfnnPRIqf9FnMXahwxsqy455HD2+AWH97tvnUg11hq7L3CN/8eOfz/B9zFvHAsGeVtvnPIlpx6u6nfK40BQ7eb9EvMXejiFe73oFV/uXThGOnDX9MnWeUneAobWeuvVHoDYwxsZjEwI2od7zWm3C7H/+jzF/rmCkdnfQd54N9/yz11LDn5Huxsf5Pfl754Dhax/I8cKy90/gpzw43yxLFcdRrWPAZyDH679zheHaqGlhmDH9PKZX/hpQtdvEJuCx8BYYPhf7UTwuy/5XpREsQCYoGP8EZKdto7HtuHGb3C1H0dn2cB0zAQC4gFxAKIBcQCe/E6C/sYPapX7bwrtcvfPrybkQXEAmIBsYBYQCyAWOBdf3wGn4+K1Y+Z6fMsXNSJji8rFhALiAXEAmIBscD3cKxjMLKAWEAsIBYQC4gFEAuIBcQCYgGxgFhALIBYQCwgFhALiAXEAogFxAJiAbGAWEAsIBZALCAWEAuIBcQCYgGxAGKBFf1dYyHpfuQ4Njvzo5EF9hxZOP6j4tfYcJpjZAGxgFhALCAWuIBTPRtWeKooZ10hhm/k9SIGt781nqvMnXvJ1maes64QpR84Sr9EfCIeTx2/vzFudh/+OdtfJ3pfxrwrRGmT7IYREXGEX48j3Ydnf1Hy53FkcAgoXyHS9sr37eDn2PadMwPIf2waXC+W8T2LNHwglunbfnTjUQvfGMvsocUci2/cwZ+yx96/QsaEW3ydbI/D2bvjWhfXri6WK1JLb6ramqD++zKqF1cvNw274oOo3ZbRXb8Yurh6uVgOvunPfPbYqDJlDy/GL65eLpaLP5AaWpqbf8bIxdXLxWIi9r2PH+Hh5qtHFrWMTMR6I0Xl4urlYrnk3JzyzGr04urlYrHb8kX3SMaUi6uXi8VE7GvumuLGX7m4erlYTMRMxL5zIuYz+IaW4j0SUy+uXi6W844SaSK2wv2Z3zxIXyKWWHwFtajFNMxuyxv3Sfn4A5WLq5eL5VKzMLst5Y2/eI9VLq5eLpaLDi1qKT18eEbsgrHEW1cwESuNFDHx4urlYjlsK/nWFejPqjp3WuXi6uViueYei47m3jXf+ozY+WOJsT/S6BXU0h8ppn20pXr5Nf09fyrvz8HSDr6hZIKzHeu4vTsZ/VFj7ApRfSfHwGIO9GTFxq1E70eJ6sXVy4+wjWyy4DMdRX+tU07cColldSH5LbG0DmaU5Z+scTdVrv7pWlIs38KE8MCxeNcxiAXEAmIBsYBYQCyAWEAsIBYQC4gFxAJiAcQCYgGxgFhALHB5f90Fh+JwBkYWEAuIBRALiAW2tMqzYQ6juALPgxlZQCwgFkAsIBYQC4gFxAJiAbEAYgGxgFhALCAWEAsgFhALiAXEAmIBsYBYALGAWEAsIBYQC4gFEAuIBcQCYgGxgFhALIBYQCwgFhALiAXEAmIBxAJiAbGAWEAsIBZALCAWEAuIBcQCYgEAANhFhPvgGNJdsNY2bQcfjCxwDkYWEAuIBcQCYgGxgFgAsYBYYFN/V1nK7/ua4t8/4nFJVK5w6135ef3n1W69hRRv2Lx+58KBKw//DMM//MRV3Hq/1+gNo3c/3Hq/flQW2F9j/x4buKOmXGHuzzDl1yzet7fSMvt/sv5KjSxgGgZiAbGAWACxgFhALCAWEAuIBRALiAXEAmIBsYBYQCyAWEAsIBYQC4gFxAKIBcQCYgGxgFhALCAWQCwgFhALiAXEAmIBsQBiAbGAWEAsIBYQCyAWEAuIBcQCYgGxgFgAsYBYQCwgFhALiAXE4i4AsYBYQCwgFhALiAUQC4gFxAJiAbGAWEAsgFhALCAWEAuIBcQCiAXEAmIBsYBYQCwgFkAsIBYQC4gFxAJiAbEAYgGxgFhALCAWEAsgFhALiAXEAmIBsYBYALGAWEAsIBYQC4gFEAuIBcQCYgGxgFhALIBYQCwgFhALiAXEAmIBxAJiAbGAWEAsIBZALCAWEAuIBcQCYgGxAGIBsYBYQCwgFhALiMVdAGIBsYBYQCwgFhALIBYQC4gFxAJiAbGAWACxgFhALCAWEAuIBRALiAXEAmIBsYBYQCxASYT7AIwsIBYQC4gFxAJiAcQCYgGxgFhALCAWEAsgFhALiAXEAmf1112wjfz5j4+hiuV7tvafzT1fl8VYDc8b/fe/XLLKGI4tWxdm90cS56Z8Bn9ow71vva//e26bzW+Xb9T/7qS1xtCmn/8WH5WvjGT2WT7XSmfji9cw8/x2NkeU0o26o860AW0gpXits/FVpr+ZWI41Dpc35ilb6uStOce/k/2vwhRBLGecpb653eZgrI2RKzyHsK8/7uzhTbP972hcHJ2xJno3uk+SmtfJ1sWNJwTuF0VnZZXd/+h8dSveorQCjCxbhDLyEJ/37TXiMQ3q3yjvM7DndSJa86iIRmXPL1bc/+ivALFsUksOjzq956u6N8oo7kvk76W5JFPEctBJWM7cvejcKMrX60zm7s9nRXUutc6TEl6FEcu2O/dZzaQcU+FGsXjzRiwX2HHJekxzp1H3NDKGx6y3hxYDi1i2n4qVW6nvjMeGkSKW08jiE8orPPJnjNYSrX/G9J+isALEsmIVudeNirOuGLha5YX8mU9FIJZtZ2LZf4Ir5tyovoqYUEvlpfuY9DsYWMSy6Yyr+3ic3Zfps7UL3b9RtvZvcnGkz8uy8cbk9lfs8MDpvh6auHR2HqI7r+m+P775KZR8vbvldZ1HXtla4H2Hov0ZltJeRvXzLDk8zthjEcuXJDv7yYRlt8I0DIwsYGQBsYBYQCyAWEAsIBYQC4gFxAJiAcQCYgGxgFhALCAWEAsgFhALiAXEAmIBsQBiAbGAWEAsIBYQC4gFEAuIBcQCYgGxgFgAsYBYQCwgFhALiAXEAogFxAJiAbGAWEAsIBZALCAWEAuIBcQCYgHEAmIBsYBYQCwgFhALIBYQC4gFxAJiAbEAYgGxgFhALCAWEAuIBRALiAXEAmIBsYBYQCyAWEAsIBYQC4gFxAKIBcQCYgGxgFhALCAWQCwgFhALiAXEAmIBsQBiAbGAWEAsIBYQCyAWEAuIBcQCYgGxgFgAsYBYQCwgFhALiAUQC4gFxAJiAbGAWEAsgFhALCAWEAuIBcQCYgHEAmIBsYBYQCwgFkAsIBYQC4gFxAJiAbEAYgGxgFhALCAWEAsgFhALiAXEAmIBsYBYALGAWEAsIBYQC4gFxAKIBcQCYgGxgFhALIBYQCwgFhALiAXEAmIByv4PwWms3AV97VoAAAAASUVORK5CYII=" } } }, "schema": { "$ref": "#/definitions/InvoiceResponse" } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "409": { "description": "The resource specified conflicts with the current state", "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } } } }, "x-amzn-api-sandbox": { "dynamic": {} } }, "/externalFulfillment/2024-09-11/shipments/{shipmentId}/shipLabels": { "put": { "tags": [ "shipmentProcessing" ], "description": "Generate and retrieve all shipping labels for one or more packages in the shipment you specify.", "operationId": "generateShipLabels", "parameters": [ { "name": "shipmentId", "in": "path", "description": "The ID of the shipment whose shipping labels you want to generate and retrieve.", "type": "string", "required": true }, { "name": "shippingOptionId", "in": "query", "description": "The ID of the shipping option whose shipping labels you want.", "type": "string", "required": false }, { "name": "operation", "in": "query", "description": "Specify whether you want to generate or regenerate a label. For retrieving existing labels, set this value to `GENERATE`", "type": "string", "enum": [ "GENERATE", "REGENERATE" ], "x-docgen-enum-table-extension": [ { "value": "GENERATE", "description": "Generate a new shipping label for the first time." }, { "value": "REGENERATE", "description": "Regenerate a new shipping label. This invalidates the previously generated label, supported only in selected marketplaces" } ], "required": true }, { "in": "body", "name": "body", "description": "Shipping details for when shipping is not done by the marketplace channel.", "schema": { "$ref": "#/definitions/ShipLabelsInput" }, "required": false } ], "responses": { "200": { "description": "Success.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "examples": { "application/json": { "packageShipLabelList": [ { "packageId": "string", "shipLabelMetadata": { "carrierName": "string", "trackingId": "string", "pickupWindow": { "startTime": 0, "endTime": 0 }, "timeSlot": { "startTime": 1612933142, "endTime": 1612494142, "handoverMethod": "PICKUP" } }, "fileData": { "url": "string" }, "status": "FAILURE", "errorDetails": { "code": "00001", "message": "A temporary failure occurred in the SmartConnect product." } } ] } }, "schema": { "$ref": "#/definitions/ShipLabelsResponse" } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "404": { "description": "The resource specified does not exist.", "headers": { "x-amzn-RateLimit-Limit": { "description": "Your rate limit (requests per second) for this operation.", "type": "string" }, "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "409": { "description": "The resource specified conflicts with the current state", "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "413": { "description": "The request size exceeded the maximum accepted size.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "415": { "description": "The request payload is in an unsupported format.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "422": { "description": "Unprocessable Entity. Unable to process the contained instructions", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "429": { "description": "The frequency of requests was greater than allowed.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } }, "503": { "description": "Temporary overloading or maintenance of the server.", "headers": { "x-amzn-RequestId": { "description": "Unique request reference identifier.", "type": "string" } }, "schema": { "$ref": "#/definitions/ErrorList" } } } }, "x-amzn-api-sandbox": { "dynamic": {} } } }, "definitions": { "ErrorList": { "type": "object", "description": "An object containing a list of error responses returned when a request is unsuccessful.", "required": [ "errors" ], "properties": { "errors": { "type": "array", "description": "A list of error responses returned when a request is unsuccessful.", "items": { "$ref": "#/definitions/Error" } } }, "example": { "errors": [ { "code": "InvalidInput", "message": "Invalid request parameter." } ] } }, "Error": { "description": "Error response returned when the request is unsuccessful.", "properties": { "code": { "description": "An error code that identifies the type of error that occurred.", "type": "string" }, "message": { "description": "A message that describes the error condition.", "type": "string" }, "details": { "description": "Additional details that can help the caller understand or fix the issue.", "type": "string" } }, "required": [ "code", "message" ], "type": "object", "example": { "code": "InvalidInput", "message": "Invalid request parameter.", "details": "The specified parameter value is invalid." } }, "Decimal": { "description": "A decimal number.", "type": "number" }, "HandoverLocation": { "description": "The drop-off location details for package handover.", "type": "object", "properties": { "address": { "description": "The address of the drop-off location.", "$ref": "#/definitions/Address" }, "distance": { "description": "The distance from the seller's location to the drop-off point.", "$ref": "#/definitions/Distance" }, "mapUrl": { "description": "URL to the map that shows the drop-off location.", "type": "string" } }, "example": { "address": { "postalCode": "98101", "addressLine1": "123 Main St", "city": "Seattle", "stateOrRegion": "WA", "countryCode": "US", "geocodes": { "latitude": 47.6062, "longitude": -122.3321 } }, "distance": { "value": 3.5, "distanceUnit": "MI" }, "mapUrl": "https://maps.example.com/location?lat=47.6062&lng=-122.3321" } }, "Distance": { "description": "A distance measurement.", "type": "object", "properties": { "value": { "description": "The numerical value of the distance.", "$ref": "#/definitions/Decimal" }, "distanceUnit": { "description": "The unit of measurement of the distance.", "type": "string", "enum": [ "MI", "KM" ], "x-docgen-enum-table-extension": [ { "value": "MI", "description": "Miles." }, { "value": "KM", "description": "Kilometers." } ] } }, "example": { "value": 3.5, "distanceUnit": "MI" }, "required": [ "value", "distanceUnit" ] }, "Geocodes": { "description": "Geographic coordinates.", "type": "object", "properties": { "latitude": { "description": "The latitude coordinate.", "$ref": "#/definitions/Decimal" }, "longitude": { "description": "The longitude coordinate.", "$ref": "#/definitions/Decimal" }, "elevation": { "description": "The elevation in meters.", "$ref": "#/definitions/Decimal" } }, "example": { "latitude": 47.6062, "longitude": -122.3321, "elevation": 56 }, "required": [ "latitude", "longitude" ] }, "Amount": { "description": "An amount of money, including units in the form of currency.", "properties": { "value": { "description": "The amount of money.", "$ref": "#/definitions/Decimal" }, "currencyCode": { "description": "Three digit currency code in ISO 4217 format.", "type": "string" } }, "required": [ "value", "currencyCode" ], "type": "object" }, "DateTime": { "description": "A date and time in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) format.", "type": "string", "format": "date-time" }, "SKU": { "description": "The seller SKU of a product (catalog item). A unique number assigned by the seller when listing an item.", "type": "string" }, "Address": { "description": "The address.", "properties": { "name": { "description": "The name of the person, business or institution at that address.", "minLength": 1, "maxLength": 50, "type": "string" }, "addressLine1": { "description": "The first line of the address.", "minLength": 1, "maxLength": 60, "type": "string" }, "addressLine2": { "description": "Additional address information, if required.", "minLength": 1, "maxLength": 60, "type": "string" }, "addressLine3": { "description": "Additional address information, if required.", "minLength": 1, "maxLength": 60, "type": "string" }, "district": { "description": "The district or state where the person, business, or institution is located.", "type": "string" }, "municipality": { "description": "The municipality where the person, business, or institution is located.", "type": "string" }, "state": { "description": "The state or region where the person, business, or institution is located.", "type": "string" }, "city": { "description": "The city where the person, business, or institution is located.", "minLength": 1, "maxLength": 50, "type": "string" }, "countryCode": { "description": "The two digit country code. In ISO 3166-1 alpha-2 format.", "minLength": 2, "maxLength": 2, "type": "string" }, "postalCode": { "description": "The postal code of the address. It contains a series of letters or digits or both, sometimes including spaces or punctuation.", "minLength": 1, "maxLength": 20, "type": "string" }, "email": { "description": "The email address of the contact associated with the address.", "maxLength": 64, "type": "string" }, "copyEmails": { "description": "The email cc addresses of the contact associated with the address.", "maxItems": 2, "type": "array", "items": { "maxLength": 64, "type": "string" } }, "phoneNumber": { "description": "The phone number of the person, business, or institution located at the address.", "minLength": 1, "maxLength": 20, "type": "string" }, "addressType": { "description": "The type of address.", "minLength": 1, "maxLength": 20, "type": "string" }, "geocodes": { "description": "The geographic coordinates of the address.", "$ref": "#/definitions/Geocodes" } }, "required": [ "postalCode" ], "type": "object" }, "Dimension": { "description": "A dimension of a package.", "type": "object", "properties": { "value": { "description": "The numerical value of the dimension. Must be a positive value.", "$ref": "#/definitions/Decimal" }, "dimensionUnit": { "description": "The unit of measurement of the dimension.", "type": "string", "enum": [ "CM", "M", "IN" ], "x-docgen-enum-table-extension": [ { "value": "CM", "description": "Centimeters." }, { "value": "M", "description": "Meters." }, { "value": "IN", "description": "Inches." } ] } }, "required": [ "value", "dimensionUnit" ] }, "Weight": { "description": "The weight of a package.", "type": "object", "properties": { "value": { "description": "The numerical value of the weight. Must be a positive value.", "$ref": "#/definitions/Decimal" }, "weightUnit": { "description": "The unit of measurement of the weight.", "type": "string", "enum": [ "G", "KG", "LB", "OZ" ], "x-docgen-enum-table-extension": [ { "value": "G", "description": "Grams." }, { "value": "KG", "description": "Kilograms." }, { "value": "LB", "description": "Pounds." }, { "value": "OZ", "description": "Ounces." } ] } }, "required": [ "value", "weightUnit" ] }, "Charge": { "description": "A shipment's charge with relevant tax information.", "type": "object", "properties": { "baseCharge": { "description": "The charge value before taxes.", "$ref": "#/definitions/ChargeBreakup" }, "taxBreakup": { "description": "The tax charge details.", "type": "array", "minItems": 1, "items": { "description": "A tax charge.", "$ref": "#/definitions/Tax" } }, "chargeType": { "description": "The type of charge.", "type": "string", "enum": [ "product", "shipping", "gift_wrap", "total", "other" ], "x-docgen-enum-table-extension": [ { "value": "product", "description": "The charge is for the product." }, { "value": "shipping", "description": "The charge is for shipping. " }, { "value": "gift_wrap", "description": "The charge is for gift wrapping." }, { "value": "total", "description": "The charge is the total charge." }, { "value": "other", "description": "The charge is for something else." } ] }, "totalCharge": { "description": "The total charge, including the base charge and taxes.", "$ref": "#/definitions/ChargeBreakup" }, "totalTax": { "description": "The sum of all taxes.", "$ref": "#/definitions/Tax" } }, "required": [ "baseCharge", "chargeType", "totalCharge", "totalTax" ] }, "Charges": { "description": "The charges associated with the shipment.", "type": "array", "minItems": 1, "items": { "$ref": "#/definitions/Charge" } }, "Tax": { "description": "Information about taxes.", "type": "object", "properties": { "type": { "description": "The type of tax.", "type": "string", "enum": [ "VAT", "CST", "IGST", "SGST", "CGST", "UTGST", "CESS", "OTHER", "TOTAL" ], "x-docgen-enum-table-extension": [ { "value": "VAT", "description": "Value added tax." }, { "value": "CST", "description": "Central sales tax." }, { "value": "IGST", "description": "Integrated goods and services tax. India specific." }, { "value": "SGST", "description": "State goods and services tax. India specific." }, { "value": "CGST", "description": "Central goods and services tax. India specific." }, { "value": "UTGST", "description": "Union territory goods and services tax. India specific." }, { "value": "CESS", "description": "Cess tax." }, { "value": "OTHER", "description": "Other type of tax." }, { "value": "TOTAL", "description": "The total tax." } ] }, "rate": { "description": "The rate of the tax.", "$ref": "#/definitions/Decimal" }, "charge": { "description": "Details of individual tax charges.", "$ref": "#/definitions/ChargeBreakup" } }, "required": [ "charge" ] }, "ChargeBreakup": { "description": "The composition of the charge.", "type": "object", "properties": { "baseAmount": { "description": "The base amount charged.", "$ref": "#/definitions/Amount" }, "discountAmount": { "description": "The offer or coupon amount.", "$ref": "#/definitions/Amount" }, "netAmount": { "description": "The total amount after discount.", "$ref": "#/definitions/Amount" } }, "required": [ "baseAmount", "discountAmount", "netAmount" ] }, "MarketplaceAttributes": { "description": "The marketplace attributes associated with the location.", "properties": { "marketplaceId": { "description": "The marketplace ID associated with the location. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).", "type": "string" }, "channelName": { "description": "The channel name associated with the location.", "type": "string" }, "merchantId": { "description": "The ID of the merchant or seller to whom this order is created.", "type": "string" }, "customAttributes": { "description": "Marketplace channel-specific custom attributes for the order. These attributes are not mandatory and each channel can provide them differently.", "$ref": "#/definitions/CustomChannelAttribute" } }, "required": [ "marketplaceId", "channelName" ], "type": "object" }, "PackageDimensions": { "description": "The dimensions of a package.", "type": "object", "properties": { "length": { "description": "The length of the package.", "$ref": "#/definitions/Dimension" }, "width": { "description": "The width of the package.", "$ref": "#/definitions/Dimension" }, "height": { "description": "The height of the package.", "$ref": "#/definitions/Dimension" } }, "required": [ "length", "width", "height" ] }, "TrackingDetails": { "description": "The carrier and tracking details of a package.", "type": "object", "properties": { "trackingId": { "description": "The carrier-provided tracking number that customers can use to monitor the package's delivery progress.", "type": "string", "minLength": 1, "example": "TBA303940590400" }, "carrier": { "description": "The carrier responsible for transporting this package to the customer.", "type": "string", "minLength": 1, "example": "AMZL" }, "shippingService": { "description": "The specific shipping method or service used for delivering this package.", "type": "string", "minLength": 1, "example": "ATS_STANDARD" } }, "required": [ "carrier" ], "example": { "trackingId": "TBA303940590400", "carrier": "AMZL", "shippingService": "ATS_STANDARD" } }, "Package": { "description": "A package that is created to ship one or more of a shipment's line items.", "type": "object", "properties": { "id": { "description": "The ID of the package whose information you want to update.", "type": "string" }, "dimensions": { "description": "The dimensions of the package.", "$ref": "#/definitions/PackageDimensions" }, "weight": { "description": "The weight of the package. The package must weigh at least 5 grams.", "$ref": "#/definitions/Weight" }, "hazmatLabels": { "description": "The optional list of HAZMAT labels applied to the package.", "type": "array", "minItems": 0, "items": { "type": "string" } }, "packageLineItems": { "description": "The list of line items in a package.", "$ref": "#/definitions/PackageLineItems" }, "status": { "description": "The current status of the package.", "type": "string", "enum": [ "CREATED", "PICKUP_SLOT_RETRIEVED", "INVOICE_GENERATED", "SHIPLABEL_GENERATED", "SHIPPED", "DELIVERED", "CANCELLED" ], "x-docgen-enum-table-extension": [ { "value": "CREATED", "description": "The package is created." }, { "value": "PICKUP_SLOT_RETRIEVED", "description": "The pickup slot is retrieved." }, { "value": "INVOICE_GENERATED", "description": "The invoice is generated." }, { "value": "SHIPLABEL_GENERATED", "description": "The shipping label is generated." }, { "value": "SHIPPED", "description": "The package is shipped." }, { "value": "DELIVERED", "description": "The package is delivered." }, { "value": "CANCELLED", "description": "The shipment is cancelled." } ] }, "packageHandlingRequirements": { "description": "Whether the package requires standard handling or extra care.", "type": "string", "enum": [ "NORMAL", "FRAGILE" ], "x-docgen-enum-table-extension": [ { "value": "NORMAL", "description": "The package requires standard handling." }, { "value": "FRAGILE", "description": "The package requires extra care in handling." } ], "example": "FRAGILE" }, "trackingDetails": { "description": "The carrier and tracking details of the package. This field is returned in responses only, and is ignored if it is provided in a request.", "$ref": "#/definitions/TrackingDetails" } }, "required": [ "dimensions", "id", "weight", "packageLineItems" ] }, "PackageLineItems": { "description": "The list of line items in a package.", "type": "array", "items": { "$ref": "#/definitions/PackageLineItem" } }, "PackageLineItem": { "description": "A line item in a package.", "type": "object", "properties": { "packageLineItemId": { "description": "The line item ID.", "type": "string" }, "quantity": { "description": "The number of items of a particular line item of a shipment that are packed into the package.", "type": "integer" }, "serialNumbers": { "description": "The list of serial numbers of items in the package, if required to be provided.", "type": "array", "minItems": 0, "items": { "$ref": "#/definitions/SerialNumber" } }, "pieces": { "description": "The number of pieces of a multi-piece item that are in this package. This is applicable only for items that are shipped in multiple pieces.", "type": "integer", "minimum": 1 }, "countryOfOrigin": { "description": "The country of origin provided by the seller, represented by a two-letter country code in ISO-3166 alpha-2 format. You must pass this field when `countryOfOriginRequirement` is `REQUIRED` in the `getShipment` or `getShipments` response.", "$ref": "#/definitions/CountryCode" }, "itemValue": { "description": "The value of the item being shipped, as provided by the seller. This serves as the basis for import duty/tax calculations. You must pass this field when `itemValueRequirement` is `REQUIRED` in the `getShipment` or `getShipments` response.", "$ref": "#/definitions/Amount" } }, "required": [ "packageLineItemId", "quantity" ] }, "RecommendedPackageLineItem": { "description": "A line item to be contained in a recommended package. This attribute is provided only for orders that come with a specific recommendation of line-item distribution within the package recommendations.", "type": "object", "properties": { "lineItemId": { "description": "An ID for a line item in an order. The line item should be present in the recommended package. This identifier has the same value as the ID of the line item present in the order.", "type": "string", "minLength": 1, "example": "LI1" } }, "required": [ "lineItemId" ] }, "RecommendedPackageLineItems": { "description": "A list of line items to be contained in a recommended package. This attribute is only for orders that come with specific recommendations for line-item distribution.", "type": "array", "maxItems": 50, "items": { "$ref": "#/definitions/RecommendedPackageLineItem" } }, "RecommendedPackage": { "description": "Recommendations for a package", "type": "object", "properties": { "dimensions": { "$ref": "#/definitions/PackageDimensions" }, "weight": { "$ref": "#/definitions/Weight" }, "lineItems": { "$ref": "#/definitions/RecommendedPackageLineItems" } }, "required": [ "weight", "dimensions" ] }, "RecommendedPackages": { "description": "Recommendations for the packages in an order.", "type": "array", "minItems": 1, "items": { "$ref": "#/definitions/RecommendedPackage" } }, "ShipmentLineItem": { "description": "Information about a line item in a shipment.", "type": "object", "properties": { "shipmentLineItemId": { "description": "An identifier for a shipment's line item. This identifier is guaranteed to be unique within the scope of its containing shipment.", "type": "string" }, "merchantSku": { "description": "The seller's identifier for the SKU in this line item.", "$ref": "#/definitions/SKU" }, "numberOfUnits": { "description": "The number of items of the SKU in this line item.", "type": "integer", "minimum": 1 }, "serialNumbers": { "description": "The serial numbers for each item in this line item.", "type": "array", "minItems": 0, "items": { "$ref": "#/definitions/SerialNumber" } }, "pieceType": { "description": "Whether the line item has multiple pieces.", "$ref": "#/definitions/PieceType" }, "hazmatLabels": { "description": "A list of HAZMAT label identifiers that must be applied to the packages for this line item.", "type": "array", "minItems": 0, "items": { "type": "string" } }, "giftAttributes": { "description": "Information about any gift wrapping that is needed for this line item.", "$ref": "#/definitions/GiftAttributes" }, "charges": { "description": "The charges associated with the line item. The charge amount does not include the tax amount.", "$ref": "#/definitions/Charges" }, "cancellations": { "description": "A list of cancellations for the given line item.", "$ref": "#/definitions/Cancellations" }, "hsnCode": { "description": "The HSN code of SKU in this line item.", "type": "string" }, "recommendedCountryOfOrigin": { "description": "The country of origin recommended by the marketplace, represented as a two-letter country code following the ISO-3166 alpha-2 standard.", "$ref": "#/definitions/CountryCode" }, "countryOfOrigin": { "description": "The country of origin provided by the seller, represented by a two-letter country code in ISO-3166 alpha-2 format. You must pass this field when `countryOfOriginRequirement` is `REQUIRED` in the `getShipment` or `getShipments` response.", "$ref": "#/definitions/CountryCode" }, "recommendedCurrencyCode": { "description": "The three digit currency code of the currency recommended by the marketplace, in ISO 4217 format.", "type": "string" }, "itemValue": { "description": "The value of the item being shipped, as provided by the seller. This serves as the basis for import duty/tax calculations. You must pass this field when `itemValueRequirement` is `REQUIRED` in the `getShipment` or `getShipments` response.", "$ref": "#/definitions/Amount" }, "complianceAttributes": { "description": "All necessary compliance attributes specific to the line item.", "$ref": "#/definitions/ComplianceAttributes" }, "customAttributes": { "description": "A list of custom passthrough attributes. For details on these attributes, reach out to your respective program teams at Amazon.", "type": "array", "items": { "$ref": "#/definitions/CustomAttribute" }, "example": [ { "key": "color", "value": "red" } ] } }, "required": [ "charges", "merchantSku", "numberOfUnits", "shipmentLineItemId", "complianceAttributes" ] }, "ComplianceAttributes": { "description": "All necessary compliance attributes specific to the line item.", "type": "object", "properties": { "hazmatLabelsRequirement": { "description": "Whether hazardous material labels must be applied on packages containing this line item.", "$ref": "#/definitions/RequirementLevel" }, "hazmatLabelRequirement": { "description": "Whether a hazardous material label must be applied on packages containing this line item.", "$ref": "#/definitions/RequirementLevel" }, "serialNumberRequirement": { "description": "Whether serial numbers must be provided for this line item.", "$ref": "#/definitions/RequirementLevel" }, "countryOfOriginRequirement": { "description": "Whether the country of origin must be provided for this line item.", "$ref": "#/definitions/RequirementLevel" }, "itemValueRequirement": { "description": "Whether the item value must be provided for this line item.", "$ref": "#/definitions/RequirementLevel" } }, "required": [ "serialNumberRequirement", "hazmatLabelsRequirement" ] }, "GiftAttributes": { "description": "Information about any gift wrapping that is needed for this line item.", "type": "object", "properties": { "giftWrapRequirement": { "description": "When true, the line item must be gift wrapped.", "$ref": "#/definitions/RequirementLevel" }, "giftWrapLabel": { "description": "The label to be printed on the wrapped gift.", "type": "string" }, "giftMessagePresence": { "description": "When true, there is a gift message that must be printed on the wrapped gift.", "$ref": "#/definitions/PresenceStatus" }, "giftMessage": { "description": "The gift message that is to be printed on the wrapped gift.", "$ref": "#/definitions/Document" } }, "required": [ "giftMessagePresence", "giftWrapRequirement" ] }, "Cancellations": { "description": "A list of cancellations for the given line item.\n\n**Note:** Currently, SmartConnect does not support partial cancellation of a shipment or its line items. This list will contain a single value with all the cancellation details.", "type": "array", "items": { "$ref": "#/definitions/Cancellation" }, "minItems": 0 }, "Cancellation": { "description": "A shipment item's cancellation details.", "type": "object", "properties": { "cancelledQuantity": { "description": "The number of items of this particular item which have been cancelled.", "type": "integer", "minimum": 1 }, "cancelledTimestamp": { "description": "The UNIX timestamp of when the line item was cancelled.", "$ref": "#/definitions/DateTime" }, "cancellationType": { "description": "The type of cancellation of the item in the shipment.", "type": "string", "enum": [ "SELLER_REJECTED", "MARKETPLACE_CANCELLED", "SYSTEM_CANCELLED" ], "x-docgen-enum-table-extension": [ { "value": "SELLER_REJECTED", "description": "The seller initiated the cancellation." }, { "value": "MARKETPLACE_CANCELLED", "description": "The marketplace initiated the cancellation." }, { "value": "SYSTEM_CANCELLED", "description": "SmartConnect initiated the cancellation. No further action is required." } ], "example": "MARKETPLACE_CANCELLED" }, "cancellationReason": { "description": "The reason for the cancellation of the shipment.", "type": "string" } }, "required": [ "cancelledQuantity", "cancelledTimestamp", "cancellationType" ] }, "Shipment": { "type": "object", "description": "Information about a shipment.", "properties": { "id": { "description": "The shipment's ID.", "type": "string" }, "locationId": { "description": "The location identifier of the seller's location in the marketplace channel to which the shipment has been created for fulfillment.", "type": "string" }, "marketplaceAttributes": { "description": "The marketplace attributes from which the shipment has been created for fulfillment.", "$ref": "#/definitions/MarketplaceAttributes" }, "shipmentInfo": { "description": "High-level details of the shipment.", "$ref": "#/definitions/ShipmentInfo" }, "invoiceInfo": { "description": "Information about the shipment's invoice.", "$ref": "#/definitions/InvoiceInfo" }, "partyInfoList": { "description": "All involved party identification and metadata for vendor, buyer, seller. Applicable only for direct-fulfillment sellers.", "$ref": "#/definitions/PartyIdentificationInfoList" }, "shipmentRequirements": { "description": "Whether a specific capabilities are enabled/required for the shipment.", "$ref": "#/definitions/ShipmentRequirements" }, "charges": { "description": "The charges associated with the shipment. The charge amount does not include the tax amount.", "$ref": "#/definitions/Charges" }, "status": { "description": "The current status of the shipment.", "type": "string", "enum": [ "CREATED", "ACCEPTED", "CONFIRMED", "PACKAGE_CREATED", "PICKUP_SLOT_RETRIEVED", "INVOICE_GENERATED", "SHIPLABEL_GENERATED", "CANCELLED", "SHIPPED", "DELIVERED" ], "x-docgen-enum-table-extension": [ { "value": "CREATED", "description": "The package is created." }, { "value": "PICKUP_SLOT_RETRIEVED", "description": "The pickup slot is retrieved." }, { "value": "INVOICE_GENERATED", "description": "The invoice is generated." }, { "value": "SHIPLABEL_GENERATED", "description": "The shipping label is generated." }, { "value": "SHIPPED", "description": "The package is shipped." }, { "value": "DELIVERED", "description": "The package is delivered." }, { "value": "CANCELLED", "description": "The shipment is cancelled." } ] }, "subStatus": { "description": "The sub status of the shipment.", "type": "string", "enum": [ "PENDING_SCHEDULE", "PENDING_PICKUP", "PENDING_DROP_OFF", "LABEL_CANCELED", "PICKED_UP", "DROPPED_OFF", "AT_ORIGIN_FC", "AT_DESTINATION_FC", "DELIVERED", "NOT_DELIVERED", "UNDELIVERABLE", "LOST", "OUT_FOR_DELIVERY", "DAMAGED" ], "x-docgen-enum-table-extension": [ { "value": "PENDING_SCHEDULE", "description": "The schedule is pending." }, { "value": "PENDING_PICKUP", "description": "Pickup is pending." }, { "value": "PENDING_DROP_OFF", "description": "Drop off is pending." }, { "value": "LABEL_CANCELED", "description": "The label is cancelled." }, { "value": "PICKED_UP", "description": "The shipment is picked up." }, { "value": "DROPPED_OFF", "description": "The shipment is dropped off." }, { "value": "AT_ORIGIN_FC", "description": "The shipment is at the origin fulfillment center." }, { "value": "AT_DESTINATION_FC", "description": "The shipment is at the destination fulfillment center." }, { "value": "DELIVERED", "description": "The shipment is delivered." }, { "value": "UNDELIVERABLE", "description": "The shipment is undeliverable." }, { "value": "NOT_DELIVERED", "description": "The shipment is not delivered." }, { "value": "LOST", "description": "The shipment is lost." }, { "value": "OUT_FOR_DELIVERY", "description": "The shipment is out for delivery." }, { "value": "DAMAGED", "description": "The shipment is damaged." } ] }, "reason": { "description": "The reason for the sub-status.", "type": "string" }, "lineItems": { "description": "The line items in the shipment.", "type": "array", "minItems": 1, "items": { "$ref": "#/definitions/ShipmentLineItem" } }, "shippingInfo": { "description": "Shipping information for the packages in this shipment.", "$ref": "#/definitions/ShippingInfo" }, "packages": { "description": "The list of packages in the shipment.", "type": "array", "minItems": 1, "items": { "$ref": "#/definitions/Package" } }, "creationDateTime": { "description": "The date and time when the shipment was created.", "$ref": "#/definitions/DateTime" }, "lastUpdatedDateTime": { "description": "The date and time when the shipment was last updated.", "$ref": "#/definitions/DateTime" }, "earliestPackDateTime": { "description": "The time when the shipment becomes eligible for processing.", "$ref": "#/definitions/DateTime" } }, "required": [ "id", "locationId", "marketplaceAttributes", "shipmentInfo", "shipmentRequirements", "charges", "status", "lineItems", "shippingInfo", "creationDateTime", "lastUpdatedDateTime" ] }, "ShippingInfo": { "description": "Shipping information for the packages in a shipment.", "type": "object", "properties": { "recommendedShipMethod": { "description": "The ship method recommended by the Amazon Fulfillment Network for the packages in this shipment.", "type": "string" }, "expectedShippingDateTime": { "description": "The date and time when Amazon expects the seller to ship the packages, in the shipment's local time zone.", "$ref": "#/definitions/DateTime" }, "expectedShippingDateTimeInUTC": { "description": "The date and time when Amazon expects the seller to ship the packages.", "$ref": "#/definitions/DateTime" }, "shipToAddress": { "description": "The address to which the packages must be shipped. Provide only basic information about the buyer's address needed for taxation purposes.", "$ref": "#/definitions/Address" }, "shippingType": { "description": "The type of shipping that the seller uses to deliver a customer order.", "type": "string", "enum": [ "Marketplace", "Self" ], "x-docgen-enum-table-extension": [ { "value": "Marketplace", "description": "Shipping is handled by the marketplace platform." }, { "value": "Self", "description": "Shipping is handled by the seller using their own logistics." } ] }, "recommendedPackages": { "$ref": "#/definitions/RecommendedPackages" } }, "required": [ "expectedShippingDateTimeInUTC" ] }, "ShipmentInfo": { "description": "High-level details of the shipment.", "type": "object", "properties": { "shipmentType": { "description": "The type of shipment.", "type": "string", "enum": [ "NEW", "EXCHANGE", "REPLACEMENT" ], "x-docgen-enum-table-extension": [ { "value": "NEW", "description": "The shipment is new." }, { "value": "EXCHANGE", "description": "The replacing shipment's SKUs are different than the original." }, { "value": "REPLACEMENT", "description": "The replacing shipment's SKUs are the same as the original." } ], "example": "NEW" }, "originalShipmentInfo": { "description": "This field contains details of the original shipment if `shipmentType` is either `REPLACEMENT` or `EXCHANGE`.", "$ref": "#/definitions/ReplacedShipmentInfo" }, "numberOfUnits": { "description": "Total number of units in the shipment.", "type": "integer", "minimum": 1 }, "priority": { "description": "The priority of the order.", "$ref": "#/definitions/Priority" }, "buyerOrderId": { "description": "The buyer's order ID.", "type": "string" }, "orderStatesEligibleForRejection": { "description": "A list of order statuses for which the marketplace allows order rejection (seller cancellation). If the order has a status that does not belong to this list, then seller cancellation is not possible.", "type": "array", "minItems": 0, "items": { "type": "string" } }, "orderPlacedTimestamp": { "description": "The epoch timestamp (in milliseconds) of when the order was placed, in UTC.", "type": "number", "format": "int64" }, "processingSource": { "description": "The source of the order operation.", "type": "string", "enum": [ "EXTERNAL_PLATFORM", "INTERNAL_PLATFORM" ], "x-docgen-enum-table-extension": [ { "value": "EXTERNAL_PLATFORM", "description": "The shipment is not shipped using the SmartConnect platform." }, { "value": "INTERNAL_PLATFORM", "description": "The shipment is shipped using the SmartConnect platform." } ] }, "paymentMethod": { "description": "The payment method for the shipment.", "type": "string", "enum": [ "CASH_ON_DELIVERY", "PREPAID" ], "example": "PREPAID", "x-docgen-enum-table-extension": [ { "value": "CASH_ON_DELIVERY", "description": "The buyer will pay for the shipment during delivery." }, { "value": "PREPAID", "description": "The buyer has already paid for the shipment." } ] } }, "required": [ "shipmentType", "numberOfUnits", "priority", "buyerOrderId" ] }, "ShipmentRequirements": { "description": "Whether specific capabilities are enabled or required for the shipment.", "type": "object", "properties": { "pSlip": { "description": "Whether the packing slip must be attached to the shipment.", "$ref": "#/definitions/PackingSlipRequirement" }, "invoice": { "description": "Whether the invoice must be attached to the shipment.", "$ref": "#/definitions/InvoiceRequirement" } }, "required": [ "pSlip", "invoice" ] }, "PackingSlipRequirement": { "description": "Whether the packing slip is required to be attached to the shipment, and its corresponding status.", "type": "object", "properties": { "requirement": { "description": "Whether the packing slip is required to be attached to the shipment.", "type": "string", "enum": [ "REQUIRED", "NOT_REQUIRED" ], "x-docgen-enum-table-extension": [ { "value": "REQUIRED", "description": "The packing slip is required to be attached to the shipment." }, { "value": "NOT_REQUIRED", "description": "The packing slip is not required to be attached to the shipment." } ] }, "status": { "description": "The status of the packing slip that is attached to the shipment.", "type": "string", "enum": [ "GENERATED", "NOT_GENERATED" ], "x-docgen-enum-table-extension": [ { "value": "GENERATED", "description": "The packing slip is generated." }, { "value": "NOT_GENERATED", "description": "The packing slip is not generated." } ] } } }, "InvoiceRequirement": { "description": "Whether the invoice document is required to be attached to the shipment and its corresponding status. Applicable only for Brazil marketplace.", "type": "object", "properties": { "requirement": { "description": "Whether the invoice document is required to be attached to the shipment.", "type": "string", "enum": [ "REQUIRED", "NOT_REQUIRED" ], "x-docgen-enum-table-extension": [ { "value": "REQUIRED", "description": "The invoice is required to be attached to the shipment." }, { "value": "NOT_REQUIRED", "description": "The invoice is not required to be attached to the shipment." } ] }, "status": { "description": "The status of the of the invoice document that is attached to the shipment.", "type": "string", "enum": [ "PENDING", "AVAILABLE", "NOT_AVAILABLE" ], "x-docgen-enum-table-extension": [ { "value": "PENDING", "description": "The invoice is pending." }, { "value": "AVAILABLE", "description": "The invoice is available." }, { "value": "NOT_AVAILABLE", "description": "The invoice is not available." } ] } } }, "PartyIdentificationInfoList": { "description": "All involved party identification and metadata for vendor, buyer, seller. Applicable only for direct-fulfillment sellers.", "type": "array", "items": { "$ref": "#/definitions/PartyIdentificationInfo" } }, "PartyIdentificationInfo": { "description": "Party identification details for the shipment, applicable only to direct fulfillment shipments.", "type": "object", "properties": { "partyId": { "description": "Assigned identification for the party. For example, a warehouse code or vendor code.", "type": "string" }, "partyType": { "description": "Assigned identification for the party. For example, a warehouse code or vendor code.", "type": "string", "enum": [ "BILL_TO_PARTY", "SHIP_TO_PARTY", "SHIP_FROM_PARTY", "SELLING_PARTY" ], "x-docgen-enum-table-extension": [ { "value": "BILL_TO_PARTY", "description": "The party to whom the bill is sent." }, { "value": "SHIP_TO_PARTY", "description": "The party to whom the shipment is sent." }, { "value": "SHIP_FROM_PARTY", "description": "The party from whom the shipment is sent." }, { "value": "SELLING_PARTY", "description": "The party who is selling the goods." } ] }, "address": { "description": "Address details of the party.", "$ref": "#/definitions/Address" }, "taxInfo": { "description": "Tax registration details of the entity.", "$ref": "#/definitions/TaxRegistrationInfo" } }, "required": [ "partyId", "partyType" ] }, "TaxRegistrationInfo": { "description": "Tax registration details of the entity. Applicable only to direct fulfillment shipments.", "type": "object", "properties": { "type": { "description": "Tax registration type for the entity", "type": "string", "enum": [ "VAT", "GST" ], "x-docgen-enum-table-extension": [ { "value": "VAT", "description": "Value Added Tax registration." }, { "value": "GST", "description": "Goods and Services Tax registration." } ] }, "number": { "description": "The tax registration number for the party. For example, their VAT ID.", "type": "string" }, "address": { "description": "The address associated with the tax registration number.", "$ref": "#/definitions/Address" }, "messages": { "description": "Tax registration message that can be used for additional tax related details.", "type": "string" } } }, "ReplacedShipmentInfo": { "description": "Details of the original shipment if `shipmentType` is either `REPLACEMENT` or `EXCHANGE`.", "type": "object", "properties": { "id": { "description": "The original shipment's ID.", "type": "string", "example": "DNkXsJZJX" }, "locationId": { "description": "The original shipment's location ID.", "type": "string", "example": "ABCD" }, "marketplaceAttributes": { "description": "marketplace attributes for the shipment", "$ref": "#/definitions/MarketplaceAttributes" }, "originalLineItems": { "description": "The line items from the original shipment that corresponds to this shipment.", "$ref": "#/definitions/OriginalLineItems" } }, "required": [ "id", "locationId", "marketplaceAttributes" ] }, "OriginalLineItems": { "description": "The line items from the original shipment that corresponds to this shipment.", "type": "array", "minItems": 1, "items": { "$ref": "#/definitions/OriginalLineItem" } }, "OriginalLineItem": { "description": "A line item from the original shipment that corresponds to this shipment.", "type": "object", "properties": { "replacingSku": { "description": "The SKU ID for this shipment", "type": "string" }, "originalSku": { "description": "The SKU ID for the original shipment.", "type": "string" }, "charges": { "description": "The charge details at the shipment level.", "$ref": "#/definitions/Charges" } }, "required": [ "replacingSku", "originalSku", "charges" ] }, "InvoiceInfo": { "description": "Information about the shipment's invoice.", "type": "object", "properties": { "invoiceId": { "description": "The unique ID of the invoice that corresponds to the shipment.", "type": "string" }, "creationDateTime": { "description": "When the invoice was created.", "$ref": "#/definitions/DateTime" } } }, "RequirementLevel": { "description": "The requirement level for this field.", "type": "string", "enum": [ "REQUIRED", "DISALLOWED" ], "x-docgen-enum-table-extension": [ { "value": "REQUIRED", "description": "This field must be provided." }, { "value": "DISALLOWED", "description": "This field must not be provided." } ] }, "PieceType": { "description": "Whether the item is a single piece or multiple pieces.", "type": "string", "enum": [ "SINGLE", "MULTIPLE" ], "x-docgen-enum-table-extension": [ { "value": "SINGLE", "description": "The item is a single piece." }, { "value": "MULTIPLE", "description": "The item consists of multiple pieces." } ] }, "PresenceStatus": { "description": " Whether the element is present or absent.", "type": "string", "enum": [ "ABSENT", "PRESENT" ], "x-docgen-enum-table-extension": [ { "value": "ABSENT", "description": "The element is not present." }, { "value": "PRESENT", "description": "The element is present." } ] }, "Priority": { "description": "The priority of the order.", "type": "string", "enum": [ "HIGH", "LOW" ], "x-docgen-enum-table-extension": [ { "value": "HIGH", "description": "High priority." }, { "value": "LOW", "description": "Low priority." } ] }, "Pagination": { "description": "An object representing data required for pagination of results.", "type": "object", "properties": { "nextToken": { "type": "string", "description": "A token that you use to retrieve the next page of results. The response includes `nextToken` when there are multiple pages of results. 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. Note that this operation can return empty pages." } } }, "ShipmentsResponse": { "description": "The response of the `getShipments` operation.", "type": "object", "properties": { "shipments": { "description": "A list of shipments.", "type": "array", "minItems": 0, "items": { "$ref": "#/definitions/Shipment" } }, "pagination": { "description": "How to manage multiple pages of data.", "$ref": "#/definitions/Pagination" } } }, "CountryCode": { "description": "A two-letter country code, as defined by the ISO-3166 alpha-2 standard.", "type": "string" }, "SerialNumber": { "description": "The serial number of the SKU in this line item.", "type": "string" }, "PackageDeliveryStatus": { "description": "The delivery status of the package.", "type": "object", "properties": { "status": { "description": "The status of the package.", "$ref": "#/definitions/PackageStatus" }, "subStatus": { "description": "The sub-status of the package.", "$ref": "#/definitions/PackageSubStatus" }, "reason": { "description": "The reason for the sub-status. Refer [table](https://developer-docs.amazon/sp-api/docs/process-shipment#step-6-update-the-package-status) for possible values.", "type": "string", "maxLength": 128 } }, "example": { "status": "DELIVERED", "subStatus": "DELIVERED", "reason": "Delivered Successfully" } }, "ShippingOptionsResponse": { "description": "The response to the `retrieveShippingOptions` operation. The response contains shipping options on a per-package basis from which the seller has to select one shipping option while they retrieve the shipping label. If the particular marketplace channel does not support scheduled shipping options, then this response will be empty.", "type": "object", "properties": { "shippingOptions": { "description": "A list of shipping options.", "type": "array", "minItems": 0, "items": { "$ref": "#/definitions/ShippingOptions" } }, "recommendedShippingOption": { "description": "The recommended shipping options that a marketplace channel provides to the seller.", "$ref": "#/definitions/ShippingOptions" } } }, "ShipLabelsInput": { "description": "Tracking details for multiple packages.", "type": "object", "properties": { "packageIds": { "description": "The subset of package IDs used to generate a label.", "type": "array", "maxItems": 50, "items": { "description": "The ID of a package for which you want a shipping label.", "type": "string" } }, "courierSupportedAttributes": { "$ref": "#/definitions/CourierSupportedAttributes" } }, "example": { "packageIds": [ "TEST_CASE_200_PACKAGE_ID" ], "courierSupportedAttributes": { "carrierName": "ATS", "trackingId": "151958276037" } }, "required": [ "packageIds" ] }, "InvoiceResponse": { "description": "The response of the `generateInvoice` operation.", "type": "object", "properties": { "document": { "description": "The invoice.", "$ref": "#/definitions/Document" } }, "required": [ "document" ] }, "ShipLabelsResponse": { "description": "The response to the `generateShipLabels` operation.", "type": "object", "required": [ "packageShipLabelList" ], "properties": { "packageShipLabelList": { "$ref": "#/definitions/PackageShipLabelList" } } }, "PackageShipLabelList": { "description": "A list of label documents for each package specified in the request. In case of partial failures when generating labels, the `isErrored` and `errorDetails` attributes detail the cause of failure.", "type": "array", "items": { "$ref": "#/definitions/PackageShipLabel" } }, "ShipLabelMetadata": { "description": "Metadata for a ship label document.", "type": "object", "properties": { "shippingOptionId": { "description": "The selected slot for the ship label.", "type": "string" }, "carrierName": { "description": "The name of the carrier.", "type": "string" }, "trackingId": { "description": "The tracking number of the package.", "type": "string" }, "pickupWindow": { "description": "The time window during which the package was picked up.", "$ref": "#/definitions/TimeWindow" }, "timeSlot": { "description": "A time window during which to hand over the package to Amazon Logistics.", "$ref": "#/definitions/TimeWindow" }, "handoverLocation": { "description": "The drop-off location details. This value is populated when `handoverMethod` is `DROPOFF`.", "$ref": "#/definitions/HandoverLocation" } }, "example": { "shippingOptionId": "TEST_CASE_200_SHIPPING_OPTION_ID", "trackingId": "343284200329", "carrierName": "ATSPL", "shipBy": "MARKETPLACE", "pickupWindow": { "startTime": 1612933142, "endTime": 1612494142 }, "timeSlot": { "startTime": 1612933142, "endTime": 1612494142, "handoverMethod": "DROPOFF" }, "handoverLocation": { "address": { "postalCode": "98101", "addressLine1": "123 Main St", "city": "Seattle", "stateOrRegion": "WA", "countryCode": "US", "geocodes": { "latitude": 47.6062, "longitude": -122.3321 } }, "distance": { "value": 3.5, "distanceUnit": "MI" }, "mapUrl": "https://maps.example.com/location?lat=47.6062&lng=-122.3321" } }, "required": [ "carrierName", "trackingId" ] }, "Document": { "description": "A document, described by its file type and data.", "type": "object", "properties": { "format": { "description": "The type of the file.", "type": "string", "enum": [ "ZPL", "PDF", "PNG", "PLAIN_TEXT" ], "x-docgen-enum-table-extension": [ { "value": "ZPL", "description": "The file is a Zebra Programming Language (ZPL) file." }, { "value": "PDF", "description": "The file is a PDF." }, { "value": "PNG", "description": "The file is a PNG." }, { "value": "PLAIN_TEXT", "description": "The file is plain text." } ] }, "content": { "type": "string", "description": "Base 64 encoded file contents." } } }, "ShippingOptions": { "description": "Shipping options for a single package.", "type": "object", "properties": { "shippingOptionId": { "description": "An identifier for the shipping option.", "type": "string" }, "shipBy": { "description": "The shipper type.", "type": "string", "enum": [ "MARKETPLACE", "SELLER", "THIRD_PARTY_CARRIER", "OTHER" ], "x-docgen-enum-table-extension": [ { "value": "MARKETPLACE", "description": "The shipper is the marketplace platform." }, { "value": "SELLER", "description": "The shipper is the seller." }, { "value": "THIRD_PARTY_CARRIER", "description": "The shipper is a third party." }, { "value": "OTHER", "description": "The shipper is not the marketplace, seller, or a third party." } ] }, "carrierName": { "description": "The carrier name for the offering. Applicable only for Self Ship program", "type": "string" }, "pickupWindow": { "description": "The time window during which the package will be picked up. This object is deprecated, please use `timeSlot` instead.", "$ref": "#/definitions/TimeWindow" }, "timeSlot": { "description": "A time window to hand over the package to or from Amazon Logistics.", "$ref": "#/definitions/TimeWindow" }, "handoverLocation": { "description": "The drop-off location details. This value is populated when `handoverMethod` is `DROPOFF`.", "$ref": "#/definitions/HandoverLocation" } }, "example": { "shippingOptionId": "TEST_CASE_200_SHIPPING_OPTION_ID", "carrierName": "ATSPL", "shipBy": "MARKETPLACE", "pickupWindow": { "startTime": 1612933142, "endTime": 1612494142 }, "timeSlot": { "startTime": 1612933142, "endTime": 1612494142, "handoverMethod": "DROPOFF" }, "handoverLocation": { "address": { "postalCode": "98101", "addressLine1": "123 Main St", "city": "Seattle", "stateOrRegion": "WA", "countryCode": "US", "geocodes": { "latitude": 47.6062, "longitude": -122.3321 } }, "distance": { "value": 3.5, "distanceUnit": "MI" }, "mapUrl": "https://maps.example.com/location?lat=47.6062&lng=-122.3321" } }, "required": [ "shippingOptionId", "shipBy" ] }, "TimeWindow": { "description": "Time duration used to specify the interval of an event, such as pick up and delivery.", "type": "object", "properties": { "startTime": { "description": "The start time of the window.", "type": "integer", "format": "int64" }, "endTime": { "description": "The end time of the window.", "type": "integer", "format": "int64" }, "handoverMethod": { "description": "Whether the seller picks up from Amazon Logistics or drops off to Amazon Logistics.", "type": "string", "enum": [ "PICKUP", "DROPOFF" ], "x-docgen-enum-table-extension": [ { "value": "PICKUP", "description": "The seller picks up the package from Amazon Logistics." }, { "value": "DROPOFF", "description": "The seller drops off the package to Amazon Logistics." } ] } }, "example": { "startTime": 1612933142, "endTime": 1612494142, "handoverMethod": "DROPOFF" }, "required": [ "startTime", "endTime" ] }, "PackageStatus": { "description": "The status of a package.", "type": "string", "enum": [ "SHIPPED", "DELIVERED" ], "x-docgen-enum-table-extension": [ { "value": "SHIPPED", "description": "The package is shipped." }, { "value": "DELIVERED", "description": "The package is delivered." } ] }, "PackageSubStatus": { "description": "The sub-status of a package.", "type": "string", "enum": [ "OUT_FOR_DELIVERY", "DELIVERED", "NOT_DELIVERED", "UNDELIVERABLE" ], "x-docgen-enum-table-extension": [ { "value": "OUT_FOR_DELIVERY", "description": "The package is out for delivery." }, { "value": "DELIVERED", "description": "The package is delivered." }, { "value": "NOT_DELIVERED", "description": "The package is not delivered." }, { "value": "UNDELIVERABLE", "description": "The package is undeliverable." } ] }, "ShipmentAcknowledgementRequest": { "description": "Information about the shipment and its line items, used to confirm or reject line items.", "type": "object", "properties": { "referenceId": { "description": "A unique identifier for every shipment rejection.", "type": "string" }, "lineItems": { "description": "Details about the line items from the shipment that are being rejected by the seller.", "type": "array", "minItems": 0, "items": { "$ref": "#/definitions/LineItemWithReason" } } }, "example": { "referenceId": "cancellation-reference-identifier1", "lineItems": [ { "lineItem": { "id": "1", "quantity": 0 }, "reason": "OUT_OF_STOCK" } ] }, "required": [ "lineItems" ] }, "DocumentV2": { "description": "An [S3-Presigned URL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-presigned-url.html) you can use to retrieve file contents.", "type": "object", "properties": { "url": { "description": "A presigned URL to fetch the ship label file using an HTTP GET request. To determine file type, use the `contentType` header of the file response. The file retrieved will be in one of the following supported formats:\n\n- **ZPL**: `x.application/zpl`\n- **PDF**: `application/pdf`\n- **PNG**: `image/png`\n- **Plain Text**: `text/plain`", "type": "string" } }, "required": [ "url" ] }, "Packages": { "description": "The request schema of the `createPackages` operation.", "type": "object", "properties": { "packages": { "description": "A list of packages.", "type": "array", "minItems": 1, "items": { "$ref": "#/definitions/Package" } } }, "example": { "packages": [ { "id": "001", "dimensions": { "length": { "value": 10, "dimensionUnit": "CM" }, "width": { "value": 10, "dimensionUnit": "CM" }, "height": { "value": 10, "dimensionUnit": "CM" } }, "weight": { "value": 200, "weightUnit": "G" }, "hazmatLabels": [], "packageLineItems": [ { "packageLineItemId": "1", "quantity": 1, "pieces": 1, "countryOfOrigin": "IN", "itemValue": { "value": 10, "currencyCode": "INR" }, "serialNumbers": [] }, { "packageLineItemId": "2", "quantity": 1, "serialNumbers": [] } ], "status": "SHIPPED" } ] }, "required": [ "packages" ] }, "CustomChannelAttribute": { "description": "Marketplace channel-specific attribute value.", "type": "array", "minItems": 0, "items": { "type": "string", "enum": [ "PRIME", "FASTTRACK" ], "x-docgen-enum-table-extension": [ { "value": "PRIME", "description": "The order contains products that are Prime eligible." }, { "value": "FASTTRACK", "description": "The order is an expedited order." } ] } }, "CustomAttribute": { "description": "A custom attribute that is loosely typed, modeled through a key-value pair and its data type.", "type": "object", "properties": { "key": { "type": "string", "description": "The attribute key.", "example": "color" }, "type": { "$ref": "#/definitions/CustomAttributeType" }, "value": { "type": "string", "description": "The attribute value.", "example": "red" } }, "example": { "key": "color", "value": "red" } }, "CustomAttributeType": { "description": "The data type of the custom attribute value to aid with parsing during deserialization.", "type": "string", "enum": [ "STRING", "BOOLEAN", "INTEGER", "DOUBLE", "JSON_STRING" ], "x-docgen-enum-table-extension": [ { "value": "STRING", "description": "String data type." }, { "value": "BOOLEAN", "description": "Boolean data type." }, { "value": "INTEGER", "description": "Integer data type." }, { "value": "DOUBLE", "description": "Double precision floating point data type." }, { "value": "JSON_STRING", "description": "JSON formatted string data type." } ], "example": "STRING" }, "PackageShipLabel": { "description": "A shipping label with a label document for a single package. If label generation fails, you can use the `status` and `errorDetails` attributes to determine the cause of failure.", "type": "object", "properties": { "packageId": { "description": "The package ID of the package.", "type": "string" }, "shipLabelMetadata": { "$ref": "#/definitions/ShipLabelMetadata" }, "fileData": { "$ref": "#/definitions/DocumentV2" }, "status": { "description": "Whether label generation failed for the current package. If `FAILURE`, use `errorDetails` to determine details of the failure.", "$ref": "#/definitions/Status" }, "errorDetails": { "$ref": "#/definitions/Error" } }, "example": { "packageId": "TEST_CASE_200_PACKAGE_ID", "shipLabelMetadata": { "carrierName": "ATSPL", "trackingId": "343284200328", "pickupWindow": { "startTime": 163132120, "endTime": 162132660 }, "timeSlot": { "startTime": 1612933142, "endTime": 1612494142, "handoverMethod": "PICKUP" } }, "fileData": { "url": "string" }, "status": "FAILURE", "errorDetails": { "code": "00001", "message": "A temporary failure occurred in the SmartConnect product." } } }, "CourierSupportedAttributes": { "description": "The tracking details of the package if it is shipped by a third party courier. This attribute should only be provided when the value of `shipBy` is `THIRD_PARTY_CARRIER`.", "type": "object", "properties": { "carrierName": { "description": "The name of the courier service used to ship the package", "type": "string" }, "trackingId": { "description": "The tracking number of the package.", "type": "string" } }, "example": { "carrierName": "ATSPL", "trackingId": "343284200328" }, "required": [ "carrierName", "trackingId" ] }, "LineItem": { "description": "Information about the line item being confirmed or rejected.", "type": "object", "properties": { "id": { "description": "The identifier of the line item from the shipment that is being confirmed or rejected by the seller.", "type": "string" }, "quantity": { "description": "The quantity of the line item.", "type": "integer" } }, "example": { "id": "1", "quantity": 0 }, "required": [ "id" ] }, "LineItemWithReason": { "description": "Information about the line item being confirmed or rejected and the reason for the rejection.", "type": "object", "properties": { "lineItem": { "$ref": "#/definitions/LineItem" }, "reason": { "description": "The reason for the rejection of the line item.", "type": "string", "enum": [ "OUT_OF_STOCK", "CUSTOMER_REQUESTED" ], "x-docgen-enum-table-extension": [ { "value": "OUT_OF_STOCK", "description": "The item is out of stock." }, { "value": "CUSTOMER_REQUESTED", "description": "The customer requested rejection." } ] } }, "example": { "lineItem": { "id": "1", "quantity": 0 }, "reason": "OUT_OF_STOCK" }, "required": [ "lineItem" ] }, "Status": { "description": "The outcome of the operation.", "type": "string", "enum": [ "SUCCESS", "FAILURE" ], "x-docgen-enum-table-extension": [ { "value": "SUCCESS", "description": "The operation succeeded." }, { "value": "FAILURE", "description": "The operation failed." } ] }, "CreateSandboxShipmentRequest": { "type": "object", "required": [ "locationId", "marketplaceId", "marketplaceChannel", "shippingType" ], "properties": { "locationId": { "type": "string", "description": "The location identifier for the shipment.", "minLength": 1, "maxLength": 36, "example": "LOC_001" }, "marketplaceId": { "$ref": "#/definitions/MarketplaceId" }, "marketplaceChannel": { "type": "string", "description": "The marketplace channel.", "enum": [ "FBA", "MFN" ], "example": "FBA" }, "shippingType": { "type": "string", "description": "The shipping type for the sandbox shipment.", "enum": [ "SELF", "MARKETPLACE", "THIRD_PARTY_CARRIER" ], "example": "SELF" }, "orderType": { "type": "array", "description": "The order type attributes for the sandbox shipment.", "minItems": 1, "items": { "type": "string", "enum": [ "HAZMAT", "GIFT_WRAP", "GIFT_MESSAGE", "MPS", "SERIAL", "CROSS_BORDER", "REPLACEMENT", "EXCHANGE", "PHARMA_NON_PRESCRIPTION", "PHARMA_PRESCRIPTION" ] }, "example": [ "HAZMAT", "MPS" ] }, "lineItemCount": { "type": "string", "description": "The number of line items in the shipment.", "enum": [ "SINGLE", "MULTIPLE" ], "example": "MULTIPLE" }, "quantityCount": { "type": "string", "description": "The quantity count per line item.", "enum": [ "SINGLE", "MULTIPLE" ], "example": "SINGLE" } }, "description": "The request object for creating a sandbox shipment.", "example": { "locationId": "LOC_001", "marketplaceId": "A21TJRUUN4KGV", "marketplaceChannel": "FBA", "shippingType": "SELF", "orderType": [ "HAZMAT", "MPS" ], "lineItemCount": "MULTIPLE", "quantityCount": "SINGLE" } }, "CreateSandboxShipmentResponse": { "type": "object", "properties": { "shipmentId": { "type": "string", "description": "The identifier of the created sandbox shipment.", "example": "D39CwZpdj" } }, "description": "The response object for creating a sandbox shipment.", "example": { "shipmentId": "D39CwZpdj" } }, "UpdateSandboxShipmentRequest": { "type": "object", "description": "The request object for updating a sandbox shipment. The `updates` object is required for `SHIPMENT_STATUS_CHANGE` and `TRANSPORT_CAPACITY_CHANGE` update types, and must not be provided for `INVOICE_AVAILABILITY_CHANGE`.", "required": [ "updateType" ], "properties": { "updateType": { "type": "string", "description": "The type of update to apply to the shipment.", "enum": [ "SHIPMENT_STATUS_CHANGE", "INVOICE_AVAILABILITY_CHANGE", "TRANSPORT_CAPACITY_CHANGE" ], "x-docgen-enum-table-extension": [ { "value": "SHIPMENT_STATUS_CHANGE", "description": "Update the shipment status or sub-status. Provide either `status` or `subStatus` in the `updates` object (mutually exclusive)." }, { "value": "INVOICE_AVAILABILITY_CHANGE", "description": "Mark the invoice as available for the shipment. No `updates` object is needed." }, { "value": "TRANSPORT_CAPACITY_CHANGE", "description": "Update the Expected Pickup Date (EPD) for the shipment. Provide `timestamp` in the `updates` object." } ], "example": "SHIPMENT_STATUS_CHANGE" }, "updates": { "$ref": "#/definitions/SandboxShipmentUpdates" } }, "example": { "updateType": "SHIPMENT_STATUS_CHANGE", "updates": { "status": "SHIPPED" } } }, "SandboxShipmentUpdates": { "type": "object", "description": "The update details for the sandbox shipment. For `SHIPMENT_STATUS_CHANGE`, provide either `status` or `subStatus` (mutually exclusive). For `TRANSPORT_CAPACITY_CHANGE`, provide `timestamp` as the Expected Pickup Date (EPD).", "properties": { "status": { "type": "string", "description": "The target shipment status. Mutually exclusive with `subStatus`. Used with `SHIPMENT_STATUS_CHANGE` update type.", "enum": [ "SHIPPED", "DELIVERED", "CANCELLED" ], "x-docgen-enum-table-extension": [ { "value": "SHIPPED", "description": "The shipment has been shipped." }, { "value": "DELIVERED", "description": "The shipment has been delivered." }, { "value": "CANCELLED", "description": "The shipment has been cancelled." } ], "example": "SHIPPED" }, "subStatus": { "type": "string", "description": "The target shipment sub-status. Mutually exclusive with `status`. Used with `SHIPMENT_STATUS_CHANGE` update type.", "enum": [ "OUT_FOR_DELIVERY" ], "x-docgen-enum-table-extension": [ { "value": "OUT_FOR_DELIVERY", "description": "The shipment is out for delivery." } ], "example": "OUT_FOR_DELIVERY" }, "timestamp": { "type": "string", "format": "date-time", "description": "The Expected Pickup Date (EPD) for the shipment. Used with `TRANSPORT_CAPACITY_CHANGE` update type. In [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.", "example": "2024-09-15T10:30:00Z" } }, "example": { "status": "SHIPPED" } }, "MarketplaceId": { "type": "string", "description": "The identifier for the marketplace. Refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids) for the full list of supported marketplace IDs.", "example": "A21TJRUUN4KGV" } } }