openapi-directory/api/ean-search.org.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"Documentation of the EAN-Search.org API, see [https://www.ean-search.org/ean-database-api.html](https://www.ean-search.org/ean-database-api.html).\nPlease consult the PDF manual in your account for more details.","title":"EAN-Search.org API","version":"1.50.0","x-apisguru-categories":["ecommerce"],"x-logo":{"url":"https://www.ean-search.org/ean-logo.svg"},"x-origin":[{"format":"swagger","url":"https://www.ean-search.org/eansearch-swagger2.json","version":"2.0"}],"x-providerName":"ean-search.org"},"paths":{"/barcode-image":{"get":{"operationId":"barcode-image","parameters":[{"description":"API operation","in":"query","name":"op","required":true,"schema":{"type":"string","enum":["barcode-image"]}},{"description":"EAN code to search for","in":"query","name":"ean","required":true,"schema":{"type":"integer","format":"unsigned64"}},{"in":"query","name":"width","schema":{"type":"integer","default":102}},{"in":"query","name":"height","schema":{"type":"integer","default":50}},{"description":"output format","in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Barcode"},"type":"array"}},"application/xml":{"schema":{"items":{"$ref":"#/components/schemas/Barcode"},"type":"array"}}}},"400":{"description":"Invalid operation requested"},"401":{"description":"Invalid access token"},"402":{"description":"Request limit reached"},"405":{"description":"Must use HTTP GET to access the API"},"429":{"description":"Too many requests (eg. rate limit exeeded)"}},"security":[{"ApiKeyAuth":[]}],"summary":"Generate a PNG barcode image"}},"/barcode-lookup":{"get":{"description":"Search by EAN code","operationId":"barcode-lookup","parameters":[{"description":"API operation","in":"query","name":"op","required":true,"schema":{"type":"string","enum":["barcode-lookup"]}},{"description":"EAN code to search for","in":"query","name":"ean","required":true,"schema":{"type":"integer","format":"unsigned64"}},{"description":"preferred language for the product name","in":"query","name":"language","schema":{"type":"integer","default":1}},{"description":"output format","in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Product"},"type":"array"}},"application/xml":{"schema":{"items":{"$ref":"#/components/schemas/Product"},"type":"array"}}}},"400":{"description":"Invalid operation requested"},"401":{"description":"Invalid access token"},"402":{"description":"Request limit reached"},"405":{"description":"Must use HTTP GET to access the API"},"429":{"description":"Too many requests (eg. rate limit exeeded)"}},"security":[{"ApiKeyAuth":[]}],"summary":"Look up an EAN"}},"/barcode-prefix-search":{"get":{"operationId":"barcode-prefix-search","parameters":[{"description":"API operation","in":"query","name":"op","required":true,"schema":{"type":"string","enum":["barcode-prefix-search"]}},{"description":"barcode prefix to search for, at least 4 digits","in":"query","name":"prefix","required":true,"schema":{"type":"string"}},{"description":"preferred language for the product name","in":"query","name":"language","schema":{"type":"integer","default":1}},{"description":"result page","in":"query","name":"page","schema":{"type":"integer","default":0}},{"description":"output format","in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Product"},"type":"array"}},"application/xml":{"schema":{"items":{"$ref":"#/components/schemas/Product"},"type":"array"}}}},"400":{"description":"Invalid operation requested"},"401":{"description":"Invalid access token"},"402":{"description":"Request limit reached"},"405":{"description":"Must use HTTP GET to access the API"},"429":{"description":"Too many requests (eg. rate limit exeeded)"}},"security":[{"ApiKeyAuth":[]}],"summary":"Query the database for all barcodes with the same beginning"}},"/category-search":{"get":{"operationId":"category-search","parameters":[{"description":"API operation","in":"query","name":"op","required":true,"schema":{"type":"string","enum":["category-search"]}},{"description":"category number","in":"query","name":"category","required":true,"schema":{"type":"integer"}},{"description":"name or keyords to search for","in":"query","name":"name","schema":{"type":"string"}},{"description":"preferred language for the product name (default any language)","in":"query","name":"language","schema":{"type":"integer","default":99}},{"description":"result page","in":"query","name":"page","schema":{"type":"integer","default":0}},{"description":"output format","in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Product"},"type":"array"}},"application/xml":{"schema":{"items":{"$ref":"#/components/schemas/Product"},"type":"array"}}}},"400":{"description":"Invalid operation requested"},"401":{"description":"Invalid access token"},"402":{"description":"Request limit reached"},"405":{"description":"Must use HTTP GET to access the API"},"429":{"description":"Too many requests (eg. rate limit exeeded)"}},"security":[{"ApiKeyAuth":[]}],"summary":"Search for products form a certain category"}},"/issuing-country":{"get":{"description":"Search for a issuing country of a barcode. In contrast to barcode-lookup, this will always give a result, even if we don't know the product name.","operationId":"issuing-country","parameters":[{"description":"API operation","in":"query","name":"op","required":true,"schema":{"type":"string","enum":["issuing-country"]}},{"description":"EAN code to search for","in":"query","name":"ean","required":true,"schema":{"type":"integer","format":"unsigned64"}},{"description":"output format","in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/IssuingCountry"},"type":"array"}},"application/xml":{"schema":{"items":{"$ref":"#/components/schemas/IssuingCountry"},"type":"array"}}}},"400":{"description":"Invalid operation requested"},"401":{"description":"Invalid access token"},"402":{"description":"Request limit reached"},"405":{"description":"Must use HTTP GET to access the API"},"429":{"description":"Too many requests (eg. rate limit exeeded)"}},"security":[{"ApiKeyAuth":[]}],"summary":"Search for a issuing country of a barcode"}},"/product-search":{"get":{"operationId":"product-search","parameters":[{"description":"API operation","in":"query","name":"op","required":true,"schema":{"type":"string","enum":["product-search"]}},{"description":"name or keyords to search for","in":"query","name":"name","required":true,"schema":{"type":"string"}},{"description":"preferred language for the product name (default any language)","in":"query","name":"language","schema":{"type":"integer","default":99}},{"description":"result page","in":"query","name":"page","schema":{"type":"integer","default":0}},{"description":"output format","in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Product"},"type":"array"}},"application/xml":{"schema":{"items":{"$ref":"#/components/schemas/Product"},"type":"array"}}}},"400":{"description":"Invalid operation requested"},"401":{"description":"Invalid access token"},"402":{"description":"Request limit reached"},"405":{"description":"Must use HTTP GET to access the API"},"429":{"description":"Too many requests (eg. rate limit exeeded)"}},"security":[{"ApiKeyAuth":[]}],"summary":"Search by product name"}},"/verify-checksum":{"get":{"operationId":"verify-checksum","parameters":[{"description":"API operation","in":"query","name":"op","required":true,"schema":{"type":"string","enum":["verify-checksum"]}},{"description":"EAN code to search for","in":"query","name":"ean","required":true,"schema":{"type":"integer","format":"unsigned64"}},{"description":"output format","in":"query","name":"format","schema":{"type":"string","enum":["json","xml"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/VerifyChecksum"},"type":"array"}},"application/xml":{"schema":{"items":{"$ref":"#/components/schemas/VerifyChecksum"},"type":"array"}}}},"400":{"description":"Invalid operation requested"},"401":{"description":"Invalid access token"},"402":{"description":"Request limit reached"},"405":{"description":"Must use HTTP GET to access the API"},"429":{"description":"Too many requests (eg. rate limit exeeded)"}},"security":[{"ApiKeyAuth":[]}],"summary":"Verify the checksum of an EAN code"}}},"servers":[{"url":"https://api.ean-search.org"}],"components":{"securitySchemes":{"ApiKeyAuth":{"in":"query","name":"token","type":"apiKey"}},"schemas":{"Barcode":{"properties":{"barcode":{"description":"base64 encoded PNG image","type":"string"},"ean":{"type":"string"}},"required":["ean","barcode"],"type":"object","xml":{"name":"product"}},"IssuingCountry":{"properties":{"ean":{"type":"string"},"issuingCountry":{"format":"ISO 3166 Alpha-2","type":"string"}},"required":["ean","issuingCountry"],"type":"object","xml":{"name":"product"}},"Product":{"properties":{"categoryId":{"type":"string"},"categoryName":{"type":"string"},"ean":{"type":"string"},"issuingCountry":{"format":"ISO 3166 Alpha-2","type":"string"},"name":{"type":"string"}},"required":["ean","name","issuingCountry"],"type":"object","xml":{"name":"product"}},"VerifyChecksum":{"properties":{"ean":{"type":"string"},"valid":{"enum":["0","1"],"type":"string"}},"required":["ean","valid"],"type":"object","xml":{"name":"product"}}}}}