Skip to main content

Integrations & API · Guide

Let a buyer's system read your traceability events

Buyers' and your own systems read the events of your lots over the GS1 EPCIS 2.0 query interface, instead of waiting for files. You choose which connected companies may read them.

Many buyers run a traceability system that speaks GS1 EPCIS 2.0, the world standard for "what happened to which lot, when and where". A-REX answers that standard directly: their system asks, A-REX answers with the events of the lots, live, filtered the way GS1 defines. No files to send.

What the other system reads

Each event says what happened to a lot: it was created, shipped, received, processed, inspected or got a certificate. Every event carries one GS1 business step (for example shipping) and, beside it, your own words for the step. Every event says it was declared by your company: sharing events does not make them verified.

  • Your own system reads every event of your company.
  • A connected company reads the events of the lots you delivered to it, and only while you share Traceability events with it (see What each company shares). It sees your deliveries to it, never your deliveries to others, and the processing up to the delivery.

Give a system access

  1. In Integrations, create an API key or a machine client with the read scope. A buyer creates it in its own company: it reads what you share with it.
  2. Give the people who run that system the address https://{API address}/v1/epcis and the key.
  3. Their system asks, for example, for the shipments of one lot: GET /v1/epcis/events?EQ_bizStep=shipping&MATCH_epcClass={the lot's Digital Link}.

A-REX records every read by a key or client. To stop a connected company reading your events, untick Traceability events on its connection page; to stop a key, revoke it.

Good to know

  • The interface only reads. Nothing can write events into A-REX through it: records still go through your approvals.
  • Long histories come a page at a time; a system that needs a lot more narrows the time window.
  • The lot's identifier in the events is its GS1 Digital Link when the product has a GTIN and the lot a lot code; otherwise an A-REX identifier.
  • Your technical team finds the full description, with every filter, in the developer documentation (EPCIS query interface).