Quick Start Integrations
Step-by-step integration scenarios and FAQs for common ESL API tasks. Each guide includes real request/response examples, typed field references, error handling, and a direct link to try it in the API explorer.
Authentication
Articles
Add / Update Article
Create a new article (POST) or merge-update existing fields (PUT). Both trigger a label display refresh.
Bulk Upload Article
Create or update hundreds of articles in one call by uploading a CSV, DAT, or TXT file via multipart/form-data.
Search / List Articles
Look up which articles exist in a store — search by ID or name, page through your catalogue, or export the full list.
Delete Article(s)
Permanently remove one or more articles and automatically unassign them from any linked labels.
Verify Article Upload with Custom Batch ID
Check whether your batch was processed successfully and inspect per-record validation errors.
Is My Product Update Reflected on the Label?
See the per-label update status for a batch: which labels refreshed, timed out, or failed.
Image Push
Determine Label Height and Width
Query a label's exact pixel dimensions, colour type, and page count before pushing images.
Push Image to a Label
Display a custom graphic (photo, banner, logo) directly on a label screen, bypassing template-based rendering.
Push Multiple Images at Once
Push images to multiple labels in a single call, or supply multiple resolution keys for labels of different sizes.
Are My Images Reflected on the Label?
Use the customBatchId to verify that each label received and rendered the pushed image.