ProductMatching.API

<back to all web services

PostProductMatchingUpdateCallbackRequest

Requires Authentication
The following routes are available for this service:
POST/v1/product-matching-update-callback
import Foundation
import ServiceStack

public class PostProductMatchingUpdateCallbackRequest : Codable
{
    public var productMatches:[ProductMatch] = []
    public var sourceUrl:Uri?

    required public init(){}
}

// @DataContract
public class ProductMatch : IProductMatch, Codable
{
    // @DataMember(Name="retailerGuid")
    public var retailerGuid:String?

    // @DataMember(Name="retailerName")
    public var retailerName:String?

    // @DataMember(Name="brand")
    public var brand:String?

    // @DataMember(Name="productName")
    public var productName:String?

    // @DataMember(Name="description")
    public var Description:String?

    // @DataMember(Name="sku")
    public var sku:String?

    // @DataMember(Name="gtin")
    public var gtin:String?

    // @DataMember(Name="ean8")
    public var eaN8:String?

    // @DataMember(Name="ean13")
    public var eaN13:String?

    // @DataMember(Name="isbn")
    public var isbn:String?

    // @DataMember(Name="upc")
    public var upc:String?

    // @DataMember(Name="productImageUrl")
    public var productImageUrl:Uri?

    // @DataMember(Name="productUrl")
    public var productUrl:Uri?

    // @DataMember(Name="auditResult")
    public var auditResult:String?

    // @DataMember(Name="auditResultReasons")
    public var auditResultReasons:[String] = []

    required public init(){}
}

public class PostProductMatchingUpdateCallbackResponse : Codable
{
    public var responseStatus:ResponseStatus?

    required public init(){}
}


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

<PostProductMatchingUpdateCallbackRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProductMatching.API.ServiceModel.V1.ProductMatching">
  <ProductMatches 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>
  </ProductMatches>
  <SourceUrl i:nil="true" />
</PostProductMatchingUpdateCallbackRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PostProductMatchingUpdateCallbackResponse 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>
</PostProductMatchingUpdateCallbackResponse>