ProductMatching.API

<back to all web services

PostProductMatchingCallbackRequest

Requires Authentication
The following routes are available for this service:
POST/v1/product-matching-callback
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ProductMatching.API.ServiceModel.V1.ProductMatching;
using ProductMatching.API.ServiceModel.DTOs;

namespace ProductMatching.API.ServiceModel.DTOs
{
    [DataContract]
    public partial class ProductMatch
        : IProductMatch
    {
        public ProductMatch()
        {
            AuditResultReasons = new List<string>{};
        }

        [DataMember(Name="retailerGuid")]
        public virtual Guid RetailerGuid { get; set; }

        [DataMember(Name="retailerName")]
        public virtual string RetailerName { get; set; }

        [DataMember(Name="brand")]
        public virtual string Brand { get; set; }

        [DataMember(Name="productName")]
        public virtual string ProductName { get; set; }

        [DataMember(Name="description")]
        public virtual string Description { get; set; }

        [DataMember(Name="sku")]
        public virtual string SKU { get; set; }

        [DataMember(Name="gtin")]
        public virtual string GTIN { get; set; }

        [DataMember(Name="ean8")]
        public virtual string EAN8 { get; set; }

        [DataMember(Name="ean13")]
        public virtual string EAN13 { get; set; }

        [DataMember(Name="isbn")]
        public virtual string ISBN { get; set; }

        [DataMember(Name="upc")]
        public virtual string UPC { get; set; }

        [DataMember(Name="productImageUrl")]
        public virtual Uri ProductImageUrl { get; set; }

        [DataMember(Name="productUrl")]
        public virtual Uri ProductUrl { get; set; }

        [DataMember(Name="auditResult")]
        public virtual string AuditResult { get; set; }

        [DataMember(Name="auditResultReasons")]
        public virtual List<string> AuditResultReasons { get; set; }
    }

}

namespace ProductMatching.API.ServiceModel.V1.ProductMatching
{
    public partial class PostProductMatchingCallbackRequest
    {
        public PostProductMatchingCallbackRequest()
        {
            MatchedProducts = new List<ProductMatch>{};
        }

        public virtual List<ProductMatch> MatchedProducts { get; set; }
        public virtual IDictionary<string, string> Request { get; set; }
    }

    public partial class PostProductMatchingCallbackResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# PostProductMatchingCallbackRequest DTOs

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/product-matching-callback HTTP/1.1 
Host: product-matching-api.kit.co 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PostProductMatchingCallbackRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProductMatching.API.ServiceModel.V1.ProductMatching">
  <MatchedProducts xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProductMatching.API.ServiceModel.DTOs">
    <d2p1:ProductMatch>
      <d2p1:auditResult>String</d2p1:auditResult>
      <d2p1:auditResultReasons xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:auditResultReasons>
      <d2p1:brand>String</d2p1:brand>
      <d2p1:description>String</d2p1:description>
      <d2p1:ean13>String</d2p1:ean13>
      <d2p1:ean8>String</d2p1:ean8>
      <d2p1:gtin>String</d2p1:gtin>
      <d2p1:isbn>String</d2p1:isbn>
      <d2p1:productImageUrl i:nil="true" />
      <d2p1:productName>String</d2p1:productName>
      <d2p1:productUrl i:nil="true" />
      <d2p1:retailerGuid>00000000-0000-0000-0000-000000000000</d2p1:retailerGuid>
      <d2p1:retailerName>String</d2p1:retailerName>
      <d2p1:sku>String</d2p1:sku>
      <d2p1:upc>String</d2p1:upc>
    </d2p1:ProductMatch>
  </MatchedProducts>
  <Request xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
</PostProductMatchingCallbackRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PostProductMatchingCallbackResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProductMatching.API.ServiceModel.V1.ProductMatching">
  <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>
</PostProductMatchingCallbackResponse>