Class PricesApi

fetch: ((input, init?) => Promise<Response>) & ((input, init?) => Promise<Response>)

options: {
    baseUrl: string;
} = ...

• baseUrl: string

body: {
    category_tag?: null | string;
    currency: "BND" | "UGX" | "HTG" | "ITL" | "SVC" | "VUV" | "XBA" | "COU" | "GRD" | "LTT" | "ZRZ" | "MZM" | "KPW" | "DZD" | "BBD" | "LUC" | "MOP" | "LKR" | "GBP" | "PHP" | "TTD" | "RHD" | "ATS" | "IEP" | "DJF" | "ILP" | "AED" | "ARL" | "INR" | "GEK" | "ZWD" | "CUP" | "RSD" | "XRE" | "BRR" | "NIC" | "USD" | "ZMW" | "MKD" | "BAD" | "XAG" | "BRC" | "BGO" | "NGN" | "UGS" | "IQD" | "TMT" | "VEF" | "ARA" | "ZMK" | "GQE" | "MDL" | "AOR" | "XAU" | "HKD" | "BTN" | "SDD" | "UAK" | "QAR" | "CLP" | "TRY" | "GEL" | "OMR" | "ROL" | "XPT" | "SAR" | "YER" | "UYI" | "ARP" | "BYR" | "JPY" | "COP" | "KZT" | "MAF" | "KGS" | "TZS" | "PGK" | "TOP" | "LUL" | "XBD" | "MMK" | "MNT" | "CAD" | "RON" | "ISK" | "XPF" | "CVE" | "MRU" | "BRL" | "MUR" | "PEI" | "BOP" | "THB" | "BEF" | "SYP" | "LTL" | "MRO" | "MDC" | "AZM" | "XEU" | "SSP" | "YDD" | "UYW" | "EGP" | "FKP" | "MZE" | "ERN" | "PYG" | "XXX" | "SEK" | "SUR" | "XOF" | "LYD" | "HRD" | "SRG" | "PKR" | "SHP" | "CNH" | "GNS" | "BEL" | "SLL" | "CLF" | "BMD" | "BRN" | "NZD" | "MXP" | "GTQ" | "TJS" | "ILR" | "MGA" | "PTE" | "PES" | "ETB" | "BRZ" | "LRD" | "CSK" | "AFA" | "KRH" | "LVL" | "CSD" | "ISJ" | "LAK" | "PLN" | "VEB" | "LVR" | "XFO" | "ZWR" | "XPD" | "TPE" | "DKK" | "ZRN" | "AMD" | "GHS" | "EUR" | "NOK" | "ZWL" | "VNN" | "AON" | "RUB" | "TRL" | "VND" | "MYR" | "UYP" | "ZAR" | "MGF" | "SZL" | "BAN" | "CHF" | "WST" | "XDR" | "BAM" | "CNY" | "MVR" | "BRE" | "DOP" | "MZN" | "FIM" | "BRB" | "PEN" | "SKK" | "USS" | "CZK" | "SOS" | "TND" | "BOB" | "ESB" | "GNF" | "MCF" | "MLF" | "FJD" | "AUD" | "AOA" | "ADP" | "MTL" | "AWG" | "ALK" | "IDR" | "JOD" | "GIP" | "JMD" | "CHW" | "CLE" | "BYB" | "BOV" | "FRF" | "LSL" | "KES" | "SGD" | "KYD" | "CRC" | "GWP" | "XTS" | "BOL" | "AOK" | "RWF" | "SLE" | "SIT" | "VES" | "ZAL" | "CNX" | "XSU" | "GWE" | "GYD" | "BDT" | "MXN" | "XCD" | "GHC" | "TWD" | "XBC" | "CHE" | "YUR" | "BSD" | "DEM" | "BWP" | "MAD" | "RUR" | "HRK" | "STN" | "BUK" | "MWK" | "NLG" | "PLZ" | "UYU" | "SBD" | "EEK" | "DDM" | "MKN" | "MVP" | "HUF" | "MXV" | "KRW" | "ILS" | "ARM" | "YUM" | "ANG" | "SRD" | "CUC" | "AFN" | "NIO" | "IRR" | "KHR" | "VED" | "ECV" | "SDG" | "TMM" | "MTP" | "NAD" | "TJR" | "XBB" | "STD" | "XFU" | "ALL" | "YUN" | "BYN" | "CDF" | "XAF" | "BGM" | "BHD" | "SDP" | "AZN" | "BEC" | "NPR" | "KMF" | "KWD" | "GMD" | "BGN" | "KRO" | "LBP" | "LUF" | "UZS" | "SCR" | "YUD" | "UAH" | "ESP" | "ECS" | "ESA" | "BGL" | "ARS" | "CYP" | "XUA" | "BIF" | "PAB" | "BZD" | "USN" | "HNL";
    date: string;
    labels_tags?: null | string[];
    location_osm_id: number;
    location_osm_type: "NODE" | "WAY" | "RELATION";
    origins_tags?: null | string[];
    price: number;
    price_is_discounted?: boolean;
    price_per?: null | "UNIT" | "KILOGRAM";
    price_without_discount?: null | number;
    product_code?: null | string;
    product_name?: null | string;
    proof_id?: null | number;
}

