ProductMatching.API

<back to all web services

PostProductMatchingCallbackRequest

Requires Authentication
The following routes are available for this service:
POST/v1/product-matching-callback
PostProductMatchingCallbackRequest Parameters:
NameParameterData TypeRequiredDescription
MatchedProductsbodyList<ProductMatch>No
RequestbodyIDictionary<string, string>No
ProductMatch Parameters:
NameParameterData TypeRequiredDescription
RetailerGuidformGuidNo
RetailerNameformstringNo
BrandformstringNo
ProductNameformstringNo
DescriptionformstringNo
SKUformstringNo
GTINformstringNo
EAN8formstringNo
EAN13formstringNo
ISBNformstringNo
UPCformstringNo
ProductImageUrlformUriNo
ProductUrlformUriNo
AuditResultformstringNo
AuditResultReasonsformList<string>No
PostProductMatchingCallbackResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /v1/product-matching-callback HTTP/1.1 
Host: product-matching-api.kit.co 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"matchedProducts":[{"retailerGuid":"00000000000000000000000000000000","retailerName":"String","brand":"String","productName":"String","description":"String","sku":"String","gtin":"String","ean8":"String","ean13":"String","isbn":"String","upc":"String","auditResult":"String","auditResultReasons":["String"]}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}