Skip to main content

Get all details about a product in a local catalog​

Returns all details about a product by its unique identifier.

Path Parameters
    id string required

    ID of the product to retrieve.

Responses

Successful response with details about a product in one of the local catalogs.

Schema
    id string required

    Opaque identifier of this product.

    provider string required

    Provider of this product. For products from local catalogs, this value is always "local".

    name string required

    Name of the product.

    description string

    Description is a longer text that describes the product and its features.

    brand string

    Brand of the product.

    manufacturer string

    Manufacturer of the product.

    matgroup string

    Matgroup is the material group on the buyer side.

    mpn string

    MPN is the manufacturer part number.

    bpn string

    BPN is the buyer part number.

    offersCount int32

    Number of offers for this product.

    offers object[]

    Offers for this product.

  • Array [
    • id string required

    Opaque identifier of this offer.

    productId string required

    Opaque identifier of this product.

    provider string required

    Provider of the result. For results from local catalogs, this property is always "local".

    sku string

    SKU is the stock-keeping unit of this product.

    vendor string

    Vendor name.

    price object required

    Price (per unit) for which the merchant will sell this product. Notice that quantity-based pricing tiers may also apply.

    amount float64 required

    Amount of the price, i.e. its monetary value.

    currency string required

    Currency code of the monetary value.

    formatted string

    Formatted monetary value in the caller's locale.

    priceQuantity float64

    Possible values: >= 1

    PriceQuantity describes the packaging unit. E.g. if the price is for a "€ 1.99 per 100 KGM", the price quantity is 100.

    orderUnit string

    OrderUnit describes the packaging unit. E.g. if the price is for a "€ 1.99 per 100 KGM", the order unit is "KGM".

    deliveryDays int32

    DeliveryDays is the delivery time in days.

    delivery string

    Delivery information.

    availability string

    Availability information.

    priceUnit string

    PriceUnit returns details about the price and the packaging unit. E.g. if the price is for a single piece, PriceUnit might be something like "per EA". However, if the price is per 100 kg of something, PriceUnit might be "per 100 KGM".

    priceTaxLabel string

    PriceTaxLabel describes the tax-related details of the price in textual form.

    priceInfo string

    PriceInfo describes price-related details in textual form.

    QuantityPriceTier object[]

    QuantityPriceTier is used when the ordered quantity has an effect on the price.

  • Array [
    • quantityDisplay string

    QuantityDisplay is a localized text that describes the quantity range for which this tier applies.

    minQuantity float64

    MinQuantity at which the given price will be applied.

    price object required

    Price for the product if the quantity is greater than or equal to minimum quantity.

    amount float64 required

    Amount of the price, i.e. its monetary value.

    currency string required

    Currency code of the monetary value.

    formatted string

    Formatted monetary value in the caller's locale.

  • ]
    • quantityDiscountsAvailable boolean

    QuantityDiscountsAvailable indicates that this product comes with a quantity-based pricing tier.

    preferred boolean

    Preferred indicates whether this product is preferred according to the buying guidelines of the organization.

    blocked boolean

    Blocked indicates whether this product must be blocked according to the buying guidelines of the organization.

    quantityMin int64

    QuantityMin represents the minimum quantity accepted for an order.

    quantityMax int64

    QuantityMax represents the maximum quantity accepted for an order.

    condition string

    Possible values: [new, used, collectible, refurbished]

    Condition describes whether the product is new, used, refurbished etc.

    fulfillment string

    Fulfillment gives hints about the fulfillment once purchased, e.g. if the product will be fulfilled by the provider or a 3rd party.

    numberOfContentUnitsPerOrderUnit float64

    NumberOfContentUnitsPerOrderUnit describes the relationship between the order unit and the content unit. E.g. if one box contains 6 bottles, the number of content units per order unit is 6.

    contentUnit string

    ContentUnit describes the details of the packaging unit. E.g. if one box contains 6 bottles, the number of content units per content unit is "box".

    quantityInterval int64

    QuantityInterval represents an interval by which the ordered quantity must follow. E.g. if you have an interval of 5, users can only purchase items in quantities of 5, 10, 15 etc.

    taxRate float64

    Possible values: <= 1

    TaxRate is a numerical value between 0.0 and 1.0 that describes the tax rate to apply to this product. Notice that taxes vary so much between different regions/countries that this is merely usable. It may work in Germany or most of the EU, but it e.g. doesn't work in the US.

    taxCode string

    TaxCode represents a proxy for a certain tax legislation. E.g. a tax code of V19 might stand for the normal tax rate that is the default to apply to all goods and services in Germany, which is 19% at the time of writing this. The advantage of using a tax code is that the underlying percentage rate might be changed without changing the code. The disadvantage is that there is no standard for tax codes, and as such usually yields from a contract between the selling and the buying party.

    attributes object

    Attributes of the offer. These are key/value pairs, both of type string. They are typically passed from the catalog source provider on to Storefront, and Storefront simply passes them on. Storefront doesn't have any knowledge about the attributes.

    property name* string
    dynamicPricing object

    DynamicPricing represents a dynamic discount from the vendor.

    discount float64

    Possible values: <= 1

    Discount is the discount in percent.

    basePrice float64

    BasePrice is the price before the discount.

    discountPercentage object

    DiscountPercentage is the discount in percent.

    amount float64

    Possible values: <= 1

    Amount of the discount.

    formatted string

    Formatted discount value in the form of string.

    dynamicPricingAvailable boolean

    dynamicPricingAvailable indicates that this product comes with a dynamic discount.

  • ]
    • taxonomies object[]

    Taxonomies represents the list of standard classifications like UNSPSC or eCl@ss for this product.

  • Array [
    • type string required

    Possible values: [unspsc, eclass]

    Type of the taxonomy.

    code string required

    Code in the standard classification.

    version string

    Version of the standard classification.

    displayName string

    DisplayName returns a textual form of the classification code.

  • ]
    • images object[]

    Images of the product in various sizes.

  • Array [
    • url url required

    URL to the image.

    width int32

    Width of the image in pixels.

    height int32

    Height of the image in pixels.

    altText string

    Alternative Text to further describe the image.

    kind string

    Possible values: [thumbnail, small, medium, large]

    Kind describes the size/purpose of the image.

  • ]
    • attachments object[]

    Attachments to a product, e.g. a datasheet or a safety sheet.

  • Array [
    • kind string

    Possible values: [datasheet, safetysheet]

    Kind of attachment.

    url string required

    URL to the external resource for download or preview.

    locale string

    Locale of the alternative text. This enables vendors to provide localized attachment descriptions, e.g. a datasheet in English and German.

    altText string

    AltText to describing the attachment by text.

  • ]
    • references object[]

    References to a different product.

  • Array [
    • id string required

    Opaque identifier of the other product.

    type string

    Possible values: [accessories, consistsOf, differentOrderUnit, followup, mandatory, select, similar, sparepart, other]

    Type of the reference.

    displayName string

    DisplayName returns a text describing the reference.

    name string required

    Name of the referenced product.

    price object

    Price of the referenced product (per unit).

    amount float64 required

    Amount of the price, i.e. its monetary value.

    currency string required

    Currency code of the monetary value.

    formatted string

    Formatted monetary value in the caller's locale.

    priceUnit string

    PriceUnit returns details about the price and the packaging unit of the referenced product, e.g. "per EA" or "per 100 MTR".

    preview object

    Image used in the search results or the product details.

    url url required

    URL to the image.

    width int32

    Width of the image in pixels.

    height int32

    Height of the image in pixels.

    altText string

    Alternative Text to further describe the image.

    kind string

    Possible values: [thumbnail, small, medium, large]

    Kind describes the size/purpose of the image.

  • ]
    • features string[]

    Features of the product in textual form.

Loading...