ProductMatching.API

<back to all web services

PostProductMatchingCallbackRequest

Requires Authentication
The following routes are available for this service:
POST/v1/product-matching-callback
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PostProductMatchingCallbackResponse:
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProductMatch(IProductMatch):
    retailer_guid: Optional[str] = None
    retailer_name: Optional[str] = None
    brand: Optional[str] = None
    product_name: Optional[str] = None
    description: Optional[str] = None
    sku: Optional[str] = None
    gtin: Optional[str] = None
    ea_n8: Optional[str] = None
    ea_n13: Optional[str] = None
    isbn: Optional[str] = None
    upc: Optional[str] = None
    product_image_url: Optional[str] = None
    product_url: Optional[str] = None
    audit_result: Optional[str] = None
    audit_result_reasons: Optional[List[str]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PostProductMatchingCallbackRequest:
    matched_products: Optional[List[ProductMatch]] = None
    request: Optional[Dict[str, str]] = None

Python 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
		}
	}
}