"description":"Returns a list of shipping labels created during the time frame that you specify. You define that time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must not be more than 7 days.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"description":"The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.",
"required":false,
"type":"string"
},
{
"name":"limit",
"in":"query",
"description":"The limit to the number of records returned.",
"required":false,
"type":"integer",
"maximum":100,
"minimum":1
},
{
"name":"createdAfter",
"in":"query",
"description":"Shipping labels that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.",
"required":true,
"type":"string",
"format":"date-time"
},
{
"name":"createdBefore",
"in":"query",
"description":"Shipping labels that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.",
"required":true,
"type":"string",
"format":"date-time"
},
{
"name":"sortOrder",
"in":"query",
"description":"Sort ASC or DESC by order creation date.",
"required":false,
"type":"string",
"default":"ASC",
"enum":[
"ASC",
"DESC"
],
"x-docgen-enum-table-extension":[
{
"value":"ASC",
"description":"Sort in ascending order by order creation date."
},
{
"value":"DESC",
"description":"Sort in descending order by order creation date."
}
]
},
{
"name":"nextToken",
"in":"query",
"description":"Used for pagination when there are more ship labels than the specified result size limit. The token value is returned in the previous API call.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Creates a shipping label for a purchase order and returns a transactionId for reference.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Returns a shipping label for the purchaseOrderNumber that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"description":"The purchase order number for which you want to return the shipping label. It should be the same purchaseOrderNumber as received in the order.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Submits one or more shipment confirmations for vendor orders.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"This API call is only to be used by Vendor-Own-Carrier (VOC) vendors. Calling this API will submit a shipment status update for the package that a vendor has shipped. It will provide the Amazon customer visibility on their order, when the package is outside of Amazon Network visibility.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Returns a list of customer invoices created during a time frame that you specify. You define the time frame using the createdAfter and createdBefore parameters. You must use both of these parameters. The date range to search must be no more than 7 days.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"description":"The vendor warehouseId for order fulfillment. If not specified, the result will contain orders for all warehouses.",
"required":false,
"type":"string"
},
{
"name":"limit",
"in":"query",
"description":"The limit to the number of records returned",
"required":false,
"type":"integer",
"maximum":100,
"minimum":1
},
{
"name":"createdAfter",
"in":"query",
"description":"Orders that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.",
"required":true,
"type":"string",
"format":"date-time"
},
{
"name":"createdBefore",
"in":"query",
"description":"Orders that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.",
"required":true,
"type":"string",
"format":"date-time"
},
{
"name":"sortOrder",
"in":"query",
"description":"Sort ASC or DESC by order creation date.",
"required":false,
"type":"string",
"enum":[
"ASC",
"DESC"
],
"x-docgen-enum-table-extension":[
{
"value":"ASC",
"description":"Sort in ascending order by order creation date."
},
{
"value":"DESC",
"description":"Sort in descending order by order creation date."
}
]
},
{
"name":"nextToken",
"in":"query",
"description":"Used for pagination when there are more orders than the specified result size limit. The token value is returned in the previous API call.",
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Returns a customer invoice based on the purchaseOrderNumber that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Returns a list of packing slips for the purchase orders that match the criteria specified. Date range to search must not be more than 7 days.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"description":"The vendor warehouseId for order fulfillment. If not specified the result will contain orders for all warehouses.",
"required":false,
"type":"string"
},
{
"name":"limit",
"in":"query",
"description":"The limit to the number of records returned",
"required":false,
"type":"integer",
"maximum":100,
"minimum":1
},
{
"name":"createdAfter",
"in":"query",
"description":"Packing slips that became available after this date and time will be included in the result. Must be in ISO-8601 date/time format.",
"required":true,
"type":"string",
"format":"date-time"
},
{
"name":"createdBefore",
"in":"query",
"description":"Packing slips that became available before this date and time will be included in the result. Must be in ISO-8601 date/time format.",
"required":true,
"type":"string",
"format":"date-time"
},
{
"name":"sortOrder",
"in":"query",
"description":"Sort ASC or DESC by packing slip creation date.",
"required":false,
"type":"string",
"default":"ASC",
"enum":[
"ASC",
"DESC"
],
"x-docgen-enum-table-extension":[
{
"value":"ASC",
"description":"Sort in ascending order by packing slip creation date."
},
{
"value":"DESC",
"description":"Sort in descending order by packing slip creation date."
}
]
},
{
"name":"nextToken",
"in":"query",
"description":"Used for pagination when there are more packing slips than the specified result size limit. The token value is returned in the previous API call.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Returns a packing slip based on the purchaseOrderNumber that you specify.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.",
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned."
"description":"A Base64encoded string of the packing slip PDF."
},
"contentType":{
"type":"string",
"description":"The format of the file such as PDF, JPEG etc.",
"enum":[
"application/pdf"
],
"x-docgen-enum-table-extension":[
{
"value":"application/pdf",
"description":"Portable Document Format (pdf)."
}
]
}
},
"description":"Packing slip information."
},
"PackingSlipList":{
"type":"object",
"properties":{
"pagination":{
"$ref":"#/definitions/Pagination"
},
"packingSlips":{
"type":"array",
"items":{
"$ref":"#/definitions/PackingSlip"
}
}
},
"description":"A list of packing slips."
},
"GetPackingSlipListResponse":{
"type":"object",
"properties":{
"payload":{
"$ref":"#/definitions/PackingSlipList"
},
"errors":{
"$ref":"#/definitions/ErrorList"
}
}
},
"GetPackingSlipResponse":{
"type":"object",
"properties":{
"payload":{
"$ref":"#/definitions/PackingSlip"
},
"errors":{
"$ref":"#/definitions/ErrorList"
}
}
},
"SubmitShippingLabelsRequest":{
"type":"object",
"properties":{
"shippingLabelRequests":{
"type":"array",
"items":{
"$ref":"#/definitions/ShippingLabelRequest"
}
}
}
},
"ShippingLabelRequest":{
"type":"object",
"required":[
"purchaseOrderNumber",
"sellingParty",
"shipFromParty"
],
"properties":{
"purchaseOrderNumber":{
"type":"string",
"description":"Purchase order number of the order for which to create a shipping label.",
"pattern":"^[a-zA-Z0-9]+$"
},
"sellingParty":{
"description":"ID of the selling party or vendor.",
"$ref":"#/definitions/PartyIdentification"
},
"shipFromParty":{
"description":"Warehouse code of vendor.",
"$ref":"#/definitions/PartyIdentification"
},
"containers":{
"type":"array",
"description":"A list of the packages in this shipment.",
"items":{
"$ref":"#/definitions/Container"
}
}
}
},
"Item":{
"type":"object",
"required":[
"itemSequenceNumber",
"shippedQuantity"
],
"properties":{
"itemSequenceNumber":{
"type":"integer",
"description":"Item Sequence Number for the item. This must be the same value as sent in order for a given item."
},
"buyerProductIdentifier":{
"type":"string",
"description":"Buyer's Standard Identification Number (ASIN) of an item. Either buyerProductIdentifier or vendorProductIdentifier is required."
},
"vendorProductIdentifier":{
"type":"string",
"description":"The vendor selected product identification of the item. Should be the same as was sent in the purchase order, like SKU Number."
},
"shippedQuantity":{
"description":"Total item quantity shipped in this shipment.",
"$ref":"#/definitions/ItemQuantity"
}
},
"description":"Details of the item being shipped."
},
"PackedItem":{
"type":"object",
"required":[
"itemSequenceNumber",
"packedQuantity"
],
"properties":{
"itemSequenceNumber":{
"type":"integer",
"description":"Item Sequence Number for the item. This must be the same value as sent in the order for a given item."
},
"buyerProductIdentifier":{
"type":"string",
"description":"Buyer's Standard Identification Number (ASIN) of an item. Either buyerProductIdentifier or vendorProductIdentifier is required."
},
"vendorProductIdentifier":{
"type":"string",
"description":"The vendor selected product identification of the item. Should be the same as was sent in the Purchase Order, like SKU Number."
},
"packedQuantity":{
"description":"Total item quantity packed in the container.",
"$ref":"#/definitions/ItemQuantity"
}
}
},
"PartyIdentification":{
"type":"object",
"required":[
"partyId"
],
"properties":{
"partyId":{
"type":"string",
"description":"Assigned Identification for the party."
},
"address":{
"description":"Identification of the party by address.",
"$ref":"#/definitions/Address"
},
"taxRegistrationDetails":{
"type":"array",
"description":"Tax registration details of the entity.",
"items":{
"$ref":"#/definitions/TaxRegistrationDetails"
}
}
}
},
"ShipmentDetails":{
"type":"object",
"required":[
"shipmentStatus",
"shippedDate"
],
"properties":{
"shippedDate":{
"type":"string",
"format":"date-time",
"description":"This field indicates the date of the departure of the shipment from vendor's location. Vendors are requested to send ASNs within 30 minutes of departure from their warehouse/distribution center or at least 6 hours prior to the appointment time at the Amazon destination warehouse, whichever is sooner. Shipped date mentioned in the Shipment Confirmation should not be in the future."
},
"shipmentStatus":{
"type":"string",
"description":"Indicate the shipment status.",
"enum":[
"SHIPPED",
"FLOOR_DENIAL"
],
"x-docgen-enum-table-extension":[
{
"value":"SHIPPED",
"description":"Orders that have left the warehouse have shipped status."
},
{
"value":"FLOOR_DENIAL",
"description":"Status for orders rejected due to quality issues with products on the floor, or the physical and virtual inventory do not match."
}
]
},
"isPriorityShipment":{
"type":"boolean",
"description":"Provide the priority of the shipment."
},
"vendorOrderNumber":{
"type":"string",
"description":"The vendor order number is a unique identifier generated by a vendor for their reference."
},
"estimatedDeliveryDate":{
"type":"string",
"format":"date-time",
"description":"Date on which the shipment is expected to reach the buyer's warehouse. It needs to be an estimate based on the average transit time between the ship-from location and the destination. The exact appointment time will be provided by buyer and is potentially not known when creating the shipment confirmation."
}
},
"description":"Details about a shipment."
},
"StatusUpdateDetails":{
"type":"object",
"required":[
"reasonCode",
"statusCode",
"statusDateTime",
"statusLocationAddress",
"trackingNumber"
],
"properties":{
"trackingNumber":{
"type":"string",
"description":"This is required to be provided for every package and should match with the trackingNumber sent for the shipment confirmation."
},
"statusCode":{
"type":"string",
"description":"Indicates the shipment status code of the package that provides transportation information for Amazon tracking systems and ultimately for the final customer."
},
"reasonCode":{
"type":"string",
"description":"Provides a reason code for the status of the package that will provide additional information about the transportation status."
},
"statusDateTime":{
"type":"string",
"format":"date-time",
"description":"The date and time when the shipment status was updated. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00."
},
"statusLocationAddress":{
"$ref":"#/definitions/Address"
},
"shipmentSchedule":{
"type":"object",
"properties":{
"estimatedDeliveryDateTime":{
"type":"string",
"format":"date-time",
"description":"Date on which the shipment is expected to reach the customer delivery location. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00."
},
"apptWindowStartDateTime":{
"type":"string",
"format":"date-time",
"description":"This field indicates the date and time at the start of the appointment window scheduled to deliver the shipment. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00."
},
"apptWindowEndDateTime":{
"type":"string",
"format":"date-time",
"description":"This field indicates the date and time at the end of the appointment window scheduled to deliver the shipment. This field is expected to be in ISO-8601 date/time format, with UTC time zone or UTC offset. For example, 2020-07-16T23:00:00Z or 2020-07-16T23:00:00+01:00."
}
}
}
},
"description":"Details for the shipment status update given by the vendor for the specific package."
},
"TaxRegistrationDetails":{
"type":"object",
"required":[
"taxRegistrationNumber"
],
"properties":{
"taxRegistrationType":{
"type":"string",
"description":"Tax registration type for the entity.",
"enum":[
"VAT",
"GST"
],
"x-docgen-enum-table-extension":[
{
"value":"VAT",
"description":"Value-added tax."
},
{
"value":"GST",
"description":"Goods and Services Tax (GST)."
}
]
},
"taxRegistrationNumber":{
"type":"string",
"description":"Tax registration number for the party. For example, VAT ID."
},
"taxRegistrationAddress":{
"description":"Address associated with the tax registration number.",
"$ref":"#/definitions/Address"
},
"taxRegistrationMessages":{
"type":"string",
"description":"Tax registration message that can be used for additional tax related details."
}
},
"description":"Tax registration details of the entity."
},
"Address":{
"type":"object",
"required":[
"addressLine1",
"countryCode",
"name"
],
"properties":{
"name":{
"type":"string",
"description":"The name of the person, business or institution at that address."
},
"addressLine1":{
"type":"string",
"description":"First line of the address."
},
"addressLine2":{
"type":"string",
"description":"Additional street address information, if required."
},
"addressLine3":{
"type":"string",
"description":"Additional street address information, if required."
},
"city":{
"type":"string",
"description":"The city where the person, business or institution is located."
},
"county":{
"type":"string",
"description":"The county where person, business or institution is located."
},
"district":{
"type":"string",
"description":"The district where person, business or institution is located."
},
"stateOrRegion":{
"type":"string",
"description":"The state or region where person, business or institution is located."
},
"postalCode":{
"type":"string",
"description":"The postal code of that address. It contains a series of letters or digits or both, sometimes including spaces or punctuation."
},
"countryCode":{
"type":"string",
"description":"The two digit country code in ISO 3166-1 alpha-2 format."
},
"phone":{
"type":"string",
"description":"The phone number of the person, business or institution located at that address."
}
},
"description":"Address of the party."
},
"Dimensions":{
"type":"object",
"required":[
"height",
"length",
"unitOfMeasure",
"width"
],
"properties":{
"length":{
"description":"The length of the container.",
"$ref":"#/definitions/Decimal"
},
"width":{
"description":"The width of the container.",
"$ref":"#/definitions/Decimal"
},
"height":{
"description":"The height of the container.",
"$ref":"#/definitions/Decimal"
},
"unitOfMeasure":{
"type":"string",
"description":"The unit of measure for dimensions.",
"enum":[
"IN",
"CM"
],
"x-docgen-enum-table-extension":[
{
"value":"IN",
"description":"Inches"
},
{
"value":"CM",
"description":"Centimeters"
}
]
}
},
"description":"Physical dimensional measurements of a container."
},
"Weight":{
"type":"object",
"required":[
"unitOfMeasure",
"value"
],
"properties":{
"unitOfMeasure":{
"type":"string",
"description":"The unit of measurement.",
"enum":[
"KG",
"LB"
],
"x-docgen-enum-table-extension":[
{
"value":"KG",
"description":"Kilogram"
},
{
"value":"LB",
"description":"Pounds (Libra for Latin)."
}
]
},
"value":{
"description":"The measurement value.",
"$ref":"#/definitions/Decimal"
}
},
"description":"The weight."
},
"Decimal":{
"type":"string",
"description":"A decimal number with no loss of precision. Useful when precision loss is unacceptable, as with currencies. Follows RFC7159 for number representation. <br>**Pattern** : `^-?(0|([1-9]\\\\d*))(\\\\.\\\\d+)?([eE][+-]?\\\\d+)?$`."
},
"ItemQuantity":{
"type":"object",
"required":[
"amount",
"unitOfMeasure"
],
"properties":{
"amount":{
"type":"integer",
"description":"Quantity of units shipped for a specific item at a shipment level. If the item is present only in certain packages or pallets within the shipment, please provide this at the appropriate package or pallet level."
},
"unitOfMeasure":{
"type":"string",
"description":"Unit of measure for the shipped quantity."
}
},
"description":"Details of item quantity."
},
"SubmitShipmentConfirmationsResponse":{
"type":"object",
"properties":{
"payload":{
"description":"The response payload for the submitShipmentConfirmations operation.",
"$ref":"#/definitions/TransactionReference"
},
"errors":{
"$ref":"#/definitions/ErrorList"
}
},
"description":"The response schema for the submitShipmentConfirmations operation."
},
"SubmitShipmentStatusUpdatesResponse":{
"type":"object",
"properties":{
"payload":{
"description":"The response payload for the submitShipmentStatusUpdates operation.",
"$ref":"#/definitions/TransactionReference"
},
"errors":{
"$ref":"#/definitions/ErrorList"
}
},
"description":"The response schema for the submitShipmentStatusUpdates operation."
},
"GetShippingLabelListResponse":{
"type":"object",
"properties":{
"payload":{
"description":"List of ship labels.",
"$ref":"#/definitions/ShippingLabelList"
},
"errors":{
"$ref":"#/definitions/ErrorList"
}
},
"description":"The response schema for the getShippingLabels operation."
},
"GetShippingLabelResponse":{
"type":"object",
"properties":{
"payload":{
"description":"The payload for the getShippingLabel operation.",
"$ref":"#/definitions/ShippingLabel"
},
"errors":{
"$ref":"#/definitions/ErrorList"
}
},
"description":"The response schema for the getShippingLabel operation."
},
"ShippingLabelList":{
"type":"object",
"properties":{
"pagination":{
"$ref":"#/definitions/Pagination"
},
"shippingLabels":{
"type":"array",
"items":{
"$ref":"#/definitions/ShippingLabel"
}
}
}
},
"LabelData":{
"type":"object",
"required":[
"content"
],
"properties":{
"packageIdentifier":{
"type":"string",
"description":"Identifier for the package. The first package will be 001, the second 002, and so on. This number is used as a reference to refer to this package from the pallet level."
},
"trackingNumber":{
"type":"string",
"description":"Package tracking identifier from the shipping carrier."
},
"shipMethod":{
"type":"string",
"description":"Ship method to be used for shipping the order. Amazon defines Ship Method Codes indicating shipping carrier and shipment service level. Ship Method Codes are case and format sensitive. The same ship method code should returned on the shipment confirmation. Note that the Ship Method Codes are vendor specific and will be provided to each vendor during the implementation."
},
"shipMethodName":{
"type":"string",
"description":"Shipping method name for internal reference."
},
"content":{
"type":"string",
"description":"This field will contain the Base64encoded string of the shipment label content."
}
},
"description":"Details of the shipment label."
},
"ShippingLabel":{
"type":"object",
"required":[
"labelData",
"labelFormat",
"purchaseOrderNumber",
"sellingParty",
"shipFromParty"
],
"properties":{
"purchaseOrderNumber":{
"type":"string",
"description":"This field will contain the Purchase Order Number for this order.",
"pattern":"^[a-zA-Z0-9]+$"
},
"sellingParty":{
"description":"ID of the selling party or vendor.",
"description":"Zebra Programming Language (zpl) format."
}
]
},
"labelData":{
"type":"array",
"description":"Provides the details of the packages in this shipment.",
"items":{
"$ref":"#/definitions/LabelData"
}
}
}
},
"SubmitShippingLabelsResponse":{
"type":"object",
"properties":{
"payload":{
"description":"The response payload for the submitShippingLabelRequest operation.",
"$ref":"#/definitions/TransactionReference"
},
"errors":{
"$ref":"#/definitions/ErrorList"
}
},
"description":"The response schema for the submitShippingLabelRequest operation."
},
"SubmitShipmentConfirmationsRequest":{
"type":"object",
"properties":{
"shipmentConfirmations":{
"type":"array",
"items":{
"$ref":"#/definitions/ShipmentConfirmation"
}
}
}
},
"ShipmentConfirmation":{
"type":"object",
"required":[
"items",
"purchaseOrderNumber",
"sellingParty",
"shipFromParty",
"shipmentDetails"
],
"properties":{
"purchaseOrderNumber":{
"type":"string",
"description":"Purchase order number corresponding to the shipment.",
"pattern":"^[a-zA-Z0-9]+$"
},
"shipmentDetails":{
"description":"Shipment information.",
"$ref":"#/definitions/ShipmentDetails"
},
"sellingParty":{
"description":"ID of the selling party or vendor.",
"$ref":"#/definitions/PartyIdentification"
},
"shipFromParty":{
"description":"Warehouse code of vendor.",
"$ref":"#/definitions/PartyIdentification"
},
"items":{
"type":"array",
"description":"Provide the details of the items in this shipment. If any of the item details field is common at a package or a pallet level, then provide them at the corresponding package.",
"items":{
"$ref":"#/definitions/Item"
}
},
"containers":{
"type":"array",
"description":"Provide the details of the items in this shipment. If any of the item details field is common at a package or a pallet level, then provide them at the corresponding package.",
"items":{
"$ref":"#/definitions/Container"
}
}
}
},
"SubmitShipmentStatusUpdatesRequest":{
"type":"object",
"properties":{
"shipmentStatusUpdates":{
"type":"array",
"items":{
"$ref":"#/definitions/ShipmentStatusUpdate"
},
"minItems":1
}
}
},
"ShipmentStatusUpdate":{
"type":"object",
"required":[
"purchaseOrderNumber",
"sellingParty",
"shipFromParty",
"statusUpdateDetails"
],
"properties":{
"purchaseOrderNumber":{
"type":"string",
"description":"Purchase order number of the shipment for which to update the shipment status.",
"pattern":"^[a-zA-Z0-9]+$"
},
"sellingParty":{
"description":"ID of the selling party or vendor.",
"$ref":"#/definitions/PartyIdentification"
},
"shipFromParty":{
"description":"Warehouse code of vendor.",
"$ref":"#/definitions/PartyIdentification"
},
"statusUpdateDetails":{
"description":"Provide the details about the status of the shipment at that particular point of time.",
"$ref":"#/definitions/StatusUpdateDetails"
}
}
},
"GetCustomerInvoicesResponse":{
"type":"object",
"properties":{
"payload":{
"description":"List of customer invoices.",
"$ref":"#/definitions/CustomerInvoiceList"
},
"errors":{
"$ref":"#/definitions/ErrorList"
}
},
"description":"The response schema for the getCustomerInvoices operation."
},
"GetCustomerInvoiceResponse":{
"type":"object",
"properties":{
"payload":{
"description":"The payload for the getCustomerInvoice operation.",
"$ref":"#/definitions/CustomerInvoice"
},
"errors":{
"$ref":"#/definitions/ErrorList"
}
},
"description":"The response schema for the getCustomerInvoice operation."
},
"CustomerInvoiceList":{
"type":"object",
"properties":{
"pagination":{
"$ref":"#/definitions/Pagination"
},
"customerInvoices":{
"type":"array",
"items":{
"$ref":"#/definitions/CustomerInvoice"
}
}
}
},
"Pagination":{
"type":"object",
"properties":{
"nextToken":{
"type":"string",
"description":"A generated string used to pass information to your next request. If NextToken is returned, pass the value of NextToken to the next request. If NextToken is not returned, there are no more order items to return."
}
}
},
"CustomerInvoice":{
"type":"object",
"required":[
"content",
"purchaseOrderNumber"
],
"properties":{
"purchaseOrderNumber":{
"type":"string",
"description":"The purchase order number for this order.",
