ProductAPI.Amazon

<back to all web services

PostProductSearchRequest

Requires Authentication
The following routes are available for this service:
POST/v1/search
PostProductSearchRequestBase Parameters:
NameParameterData TypeRequiredDescription
DataformIList<ProductData>No
TimeoutMsformuintNo
MaxStalenessMsformulongNo
CountryIso2sformList<string>No
TargetProductCategoriesformIEnumerable<string>No
ProductData Parameters:
NameParameterData TypeRequiredDescription
AttributesformProductAttributesNo
RetailerSpecificAttributesformRetailerSpecificAttributesNo
RawSourceDataformstringNo
ProductAttributes Parameters:
NameParameterData TypeRequiredDescription
RetailerformstringNo
RetailerGuidformGuidNo
StorefrontformstringNo
StorefrontIso2formstringNo
StorefrontGuidformGuidNo
CategoryformstringNo
CategoryGuidformGuidNo
BrandformstringNo
BrandGuidformGuidNo
ManufacturerformstringNo
ManufacturerGuidformGuidNo
IdentifiersformProductIdentifiersNo
ItemAttributesformItemAttributesNo
ProductIdentifiers Parameters:
NameParameterData TypeRequiredDescription
ProductGuidformGuidNo
GtinsformList<string>No
MpnsformList<string>No
Ean8formList<string>No
Ean13formList<string>No
Isbn9formList<string>No
Isbn10formList<string>No
Isbn13formList<string>No
ITF14formList<string>No
Upc12formList<string>No
ItemAttributes Parameters:
NameParameterData TypeRequiredDescription
BookformBookAttributesNo
AudiobookformAudiobookAttributesNo
EBookformEBookAttributesNo
BookAttributes Parameters:
NameParameterData TypeRequiredDescription
AuthorsformList<string>No
RetailerSpecificAttributes Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
DescriptionformstringNo
SkusformList<string>No
AsinformstringNo
UrlformUriNo
ProductImagesformDictionary<string, Uri>No
AdditionalDataformDictionary<string, string>No
PostProductSearchResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
MatchResultsformIEnumerable<MatchResult>No
MatchResult Parameters:
NameParameterData TypeRequiredDescription
RetailerformstringNo
RetailerGuidformGuidNo
StorefrontformstringNo
StorefrontIso2formstringNo
StorefrontGuidformGuidNo
DataformProductDataNo
ErrorsformList<MatchError>No
MatchAccuracyformstringNo
MatchingRuleNameformstringNo
DataSourceformstringNo
MatchError Parameters:
NameParameterData TypeRequiredDescription
MessageformstringNo
CodeformErrorCodeNo
ErrorCode Enum:
Throttled
TargetRetailerProductNotFound
Unknown
NullMatchResult
NullSourceData
SourceDataProcessingFailure
LocalizationFailure

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/search HTTP/1.1 
Host: product-amazon-api.qa.platform.georiot.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PostProductSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProductAPI.Amazon.ServiceModel.V1.Requests">
  <countryIso2s xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/ProductAPI.Contracts.V1.Requests">
    <d2p1:string>String</d2p1:string>
  </countryIso2s>
  <data xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProductAPI.Contracts.V1.DTOs" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/ProductAPI.Contracts.V1.Requests" />
  <maxStaleness xmlns="http://schemas.datacontract.org/2004/07/ProductAPI.Contracts.V1.Requests">0</maxStaleness>
  <productTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/ProductAPI.Contracts.V1.Requests" />
  <timeoutMs xmlns="http://schemas.datacontract.org/2004/07/ProductAPI.Contracts.V1.Requests">0</timeoutMs>
</PostProductSearchRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PostProductSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProductAPI.Amazon.ServiceModel.V1.Responses">
  <matchResults xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProductAPI.Contracts.V1.DTOs" i:nil="true" />
  <responseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </responseStatus>
</PostProductSearchResponse>