GeniuslinkAPI

<back to all web services

GetProductMatchesByCriteriaRequest

Requires Authentication
The following routes are available for this service:
POST/v3.5/product/search
namespace Geniuslink.Products.QueuedService.Contracts.V1.DTOs

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type ProductIdentifiers() = 
        [<DataMember(Name="productGuid", EmitDefaultValue=false)>]
        member val ProductGuid:Guid = new Guid() with get,set

        [<DataMember(Name="gtins", EmitDefaultValue=false)>]
        member val Gtins:ResizeArray<String> = null with get,set

        [<DataMember(Name="mpns", EmitDefaultValue=false)>]
        member val Mpns:ResizeArray<String> = null with get,set

        [<DataMember(Name="ean8", EmitDefaultValue=false)>]
        member val Ean8:ResizeArray<String> = null with get,set

        [<DataMember(Name="ean13", EmitDefaultValue=false)>]
        member val Ean13:ResizeArray<String> = null with get,set

        [<DataMember(Name="isbn9", EmitDefaultValue=false)>]
        member val Isbn9:ResizeArray<String> = null with get,set

        [<DataMember(Name="isbn10", EmitDefaultValue=false)>]
        member val Isbn10:ResizeArray<String> = null with get,set

        [<DataMember(Name="isbn13", EmitDefaultValue=false)>]
        member val Isbn13:ResizeArray<String> = null with get,set

        [<DataMember(Name="itf14", EmitDefaultValue=false)>]
        member val ITF14:ResizeArray<String> = null with get,set

        [<DataMember(Name="upc12", EmitDefaultValue=false)>]
        member val Upc12:ResizeArray<String> = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BookAttributes() = 
        [<DataMember(Name="authors", EmitDefaultValue=false)>]
        member val Authors:ResizeArray<String> = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type AudiobookAttributes() = 
        inherit BookAttributes()

    [<DataContract>]
    [<AllowNullLiteral>]
    type EBookAttributes() = 
        inherit BookAttributes()

    [<DataContract>]
    [<AllowNullLiteral>]
    type ItemAttributes() = 
        [<DataMember(Name="book", EmitDefaultValue=false)>]
        member val Book:BookAttributes = null with get,set

        [<DataMember(Name="audiobook", EmitDefaultValue=false)>]
        member val Audiobook:AudiobookAttributes = null with get,set

        [<DataMember(Name="ebook", EmitDefaultValue=false)>]
        member val EBook:EBookAttributes = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ProductAttributes() = 
        [<DataMember(Name="retailer", EmitDefaultValue=false)>]
        member val Retailer:String = null with get,set

        [<DataMember(Name="retailerGuid", EmitDefaultValue=false)>]
        member val RetailerGuid:Guid = new Guid() with get,set

        [<DataMember(Name="storefront", EmitDefaultValue=false)>]
        member val Storefront:String = null with get,set

        [<DataMember(Name="storefrontIso2", EmitDefaultValue=false)>]
        member val StorefrontIso2:String = null with get,set

        [<DataMember(Name="storefrontGuid", EmitDefaultValue=false)>]
        member val StorefrontGuid:Guid = new Guid() with get,set

        [<DataMember(Name="category", EmitDefaultValue=false)>]
        member val Category:String = null with get,set

        [<DataMember(Name="categoryGuid", EmitDefaultValue=false)>]
        member val CategoryGuid:Guid = new Guid() with get,set

        [<DataMember(Name="brand", EmitDefaultValue=false)>]
        member val Brand:String = null with get,set

        [<DataMember(Name="brandGuid", EmitDefaultValue=false)>]
        member val BrandGuid:Guid = new Guid() with get,set

        [<DataMember(Name="manufacturer", EmitDefaultValue=false)>]
        member val Manufacturer:String = null with get,set

        [<DataMember(Name="manufacturerGuid", EmitDefaultValue=false)>]
        member val ManufacturerGuid:Guid = new Guid() with get,set

        [<DataMember(Name="identifiers", EmitDefaultValue=false)>]
        member val Identifiers:ProductIdentifiers = null with get,set

        [<DataMember(Name="itemAttributes", EmitDefaultValue=false)>]
        member val ItemAttributes:ItemAttributes = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type RetailerSpecificAttributes() = 
        [<DataMember(Name="name", EmitDefaultValue=false)>]
        member val Name:String = null with get,set

        [<DataMember(Name="description", EmitDefaultValue=false)>]
        member val Description:String = null with get,set

        [<DataMember(Name="skus", EmitDefaultValue=false)>]
        member val Skus:ResizeArray<String> = null with get,set

        [<DataMember(Name="asin", EmitDefaultValue=false)>]
        member val Asin:String = null with get,set

        [<DataMember(Name="url", EmitDefaultValue=false)>]
        member val Url:Uri = null with get,set

        [<DataMember(Name="productImages", EmitDefaultValue=false)>]
        member val ProductImages:Dictionary<String, Uri> = null with get,set

        [<DataMember(Name="additionalData", EmitDefaultValue=false)>]
        member val AdditionalData:Dictionary<String, String> = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ProductData() = 
        [<DataMember(Name="attributes", EmitDefaultValue=false)>]
        member val Attributes:ProductAttributes = null with get,set

        [<DataMember(Name="retailerSpecificAttributes", EmitDefaultValue=false)>]
        member val RetailerSpecificAttributes:RetailerSpecificAttributes = null with get,set

        [<DataMember(Name="rawSourceData", EmitDefaultValue=false)>]
        member val RawSourceData:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type MatchCriteria() = 
        [<DataMember(Name="retailerGuid")>]
        member val RetailerGuid:Guid = new Guid() with get,set

        [<DataMember(Name="timeoutMs")>]
        member val TimeoutMs:UInt32 = new UInt32() with get,set

        [<DataMember(Name="countryIso2s")>]
        member val CountryIso2s:IEnumerable<String> = null with get,set

        [<DataMember(Name="maxStalenessMs")>]
        member val MaxStalenessMs:UInt64 = new UInt64() with get,set

        [<DataMember(Name="targetProductCategories")>]
        member val TargetProductCategories:IEnumerable<String> = null with get,set

    [<AllowNullLiteral>]
    type GetProductMatchesByCriteriaRequest() = 
        member val Data:IEnumerable<ProductData> = null with get,set
        member val MatchCriteria:IEnumerable<MatchCriteria> = null with get,set
        member val MaxTimeoutMs:UInt32 = new UInt32() with get,set
        member val SkipCriteriaCheck:Boolean = new Boolean() with get,set

F# 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>