GeniuslinkAPI

<back to all web services

GetProductMatchesByUrlRequest

Requires Authentication
The following routes are available for this service:
GET/v3.5/product/matches
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using GeniuslinkAPI.ServiceModel.V4.Products.Requests;
using GeniuslinkAPI.ServiceModel.V4.Products.Responses;
using Geniuslink.Products.QueuedService.Contracts.V1.DTOs;

namespace Geniuslink.Products.QueuedService.Contracts.V1.DTOs
{
    [DataContract]
    public partial class AudiobookAttributes
        : BookAttributes
    {
    }

    [DataContract]
    public partial class BookAttributes
    {
        [DataMember(Name="authors", EmitDefaultValue=false)]
        public virtual List<string> Authors { get; set; }
    }

    [DataContract]
    public partial class EBookAttributes
        : BookAttributes
    {
    }

    public enum ErrorCode
    {
        Throttled,
        TargetRetailerProductNotFound,
        Unknown,
        NullMatchResult,
        NullSourceData,
        SourceDataProcessingFailure,
        LocalizationFailure,
    }

    [DataContract]
    public partial class ItemAttributes
    {
        [DataMember(Name="book", EmitDefaultValue=false)]
        public virtual BookAttributes Book { get; set; }

        [DataMember(Name="audiobook", EmitDefaultValue=false)]
        public virtual AudiobookAttributes Audiobook { get; set; }

        [DataMember(Name="ebook", EmitDefaultValue=false)]
        public virtual EBookAttributes EBook { get; set; }
    }

    [DataContract]
    public partial class MatchError
    {
        [DataMember(Name="message")]
        public virtual string Message { get; set; }

        [DataMember(Name="error")]
        public virtual ErrorCode Code { get; set; }
    }

    [DataContract]
    public partial class MatchResult
    {
        [DataMember(Name="retailer")]
        public virtual string Retailer { get; set; }

        [DataMember(Name="retailerGuid")]
        public virtual Guid RetailerGuid { get; set; }

        [DataMember(Name="storefront")]
        public virtual string Storefront { get; set; }

        [DataMember(Name="storefrontIso2")]
        public virtual string StorefrontIso2 { get; set; }

        [DataMember(Name="storefrontGuid")]
        public virtual Guid StorefrontGuid { get; set; }

        [DataMember(Name="data")]
        public virtual ProductData Data { get; set; }

        [DataMember(Name="errors")]
        public virtual List<MatchError> Errors { get; set; }

        [DataMember(Name="matchAccuracy")]
        public virtual string MatchAccuracy { get; set; }

        [DataMember(Name="matchingRuleName")]
        public virtual string MatchingRuleName { get; set; }

        [DataMember(Name="dataSource")]
        public virtual string DataSource { get; set; }
    }

    [DataContract]
    public partial class ProductAttributes
    {
        [DataMember(Name="retailer", EmitDefaultValue=false)]
        public virtual string Retailer { get; set; }

        [DataMember(Name="retailerGuid", EmitDefaultValue=false)]
        public virtual Guid RetailerGuid { get; set; }

        [DataMember(Name="storefront", EmitDefaultValue=false)]
        public virtual string Storefront { get; set; }

        [DataMember(Name="storefrontIso2", EmitDefaultValue=false)]
        public virtual string StorefrontIso2 { get; set; }

        [DataMember(Name="storefrontGuid", EmitDefaultValue=false)]
        public virtual Guid StorefrontGuid { get; set; }

        [DataMember(Name="category", EmitDefaultValue=false)]
        public virtual string Category { get; set; }

        [DataMember(Name="categoryGuid", EmitDefaultValue=false)]
        public virtual Guid CategoryGuid { get; set; }

        [DataMember(Name="brand", EmitDefaultValue=false)]
        public virtual string Brand { get; set; }

        [DataMember(Name="brandGuid", EmitDefaultValue=false)]
        public virtual Guid BrandGuid { get; set; }

        [DataMember(Name="manufacturer", EmitDefaultValue=false)]
        public virtual string Manufacturer { get; set; }

        [DataMember(Name="manufacturerGuid", EmitDefaultValue=false)]
        public virtual Guid ManufacturerGuid { get; set; }

        [DataMember(Name="identifiers", EmitDefaultValue=false)]
        public virtual ProductIdentifiers Identifiers { get; set; }