• Optional category_tag?: null | string

  Category Tag

  Description

  ID of the Open Food Facts category of the product for products without barcode.

      This is mostly for raw products such as vegetables or fruits. This
      field is exclusive with `product_code`: if this field is set, it means
      that the product does not have a barcode.
  
      This ID must be a canonical category ID in the Open Food Facts taxonomy.
      If the ID is not valid, the price will be rejected.
  Copy

• currency: "BND" | "UGX" | "HTG" | "ITL" | "SVC" | "VUV" | "XBA" | "COU" | "GRD" | "LTT" | "ZRZ" | "MZM" | "KPW" | "DZD" | "BBD" | "LUC" | "MOP" | "LKR" | "GBP" | "PHP" | "TTD" | "RHD" | "ATS" | "IEP" | "DJF" | "ILP" | "AED" | "ARL" | "INR" | "GEK" | "ZWD" | "CUP" | "RSD" | "XRE" | "BRR" | "NIC" | "USD" | "ZMW" | "MKD" | "BAD" | "XAG" | "BRC" | "BGO" | "NGN" | "UGS" | "IQD" | "TMT" | "VEF" | "ARA" | "ZMK" | "GQE" | "MDL" | "AOR" | "XAU" | "HKD" | "BTN" | "SDD" | "UAK" | "QAR" | "CLP" | "TRY" | "GEL" | "OMR" | "ROL" | "XPT" | "SAR" | "YER" | "UYI" | "ARP" | "BYR" | "JPY" | "COP" | "KZT" | "MAF" | "KGS" | "TZS" | "PGK" | "TOP" | "LUL" | "XBD" | "MMK" | "MNT" | "CAD" | "RON" | "ISK" | "XPF" | "CVE" | "MRU" | "BRL" | "MUR" | "PEI" | "BOP" | "THB" | "BEF" | "SYP" | "LTL" | "MRO" | "MDC" | "AZM" | "XEU" | "SSP" | "YDD" | "UYW" | "EGP" | "FKP" | "MZE" | "ERN" | "PYG" | "XXX" | "SEK" | "SUR" | "XOF" | "LYD" | "HRD" | "SRG" | "PKR" | "SHP" | "CNH" | "GNS" | "BEL" | "SLL" | "CLF" | "BMD" | "BRN" | "NZD" | "MXP" | "GTQ" | "TJS" | "ILR" | "MGA" | "PTE" | "PES" | "ETB" | "BRZ" | "LRD" | "CSK" | "AFA" | "KRH" | "LVL" | "CSD" | "ISJ" | "LAK" | "PLN" | "VEB" | "LVR" | "XFO" | "ZWR" | "XPD" | "TPE" | "DKK" | "ZRN" | "AMD" | "GHS" | "EUR" | "NOK" | "ZWL" | "VNN" | "AON" | "RUB" | "TRL" | "VND" | "MYR" | "UYP" | "ZAR" | "MGF" | "SZL" | "BAN" | "CHF" | "WST" | "XDR" | "BAM" | "CNY" | "MVR" | "BRE" | "DOP" | "MZN" | "FIM" | "BRB" | "PEN" | "SKK" | "USS" | "CZK" | "SOS" | "TND" | "BOB" | "ESB" | "GNF" | "MCF" | "MLF" | "FJD" | "AUD" | "AOA" | "ADP" | "MTL" | "AWG" | "ALK" | "IDR" | "JOD" | "GIP" | "JMD" | "CHW" | "CLE" | "BYB" | "BOV" | "FRF" | "LSL" | "KES" | "SGD" | "KYD" | "CRC" | "GWP" | "XTS" | "BOL" | "AOK" | "RWF" | "SLE" | "SIT" | "VES" | "ZAL" | "CNX" | "XSU" | "GWE" | "GYD" | "BDT" | "MXN" | "XCD" | "GHC" | "TWD" | "XBC" | "CHE" | "YUR" | "BSD" | "DEM" | "BWP" | "MAD" | "RUR" | "HRK" | "STN" | "BUK" | "MWK" | "NLG" | "PLZ" | "UYU" | "SBD" | "EEK" | "DDM" | "MKN" | "MVP" | "HUF" | "MXV" | "KRW" | "ILS" | "ARM" | "YUM" | "ANG" | "SRD" | "CUC" | "AFN" | "NIO" | "IRR" | "KHR" | "VED" | "ECV" | "SDG" | "TMM" | "MTP" | "NAD" | "TJR" | "XBB" | "STD" | "XFU" | "ALL" | "YUN" | "BYN" | "CDF" | "XAF" | "BGM" | "BHD" | "SDP" | "AZN" | "BEC" | "NPR" | "KMF" | "KWD" | "GMD" | "BGN" | "KRO" | "LBP" | "LUF" | "UZS" | "SCR" | "YUD" | "UAH" | "ESP" | "ECS" | "ESA" | "BGL" | "ARS" | "CYP" | "XUA" | "BIF" | "PAB" | "BZD" | "USN" | "HNL"

  Description

  currency of the price, as a string. The currency must be a valid currency code. See https://en.wikipedia.org/wiki/ISO_4217 for a list of valid currency codes.

