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 java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class PostProductMatchingUpdateCallbackRequest
{
    var productMatches:ArrayList<ProductMatch> = ArrayList<ProductMatch>()
    var sourceUrl:Uri? = null
}

@DataContract
open class ProductMatch : IProductMatch
{
    @DataMember(Name="retailerGuid")
    @SerializedName("retailerGuid")
    var retailerGuid:UUID? = null

    @DataMember(Name="retailerName")
    @SerializedName("retailerName")
    var retailerName:String? = null

    @DataMember(Name="brand")
    @SerializedName("brand")
    var brand:String? = null

    @DataMember(Name="productName")
    @SerializedName("productName")
    var productName:String? = null

    @DataMember(Name="description")
    @SerializedName("description")
    var description:String? = null

    @DataMember(Name="sku")
    @SerializedName("sku")
    var sku:String? = null

    @DataMember(Name="gtin")
    @SerializedName("gtin")
    var gtin:String? = null

    @DataMember(Name="ean8")
    @SerializedName("ean8")
    var eaN8:String? = null

    @DataMember(Name="ean13")
    @SerializedName("ean13")
    var eaN13:String? = null

    @DataMember(Name="isbn")
    @SerializedName("isbn")
    var isbn:String? = null

    @DataMember(Name="upc")
    @SerializedName("upc")
    var upc:String? = null

    @DataMember(Name="productImageUrl")
    @SerializedName("productImageUrl")
    var productImageUrl:Uri? = null

    @DataMember(Name="productUrl")
    @SerializedName("productUrl")
    var productUrl:Uri? = null

    @DataMember(Name="auditResult")
    @SerializedName("auditResult")
    var auditResult:String? = null

    @DataMember(Name="auditResultReasons")
    @SerializedName("auditResultReasons")
    var auditResultReasons:ArrayList<String> = ArrayList<String>()
}

open class PostProductMatchingUpdateCallbackResponse
{
    var responseStatus:ResponseStatus? = null
}

Kotlin 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>