GeniuslinkAPI

<back to all web services

ProductMetadataLookupRequest

Requires Authentication
The following routes are available for this service:
GET/v3.5/product-metadata/lookup
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 ProductMetadataLookupResponse(IProductMetadataLookupResponse):
    product_metadata: Optional[ProductData] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProductMetadataLookupRequest(IProductMetadataLookupRequest):
    url: Optional[str] = None

Python ProductMetadataLookupRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v3.5/product-metadata/lookup HTTP/1.1 
Host: geniuslink-api-zane.dev.platform.georiot.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"productMetadata":{"attributes":{"retailer":"String","storefront":"String","storefrontIso2":"String","category":"String","brand":"String","manufacturer":"String","identifiers":{"gtins":["String"],"mpns":["String"],"ean8":["String"],"ean13":["String"],"isbn9":["String"],"isbn10":["String"],"isbn13":["String"],"itf14":["String"],"upc12":["String"]},"itemAttributes":{"book":{"authors":["String"]},"audiobook":{"authors":["String"]},"ebook":{"authors":["String"]}}},"retailerSpecificAttributes":{"name":"String","description":"String","skus":["String"],"asin":"String","productImages":{},"additionalData":{"String":"String"}},"rawSourceData":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}