| GET | /v3.5/product/matches |
|---|
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
type ErrorCode =
| Throttled = 0
| TargetRetailerProductNotFound = 1
| Unknown = 2
| NullMatchResult = 3
| NullSourceData = 4
| SourceDataProcessingFailure = 5
| LocalizationFailure = 6
[<DataContract>]
[<AllowNullLiteral>]
type MatchError() =
[<DataMember(Name="message")>]
member val Message:String = null with get,set
[<DataMember(Name="error")>]
member val Code:ErrorCode = new ErrorCode() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type MatchResult() =
[<DataMember(Name="retailer")>]
member val Retailer:String = null with get,set
[<DataMember(Name="retailerGuid")>]
member val RetailerGuid:Guid = new Guid() with get,set
[<DataMember(Name="storefront")>]
member val Storefront:String = null with get,set
[<DataMember(Name="storefrontIso2")>]
member val StorefrontIso2:String = null with get,set
[<DataMember(Name="storefrontGuid")>]
member val StorefrontGuid:Guid = new Guid() with get,set
[<DataMember(Name="data")>]
member val Data:ProductData = null with get,set
[<DataMember(Name="errors")>]
member val Errors:ResizeArray<MatchError> = null with get,set
[<DataMember(Name="matchAccuracy")>]
member val MatchAccuracy:String = null with get,set
[<DataMember(Name="matchingRuleName")>]
member val MatchingRuleName:String = null with get,set
[<DataMember(Name="dataSource")>]
member val DataSource:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type ProductMetadata() =
[<DataMember(Name="title")>]
member val Title:String = null with get,set
[<DataMember(Name="author")>]
member val Author:String = null with get,set
[<DataMember(Name="url")>]
member val Url:Uri = null with get,set
[<DataMember(Name="description")>]
member val Description:String = null with get,set
[<DataMember(Name="retailer")>]
member val Retailer:String = null with get,set
[<DataMember(Name="productImages")>]
member val ProductImages:IDictionary<String, Uri> = null with get,set
[<DataMember(Name="rawAttributes")>]
member val RawAttributes:MatchResult = null with get,set
[<AllowNullLiteral>]
type GetProductMatchesByUrlResponse() =
member val Products:IEnumerable<ProductMetadata> = null with get,set
member val ResponseStatus:ResponseStatus = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type GetProductMatchesByUrlRequest() =
[<DataMember(Name="url")>]
member val Url:String = null with get,set
[<DataMember(Name="includeRaw")>]
member val IncludeRaw:Boolean = new Boolean() with get,set
F# GetProductMatchesByUrlRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}