Conversation
The previous example for a successful 200 response code did not match
the structure of the "GetOrderItemsBuyerInfoResponse" response schema
(see below). It was missing the "OrderItemsBuyerInfoList" and
"OrderItemBuyerInfoList" levels of the data structure, skipping straight
to the "OrderItemBuyerInfo" level instead, where it had an incorrect
value of "903-1671087-0812628" for "OrderItemId", which actually should
have been the "AmazonOrderId" in the missing "OrderItemsBuyerInfoList"
level of the structure.
To fix this example response, I started with the data from the example
response for "getOrderItems", which was using the same "AmazonOrderId"
value of "903-1671087-0812628". I restructured the response data to
match the correct response schema for this operation and removed the
extraneous data.
The fixed example should be valid for the response schema:
"GetOrderItemsBuyerInfoResponse": {
"type": "object",
"properties": {
"payload": {
"description": "The payload for the getOrderItemsBuyerInfo operation.",
"$ref": "#/definitions/OrderItemsBuyerInfoList"
},
"errors": {
"description": "One or more unexpected errors occurred during the getOrderItemsBuyerInfo operation.",
"$ref": "#/definitions/ErrorList"
}
},
"description": "The response schema for the getOrderItemsBuyerInfo operation."
},
"OrderItemsBuyerInfoList": {
"type": "object",
"required": [
"AmazonOrderId",
"OrderItems"
],
"properties": {
"OrderItems": {
"$ref": "#/definitions/OrderItemBuyerInfoList"
},
"NextToken": {
"type": "string",
"description": "When present and not empty, pass this string token in the next request to return the next response page."
},
"AmazonOrderId": {
"type": "string",
"description": "An Amazon-defined order identifier, in 3-7-7 format."
}
},
"description": "A single order item's buyer information list with the order ID."
},
"OrderItemBuyerInfoList": {
"type": "array",
"description": "A single order item's buyer information list.",
"items": {
"$ref": "#/definitions/OrderItemBuyerInfo"
}
},
"OrderItemBuyerInfo": {
"type": "object",
"required": [
"OrderItemId"
],
"properties": {
"OrderItemId": {
"type": "string",
"description": "An Amazon-defined order item identifier."
},
"BuyerCustomizedInfo": {
"description": "Buyer information for custom orders from the Amazon Custom program.",
"$ref": "#/definitions/BuyerCustomizedInfoDetail"
},
"GiftWrapPrice": {
"description": "The gift wrap price of the item.",
"$ref": "#/definitions/Money"
},
"GiftWrapTax": {
"description": "The tax on the gift wrap price.",
"$ref": "#/definitions/Money"
},
"GiftMessageText": {
"type": "string",
"description": "A gift message provided by the buyer."
},
"GiftWrapLevel": {
"type": "string",
"description": "The gift wrap level specified by the buyer."
}
},
"description": "A single order item's buyer information."
},
deven
force-pushed
the
fix-getOrderItemsBuyerInfo-example
branch
from
October 8, 2025 23:35
6ea2b58 to
bfe7e65
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The previous example for a successful 200 response code did not match the structure of the "GetOrderItemsBuyerInfoResponse" response schema (see below). It was missing the "OrderItemsBuyerInfoList" and "OrderItemBuyerInfoList" levels of the data structure, skipping straight to the "OrderItemBuyerInfo" level instead, where it had an incorrect value of "903-1671087-0812628" for "OrderItemId", which actually should have been the "AmazonOrderId" in the missing "OrderItemsBuyerInfoList" level of the structure.
To fix this example response, I started with the data from the example response for "getOrderItems", which was using the same "AmazonOrderId" value of "903-1671087-0812628". I restructured the response data to match the correct response schema for this operation and removed the extraneous data.
The fixed example should be valid for the response schema:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.