• date: string

  Date Format: date

  Description

  date when the product was bought.

• Optional labels_tags?: null | string[]

  Labels Tags

  Description

  labels of the product, only for products without barcode.

      The labels must be valid labels in the Open Food Facts taxonomy.
      If one of the labels is not valid, the price will be rejected.
  
      The most common labels are:
      - `en:organic`: the product is organic
      - `fr:ab-agriculture-biologique`: the product is organic, in France
      - `en:fair-trade`: the product is fair-trade
  
      Other labels can be provided if relevant.
  Copy

• location_osm_id: number

  Location Osm Id

  Description

  ID of the location in OpenStreetMap: the store where the product was bought.

• location_osm_type: "NODE" | "WAY" | "RELATION"

  Description

  type of the OpenStreetMap location object. Stores can be represented as nodes, ways or relations in OpenStreetMap. It is necessary to be able to fetch the correct information about the store using the ID.

• Optional origins_tags?: null | string[]

  Origins Tags

  Description

  origins of the product, only for products without barcode.

      This field is a list as some products may be a mix of several origins,
      but most products have only one origin.
  
      The origins must be valid origins in the Open Food Facts taxonomy.
      If one of the origins is not valid, the price will be rejected.
  Copy

• price: number

  Price

  Description

  price of the product, without its currency, taxes included.

• Optional price_is_discounted?: boolean

  Price Is Discounted

  Description

  true if the price is discounted.

  Default

  false
  Copy

• Optional price_per?: null | "UNIT" | "KILOGRAM"

  Description

  if the price is about a barcode-less product (if category_tag is provided), this field must be set to KILOGRAM or UNIT (KILOGRAM by default). This field is set to null and ignored if product_code is provided.

  Default

  KILOGRAM
  Copy

• Optional price_without_discount?: null | number

  Price Without Discount

  Description

  price of the product without discount, without its currency, taxes included. If the product is not discounted, this field must be null.

• Optional product_code?: null | string

  Product Code

  Description

  barcode (EAN) of the product, as a string.

• Optional product_name?: null | string

  Product Name

  Description

  name of the product, as displayed on the receipt or the price tag.

• Optional proof_id?: null | number

  Proof Id

  Description

  ID of the proof, if any. The proof is a file (receipt or price tag image) uploaded by the user to prove the price of the product. The proof must be uploaded before the price, and the authenticated user must be the owner of the proof.