Ordering API v1 model
{
"swagger" : "2.0",
"info" : {
"description" : "With Amazon Business ordering API, integrators can build applications that allow Amazon Business customers to define and execute an order request.",
"version" : "1.0.0",
"title" : "Amazon Business Ordering API Model"
},
"host" : "www",
"schemes" : [ "https" ],
"paths" : {
"/ordering/2022-10-30/orders" : {
"post" : {
"description" : "Attempts to place an order with the given attributes and expectations from the order request.",
"operationId" : "placeOrder",
"parameters" : [ {
"in" : "body",
"name" : "request",
"description" : "A request to place an order.",
"required" : true,
"schema" : {
"$ref" : "#/definitions/PlaceOrderRequest"
}
} ],
"responses" : {
"200" : {
"description" : "The order was successfully placed.",
"headers" : {
"x-amzn-RateLimit-Limit" : {
"type" : "string",
"description" : "The allowed rate limit (requests per second) for this operation."
},
"x-amzn-requestid" : {
"type" : "string",
"description" : "Unique request reference identifier."
}
},
"schema" : {
"$ref" : "#/definitions/PlaceOrderResult"
},
"x-amzn-api-sandbox" : {
"static" : [ {
"request" : {
"parameters" : {
"body" : {
"value" : {
"externalId" : "[orderIdentifier]",
"attributes" : [ {
"attributeType" : "[attributeSubtypeName]"
} ],
"expectations" : [ {
"expectationType" : "[expectationSubtypeName]"
} ],
"lineItems" : [ {
"externalId" : "[lineItemIdentifier]",
"quantity" : 3,
"attributes" : [ {
"attributeType" : "[attributeSubtypeName]"
} ],
"expectations" : [ {
"expectationType" : "[expectationSubtypeName]"
} ]
} ]
}
}
}
},
"response" : {
"lineItems" : [ {
"externalId" : "[lineItemIdentifier]",
"acceptedItems" : [ {
"quantity" : 2,
"artifacts" : [ {
"acceptanceArtifactType" : "[acceptanceArtifactSubtypeName]"
} ]
} ],
"rejectedItems" : [ {
"quantity" : 1,
"artifacts" : [ {
"rejectionArtifactType" : "[rejectionArtifactSubtypeName]"
} ]
} ]
} ],
"acceptanceArtifacts" : [ {
"acceptanceArtifactType" : "[acceptanceArtifactSubtypeName]"
} ],
"rejectionArtifacts" : [ {
"rejectionArtifactType" : "[rejectionArtifactSubtypeName]"
} ]
}
} ]
}
},
"400" : {
"description" : "Request has missing or invalid parameters and can't be parsed.",
"headers" : {
"x-amzn-RateLimit-Limit" : {
"type" : "string",
"description" : "The allowed rate limit (requests per second) for this operation."
},
"x-amzn-requestId" : {
"type" : "string",
"description" : "Unique request reference identifier."
}
},
"schema" : {
"$ref" : "#/definitions/ErrorList"
},
"x-amzn-api-sandbox" : {
"static" : [ {
"request" : {
"parameters" : {
"body" : {
"value" : {
"externalId" : "[orderIdentifier]",
"attributes" : [ {
"attributeType" : "[attributeSubtypeName]"
} ],
"expectations" : [ {
"expectationType" : "[expectationSubtypeName]"
} ]
}
}
}
},
"response" : {
"errors" : [ {
"code" : "INVALID_REQUEST_PARAMETER",
"message" : "The required request parameter is missing: lineItems.",
"details" : "Please provide the required parameter (lineItems) in the order request."
} ]
}
} ]
}
},
"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 specified resource doesn't exist.",
"headers" : {
"x-amzn-RateLimit-Limit" : {
"type" : "string",
"description" : "The allowed rate limit (requests per second) for this operation."
},
"x-amzn-requestId" : {
"type" : "string",
"description" : "A unique request reference identifier."
}
},
"schema" : {
"$ref" : "#/definitions/ErrorList"
}
},
"415" : {
"description" : "The request payload is in an unsupported format.",
"headers" : {
"x-amzn-RateLimit-Limit" : {
"type" : "string",
"description" : "The allowed rate limit (requests per second) for this operation."
},
"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-RateLimit-Limit" : {
"type" : "string",
"description" : "The allowed rate limit (requests per second) for this operation."
},
"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.",
"headers" : {
"x-amzn-RateLimit-Limit" : {
"type" : "string",
"description" : "The allowed rate limit (requests per second) for this operation."
},
"x-amzn-requestId" : {
"type" : "string",
"description" : "Unique request reference identifier."
}
},
"schema" : {
"$ref" : "#/definitions/ErrorList"
}
}
}
}
},
"/ordering/2022-10-30/orders/{externalId}" : {
"get" : {
"description" : "Retrieves order details with externalId.",
"operationId" : "orderDetails",
"parameters" : [ {
"name" : "externalId",
"in" : "path",
"description" : "The unique identifier provided by the customer while placing the order.",
"required" : true,
"type" : "string"
}, {
"name" : "x-amz-user-email",
"in" : "header",
"description" : "The email address of the user requesting this resource.",
"required" : true,
"type" : "string"
} ],
"responses" : {
"200" : {
"description" : "Order details successfully retrieved.",
"headers" : {
"x-amzn-RateLimit-Limit" : {
"type" : "string",
"description" : "The allowed rate limit (requests per second) for this operation."
},
"x-amzn-requestid" : {
"type" : "string",
"description" : "A unique request reference identifier."
}
},
"schema" : {
"$ref" : "#/definitions/OrderDetailsResult"
},
"x-amzn-api-sandbox" : {
"static" : [ {
"request" : {
"parameters" : {
"externalId" : {
"value" : "[orderIdentifier]"
}
}
},
"response" : {
"lineItems" : [ {
"externalId" : "[lineItemIdentifier]",
"acceptedItems" : [ {
"quantity" : 2,
"artifacts" : [ {
"acceptanceArtifactType" : "[acceptanceArtifactSubtypeName]"
} ]
} ],
"rejectedItems" : [ {
"quantity" : 1,
"artifacts" : [ {
"rejectionArtifactType" : "[rejectionArtifactSubtypeName]"
} ]
} ]
} ],
"acceptanceArtifacts" : [ {
"acceptanceArtifactType" : "[acceptanceArtifactSubtypeName]"
} ],
"rejectionArtifacts" : [ {
"rejectionArtifactType" : "[rejectionArtifactSubtypeName]"
} ]
}
} ]
}
},
"400" : {
"description" : "The request has missing or invalid parameters and can't be parsed.",
"headers" : {
"x-amzn-RateLimit-Limit" : {
"type" : "string",
"description" : "The allowed rate limit (requests per second) for this operation."
},
"x-amzn-requestId" : {
"type" : "string",
"description" : "A unique request reference identifier."
}
},
"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" : {
"type" : "string",
"description" : "A unique request reference identifier."
}
},
"schema" : {
"$ref" : "#/definitions/ErrorList"
}
},
"404" : {
"description" : "The specified resource doesn't exist.",
"headers" : {
"x-amzn-RateLimit-Limit" : {
"type" : "string",
"description" : "The allowed rate limit (requests per second) for this operation."
},
"x-amzn-requestId" : {
"type" : "string",
"description" : "A unique request reference identifier."
}
},
"schema" : {
"$ref" : "#/definitions/ErrorList"
}
},
"429" : {
"description" : "The frequency of requests was greater than allowed.",
"headers" : {
"x-amzn-RateLimit-Limit" : {
"type" : "string",
"description" : "The allowed rate limit (requests per second) for this operation."
},
"x-amzn-requestId" : {
"type" : "string",
"description" : "A unique request reference identifier."
}
},
"schema" : {
"$ref" : "#/definitions/ErrorList"
}
},
"500" : {
"description" : "An unexpected condition occurred that prevented the server from fulfilling the request.",
"headers" : {
"x-amzn-RateLimit-Limit" : {
"type" : "string",
"description" : "The allowed rate limit (requests per second) for this operation."
},
"x-amzn-requestId" : {
"type" : "string",
"description" : "A unique request reference identifier."
}
},
"schema" : {
"$ref" : "#/definitions/ErrorList"
}
}
}
}
}
},
"definitions" : {
"PlaceOrderRequest" : {
"type" : "object",
"required" : [ "attributes", "expectations", "externalId", "lineItems" ],
"properties" : {
"externalId" : {
"type" : "string",
"description" : "A customer-specified identifier that is unique for each order.",
"minLength" : 1,
"maxLength" : 255
},
"lineItems" : {
"type" : "array",
"description" : "Items in the order.",
"items" : {
"$ref" : "#/definitions/RequestLineItem"
},
"maxItems" : 50,
"minItems" : 1
},
"attributes" : {
"type" : "array",
"description" : "Customer-determined order properties.",
"items" : {
"$ref" : "#/definitions/Attribute"
}
},
"expectations" : {
"type" : "array",
"description" : "Customer expectations about aspects of an order they do not directly control.",
"items" : {
"$ref" : "#/definitions/Expectation"
}
}
},
"description" : "A request to place an order."
},
"RequestLineItem" : {
"type" : "object",
"required" : [ "attributes", "expectations", "externalId", "quantity" ],
"properties" : {
"externalId" : {
"type" : "string",
"description" : "A customer-specified identifier that is unique for each line item.",
"minLength" : 1,
"maxLength" : 127
},
"quantity" : {
"type" : "integer",
"description" : "The total number to order for this item.",
"minimum" : 1
},
"attributes" : {
"type" : "array",
"description" : "Customer-determined line item properties.",
"items" : {
"$ref" : "#/definitions/Attribute"
}
},
"expectations" : {
"type" : "array",
"description" : "Line-item-specific customer expectations about aspects of the order they do not directly control.",
"items" : {
"$ref" : "#/definitions/Expectation"
}
}
},
"description" : "A single line item in an order request."
},
"Attribute" : {
"type" : "object",
"required" : [ "attributeType" ],
"discriminator" : "attributeType",
"properties" : {
"attributeType" : {
"type" : "string",
"description" : "The schema name for a subtype."
}
},
"description" : "A customer-determined aspect of the order."
},
"Expectation" : {
"type" : "object",
"required" : [ "expectationType" ],
"discriminator" : "expectationType",
"properties" : {
"expectationType" : {
"type" : "string",
"description" : "The schema name for a subtype."
}
},
"description" : "A customer's expectation about an aspect of an order they do not control."
},
"PlaceOrderResult" : {
"allOf" : [ {
"$ref" : "#/definitions/OrderResult"
} ],
"description" : "The result of a request to place an order. Specifies how line items in the request were broken up into ordered and rejected portions."
},
"OrderDetailsResult" : {
"allOf" : [ {
"$ref" : "#/definitions/OrderResult"
} ],
"description" : "The details of the order. Specifies how line items are broken up into ordered and rejected portions."
},
"OrderResult" : {
"type" : "object",
"required" : [ "acceptanceArtifacts", "lineItems", "rejectionArtifacts" ],
"properties" : {
"lineItems" : {
"type" : "array",
"description" : "Order results for specific line items.",
"items" : {
"$ref" : "#/definitions/ResultLineItem"
}
},
"acceptanceArtifacts" : {
"type" : "array",
"description" : "Results of a successful order.",
"items" : {
"$ref" : "#/definitions/AcceptanceArtifact"
}
},
"rejectionArtifacts" : {
"type" : "array",
"description" : "Reasons the order was rejected.",
"items" : {
"$ref" : "#/definitions/RejectionArtifact"
}
}
}
},
"ResultLineItem" : {
"type" : "object",
"required" : [ "acceptedItems", "externalId", "rejectedItems" ],
"properties" : {
"externalId" : {
"type" : "string",
"description" : "The customer-specified identifier for this line item."
},
"acceptedItems" : {
"type" : "array",
"description" : "Portions of the requested line item quantity that were successfully ordered.",
"items" : {
"$ref" : "#/definitions/AcceptedItem"
}
},
"rejectedItems" : {
"type" : "array",
"description" : "Portions of the requested line item quantity that couldn't be ordered.",
"items" : {
"$ref" : "#/definitions/RejectedItem"
}
}
},
"description" : "Results of an order for a specific line item."
},
"AcceptedItem" : {
"type" : "object",
"required" : [ "artifacts", "quantity" ],
"properties" : {
"quantity" : {
"type" : "integer",
"description" : "The accepted line item quantity."
},
"artifacts" : {
"type" : "array",
"description" : "Details about the ordered line item quantity.",
"items" : {
"$ref" : "#/definitions/AcceptanceArtifact"
}
}
},
"description" : "A portion of requested item quantity that was successfully ordered."
},
"RejectedItem" : {
"type" : "object",
"required" : [ "artifacts", "quantity" ],
"properties" : {
"quantity" : {
"type" : "integer",
"description" : "This rejected portion's item quantity."
},
"artifacts" : {
"type" : "array",
"description" : "Details about the rejected line item quantity.",
"items" : {
"$ref" : "#/definitions/RejectionArtifact"
}
}
},
"description" : "A portion of requested item quantity that couldn't be ordered."
},
"AcceptanceArtifact" : {
"type" : "object",
"required" : [ "acceptanceArtifactType" ],
"discriminator" : "acceptanceArtifactType",
"properties" : {
"acceptanceArtifactType" : {
"type" : "string",
"description" : "The schema name for a subtype."
}
},
"description" : "The details of a successful order."
},
"RejectionArtifact" : {
"type" : "object",
"required" : [ "rejectionArtifactType" ],
"discriminator" : "rejectionArtifactType",
"properties" : {
"rejectionArtifactType" : {
"type" : "string",
"description" : "The schema name for a subtype."
}
},
"description" : "Details the reason for order rejection."
},
"ErrorList" : {
"type" : "object",
"required" : [ "errors" ],
"properties" : {
"errors" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/Error"
}
}
},
"description" : "A list of error responses for an unsuccessful request."
},
"Error" : {
"type" : "object",
"required" : [ "code", "message" ],
"properties" : {
"code" : {
"type" : "string",
"description" : "An error code that identifies the type of error that occurred."
},
"message" : {
"type" : "string",
"description" : "A message describing the error condition."
},
"details" : {
"type" : "string",
"description" : "Additional details to help the caller understand or fix the issue."
}
},
"description" : "An error response for an unsuccessful request."
},
"Region" : {
"allOf" : [ {
"$ref" : "#/definitions/Attribute"
}, {
"required" : [ "region" ],
"properties" : {
"region" : {
"type" : "string",
"description" : "The Amazon Business stores.",
"enum" : [ "DE", "FR", "UK", "IT", "ES", "US", "CA", "JP" ],
"x-docgen-enum-table-extension" : [ {
"value" : "DE",
"description" : "amazon.de"
}, {
"value" : "FR",
"description" : "amazon.fr"
}, {
"value" : "UK",
"description" : "amazon.co.uk"
}, {
"value" : "IT",
"description" : "amazon.it"
}, {
"value" : "ES",
"description" : "amazon.es"
}, {
"value" : "US",
"description" : "amazon.com"
}, {
"value" : "CA",
"description" : "amazon.ca"
}, {
"value" : "JP",
"description" : "amazon.co.jp"
} ]
}
}
} ],
"description" : "The country or region where the buyer places an order."
},
"SelectedProductReference" : {
"allOf" : [ {
"$ref" : "#/definitions/Attribute"
}, {
"required" : [ "productReference" ],
"properties" : {
"productReference" : {
"description" : "The type of reference selected for a product.",
"$ref" : "#/definitions/ProductReference"
}
}
} ],
"description" : "Contains a reference to the product to order. This attribute can be passed at line-item or order level. If passed at order level, the product reference will apply to all line items that has no set attribute."
},
"SelectedBuyingOptionReference" : {
"allOf" : [ {
"$ref" : "#/definitions/Attribute"
}, {
"required" : [ "buyingOptionReference" ],
"properties" : {
"buyingOptionReference" : {
"description" : "The type of reference selected for a buying option.",
"$ref" : "#/definitions/BuyingOptionReference"
}
}
} ],
"description" : "Contains a reference to the buying option to order. This attribute can be passed at line-item or order level. If passed at order level, the buying option reference will apply to all line items that has no set attribute."
},
"ShippingAddress" : {
"allOf" : [ {
"$ref" : "#/definitions/Attribute"
}, {
"required" : [ "address" ],
"properties" : {
"address" : {
"description" : "The address where an item or order will be sent. This attribute can be passed at line-item or order level. If passed at order level, the address will apply to all line items that has no set attribute.",
"$ref" : "#/definitions/Address"
}
}
} ],
"description" : "The address where the order will be shipped."
},
"SelectedPaymentMethodReference" : {
"allOf" : [ {
"$ref" : "#/definitions/Attribute"
}, {
"required" : [ "paymentMethodReference" ],
"properties" : {
"paymentMethodReference" : {
"description" : "The payment method used to purchase the item or order.",
"$ref" : "#/definitions/PaymentMethodReference"
}
}
} ],
"description" : "The payment method where the charges for the order will apply. This attribute can only be passed at order level."
},
"BuyingGroupReference" : {
"allOf" : [ {
"$ref" : "#/definitions/Attribute"
}, {
"required" : [ "groupReference" ],
"properties" : {
"groupReference" : {
"description" : "A reference to the buying group.",
"$ref" : "#/definitions/GroupReference"
}
}
} ],
"description" : "A reference to the buying group associated with an order request. This attribute can only be passed at order level."
},
"BuyerReference" : {
"allOf" : [ {
"$ref" : "#/definitions/Attribute"
}, {
"required" : [ "userReference" ],
"properties" : {
"userReference" : {
"description" : "A reference to the buyer.",
"$ref" : "#/definitions/UserReference"
}
}
} ],
"description" : "A reference to the buying customer. This attribute can only be passed at order level."
},
"PurchaseOrderNumber" : {
"allOf" : [ {
"$ref" : "#/definitions/Attribute"
}, {
"required" : [ "purchaseOrderNumber" ],
"properties" : {
"purchaseOrderNumber" : {
"type" : "string",
"description" : "A numerical string acting as the identifier for the purchase order form.",
"minLength" : 1,
"maxLength" : 255
}
}
} ],
"description" : "A unique reference to the purchase order form of the order request. This attribute can only be passed at order level."
},
"BlanketPurchaseOrderNumber" : {
"allOf" : [ {
"$ref" : "#/definitions/PurchaseOrderNumber"
}, { } ],
"description" : "Identifies if the order request is placed against the blanket purchase order."
},
"TrialMode" : {
"allOf" : [ {
"$ref" : "#/definitions/Attribute"
}, { } ],
"description" : "Indicates that an order is a trial order. The steps to place an order will be completed, but no actual order will be created. This attribute can only be passed at order level."
},
"ExpectedUnitPrice" : {
"allOf" : [ {
"$ref" : "#/definitions/Expectation"
}, {
"required" : [ "amount" ],
"properties" : {
"amount" : {
"description" : "The expected unit price for an item.",
"$ref" : "#/definitions/Money"
}
}
} ],
"description" : "The unit price value the customer expects for an item. This expectation can be passed at line-item or order level. If passed at order level, the expected monetary charge will apply to all line items that has no set expectation."
},
"ExpectedCharge" : {
"allOf" : [ {
"$ref" : "#/definitions/Expectation"
}, {
"required" : [ "amount", "source" ],
"properties" : {
"amount" : {
"description" : "The expected charge amount.",
"$ref" : "#/definitions/Money"
},
"source" : {
"description" : "Indicates where the charges come from.",
"$ref" : "#/definitions/ChargeSource"
}
}
} ],
"description" : "The monetary charge that is expected for an item or order. This expectation can be passed at line-item or order level. If passed at order level, the expected monetary charge will apply to all line items that has no set expectation."
},
"OrderIdentifier" : {
"allOf" : [ {
"$ref" : "#/definitions/AcceptanceArtifact"
}, {
"required" : [ "identifier" ],
"properties" : {
"identifier" : {
"type" : "string",
"description" : "The identifier."
}
}
} ],
"description" : "The Amazon-generated identifier for a placed order. This artifact will be included at acceptance-item level."
},
"DeliveryTimeRange" : {
"allOf" : [ {
"$ref" : "#/definitions/AcceptanceArtifact"
}, {
"required" : [ "lowerBoundary", "upperBoundary" ],
"properties" : {
"lowerBoundary" : {
"description" : "The earliest estimated delivery date when an item or order is expected to reach the buyer or recipient.",
"$ref" : "#/definitions/DateTime"
},
"upperBoundary" : {
"description" : "The latest estimated delivery date when an item or order is expected to reach the buyer or recipient.",
"$ref" : "#/definitions/DateTime"
}
}
} ],
"description" : "The time range when a product is expected to reach its specified location. This artifact will appear at acceptance-item level."
},
"UnitPrice" : {
"allOf" : [ {
"$ref" : "#/definitions/AcceptanceArtifact"
}, {
"required" : [ "amount" ],
"properties" : {
"amount" : {
"description" : "The unit price.",
"$ref" : "#/definitions/Money"
}
}
} ],
"description" : "The unit price for an item. This artifact will appear at acceptance-item level."
},
"Charge" : {
"allOf" : [ {
"$ref" : "#/definitions/AcceptanceArtifact"
}, {
"required" : [ "amount", "category", "type" ],
"properties" : {
"amount" : {
"description" : "The charge.",
"$ref" : "#/definitions/Money"
},
"category" : {
"type" : "string",
"description" : "The charge category.",
"enum" : [ "SUBTOTAL", "SHIPPING", "GIFT_WRAP", "PAYMENT_METHOD_FEE", "EXPORT_FEE", "OTHER" ],
"x-docgen-enum-table-extension" : [ {
"value" : "SUBTOTAL",
"description" : "The sum of adding some numbers together but isn't the final total."
}, {
"value" : "SHIPPING",
"description" : "The cost of shipping an item or order."
}, {
"value" : "GIFT_WRAP",
"description" : "The cost of wrapping an item or order."
}, {
"value" : "PAYMENT_METHOD_FEE",
"description" : "An extra fee associated with the selected payment method."
}, {
"value" : "EXPORT_FEE",
"description" : "The cost of exporting an item or order."
}, {
"value" : "OTHER",
"description" : "Uncategorized charges"
} ]
},
"type" : {
"type" : "string",
"description" : "These are the type of charges applied to an item or order.",
"enum" : [ "PRINCIPAL", "TAX", "DISCOUNT" ],
"x-docgen-enum-table-extension" : [ {
"value" : "PRINCIPAL",
"description" : "The price of an item or order before any additional charges or credits are applied."
}, {
"value" : "TAX",
"description" : "The tax charges applied to the item or order."
}, {
"value" : "DISCOUNT",
"description" : "The discount applied to the item or order."
} ]
}
}
} ],
"description" : "A qualified monetary charge for an item or an order. This artifact will appear at acceptance-item level."
},
"PriceSuppressionDirective" : {
"allOf" : [ {
"$ref" : "#/definitions/Attribute"
}, { } ],
"description" : "Indicates that price information should be omitted in packing slips for all shipments in the order. This attribute can only be passed at order level."
},
"UnavailableQuantity" : {
"allOf" : [ {
"$ref" : "#/definitions/RejectionArtifact"
}, {
"required" : [ "quantity" ],
"properties" : {
"quantity" : {
"type" : "integer",
"description" : "The number of unavailable items."
}
}
} ],
"description" : "The number of unavailable quantity deducted from the total requested quantity. The order can only be fulfilled by the number of available quantity. This artifact will appear at rejected-item level."
},
"AvailableQuantity" : {
"allOf" : [ {
"$ref" : "#/definitions/RejectionArtifact"
}, {
"required" : [ "quantity" ],
"properties" : {
"quantity" : {
"type" : "integer",
"description" : "The number of available items."
}
}
} ],
"description" : "The number of available items. The order may be rejected because of the ordering constraints. This artifact will appear at rejected-item level."
},
"RejectionMessage" : {
"allOf" : [ {
"$ref" : "#/definitions/RejectionArtifact"
}, {
"required" : [ "message" ],
"properties" : {
"message" : {
"type" : "string",
"description" : "The rejection message."
}
}
} ],
"description" : "A message that summarizes a reason for rejection. This artifact will appear at rejected-item level."
},
"RejectionCode" : {
"allOf" : [ {
"$ref" : "#/definitions/RejectionArtifact"
}, {
"required" : [ "code" ],
"properties" : {
"code" : {
"type" : "string",
"description" : "The rejection code."
}
}
} ],
"description" : "A code that maps to a reason for rejection. This artifact will appear at rejected-item level."
},
"AgeRestriction" : {
"allOf" : [ {
"$ref" : "#/definitions/RejectionArtifact"
}, {
"required" : [ "minimumAge" ],
"properties" : {
"minimumAge" : {
"type" : "number",
"description" : "The minimum age required to purchase the item."
}
}
} ],
"description" : "A non-compliance with the age limit requirement results in order rejection. This artifact will appear at rejected-item level."
},
"DeliveryTimeRangeIncongruity" : {
"allOf" : [ {
"$ref" : "#/definitions/RejectionArtifact"
}, {
"required" : [ "actualDateTime", "upperBoundary" ],
"properties" : {
"upperBoundary" : {
"description" : "The item or order is for delivery on a later date.",
"$ref" : "#/definitions/DateTime"
},
"actualDateTime" : {
"description" : "The item or order is for delivery on the actual estimated delivery time.",
"$ref" : "#/definitions/DateTime"
}
}
} ],
"description" : "The estimated delivery time is outside the delivery time range, which led to order rejection. This artifact will appear at rejected-item level."
},
"BrokenUnitPriceExpectation" : {
"allOf" : [ {
"$ref" : "#/definitions/RejectionArtifact"
}, {
"required" : [ "actualAmount", "boundary" ],
"properties" : {
"boundary" : {
"description" : "The broken boundary for the unit price.",
"$ref" : "#/definitions/Money"
},
"actualAmount" : {
"description" : "The actual unit price of an item or order.",
"$ref" : "#/definitions/Money"
}
}
} ],
"description" : "The unit price exceeds the expected limit, which led to order rejection. This artifact will appear at rejected-item level."
},
"BrokenChargeExpectation" : {
"allOf" : [ {
"$ref" : "#/definitions/RejectionArtifact"
}, {
"required" : [ "actualAmount", "boundary" ],
"properties" : {
"boundary" : {
"description" : "The broken boundary for the charge.",
"$ref" : "#/definitions/Money"
},
"actualAmount" : {
"description" : "The actual amount charged to an item or order.",
"$ref" : "#/definitions/Money"
},
"sources" : {
"type" : "array",
"description" : "The list of charges with sum that exceeds the limit.",
"items" : {
"$ref" : "#/definitions/ChargeSource"
}
}
}
} ],
"description" : "The charges exceed the expected limit, which led to order rejection. This artifact will appear at rejected-item level."
},
"ChargeSource" : {
"type" : "string",
"description" : "The source of a monetary charge in an item or an order.",
"enum" : [ "SUBTOTAL", "SHIPPING", "TAX" ],
"x-docgen-enum-table-extension" : [ {
"value" : "SUBTOTAL",
"description" : "The sum of adding some numbers together but isn't the final total."
}, {
"value" : "SHIPPING",
"description" : "The cost of shipping an item or order."
}, {
"value" : "TAX",
"description" : "The tax charges for an item or order."
} ]
},
"Signed" : {
"allOf" : [ {
"$ref" : "#/definitions/AcceptanceArtifact"
}, { } ],
"description" : "Indicates that all accepted items have been placed as Amazon Business orders. This artifact will appear at order-result level."
},
"Shipment" : {
"allOf" : [ {
"$ref" : "#/definitions/AcceptanceArtifact"
}, {
"required" : [ "identifier", "packages" ],
"properties" : {
"identifier" : {
"type" : "string",
"description" : "The identifier for a shipment."
},
"packages" : {
"type" : "array",
"description" : "The collection of packages in this shipment.",
"items" : {
"$ref" : "#/definitions/Package"
}
}
}
} ],
"description" : "The shipment details for an order. This artifact will appear at order-level."
},
"Package" : {
"type" : "object",
"required" : [ "packageAttributes", "packageReference" ],
"properties" : {
"packageReference" : {
"description" : "A reference to the package.",
"$ref" : "#/definitions/PackageReference"
},
"packageAttributes" : {
"type" : "array",
"description" : "The attributes of the package.",
"items" : {
"$ref" : "#/definitions/packageAttribute"
}
}
},
"description" : "The package within the shipment."
},
"ShipmentGroup" : {
"allOf" : [ {
"$ref" : "#/definitions/AcceptanceArtifact"
}, {
"required" : [ "identifier", "packageReferences", "quantity" ],
"properties" : {
"identifier" : {
"type" : "string",
"description" : "The identifier for a shipment."
},
"packageReferences" : {
"type" : "array",
"description" : "The collection of package references.",
"items" : {
"$ref" : "#/definitions/PackageReference"
}
},
"quantity" : {
"type" : "integer",
"description" : "The total number of quantities in the package or shipment."
}
}
} ],
"description" : "The shipment group details for a line item. This artifact will appear at line item level."
},
"PackageReference" : {
"type" : "object",
"required" : [ "packageReferenceType" ],
"discriminator" : "packageReferenceType",
"properties" : {
"packageReferenceType" : {
"type" : "string",
"description" : "The schema name for a subtype."
}
},
"description" : "The base type for a reference to a package."
},
"CarrierTrackingNumber" : {
"allOf" : [ {
"$ref" : "#/definitions/PackageReference"
}, {
"required" : [ "value" ],
"properties" : {
"value" : {
"type" : "string",
"description" : "The carrier tracking number.",
"minLength" : 1
}
}
} ],
"description" : "The carrier tracking number of the package."
},
"PackageAttribute" : {
"type" : "object",
"required" : [ "packageAttributeType" ],
"discriminator" : "packageAttributeType",
"properties" : {
"packageAttributeType" : {
"type" : "string",
"description" : "The schema name for a subtype."
}
},
"description" : "The base type for a package attribute."
},
"PackageTrackingAttribute" : {
"allOf" : [ {
"$ref" : "#/definitions/PackageAttribute"
}, {
"required" : [ "carrierName", "deliveryDateRange" ],
"properties" : {
"carrierName" : {
"type" : "string",
"description" : "The carrier name.",
"minLength" : 1
},
"deliveryDateRange" : {
"type" : "object",
"description" : "The delivery date range when a package is expected to reach the buyer.",
"properties" : {
"startDateTime" : {
"description" : "The earliest delivery date for the package to reach the buyer.",
"$ref" : "#/definitions/DateTime"
},
"endDateTime" : {
"description" : "The later delivery date for the package to reach the buyer.",
"$ref" : "#/definitions/DateTime"
}
},
"required" : [ "endDateTime", "startDateTime" ]
}
}
} ],
"description" : "The tracking package attribute."
},
"ProductReference" : {
"type" : "object",
"required" : [ "productReferenceType" ],
"discriminator" : "productReferenceType",
"properties" : {
"productReferenceType" : {
"type" : "string",
"description" : "The schema name for a subtype."
}
},
"description" : "A unique reference for a product."
},
"BuyingOptionReference" : {
"type" : "object",
"required" : [ "buyingOptionReferenceType" ],
"discriminator" : "buyingOptionReferenceType",
"properties" : {
"buyingOptionReferenceType" : {
"type" : "string",
"description" : "The schema name for a subtype."
}
},
"description" : "A unique reference for a buying option."
},
"Address" : {
"type" : "object",
"required" : [ "addressType" ],
"discriminator" : "addressType",
"properties" : {
"addressType" : {
"type" : "string",
"description" : "The schema name for a subtype."
}
},
"description" : "The base type for an address."
},
"PaymentMethodReference" : {
"type" : "object",
"required" : [ "paymentMethodReferenceType" ],
"discriminator" : "paymentMethodReferenceType",
"properties" : {
"paymentMethodReferenceType" : {
"type" : "string",
"description" : "The schema name for a subtype."
}
},
"description" : "A unique reference to a payment method."
},
"GroupReference" : {
"type" : "object",
"required" : [ "groupReferenceType" ],
"discriminator" : "groupReferenceType",
"properties" : {
"groupReferenceType" : {
"type" : "string",
"description" : "The schema name for a subtype."
}
},
"description" : "A unique reference for a group."
},
"UserReference" : {
"type" : "object",
"required" : [ "userReferenceType" ],
"discriminator" : "userReferenceType",
"properties" : {
"userReferenceType" : {
"type" : "string",
"description" : "The schema name for a subtype."
}
},
"description" : "A unique reference for a user."
},
"Money" : {
"type" : "object",
"required" : [ "amount", "currencyCode" ],
"properties" : {
"currencyCode" : {
"type" : "string",
"description" : "The three-digit currency code based on ISO 4217.",
"pattern" : "^[A-Z]{3}$"
},
"amount" : {
"type" : "number",
"description" : "The amount in currency value."
}
},
"description" : "Represents a monetary value in currency."
},
"DateTime" : {
"type" : "object",
"required" : [ "date" ],
"properties" : {
"date" : {
"type" : "string",
"format" : "date-time",
"description" : "The date and time format based on ISO 8601. Time zone is optional. The format is YYYY-MM-DD HH:MM:SS:MMS. For example, 2020-07-10 15:00:00.000, represents the 10th of July 2020 at 3 p.m."
}
},
"description" : "The date format based on ISO 8601."
}
},
"Auxiliary": {
"type": "object",
"description": "An additional fields for customers to send additional information for pre or post order processing.",
"allOf": [
{
"$ref": "#/definitions/Attribute"
},
{
"properties": {
"values": {
"description": "A reference to a auxiliary values.",
"$ref": "#/definitions/AuxiliaryValues"
}
},
"required": [
"auxiliaryValues"
]
}
]
},
"AuxiliaryValues": {
"type": "object",
"description": "An auxiliary field values.",
"maxProperties": 30,
"additionalProperties": {
"$ref": "#/definitions/AuxiliaryValue"
}
},
"AuxiliaryValue": {
"type": "object",
"description": "An auxiliary value.",
"properties": {
"value": {
"description": "A value of auxiliary field.",
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"required": [
"value"
]
}
}
Updated 5 months ago
Did this page help you?