Product

A product in the vendor's catalog, with its stock level resolved across the vendor's locations.

Fields

    ageRestricted
    Boolean!
    Required
    Whether buyers must pass an age check before ordering.
    approved
    Boolean!
    Required

    Whether the product cleared platform moderation. Unapproved products stay hidden from customers regardless of isActive.

    availableQty
    Int

    Stock summed across every location stocking this product. null when the inventory lookup failed, which is not the same as zero stock.

    barcode
    String
    Scanned barcode (EAN/UPC), if the product carries one.
    capacity
    String

    Packaged size as free text, e.g. 500 alongside a unit of ml.

    createdAt
    DateTime!
    Required
    When the product was created, in UTC.
    currencyCode
    String!
    Required
    ISO 4217 alphabetic currency code both prices are quoted in.
    deliverable
    Boolean!
    Required
    Whether the product can be delivered (as opposed to pickup only).
    description
    String
    Long-form description shown on the product page.
    digital
    Boolean!
    Required
    Whether the product is digital and needs no physical fulfilment.
    discountPrice
    Decimal!
    Required

    Sale price in major units. 0 means no discount is running.

    featured
    Boolean!
    Required
    Whether the product appears in featured placements.
    id
    Int!
    Required
    Unique identifier of the product.
    inOrder
    Int!
    Required
    Display sort position within its listing. Lower sorts first.
    isActive
    Boolean!
    Required
    Whether the product is orderable.
    name
    String!
    Required
    Customer-facing product name.
    packageCount
    String
    Number of items in a multi-pack, as free text.
    plusOption
    Boolean!
    Required
    Whether the product is restricted to Plus members.
    price
    Decimal!
    Required

    List price in major units of currencyCode, e.g. 12.50. Tax is not included — it is applied per order from the vendor's tax rate.

    sku
    String
    Vendor's own stock-keeping unit, if set.
    unit
    String

    Unit capacity is expressed in, e.g. g, ml, piece.

    updatedAt
    DateTime!
    Required
    When the product was last changed, in UTC.
Built with