GeniuslinkAPI

<back to all web services

GetProductMatchesByUrlRequest

// @DataContract
export class ProductIdentifiers
{
    // @DataMember(Name="productGuid", EmitDefaultValue=false)
    public productGuid: string;

    // @DataMember(Name="gtins", EmitDefaultValue=false)
    public gtins: string[];

    // @DataMember(Name="mpns", EmitDefaultValue=false)
    public mpns: string[];

    // @DataMember(Name="ean8", EmitDefaultValue=false)
    public ean8: string[];

    // @DataMember(Name="ean13", EmitDefaultValue=false)
    public ean13: string[];

    // @DataMember(Name="isbn9", EmitDefaultValue=false)
    public isbn9: string[];

    // @DataMember(Name="isbn10", EmitDefaultValue=false)
    public isbn10: string[];

    // @DataMember(Name="isbn13", EmitDefaultValue=false)
    public isbn13: string[];

    // @DataMember(Name="itf14", EmitDefaultValue=false)
    public itf14: string[];

    // @DataMember(Name="upc12", EmitDefaultValue=false)
    public upc12: string[];

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

// @DataContract
export class BookAttributes
{
    // @DataMember(Name="authors", EmitDefaultValue=false)
    public authors: string[];

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

// @DataContract
export class AudiobookAttributes extends BookAttributes
{

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

// @DataContract
export class EBookAttributes extends BookAttributes
{

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

// @DataContract
export class ItemAttributes
{
    // @DataMember(Name="book", EmitDefaultValue=false)
    public book: BookAttributes;

    // @DataMember(Name="audiobook", EmitDefaultValue=false)
    public audiobook: AudiobookAttributes;

    // @DataMember(Name="ebook", EmitDefaultValue=false)
    public ebook: EBookAttributes;

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

// @DataContract
export class ProductAttributes
{
    // @DataMember(Name="retailer", EmitDefaultValue=false)
    public retailer: string;

    // @DataMember(Name="retailerGuid", EmitDefaultValue=false)
    public retailerGuid: string;

    // @DataMember(Name="storefront", EmitDefaultValue=false)
    public storefront: string;

    // @DataMember(Name="storefrontIso2", EmitDefaultValue=false)
    public storefrontIso2: string;

    // @DataMember(Name="storefrontGuid", EmitDefaultValue=false)
    public storefrontGuid: string;

    // @DataMember(Name="category", EmitDefaultValue=false)
    public category: string;

    // @DataMember(Name="categoryGuid", EmitDefaultValue=false)
    public categoryGuid: string;

    // @DataMember(Name="brand", EmitDefaultValue=false)
    public brand: string;

    // @DataMember(Name="brandGuid", EmitDefaultValue=false)
    public brandGuid: string;

    // @DataMember(Name="manufacturer", EmitDefaultValue=false)
    public manufacturer: string;

    // @DataMember(Name="manufacturerGuid", EmitDefaultValue=false)
    public manufacturerGuid: string;

    // @DataMember(Name="identifiers", EmitDefaultValue=false)
    public identifiers: ProductIdentifiers;

    // @DataMember(Name="itemAttributes", EmitDefaultValue=false)
    public itemAttributes: ItemAttributes;

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

// @DataContract
export class RetailerSpecificAttributes
{
    // @DataMember(Name="name", EmitDefaultValue=false)
    public name: string;

    // @DataMember(Name="description", EmitDefaultValue=false)
    public description: string;

    // @DataMember(Name="skus", EmitDefaultValue=false)
    public skus: string[];

    // @DataMember(Name="asin", EmitDefaultValue=false)
    public asin: string;

    // @DataMember(Name="url", EmitDefaultValue=false)
    public url: string;

    // @DataMember(Name="productImages", EmitDefaultValue=false)
    public productImages: { [index:string]: string; };

    // @DataMember(Name="additionalData", EmitDefaultValue=false)
    public additionalData: { [index:string]: string; };

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

// @DataContract
export class ProductData
{
    // @DataMember(Name="attributes", EmitDefaultValue=false)
    public attributes: ProductAttributes;

    // @DataMember(Name="retailerSpecificAttributes", EmitDefaultValue=false)
    public retailerSpecificAttributes: RetailerSpecificAttributes;

    // @DataMember(Name="rawSourceData", EmitDefaultValue=false)
    public rawSourceData: string;

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

export enum ErrorCode
{
    Throttled = 'Throttled',
    TargetRetailerProductNotFound = 'TargetRetailerProductNotFound',
    Unknown = 'Unknown',
    NullMatchResult = 'NullMatchResult',
    NullSourceData = 'NullSourceData',
    SourceDataProcessingFailure = 'SourceDataProcessingFailure',
    LocalizationFailure = 'LocalizationFailure',
}

// @DataContract
export class MatchError
{
    // @DataMember(Name="message")
    public message: string;

    // @DataMember(Name="error")
    public error: ErrorCode;

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

// @DataContract
export class MatchResult
{
    // @DataMember(Name="retailer")
    public retailer: string;

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

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

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

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

    // @DataMember(Name="data")
    public data: ProductData;

    // @DataMember(Name="errors")
    public errors: MatchError[];

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

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

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

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

// @DataContract
export class ProductMetadata
{
    // @DataMember(Name="title")
    public title: string;

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

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

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

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

    // @DataMember(Name="productImages")
    public productImages: { [index:string]: string; };

    // @DataMember(Name="rawAttributes")
    public rawAttributes: MatchResult;

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

export class GetProductMatchesByUrlResponse implements IGetProductMatchesByUrlResponse
{
    public products: ProductMetadata[];
    public responseStatus: ResponseStatus;

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

// @DataContract
export class GetProductMatchesByUrlRequest implements IGetProductMatchesByUrlRequest
{
    // @DataMember(Name="url")
    public url: string;

    // @DataMember(Name="includeRaw")
    public includeRaw: boolean;

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

TypeScript GetProductMatchesByUrlRequest DTOs

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>