GeniuslinkAPI

<back to all web services

GetProductMatchesByCriteriaRequest

Requires Authentication
The following routes are available for this service:
POST/v3.5/product/search
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 ProductIdentifiers:
    product_guid: Optional[str] = None
    gtins: Optional[List[str]] = None
    mpns: Optional[List[str]] = None
    ean8: Optional[List[str]] = None
    ean13: Optional[List[str]] = None
    isbn9: Optional[List[str]] = None
    isbn10: Optional[List[str]] = None
    isbn13: Optional[List[str]] = None
    it_f14: Optional[List[str]] = None
    upc12: Optional[List[str]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BookAttributes:
    authors: Optional[List[str]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AudiobookAttributes(BookAttributes):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EBookAttributes(BookAttributes):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ItemAttributes:
    book: Optional[BookAttributes] = None
    audiobook: Optional[AudiobookAttributes] = None
    e_book: Optional[EBookAttributes] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProductAttributes:
    retailer: Optional[str] = None
    retailer_guid: Optional[str] = None
    storefront: Optional[str] = None
    storefront_iso2: Optional[str] = None
    storefront_guid: Optional[str] = None
    category: Optional[str] = None
    category_guid: Optional[str] = None
    brand: Optional[str] = None
    brand_guid: Optional[str] = None
    manufacturer: Optional[str] = None
    manufacturer_guid: Optional[str] = None
    identifiers: Optional[ProductIdentifiers] = None
    item_attributes: Optional[ItemAttributes] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RetailerSpecificAttributes:
    name: Optional[str] = None
    description: Optional[str] = None
    skus: Optional[List[str]] = None
    asin: Optional[str] = None
    url: Optional[str] = None
    product_images: Optional[Dict[str, str]] = None
    additional_data: Optional[Dict[str, str]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProductData:
    attributes: Optional[ProductAttributes] = None
    retailer_specific_attributes: Optional[RetailerSpecificAttributes] = None
    raw_source_data: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MatchCriteria:
    retailer_guid: Optional[str] = None
    timeout_ms: int = 0
    country_iso2s: Optional[List[str]] = None
    max_staleness_ms: int = 0
    target_product_categories: Optional[List[str]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetProductMatchesByCriteriaRequest(IGetProductMatchesByCriteriaRequest):
    data: Optional[List[ProductData]] = None
    match_criteria: Optional[List[MatchCriteria]] = None
    max_timeout_ms: int = 0
    skip_criteria_check: bool = False

Python GetProductMatchesByCriteriaRequest 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 /v3.5/product/search HTTP/1.1 
Host: geniuslink-api-zane.dev.platform.georiot.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetProductMatchesByCriteriaRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GeniuslinkAPI.ServiceModel.V4.Products.Requests">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Geniuslink.Products.QueuedService.Contracts.V1.DTOs" i:nil="true" />
  <MatchCriteria xmlns:d2p1="http://schemas.datacontract.org/2004/07/Geniuslink.Products.QueuedService.Contracts.V1.DTOs" i:nil="true" />
  <MaxTimeoutMs>0</MaxTimeoutMs>
  <SkipCriteriaCheck>false</SkipCriteriaCheck>
</GetProductMatchesByCriteriaRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetProductMatchesByCriteriaRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GeniuslinkAPI.ServiceModel.V4.Products.Requests">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Geniuslink.Products.QueuedService.Contracts.V1.DTOs" i:nil="true" />
  <MatchCriteria xmlns:d2p1="http://schemas.datacontract.org/2004/07/Geniuslink.Products.QueuedService.Contracts.V1.DTOs" i:nil="true" />
  <MaxTimeoutMs>0</MaxTimeoutMs>
  <SkipCriteriaCheck>false</SkipCriteriaCheck>
</GetProductMatchesByCriteriaRequest>