GeniuslinkAPI

<back to all web services

GetProductMatchesByUrlRequest

Requires Authentication
The following routes are available for this service:
GET/v3.5/product/matches
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


class ErrorCode(str, Enum):
    THROTTLED = 'Throttled'
    TARGET_RETAILER_PRODUCT_NOT_FOUND = 'TargetRetailerProductNotFound'
    UNKNOWN = 'Unknown'
    NULL_MATCH_RESULT = 'NullMatchResult'
    NULL_SOURCE_DATA = 'NullSourceData'
    SOURCE_DATA_PROCESSING_FAILURE = 'SourceDataProcessingFailure'
    LOCALIZATION_FAILURE = 'LocalizationFailure'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MatchError:
    message: Optional[str] = None
    code: Optional[ErrorCode] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MatchResult:
    retailer: Optional[str] = None
    retailer_guid: Optional[str] = None
    storefront: Optional[str] = None
    storefront_iso2: Optional[str] = None
    storefront_guid: Optional[str] = None
    data: Optional[ProductData] = None
    errors: Optional[List[MatchError]] = None
    match_accuracy: Optional[str] = None
    matching_rule_name: Optional[str] = None
    data_source: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProductMetadata:
    title: Optional[str] = None
    author: Optional[str] = None
    url: Optional[str] = None
    description: Optional[str] = None
    retailer: Optional[str] = None
    product_images: Optional[Dict[str, str]] = None
    raw_attributes: Optional[MatchResult] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetProductMatchesByUrlResponse(IGetProductMatchesByUrlResponse):
    products: Optional[List[ProductMetadata]] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetProductMatchesByUrlRequest(IGetProductMatchesByUrlRequest):
    url: Optional[str] = None
    include_raw: bool = False

Python GetProductMatchesByUrlRequest 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.

GET /v3.5/product/matches HTTP/1.1 
Host: geniuslink-api-zane.dev.platform.georiot.com 
Accept: application/xml

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

<GetProductMatchesByUrlResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GeniuslinkAPI.ServiceModel.V4.Products.Responses">
  <Products xmlns:d2p1="http://schemas.datacontract.org/2004/07/Geniuslink.Products.QueuedService.Contracts.V1.DTOs" i:nil="true" />
  <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>
</GetProductMatchesByUrlResponse>