Skip to main content

Get Products

POST 

/products

Retrieves product details information (e.g. price, description etc) for given items. The endpoing can return either a parent product containing it's variants or the variant/simple product itself.

Request

Body

required

    request_id uuidrequired

    A unique identifier to track this request

    currency currency (string)required

    Possible values: >= 3 characters and <= 3 characters

    The ISO 4217 code of a currency

    metadata

    object[]

    Custom key-value pairs defined during cart creation

  • Array [

  • key stringrequired
    value stringrequired
  • ]

  • items

    object[]

    required

    Cart's line items

  • Array [

  • id stringrequired

    Product ID

    quantity int32required

    attributes

    object

    User selected attributes (e.g. color, size)

    property name* string
  • ]

Responses

OK

Schema

    request_id uuid

    items

    object[]

  • Array [

  • oneOf

    id stringrequired

    Product's unique identifier

    title stringrequired
    stock int64required
    sku stringrequired
    description stringrequired
    image_url stringrequired
    price_cents int64required
    shippable booleanrequired

    Indicates whether product is physical or virtual

    attributes

    object

    Product attributes are the characteristics, such as color, size etc. that define a variation product or provide configuration information about a simple product. attributes object holds a list of attribute id/attribute value id pairs applied on this product. So for the following attribute applied on the product, {attribute_id => 1, attribute_label => color, attribute_option_label => black, attribute_option_id => 34}, this is expected as response: {'1':'34'}. These attributes are used during quote and order.

    property name* string

    titled_attributes

    object

    Product attributes are the characteristics, such as color, size etc. that define a variation product or provide configuration information about a simple product. titled attributes object holds a list of attribute id title/attribute value title pairs applied on this product. So for the following attribute applied on the product, {attribute_id => 1, attribute_label => color, attribute_option_label => black, attribute_option_id => 34}, this is expected as response: {'color':'black'}. The titled attributes are only used in product display in UI and not in any subsequent api calls.

    property name* string

    variations

    object[]

  • Array [

  • id stringrequired

    Product's unique identifier

    title stringrequired
    stock int64required
    sku stringrequired
    description stringrequired
    image_url stringrequired
    price_cents int64required
    shippable booleanrequired

    Indicates whether product is physical or virtual

    attributes

    object

    Product attributes are the characteristics, such as color, size etc. that define a variation product or provide configuration information about a simple product. attributes object holds a list of attribute id/attribute value id pairs applied on this product. So for the following attribute applied on the product, {attribute_id => 1, attribute_label => color, attribute_option_label => black, attribute_option_id => 34}, this is expected as response: {'1':'34'}. These attributes are used during quote and order.

    property name* string
  • ]

  • options

    object[]

  • Array [

  • id stringrequired

    Attribute's unique identifier e.g attr_color

    title stringrequired

    Attribute's user friendly title e.g Color

    values

    object[]

    required

    A list of possible values for this option

  • Array [

  • id stringrequired

    Value's unique identifier e.g. val_black

    title stringrequired

    Value's user friendly title e.g Black

  • ]

  • ]

  • ]

Loading...