        [DataMember(Name="itemAttributes", EmitDefaultValue=false)]
        public virtual ItemAttributes ItemAttributes { get; set; }
    }

    [DataContract]
    public partial class ProductData
    {
        [DataMember(Name="attributes", EmitDefaultValue=false)]
        public virtual ProductAttributes Attributes { get; set; }

        [DataMember(Name="retailerSpecificAttributes", EmitDefaultValue=false)]
        public virtual RetailerSpecificAttributes RetailerSpecificAttributes { get; set; }

        [DataMember(Name="rawSourceData", EmitDefaultValue=false)]
        public virtual string RawSourceData { get; set; }
    }

    [DataContract]
    public partial class ProductIdentifiers
    {
        [DataMember(Name="productGuid", EmitDefaultValue=false)]
        public virtual Guid ProductGuid { get; set; }

        [DataMember(Name="gtins", EmitDefaultValue=false)]
        public virtual List<string> Gtins { get; set; }

        [DataMember(Name="mpns", EmitDefaultValue=false)]
        public virtual List<string> Mpns { get; set; }

        [DataMember(Name="ean8", EmitDefaultValue=false)]
        public virtual List<string> Ean8 { get; set; }

        [DataMember(Name="ean13", EmitDefaultValue=false)]
        public virtual List<string> Ean13 { get; set; }

        [DataMember(Name="isbn9", EmitDefaultValue=false)]
        public virtual List<string> Isbn9 { get; set; }

        [DataMember(Name="isbn10", EmitDefaultValue=false)]
        public virtual List<string> Isbn10 { get; set; }

        [DataMember(Name="isbn13", EmitDefaultValue=false)]
        public virtual List<string> Isbn13 { get; set; }

        [DataMember(Name="itf14", EmitDefaultValue=false)]
        public virtual List<string> ITF14 { get; set; }

        [DataMember(Name="upc12", EmitDefaultValue=false)]
        public virtual List<string> Upc12 { get; set; }
    }

    [DataContract]
    public partial class ProductMetadata
    {
        [DataMember(Name="title")]
        public virtual string Title { get; set; }

        [DataMember(Name="author")]
        public virtual string Author { get; set; }

        [DataMember(Name="url")]
        public virtual Uri Url { get; set; }

        [DataMember(Name="description")]
        public virtual string Description { get; set; }

        [DataMember(Name="retailer")]
        public virtual string Retailer { get; set; }

        [DataMember(Name="productImages")]
        public virtual IDictionary<string, Uri> ProductImages { get; set; }

        [DataMember(Name="rawAttributes")]
        public virtual MatchResult RawAttributes { get; set; }
    }

    [DataContract]
    public partial class RetailerSpecificAttributes
    {
        [DataMember(Name="name", EmitDefaultValue=false)]
        public virtual string Name { get; set; }

        [DataMember(Name="description", EmitDefaultValue=false)]
        public virtual string Description { get; set; }

        [DataMember(Name="skus", EmitDefaultValue=false)]
        public virtual List<string> Skus { get; set; }

        [DataMember(Name="asin", EmitDefaultValue=false)]
        public virtual string Asin { get; set; }

        [DataMember(Name="url", EmitDefaultValue=false)]
        public virtual Uri Url { get; set; }

        [DataMember(Name="productImages", EmitDefaultValue=false)]
        public virtual Dictionary<string, Uri> ProductImages { get; set; }

        [DataMember(Name="additionalData", EmitDefaultValue=false)]
        public virtual Dictionary<string, string> AdditionalData { get; set; }
    }

}

namespace GeniuslinkAPI.ServiceModel.V4.Products.Requests
{
    [DataContract]
    public partial class GetProductMatchesByUrlRequest
        : IGetProductMatchesByUrlRequest
    {
        [DataMember(Name="url")]
        public virtual string Url { get; set; }

        [DataMember(Name="includeRaw")]
        public virtual bool IncludeRaw { get; set; }
    }

}

namespace GeniuslinkAPI.ServiceModel.V4.Products.Responses
{
    public partial class GetProductMatchesByUrlResponse
        : IGetProductMatchesByUrlResponse
    {
        public virtual IEnumerable<ProductMetadata> Products { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# GetProductMatchesByUrlRequest DTOs

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}