openapi: 3.2.0 info: title: Open Food Facts open- REST Prices API version: 0.0.0 (api) description: Open Prices API allows you to add product prices contact: name: The Open Food Facts team url: https://world.openfoodfacts.org email: contact@openfoodfacts.org license: name: ' AGPL-3.0' url: https://www.gnu.org/licenses/agpl-3.0.en.html tags: - name: Prices paths: /api/v1/prices: get: operationId: prices_list parameters: - in: query name: category_tag schema: type: string - in: query name: created__gte schema: type: string format: date-time - in: query name: created__lte schema: type: string format: date-time - in: query name: currency schema: type: - string - 'null' enum: - 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 - XCG - 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 - ZWG - ZWL - ZWR description: '* `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 * `XCG` - XCG * `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 * `ZWG` - ZWG * `ZWL` - ZWL * `ZWR` - ZWR' - in: query name: date schema: type: string format: date - in: query name: date__gt schema: type: string format: date - in: query name: date__gte schema: type: string format: date - in: query name: date__lt schema: type: string format: date - in: query name: date__lte schema: type: string format: date - in: query name: date__month schema: type: number - in: query name: date__year schema: type: number - in: query name: discount_type schema: type: - string - 'null' enum: - EXPIRES_SOON - LOYALTY_PROGRAM - OTHER - PICK_IT_YOURSELF - QUANTITY - SALE - SEASONAL - SECOND_HAND description: '* `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' - in: query name: duplicate_of__isnull schema: type: boolean - in: query name: kind schema: type: string enum: - COMMUNITY - CONSUMPTION description: '* `COMMUNITY` - COMMUNITY * `CONSUMPTION` - CONSUMPTION' - in: query name: labels_tags__contains schema: type: string - in: query name: lat schema: type: number description: Latitude of the center point (-90 to 90). Must be sent together with lon and radius_km. - in: query name: location__osm_name__contains schema: type: string - in: query name: location__type schema: type: string enum: - ONLINE - OSM description: '* `OSM` - OSM * `ONLINE` - ONLINE' - in: query name: location_id schema: type: integer - in: query name: location_id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: location_id__isnull schema: type: boolean - in: query name: location_osm_id schema: type: integer - in: query name: location_osm_type schema: type: - string - 'null' enum: - NODE - RELATION - WAY description: '* `NODE` - NODE * `WAY` - WAY * `RELATION` - RELATION' - in: query name: lon schema: type: number description: Longitude of the center point (-180 to 180). Must be sent together with lat and radius_km. - name: order_by required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: origins_tags__contains schema: type: string - in: query name: owner schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - in: query name: price schema: type: number - in: query name: price__gt schema: type: number - in: query name: price__gte schema: type: number - in: query name: price__lt schema: type: number - in: query name: price__lte schema: type: number - in: query name: price_is_discounted schema: type: boolean - in: query name: product__categories_tags__contains schema: type: string - in: query name: product__categories_tags__overlap schema: type: array items: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: product__source schema: type: - string - 'null' enum: - obf - 'off' - opf - opff description: '* `off` - off * `obf` - obf * `opff` - opff * `opf` - opf' - in: query name: product__source__isnull schema: type: boolean - in: query name: product_code schema: type: string - in: query name: product_code__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: product_code__isnull schema: type: boolean - in: query name: product_id schema: type: integer - in: query name: product_id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: product_id__isnull schema: type: boolean - in: query name: product_name schema: type: string - in: query name: proof__type schema: type: array items: type: string enum: - GDPR_REQUEST - PRICE_TAG - RECEIPT - SHOP_IMPORT description: '* `PRICE_TAG` - PRICE_TAG * `RECEIPT` - RECEIPT * `GDPR_REQUEST` - GDPR_REQUEST * `SHOP_IMPORT` - SHOP_IMPORT' explode: true style: form - in: query name: proof_id schema: type: integer - in: query name: proof_id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: proof_id__isnull schema: type: boolean - in: query name: radius_km schema: type: number description: Search radius in kilometers (0 or more). Must be sent together with lat and lon. - name: size required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: tags__contains schema: type: string - in: query name: type schema: type: string enum: - CATEGORY - PRODUCT description: '* `PRODUCT` - PRODUCT * `CATEGORY` - CATEGORY' tags: - Prices security: - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedPriceFullList' description: '' summary: Prices list x-summary-source: derived post: operationId: prices_create tags: - Prices requestBody: content: application/json: schema: $ref: '#/components/schemas/PriceCreate' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PriceCreate' multipart/form-data: schema: $ref: '#/components/schemas/PriceCreate' required: true security: - CustomAuthentication: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/PriceCreate' description: '' summary: Prices create x-summary-source: derived /api/v1/prices/{id}: get: operationId: prices_retrieve parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this Price. required: true tags: - Prices security: - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PriceFull' description: '' summary: Prices retrieve x-summary-source: derived patch: operationId: prices_partial_update parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this Price. required: true tags: - Prices requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedPriceUpdate' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedPriceUpdate' multipart/form-data: schema: $ref: '#/components/schemas/PatchedPriceUpdate' security: - CustomAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PriceUpdate' description: '' summary: Prices partial update x-summary-source: derived delete: operationId: prices_destroy parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this Price. required: true tags: - Prices security: - CustomAuthentication: [] responses: '204': description: No response body summary: Prices destroy x-summary-source: derived /api/v1/prices/{id}/history: get: operationId: prices_history_list parameters: - in: query name: category_tag schema: type: string - in: query name: created__gte schema: type: string format: date-time - in: query name: created__lte schema: type: string format: date-time - in: query name: currency schema: type: - string - 'null' enum: - 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 - XCG - 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 - ZWG - ZWL - ZWR description: '* `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 * `XCG` - XCG * `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 * `ZWG` - ZWG * `ZWL` - ZWL * `ZWR` - ZWR' - in: query name: date schema: type: string format: date - in: query name: date__gt schema: type: string format: date - in: query name: date__gte schema: type: string format: date - in: query name: date__lt schema: type: string format: date - in: query name: date__lte schema: type: string format: date - in: query name: date__month schema: type: number - in: query name: date__year schema: type: number - in: query name: discount_type schema: type: - string - 'null' enum: - EXPIRES_SOON - LOYALTY_PROGRAM - OTHER - PICK_IT_YOURSELF - QUANTITY - SALE - SEASONAL - SECOND_HAND description: '* `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' - in: query name: duplicate_of__isnull schema: type: boolean - in: path name: id schema: type: integer description: A unique integer value identifying this Price. required: true - in: query name: kind schema: type: string enum: - COMMUNITY - CONSUMPTION description: '* `COMMUNITY` - COMMUNITY * `CONSUMPTION` - CONSUMPTION' - in: query name: labels_tags__contains schema: type: string - in: query name: lat schema: type: number description: Latitude of the center point (-90 to 90). Must be sent together with lon and radius_km. - in: query name: location__osm_name__contains schema: type: string - in: query name: location__type schema: type: string enum: - ONLINE - OSM description: '* `OSM` - OSM * `ONLINE` - ONLINE' - in: query name: location_id schema: type: integer - in: query name: location_id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: location_id__isnull schema: type: boolean - in: query name: location_osm_id schema: type: integer - in: query name: location_osm_type schema: type: - string - 'null' enum: - NODE - RELATION - WAY description: '* `NODE` - NODE * `WAY` - WAY * `RELATION` - RELATION' - in: query name: lon schema: type: number description: Longitude of the center point (-180 to 180). Must be sent together with lat and radius_km. - name: order_by required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: origins_tags__contains schema: type: string - in: query name: owner schema: type: string - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - in: query name: price schema: type: number - in: query name: price__gt schema: type: number - in: query name: price__gte schema: type: number - in: query name: price__lt schema: type: number - in: query name: price__lte schema: type: number - in: query name: price_is_discounted schema: type: boolean - in: query name: product__categories_tags__contains schema: type: string - in: query name: product__categories_tags__overlap schema: type: array items: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: product__source schema: type: - string - 'null' enum: - obf - 'off' - opf - opff description: '* `off` - off * `obf` - obf * `opff` - opff * `opf` - opf' - in: query name: product__source__isnull schema: type: boolean - in: query name: product_code schema: type: string - in: query name: product_code__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: product_code__isnull schema: type: boolean - in: query name: product_id schema: type: integer - in: query name: product_id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: product_id__isnull schema: type: boolean - in: query name: product_name schema: type: string - in: query name: proof__type schema: type: array items: type: string enum: - GDPR_REQUEST - PRICE_TAG - RECEIPT - SHOP_IMPORT description: '* `PRICE_TAG` - PRICE_TAG * `RECEIPT` - RECEIPT * `GDPR_REQUEST` - GDPR_REQUEST * `SHOP_IMPORT` - SHOP_IMPORT' explode: true style: form - in: query name: proof_id schema: type: integer - in: query name: proof_id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: proof_id__isnull schema: type: boolean - in: query name: radius_km schema: type: number description: Search radius in kilometers (0 or more). Must be sent together with lat and lon. - name: size required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: tags__contains schema: type: string - in: query name: type schema: type: string enum: - CATEGORY - PRODUCT description: '* `PRODUCT` - PRODUCT * `CATEGORY` - CATEGORY' tags: - Prices security: - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedPriceHistoryList' description: '' summary: Prices history list x-summary-source: derived /api/v1/prices/stats: get: operationId: prices_stats_retrieve parameters: - in: query name: category_tag schema: type: string - in: query name: created__gte schema: type: string format: date-time - in: query name: created__lte schema: type: string format: date-time - in: query name: currency schema: type: - string - 'null' enum: - 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 - XCG - 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 - ZWG - ZWL - ZWR description: '* `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 * `XCG` - XCG * `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 * `ZWG` - ZWG * `ZWL` - ZWL * `ZWR` - ZWR' - in: query name: date schema: type: string format: date - in: query name: date__gt schema: type: string format: date - in: query name: date__gte schema: type: string format: date - in: query name: date__lt schema: type: string format: date - in: query name: date__lte schema: type: string format: date - in: query name: date__month schema: type: number - in: query name: date__year schema: type: number - in: query name: discount_type schema: type: - string - 'null' enum: - EXPIRES_SOON - LOYALTY_PROGRAM - OTHER - PICK_IT_YOURSELF - QUANTITY - SALE - SEASONAL - SECOND_HAND description: '* `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' - in: query name: duplicate_of__isnull schema: type: boolean - in: query name: kind schema: type: string enum: - COMMUNITY - CONSUMPTION description: '* `COMMUNITY` - COMMUNITY * `CONSUMPTION` - CONSUMPTION' - in: query name: labels_tags__contains schema: type: string - in: query name: lat schema: type: number description: Latitude of the center point (-90 to 90). Must be sent together with lon and radius_km. - in: query name: location__osm_name__contains schema: type: string - in: query name: location__type schema: type: string enum: - ONLINE - OSM description: '* `OSM` - OSM * `ONLINE` - ONLINE' - in: query name: location_id schema: type: integer - in: query name: location_id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: location_id__isnull schema: type: boolean - in: query name: location_osm_id schema: type: integer - in: query name: location_osm_type schema: type: - string - 'null' enum: - NODE - RELATION - WAY description: '* `NODE` - NODE * `WAY` - WAY * `RELATION` - RELATION' - in: query name: lon schema: type: number description: Longitude of the center point (-180 to 180). Must be sent together with lat and radius_km. - name: order_by required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: origins_tags__contains schema: type: string - in: query name: owner schema: type: string - in: query name: price schema: type: number - in: query name: price__gt schema: type: number - in: query name: price__gte schema: type: number - in: query name: price__lt schema: type: number - in: query name: price__lte schema: type: number - in: query name: price_is_discounted schema: type: boolean - in: query name: product__categories_tags__contains schema: type: string - in: query name: product__categories_tags__overlap schema: type: array items: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: product__source schema: type: - string - 'null' enum: - obf - 'off' - opf - opff description: '* `off` - off * `obf` - obf * `opff` - opff * `opf` - opf' - in: query name: product__source__isnull schema: type: boolean - in: query name: product_code schema: type: string - in: query name: product_code__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: product_code__isnull schema: type: boolean - in: query name: product_id schema: type: integer - in: query name: product_id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: product_id__isnull schema: type: boolean - in: query name: product_name schema: type: string - in: query name: proof__type schema: type: array items: type: string enum: - GDPR_REQUEST - PRICE_TAG - RECEIPT - SHOP_IMPORT description: '* `PRICE_TAG` - PRICE_TAG * `RECEIPT` - RECEIPT * `GDPR_REQUEST` - GDPR_REQUEST * `SHOP_IMPORT` - SHOP_IMPORT' explode: true style: form - in: query name: proof_id schema: type: integer - in: query name: proof_id__in schema: type: array items: type: integer description: Multiple values may be separated by commas. explode: false style: form - in: query name: proof_id__isnull schema: type: boolean - in: query name: radius_km schema: type: number description: Search radius in kilometers (0 or more). Must be sent together with lat and lon. - in: query name: tags__contains schema: type: string - in: query name: type schema: type: string enum: - CATEGORY - PRODUCT description: '* `PRODUCT` - PRODUCT * `CATEGORY` - CATEGORY' tags: - Prices security: - {} responses: '200': content: application/json: schema: $ref: '#/components/schemas/PriceStats' description: '' summary: Prices stats retrieve x-summary-source: derived components: schemas: PriceHistory: type: object properties: history_id: type: integer history_date: type: string format: date-time history_change_reason: type: string history_type: $ref: '#/components/schemas/HistoryTypeEnum' history_user_id: type: string changes: type: array items: {} required: - changes - history_change_reason - history_date - history_id - history_type - history_user_id PricePerEnum: enum: - UNIT - KILOGRAM type: string description: '* `UNIT` - UNIT * `KILOGRAM` - KILOGRAM' PriceCreate: type: object properties: product_code: type: - string - 'null' category_tag: type: - string - 'null' labels_tags: type: - array - 'null' items: type: string origins_tags: type: - array - 'null' items: type: string price: type: - number - 'null' format: double minimum: 0 exclusiveMaximum: 10000000 price_is_discounted: type: boolean price_without_discount: type: - number - 'null' format: double minimum: 0 exclusiveMaximum: 10000000 discount_type: oneOf: - $ref: '#/components/schemas/DiscountTypeEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' price_per: oneOf: - $ref: '#/components/schemas/PricePerEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' currency: oneOf: - $ref: '#/components/schemas/CurrencyEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' date: type: - string - 'null' format: date receipt_quantity: type: - number - 'null' format: double minimum: 0 title: Receipt's price quantity (user input) exclusiveMaximum: 10000000 owner_comment: type: - string - 'null' type: $ref: '#/components/schemas/PriceTypeEnum' product_name: type: - string - 'null' location_osm_id: type: - integer - 'null' maximum: 9223372036854775807 minimum: 0 format: int64 location_osm_type: oneOf: - $ref: '#/components/schemas/LocationOsmTypeEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' location_id: type: integer proof_id: type: integer required: - proof_id NullEnum: enum: - null LocationTypeEnum: enum: - OSM - ONLINE type: string description: '* `OSM` - OSM * `ONLINE` - ONLINE' SourceEnum: enum: - 'off' - obf - opff - opf type: string description: '* `off` - off * `obf` - obf * `opff` - opff * `opf` - opf' BlankEnum: enum: - '' CurrencyEnum: enum: - 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 - XCG - 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 - ZWG - ZWL - ZWR type: string description: '* `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 * `XCG` - XCG * `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 * `ZWG` - ZWG * `ZWL` - ZWL * `ZWR` - ZWR' DiscountTypeEnum: enum: - QUANTITY - SALE - SEASONAL - LOYALTY_PROGRAM - EXPIRES_SOON - PICK_IT_YOURSELF - SECOND_HAND - OTHER type: string description: '* `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' ProofTypeEnum: enum: - PRICE_TAG - RECEIPT - GDPR_REQUEST - SHOP_IMPORT type: string description: '* `PRICE_TAG` - PRICE_TAG * `RECEIPT` - RECEIPT * `GDPR_REQUEST` - GDPR_REQUEST * `SHOP_IMPORT` - SHOP_IMPORT' LocationOsmTypeEnum: enum: - NODE - WAY - RELATION type: string description: '* `NODE` - NODE * `WAY` - WAY * `RELATION` - RELATION' PaginatedPriceHistoryList: type: object required: - items - page - pages - size - total properties: items: type: array items: $ref: '#/components/schemas/PriceHistory' page: type: integer description: Current page number example: 1 pages: type: integer description: Total number of pages example: 16 size: type: integer description: Number of items per page example: 100 total: type: integer description: Total number of items example: 1531 PriceFull: type: object properties: id: type: integer readOnly: true product_id: type: integer location_id: type: integer proof_id: type: integer product: $ref: '#/components/schemas/ProductFull' location: $ref: '#/components/schemas/Location' proof: $ref: '#/components/schemas/Proof' type: $ref: '#/components/schemas/PriceTypeEnum' product_code: type: - string - 'null' product_name: type: - string - 'null' category_tag: type: - string - 'null' labels_tags: type: - array - 'null' items: type: string origins_tags: type: - array - 'null' items: type: string price: type: - number - 'null' format: double minimum: 0 exclusiveMaximum: 10000000 price_is_discounted: type: boolean price_without_discount: type: - number - 'null' format: double minimum: 0 exclusiveMaximum: 10000000 discount_type: oneOf: - $ref: '#/components/schemas/DiscountTypeEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' price_per: oneOf: - $ref: '#/components/schemas/PricePerEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' currency: oneOf: - $ref: '#/components/schemas/CurrencyEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' location_osm_id: type: - integer - 'null' maximum: 9223372036854775807 minimum: 0 format: int64 location_osm_type: oneOf: - $ref: '#/components/schemas/LocationOsmTypeEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' date: type: - string - 'null' format: date receipt_quantity: type: - number - 'null' format: double minimum: 0 title: Receipt's price quantity (user input) exclusiveMaximum: 10000000 owner_comment: type: - string - 'null' owner: type: - string - 'null' source: type: - string - 'null' tags: type: array items: type: string created: type: string format: date-time updated: type: string format: date-time readOnly: true duplicate_of: type: - integer - 'null' required: - id - location - location_id - product - product_id - proof - proof_id - type - updated Proof: type: object properties: id: type: integer readOnly: true location_id: type: integer file_path: type: - string - 'null' mimetype: type: - string - 'null' type: $ref: '#/components/schemas/ProofTypeEnum' image_md5_hash: type: - string - 'null' maxLength: 32 image_thumb_path: type: - string - 'null' location_osm_id: type: - integer - 'null' maximum: 9223372036854775807 minimum: 0 format: int64 location_osm_type: oneOf: - $ref: '#/components/schemas/LocationOsmTypeEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' date: type: - string - 'null' format: date currency: oneOf: - $ref: '#/components/schemas/CurrencyEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' receipt_price_count: type: - integer - 'null' maximum: 2147483647 minimum: 0 title: Receipt's number of prices (user input) receipt_price_total: type: - number - 'null' format: double minimum: 0 title: Receipt's total amount (user input) exclusiveMaximum: 10000000 receipt_online_delivery_costs: type: - number - 'null' format: double minimum: 0 title: Receipt's online delivery costs (user input) exclusiveMaximum: 10000000 ready_for_price_tag_validation: type: boolean owner_consumption: type: - boolean - 'null' owner_comment: type: - string - 'null' draft: type: boolean price_count: type: integer maximum: 2147483647 minimum: 0 prediction_count: type: integer maximum: 2147483647 minimum: 0 owner: type: - string - 'null' source: type: - string - 'null' tags: type: array items: type: string created: type: string format: date-time updated: type: string format: date-time readOnly: true required: - id - location_id - type - updated ProductFull: type: object properties: id: type: integer readOnly: true code: type: string source: oneOf: - $ref: '#/components/schemas/SourceEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' source_last_synced: type: - string - 'null' format: date-time product_name: type: - string - 'null' image_url: type: - string - 'null' product_quantity: type: - integer - 'null' maximum: 2147483647 minimum: -2147483648 product_quantity_unit: type: - string - 'null' quantity: type: - string - 'null' categories_tags: type: array items: type: string brands: type: - string - 'null' brands_tags: type: array items: type: string labels_tags: type: array items: type: string nutriscore_grade: type: - string - 'null' ecoscore_grade: type: - string - 'null' nova_group: type: - integer - 'null' maximum: 2147483647 minimum: 0 creator: type: - string - 'null' unique_scans_n: type: - integer - 'null' maximum: 2147483647 minimum: 0 price_count: type: integer maximum: 2147483647 minimum: 0 price_currency_count: type: integer maximum: 2147483647 minimum: 0 location_count: type: integer maximum: 2147483647 minimum: 0 location_type_osm_country_count: type: integer maximum: 2147483647 minimum: 0 user_count: type: integer maximum: 2147483647 minimum: 0 proof_count: type: integer maximum: 2147483647 minimum: 0 created: type: string format: date-time updated: type: string format: date-time readOnly: true required: - code - id - updated HistoryTypeEnum: enum: - + - '~' - '-' type: string description: '* `+` - Created * `~` - Changed * `-` - Deleted' PriceUpdate: type: object properties: product_code: type: - string - 'null' category_tag: type: - string - 'null' labels_tags: type: - array - 'null' items: type: string origins_tags: type: - array - 'null' items: type: string price: type: - number - 'null' format: double minimum: 0 exclusiveMaximum: 10000000 price_is_discounted: type: boolean price_without_discount: type: - number - 'null' format: double minimum: 0 exclusiveMaximum: 10000000 discount_type: oneOf: - $ref: '#/components/schemas/DiscountTypeEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' price_per: oneOf: - $ref: '#/components/schemas/PricePerEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' currency: oneOf: - $ref: '#/components/schemas/CurrencyEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' date: type: - string - 'null' format: date receipt_quantity: type: - number - 'null' format: double minimum: 0 title: Receipt's price quantity (user input) exclusiveMaximum: 10000000 owner_comment: type: - string - 'null' PriceTypeEnum: enum: - PRODUCT - CATEGORY type: string description: '* `PRODUCT` - PRODUCT * `CATEGORY` - CATEGORY' PaginatedPriceFullList: type: object required: - items - page - pages - size - total properties: items: type: array items: $ref: '#/components/schemas/PriceFull' page: type: integer description: Current page number example: 1 pages: type: integer description: Total number of pages example: 16 size: type: integer description: Number of items per page example: 100 total: type: integer description: Total number of items example: 1531 PriceStats: type: object properties: price__count: type: integer price__min: type: number format: double exclusiveMinimum: -100000000 exclusiveMaximum: 100000000 price__max: type: number format: double exclusiveMinimum: -100000000 exclusiveMaximum: 100000000 price__avg: type: number format: double exclusiveMinimum: -100000000 exclusiveMaximum: 100000000 required: - price__avg - price__count - price__max - price__min Location: type: object properties: id: type: integer readOnly: true osm_brand_logo_url: type: string readOnly: true type: $ref: '#/components/schemas/LocationTypeEnum' osm_id: type: - integer - 'null' maximum: 9223372036854775807 minimum: 0 format: int64 osm_type: oneOf: - $ref: '#/components/schemas/LocationOsmTypeEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' osm_name: type: - string - 'null' osm_display_name: type: - string - 'null' osm_tag_key: type: - string - 'null' osm_tag_value: type: - string - 'null' osm_brand: type: - string - 'null' osm_address_postcode: type: - string - 'null' osm_address_city: type: - string - 'null' osm_address_country: type: - string - 'null' osm_address_country_code: type: - string - 'null' osm_lat: type: - number - 'null' format: double exclusiveMinimum: -10000 exclusiveMaximum: 10000 osm_lon: type: - number - 'null' format: double exclusiveMinimum: -10000 exclusiveMaximum: 10000 osm_version: type: - integer - 'null' maximum: 2147483647 minimum: 0 osm_version_date: type: - string - 'null' format: date-time website_url: type: - string - 'null' format: uri maxLength: 200 price_count: type: integer maximum: 2147483647 minimum: 0 user_count: type: integer maximum: 2147483647 minimum: 0 product_count: type: integer maximum: 2147483647 minimum: 0 proof_count: type: integer maximum: 2147483647 minimum: 0 source: type: - string - 'null' created: type: string format: date-time updated: type: string format: date-time readOnly: true required: - id - osm_brand_logo_url - type - updated PatchedPriceUpdate: type: object properties: product_code: type: - string - 'null' category_tag: type: - string - 'null' labels_tags: type: - array - 'null' items: type: string origins_tags: type: - array - 'null' items: type: string price: type: - number - 'null' format: double minimum: 0 exclusiveMaximum: 10000000 price_is_discounted: type: boolean price_without_discount: type: - number - 'null' format: double minimum: 0 exclusiveMaximum: 10000000 discount_type: oneOf: - $ref: '#/components/schemas/DiscountTypeEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' price_per: oneOf: - $ref: '#/components/schemas/PricePerEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' currency: oneOf: - $ref: '#/components/schemas/CurrencyEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' date: type: - string - 'null' format: date receipt_quantity: type: - number - 'null' format: double minimum: 0 title: Receipt's price quantity (user input) exclusiveMaximum: 10000000 owner_comment: type: - string - 'null' securitySchemes: CustomAuthentication: type: http scheme: bearer