Open Food Facts Price Tags API
The price-tags API from Open Food Facts — 2 operation(s) for price-tags.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/open-food-facts:open-food-facts-price-tags-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Open Food Facts open-prices REST Price Tags 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: price-tags
paths:
/api/v1/price-tags:
get:
operationId: price_tags_list
parameters:
- in: query
name: created__gte
schema:
type: string
format: date-time
- in: query
name: created__lte
schema:
type: string
format: date-time
- name: order_by
required: false
in: query
description: Which field to use when ordering the results.
schema:
type: string
- name: page
required: false
in: query
description: A page number within the paginated result set.
schema:
type: integer
- in: query
name: prediction_count
schema:
type: integer
- in: query
name: prediction_count__gte
schema:
type: integer
- in: query
name: prediction_count__lte
schema:
type: integer
- in: query
name: price_id
schema:
type: integer
- in: query
name: proof__location__osm_address_country_code
schema:
type: string
- in: query
name: proof__owner
schema:
type: string
- in: query
name: proof__ready_for_price_tag_validation
schema:
type: boolean
- in: query
name: proof_id
schema:
type: integer
- name: size
required: false
in: query
description: Number of results to return per page.
schema:
type: integer
- in: query
name: status
schema:
type:
- integer
- 'null'
enum:
- 0
- 1
- 10
- 2
- 3
- 4
- 5
description: 'The annotation status
* `0` - deleted
* `1` - linked_to_price
* `2` - not_readable
* `3` - truncated
* `4` - not_price_tag
* `5` - no_barcode
* `10` - other'
- in: query
name: status__isnull
schema:
type: boolean
- in: query
name: tags__contains
schema:
type: string
- in: query
name: tags__not_contains
schema:
type: string
tags:
- price-tags
security:
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedPriceTagFullList'
description: ''
summary: Price tags list
x-summary-source: derived
post:
operationId: price_tags_create
tags:
- price-tags
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PriceTagCreate'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PriceTagCreate'
multipart/form-data:
schema:
$ref: '#/components/schemas/PriceTagCreate'
required: true
security:
- CustomAuthentication: []
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/PriceTagCreate'
description: ''
summary: Price tags create
x-summary-source: derived
/api/v1/price-tags/{id}:
get:
operationId: price_tags_retrieve
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Price Tag.
required: true
tags:
- price-tags
security:
- {}
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PriceTagFull'
description: ''
summary: Price tags retrieve
x-summary-source: derived
patch:
operationId: price_tags_partial_update
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Price Tag.
required: true
tags:
- price-tags
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedPriceTagUpdate'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PatchedPriceTagUpdate'
multipart/form-data:
schema:
$ref: '#/components/schemas/PatchedPriceTagUpdate'
security:
- CustomAuthentication: []
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PriceTagUpdate'
description: ''
summary: Price tags partial update
x-summary-source: derived
delete:
operationId: price_tags_destroy
parameters:
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this Price Tag.
required: true
tags:
- price-tags
security:
- CustomAuthentication: []
responses:
'204':
description: No response body
summary: Price tags destroy
x-summary-source: derived
components:
schemas:
PatchedPriceTagUpdate:
type: object
properties:
bounding_box:
type: array
items:
type: number
format: double
description: Coordinates of the bounding box, in the format [y_min, x_min, y_max, x_max]
status:
description: 'The annotation status
* `0` - deleted
* `1` - linked_to_price
* `2` - not_readable
* `3` - truncated
* `4` - not_price_tag
* `5` - no_barcode
* `10` - other'
minimum: -2147483648
maximum: 2147483647
oneOf:
- $ref: '#/components/schemas/PriceTagStatusEnum'
- $ref: '#/components/schemas/NullEnum'
price_id:
type: integer
PriceTagCreate:
type: object
properties:
bounding_box:
type: array
items:
type: number
format: double
description: Coordinates of the bounding box, in the format [y_min, x_min, y_max, x_max]
status:
description: 'The annotation status
* `0` - deleted
* `1` - linked_to_price
* `2` - not_readable
* `3` - truncated
* `4` - not_price_tag
* `5` - no_barcode
* `10` - other'
minimum: -2147483648
maximum: 2147483647
oneOf:
- $ref: '#/components/schemas/PriceTagStatusEnum'
- $ref: '#/components/schemas/NullEnum'
price_id:
type: integer
proof_id:
type: integer
required:
- bounding_box
- proof_id
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
LocationOsmTypeEnum:
enum:
- NODE
- WAY
- RELATION
type: string
description: '* `NODE` - NODE
* `WAY` - WAY
* `RELATION` - RELATION'
PaginatedPriceTagFullList:
type: object
required:
- items
- page
- pages
- size
- total
properties:
items:
type: array
items:
$ref: '#/components/schemas/PriceTagFull'
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
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'
ProofHalfFull:
type: object
properties:
id:
type: integer
readOnly: true
location_id:
type: integer
location:
$ref: '#/components/schemas/Location'
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
- location_id
- type
- updated
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'
PriceTagUpdate:
type: object
properties:
bounding_box:
type: array
items:
type: number
format: double
description: Coordinates of the bounding box, in the format [y_min, x_min, y_max, x_max]
status:
description: 'The annotation status
* `0` - deleted
* `1` - linked_to_price
* `2` - not_readable
* `3` - truncated
* `4` - not_price_tag
* `5` - no_barcode
* `10` - other'
minimum: -2147483648
maximum: 2147483647
oneOf:
- $ref: '#/components/schemas/PriceTagStatusEnum'
- $ref: '#/components/schemas/NullEnum'
price_id:
type: integer
required:
- bounding_box
- price_id
NullEnum:
enum:
- null
PriceTagPredictionTypeEnum:
enum:
- PRICE_TAG_EXTRACTION
- PRICE_TAG_CLF
type: string
description: '* `PRICE_TAG_EXTRACTION` - PRICE_TAG_EXTRACTION
* `PRICE_TAG_CLF` - PRICE_TAG_CLF'
BlankEnum:
enum:
- ''
LocationTypeEnum:
enum:
- OSM
- ONLINE
type: string
description: '* `OSM` - OSM
* `ONLINE` - ONLINE'
PriceTagPrediction:
type: object
properties:
type:
allOf:
- $ref: '#/components/schemas/PriceTagPredictionTypeEnum'
description: 'The type of the prediction
* `PRICE_TAG_EXTRACTION` - PRICE_TAG_EXTRACTION
* `PRICE_TAG_CLF` - PRICE_TAG_CLF'
model_name:
type: string
description: The name of the model that generated the prediction
maxLength: 30
model_version:
type: string
description: The specific version of the model that generated the prediction
maxLength: 30
schema_version:
type:
- string
- 'null'
description: The schema version of the prediction data. Used to handle changes in the prediction data structure. It is currently used when calling Gemini API to extract price tags.
maxLength: 20
data:
description: a dict representing the data of the prediction. This field is model-specific.
created:
type: string
format: date-time
description: When the prediction was created in DB
required:
- model_name
- model_version
- type
PriceTagStatusEnum:
enum:
- 0
- 1
- 2
- 3
- 4
- 5
- 10
type: integer
description: '* `0` - deleted
* `1` - linked_to_price
* `2` - not_readable
* `3` - truncated
* `4` - not_price_tag
* `5` - no_barcode
* `10` - other'
PriceTagFull:
type: object
properties:
id:
type: integer
readOnly: true
price_id:
type:
- integer
- 'null'
description: The price linked to this tag
readOnly: true
predictions:
type: array
items:
$ref: '#/components/schemas/PriceTagPrediction'
readOnly: true
proof:
$ref: '#/components/schemas/ProofHalfFull'
image_path:
type: string
readOnly: true
bounding_box:
type: array
items:
type: number
format: double
description: Coordinates of the bounding box, in the format [y_min, x_min, y_max, x_max]
status:
description: 'The annotation status
* `0` - deleted
* `1` - linked_to_price
* `2` - not_readable
* `3` - truncated
* `4` - not_price_tag
* `5` - no_barcode
* `10` - other'
minimum: -2147483648
maximum: 2147483647
oneOf:
- $ref: '#/components/schemas/PriceTagStatusEnum'
- $ref: '#/components/schemas/NullEnum'
prediction_count:
type: integer
maximum: 2147483647
minimum: 0
created_by:
type:
- string
- 'null'
description: The name of the user who created this price tag. This field is null if the tag was created by a model.
maxLength: 100
updated_by:
type:
- string
- 'null'
description: The name of the user who last updated this price tag bounding boxes. If the price tag bounding boxes were never updated, this field is null.
maxLength: 100
tags:
type: array
items:
type: string
created:
type: string
format: date-time
description: When the tag was created in DB
updated:
type: string
format: date-time
readOnly: true
description: When the tag was last updated
proof_prediction:
type:
- integer
- 'null'
description: The proof prediction used to create this price tag. Null if created by a user.
required:
- bounding_box
- id
- image_path
- predictions
- price_id
- proof
- updated
securitySchemes:
CustomAuthentication:
type: http
scheme: bearer
x-provenance:
method: harvested
publisher: Open Food Facts
source: https://prices.openfoodfacts.org/api/schema
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)