This section of the documentation contains details of other XML tags returned by ECS.
The Customer/ element is returned by CustomerContentSearch or CustomerContentLookup operations. This data is available only if the customer has agreed to make it public on the Amazon Web site.
Customer
| Element | Notes |
|---|---|
| Name | |
| Nickname | Not returned for JP, FR, and CA. |
| AboutMe | |
| Birthday | |
| CustomerId | |
| Location/ | City, State and Country |
| TotalPages | |
| TotalResults | |
| WishListId |
Customer-contributed reviews are also available through ECS and are described in the Reviews chapter of this manual.
Sellers are:
zShops sellers
Marketplace sellers
Seller information is returned:
As a result of a SellerLookup. A Sellers/Seller element is returned for each seller, with all of the elements returned.
As a result of a SellerListingLookup or SellerListingSearch. A SellerListing/Seller element is returned which contains only the SellerId and Nickname elements.
As a result of ItemSearch or ItemLookup. An Offers/Offer/Seller element is returned which omits SellerFeedback and SelllerName.
| Element | Notes | |||
|---|---|---|---|---|
| Seller/ | ||||
| SellerId | Unique identifier of this seller | |||
| Location/ | Geographic location of this seller | |||
| City | ||||
| State | ||||
| GlancePage | URL for Web page of this seller. A GlancePage is not returned when the merchant is Amazon. | |||
| About | ||||
| MoreAbout | ||||
| SellerName | Seller's name | |||
| SellerNickname | Seller-provided nickname | |||
| AverageFeedbackRating | Average rating given by customers | |||
| TotalFeedback | Number of customer comments available for this seller. | |||
| SellerFeedback/ | One instance per seller; element contains feedback comments by customers. | |||
| Feedback/ | One instance for each customer feedback comment. | |||
| Rating | Customer evaluation, on a scale of 0 to 5 where 5 is the best. | |||
| Comment | Customer comments. | |||
| Date | Date the comment was made. | |||
| RatedBy | Customer ID of the individual making the comment. |
Seller listings are product listings for zShops, that do not appear in the usual Amazon catalog results. The SellerListing element has the child elements shown in the table below.
| Element | Notes |
|---|---|
| ASIN | |
| Availability | |
| Condition | |
| ConditionNote | Not returned for JP, FR, and CA. |
| EndDate | |
| ExchangeId | |
| FeaturedCategory | Not returned for JP, FR, and CA. |
| Image | |
| ListingId | |
| Price/ | Price for this item with child elements that contain the price. Note that the actual price(s) are listed in the offer(s). |
| Quantity | |
| QuantityAllocated | Not returned for JP, FR, and CA. |
| Seller/ | |
| StartDate | |
| Status | |
| SubCondition | |
| Title |
The shopping cart operations return a Cart/ element which contains the product(s) that the customer wishes to purchase.
The cart is a very simple data structure that consists of:
Overview of the Cart element and its Child Elements
| Data Structure | XML tag | Description |
|---|---|---|
| Shopping cart | Cart | The cart is a data container which holds a collection of items. |
| Cart items | Cart/Cartitems/CartItem | Similar to a line item on an invoice, each cart item has a minimum of: a product identifier (typically an ASIN) and quantity. Cart items can also have other properties such as color, size, style, etc. depending on the product. There can be up to 50 cart items in an ECS cart. Cart items must be referenced by their identifier within the cart, the CartItemId: Cart/CartItems/CartItem/CartItemId rather than by ASIN. When available items are added to the cart (via CartCreate or CartAdd), they are added as cart items. |
| Saved items | Cart/SavedForLaterItems/SavedForLaterItem | Saved items are still in the cart, but will not be purchased until they are converted to cart items. When an unvailable or discontinued item is added to the cart, it is automatically added as a saved item rather than a cart item. However the CartModify operation can be used to change saved items to cart items and vice versa. |
The Cart element returned by the cart operations consists of:
The Cart element and its children
| Element | Description | |||
|---|---|---|---|---|
| Cart/ | One instance returned for each cart operation response. | |||
| CartId | Unique identifier returned from a CartCreate operation. Both CartId and HMAC are required to specify a cart and both should be validated on modified carts. Note that the <CartId> and <HMAC> elements may contain non-alphanumeric characters. If you wish to use CartModify, CartAdd, CartClear or CartGet with the same cart, you must be sure that such characters are URL-encoded. |
|||
| HMAC | Security token
returned when the cart is created. Both HMAC and
CartId are required to specify a cart and both should be
validated on modified carts. HMAC is linked with the
Associate ID that was used to create the cart, and subsequent operations on the
cart will not be allowed if the Associate ID is different than the ID that was
used for the cart creation.
Note that the <CartId> and <HMAC> elements may contain non-alphanumeric characters. If you wish to use CartModify, CartAdd, CartClear or CartGet with the same cart, you must be sure that such characters are URL-encoded. |
|||
| PurchaseURL | Amazon URL for purchasing the contents of this cart. This URL encodes the CartId and HMAC as well as your Associate ID to ensure you are credited with a commission if/when the customer completes the purchase transaction. | |||
| CartItems/ | One instance per Cart. Contains the cart entries. | |||
| CartItem/ | Entry for an item currently being purchased. | |||
| CartItemId | Unique identifier for this cart entry. | |||
| ASIN | Amazon Standard Identification Number. Unique product identifier on the current Amazon Web site. | |||
| Price/ | Standard price element for this item with child elements that contain the price. Note that the actual price(s) are listed in the offer(s). | |||
| ProductGroup | Product category to which the item belongs (e.g., Book, Video, etc.) | |||
| MerchantId | ||||
| SellerId | ||||
| ExchangeId | ||||
| Quantity | Number of this product that are to be purchased. | |||
| Title | Name or description of the product. For books, this is the title. For apparel, this is a brief description. For electronics, this is the product name/model. | |||
| SavedForLaterItems/ | ||||
| SavedForLaterItem/ | Entry for an item that is currently unavailable or no longer being currently considered for purchase. | |||
| ASIN | ||||
| ItemId | ||||
| Price/ | Standard price element for this item with child elements that contain the price. Note that the actual price(s) are listed in the offer(s). | |||
| ProductGroup | ||||
| MerchantId | ||||
| SellerId | ||||
| ExchangeId | ||||
| Quantity | ||||
| Title | ||||
| SimilarProducts/ | ||||
| ASIN | ||||
| Title |
The Transaction element contains information about transaction totals.
| Element | Notes |
|---|---|
| TransactionId | |
| SellerId | |
| Condition | New, used, refurbished or collectible. |
| TransactionDate | Format: yyyy-mm-ddThh:xx:ss (yyyy=year, mm=month, dd=day, hh=hours, xx=minutes, ss=seconds) |
| TransactionDateEpoch | Epoch date of the transaction (number of seconds since 1/1/1970). |
| SellerName | |
| Totals |
For Amazon partners, you will receive an additional element called TransactionItem which includes details of the items in the transaction.
Child Elements of the TransactionItem Element
| Element | Notes |
|---|---|
| TransactionItemId | Analagous to CartItemId or LookupItemId, an identifier that is only valid within the scope of this transaction. |
| Quantity | |
| UnitPrice | |
| TotalPrice | |
| ASIN | |
| ChildTransactionItems/ |
The Help operation returns an Information element that contains two elements:
If you set the HelpType parameter to Operation, the Information element contains an OperationInformation element.
If you set the HelpType parameter to ResponseGroup, the Information element contains a ResponseGroupInformation element.
This element contains a description of an operation, as shown in the table below.
Child Elements of an OperationInformation Element
| Element | Notes |
|---|---|
| Name | |
| Description | |
| RequiredParameters/ | One instance containing multiple Parameter child elements, one for each required parameter. Required parameters must be included in each operation request of this type or an error will be returned. |
| AvailableParameters/ | One instance containing multiple Parameter child elements, one for each optional parameter. Required parameters are not included in this element. If an optional parameter has a default value and it is not included in the operation request, then the default value will be used to generate the response to the operation. |
| DefaultResponseGroups/ | One instance containing multiple ResponseGroup child elements, one for each default response group. |
| AvailableResponseGroups/ | One instance containing multiple ResponseGroup child elements, one for each valid response group. Default response groups are included in this element. |
This element is returned when a Help operation has the HelpType parameter set to ResponseGroup. This element describes a response group.
| Element | Notes |
|---|---|
| Name | |
| CreationDate | Earliest WSDL version that included this response group. |
| ValidOperations/ | One instance with multiple Operation child elements, one for each operation for which this response group is valid. |
| Elements/ | One instance with multiple Element child elements, one for each element that is potentially returned by operation requests that specify this response group. |