{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/ecommerce:ean-search/barcode-image":{"get":{"operationId":"ecommerce_ean_search_barcode_image","summary":"Generate a PNG barcode image","description":"GET /barcode-image","tags":["ecommerce"],"parameters":[{"name":"op","in":"query","required":true,"description":"API operation","schema":{"type":"string","enum":["barcode-image"],"description":"API operation"}},{"name":"ean","in":"query","required":true,"description":"EAN code to search for","schema":{"type":"integer","description":"EAN code to search for"}},{"name":"width","in":"query","required":false,"schema":{"type":"integer","default":102}},{"name":"height","in":"query","required":false,"schema":{"type":"integer","default":50}},{"name":"format","in":"query","required":false,"description":"output format","schema":{"type":"string","enum":["json","xml"],"description":"output format"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ean-search/barcode-lookup":{"get":{"operationId":"ecommerce_ean_search_barcode_lookup","summary":"Look up an EAN","description":"GET /barcode-lookup","tags":["ecommerce"],"parameters":[{"name":"op","in":"query","required":true,"description":"API operation","schema":{"type":"string","enum":["barcode-lookup"],"description":"API operation"}},{"name":"ean","in":"query","required":true,"description":"EAN code to search for","schema":{"type":"integer","description":"EAN code to search for"}},{"name":"language","in":"query","required":false,"description":"preferred language for the product name","schema":{"type":"integer","default":1,"description":"preferred language for the product name"}},{"name":"format","in":"query","required":false,"description":"output format","schema":{"type":"string","enum":["json","xml"],"description":"output format"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ean-search/barcode-prefix-search":{"get":{"operationId":"ecommerce_ean_search_barcode_prefix_search","summary":"Query the database for all barcodes with the same beginning","description":"GET /barcode-prefix-search","tags":["ecommerce"],"parameters":[{"name":"op","in":"query","required":true,"description":"API operation","schema":{"type":"string","enum":["barcode-prefix-search"],"description":"API operation"}},{"name":"prefix","in":"query","required":true,"description":"barcode prefix to search for, at least 4 digits","schema":{"type":"string","description":"barcode prefix to search for, at least 4 digits"}},{"name":"language","in":"query","required":false,"description":"preferred language for the product name","schema":{"type":"integer","default":1,"description":"preferred language for the product name"}},{"name":"page","in":"query","required":false,"description":"result page","schema":{"type":"integer","default":0,"description":"result page"}},{"name":"format","in":"query","required":false,"description":"output format","schema":{"type":"string","enum":["json","xml"],"description":"output format"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ean-search/category-search":{"get":{"operationId":"ecommerce_ean_search_category_search","summary":"Search for products form a certain category","description":"GET /category-search","tags":["ecommerce"],"parameters":[{"name":"op","in":"query","required":true,"description":"API operation","schema":{"type":"string","enum":["category-search"],"description":"API operation"}},{"name":"category","in":"query","required":true,"description":"category number","schema":{"type":"integer","description":"category number"}},{"name":"name","in":"query","required":false,"description":"name or keyords to search for","schema":{"type":"string","description":"name or keyords to search for"}},{"name":"language","in":"query","required":false,"description":"preferred language for the product name (default any language)","schema":{"type":"integer","default":99,"description":"preferred language for the product name (default any language)"}},{"name":"page","in":"query","required":false,"description":"result page","schema":{"type":"integer","default":0,"description":"result page"}},{"name":"format","in":"query","required":false,"description":"output format","schema":{"type":"string","enum":["json","xml"],"description":"output format"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ean-search/issuing-country":{"get":{"operationId":"ecommerce_ean_search_issuing_country","summary":"Search for a issuing country of a barcode","description":"GET /issuing-country","tags":["ecommerce"],"parameters":[{"name":"op","in":"query","required":true,"description":"API operation","schema":{"type":"string","enum":["issuing-country"],"description":"API operation"}},{"name":"ean","in":"query","required":true,"description":"EAN code to search for","schema":{"type":"integer","description":"EAN code to search for"}},{"name":"format","in":"query","required":false,"description":"output format","schema":{"type":"string","enum":["json","xml"],"description":"output format"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ean-search/product-search":{"get":{"operationId":"ecommerce_ean_search_product_search","summary":"Search by product name","description":"GET /product-search","tags":["ecommerce"],"parameters":[{"name":"op","in":"query","required":true,"description":"API operation","schema":{"type":"string","enum":["product-search"],"description":"API operation"}},{"name":"name","in":"query","required":true,"description":"name or keyords to search for","schema":{"type":"string","description":"name or keyords to search for"}},{"name":"language","in":"query","required":false,"description":"preferred language for the product name (default any language)","schema":{"type":"integer","default":99,"description":"preferred language for the product name (default any language)"}},{"name":"page","in":"query","required":false,"description":"result page","schema":{"type":"integer","default":0,"description":"result page"}},{"name":"format","in":"query","required":false,"description":"output format","schema":{"type":"string","enum":["json","xml"],"description":"output format"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:ean-search/verify-checksum":{"get":{"operationId":"ecommerce_ean_search_verify_checksum","summary":"Verify the checksum of an EAN code","description":"GET /verify-checksum","tags":["ecommerce"],"parameters":[{"name":"op","in":"query","required":true,"description":"API operation","schema":{"type":"string","enum":["verify-checksum"],"description":"API operation"}},{"name":"ean","in":"query","required":true,"description":"EAN code to search for","schema":{"type":"integer","description":"EAN code to search for"}},{"name":"format","in":"query","required":false,"description":"output format","schema":{"type":"string","enum":["json","xml"],"description":"output format"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}