Prices

Prices_list

GET
/api/v1/prices

Query Parameters

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

Which field to use when ordering the results.

origins_tags__contains?string
owner?string
page?integer

A page number within the paginated result set.

price?number
price__gt?number
price__gte?number
price__lt?number
price__lte?number
price_is_discounted?boolean
product__categories_tags__contains?string
product__categories_tags__overlap?array<array<string>>

Provide multiple values as separate query parameters. Example: ?product__categories_tags__overlap=en:breakfasts&product__categories_tags__overlap=en:apples

product_code?string
product_id?integer | null
product_id__isnull?boolean
product_name?string
proof__type?array<string>
  • PRICE_TAG - PRICE_TAG
  • RECEIPT - RECEIPT
  • GDPR_REQUEST - GDPR_REQUEST
  • SHOP_IMPORT - SHOP_IMPORT
proof_id?integer | null
proof_id__isnull?boolean
size?integer

Number of results to return per page.

tags__contains?string
type?string
  • PRODUCT - PRODUCT
  • CATEGORY - CATEGORY
Value in"CATEGORY" | "PRODUCT"

Response Body

curl -X GET "https://loading/api/v1/prices?category_tag=string&created__gte=2019-08-24T14%3A15%3A22Z&created__lte=2019-08-24T14%3A15%3A22Z&currency=ADP&date=2019-08-24&date__gt=2019-08-24&date__gte=2019-08-24&date__lt=2019-08-24&date__lte=2019-08-24&date__month=0&date__year=0&discount_type=EXPIRES_SOON&kind=COMMUNITY&labels_tags__contains=string&location__osm_name__contains=string&location_id=0&location_id__isnull=true&location_osm_id=0&location_osm_type=NODE&order_by=string&origins_tags__contains=string&owner=string&page=0&price=0&price__gt=0&price__gte=0&price__lt=0&price__lte=0&price_is_discounted=true&product__categories_tags__contains=string&product__categories_tags__overlap=string&product_code=string&product_id=0&product_id__isnull=true&product_name=string&proof__type=GDPR_REQUEST&proof_id=0&proof_id__isnull=true&size=0&tags__contains=string&type=CATEGORY"
{
  "items": [
    [
      {
        "id": 0,
        "product_id": 0,
        "location_id": 0,
        "proof_id": 0,
        "product": {
          "id": 0,
          "code": "string",
          "source": "off",
          "source_last_synced": "2019-08-24T14:15:22Z",
          "product_name": "string",
          "image_url": "string",
          "product_quantity": -2147483648,
          "product_quantity_unit": "string",
          "categories_tags": [
            "string"
          ],
          "brands": "string",
          "brands_tags": [
            "string"
          ],
          "labels_tags": [
            "string"
          ],
          "nutriscore_grade": "string",
          "ecoscore_grade": "string",
          "nova_group": 2147483647,
          "unique_scans_n": 2147483647,
          "price_count": 2147483647,
          "price_currency_count": 2147483647,
          "location_count": 2147483647,
          "location_type_osm_country_count": 2147483647,
          "user_count": 2147483647,
          "proof_count": 2147483647,
          "created": "2019-08-24T14:15:22Z",
          "updated": "2019-08-24T14:15:22Z"
        },
        "location": {
          "id": 0,
          "type": "OSM",
          "osm_id": 9223372036854776000,
          "osm_type": "NODE",
          "osm_name": "string",
          "osm_display_name": "string",
          "osm_tag_key": "string",
          "osm_tag_value": "string",
          "osm_brand": "string",
          "osm_address_postcode": "string",
          "osm_address_city": "string",
          "osm_address_country": "string",
          "osm_address_country_code": "string",
          "osm_lat": -9999,
          "osm_lon": -9999,
          "osm_version": 2147483647,
          "website_url": "http://example.com",
          "price_count": 2147483647,
          "user_count": 2147483647,
          "product_count": 2147483647,
          "proof_count": 2147483647,
          "source": "string",
          "created": "2019-08-24T14:15:22Z",
          "updated": "2019-08-24T14:15:22Z"
        },
        "proof": {
          "id": 0,
          "location_id": 0,
          "file_path": "string",
          "mimetype": "string",
          "type": "PRICE_TAG",
          "image_md5_hash": "string",
          "image_thumb_path": "string",
          "location_osm_id": 9223372036854776000,
          "location_osm_type": "NODE",
          "date": "2019-08-24",
          "currency": "ADP",
          "receipt_price_count": 2147483647,
          "receipt_price_total": 9999999,
          "receipt_online_delivery_costs": 9999999,
          "ready_for_price_tag_validation": true,
          "owner_consumption": true,
          "owner_comment": "string",
          "price_count": 2147483647,
          "prediction_count": 2147483647,
          "owner": "string",
          "source": "string",
          "tags": [
            "string"
          ],
          "created": "2019-08-24T14:15:22Z",
          "updated": "2019-08-24T14:15:22Z"
        },
        "type": "PRODUCT",
        "product_code": "string",
        "product_name": "string",
        "category_tag": "string",
        "labels_tags": [
          "string"
        ],
        "origins_tags": [
          "string"
        ],
        "price": 9999999,
        "price_is_discounted": true,
        "price_without_discount": 9999999,
        "discount_type": "QUANTITY",
        "price_per": "UNIT",
        "currency": "ADP",
        "location_osm_id": 9223372036854776000,
        "location_osm_type": "NODE",
        "date": "2019-08-24",
        "receipt_quantity": 9999999,
        "owner_comment": "string",
        "owner": "string",
        "source": "string",
        "tags": [
          "string"
        ],
        "created": "2019-08-24T14:15:22Z",
        "updated": "2019-08-24T14:15:22Z"
      }
    ]
  ],
  "page": 1,
  "pages": 16,
  "size": 100,
  "total": 1531
}

Prices_history_list GET

Previous Page

Prices_partial_update PATCH

Next Page