Product

Product information

  • box_weight
    Type: numberFormat: float

    Box weight

  • boxes_per_pallet
    Type: integer

    Boxes per pallet

  • brand
    Type: string

    Brand name

  • category
    Type: string

    Product category

  • created_at
    Type: stringFormat: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • display_name
    Type: string

    Display name

  • ean_code
    Type: string

    EAN/barcode

  • group
    Type: string

    Product group

  • hash_id
    Type: string

    Product hash ID

  • id
    Type: integerFormat: uint

    Product ID

  • images
    Type: array object[]
    • url
      Type: string

      Image URL

  • is_por
    Type: boolean

    Price On Request flag

  • organic
    Type: stringenum

    Organic certification

    values
    • true
    • false
    • organic
    • conventional
  • origin
    Type: string

    Country of origin (ISO code)

  • pieces_per_box
    Type: integer

    Pieces per box

  • price
    Type: numberFormat: float

    Base price

  • price_unit
    Type: stringenum

    Price unit

    values
    • kg
    • unit
    • box
    • pallet
  • reference_code_type
    Type: stringenum

    Product code type

    values
    • EAN
    • PLU
    • UPC
  • region
    Type: string

    Region of origin

  • sale_units
    Type: array string[]

    Available sale units

  • sku
    Type: string

    Stock Keeping Unit

  • status
    Type: stringenum

    Product status

    values
    • active
    • draft
    • archived
  • tags
    Type: array string[]

    Product tags

  • tare
    Type: numberFormat: float

    Tare weight

  • tax
    Type: numberFormat: float

    Tax rate (%)

  • type
    Type: string

    Product type

  • updated_at
    Type: stringFormat: date-time

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • variety
    Type: string

    Product variety

  • workspace_id
    Type: integerFormat: uint

    Workspace ID