ProductMatching.API

PostProductMatchingCallbackRequest

The following routes are available for this service:
POST	/v1/product-matching-callback


export class PostProductMatchingCallbackResponse
{
    public responseStatus?: ResponseStatus;

    public constructor(init?: Partial<PostProductMatchingCallbackResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ProductMatch implements IProductMatch
{
    // @DataMember(Name="retailerGuid")
    public retailerGuid?: string;

    // @DataMember(Name="retailerName")
    public retailerName?: string;

    // @DataMember(Name="brand")
    public brand?: string;

    // @DataMember(Name="productName")
    public productName?: string;

    // @DataMember(Name="description")
    public description?: string;

    // @DataMember(Name="sku")
    public sku?: string;

    // @DataMember(Name="gtin")
    public gtin?: string;

    // @DataMember(Name="ean8")
    public eaN8?: string;

    // @DataMember(Name="ean13")
    public eaN13?: string;

    // @DataMember(Name="isbn")
    public isbn?: string;

    // @DataMember(Name="upc")
    public upc?: string;

    // @DataMember(Name="productImageUrl")
    public productImageUrl?: string;

    // @DataMember(Name="productUrl")
    public productUrl?: string;

    // @DataMember(Name="auditResult")
    public auditResult?: string;

    // @DataMember(Name="auditResultReasons")
    public auditResultReasons?: string[];

    public constructor(init?: Partial<ProductMatch>) { (Object as any).assign(this, init); }
}

export class PostProductMatchingCallbackRequest
{
    public matchedProducts?: ProductMatch[];
    public request?: { [index: string]: string; };

    public constructor(init?: Partial<PostProductMatchingCallbackRequest>) { (Object as any).assign(this, init); }
}

TypeScript PostProductMatchingCallbackRequest DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
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: text/jsv
Content-Length: length

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