Common IDs
Since all entities in EVA are basically represented by a JSON data model, we try to be as consistent as possible in naming their properties. This results in you coming across some properties on a regular basis. In this document we talk about these common properties and what they are meant to represent.
BackendIDs
These are extremely common. We have normal BackendID's, BackendSystemID's, ProductBackendID's and some more.
BackendID's are ID's that did not originate in EVA but in some third party system. We do however want these ID's to be known in EVA for matching and communication purposes.
The BackendID is a string value between 2 and 128 characters.
Since these BackendIDs are not managed by us, projects requiring a globally unique approach should develop these IDs outside of EVA.
Let's say you are importing a bunch of products from an external product information management system into EVA. During the import, you can specify the BackendSystemID, which should represent the external PIM system, and the BackendID, which should be the ID the product has in the external system.
EVA ID
After the import, EVA will generate its own ID for the products. Often referred to as either ID or EVA ID or any other form of ID that does not specifically identify itself as a BackendID. This ID cannot be changed.
Order numbers
All orders in EVA are given a sequential numeric ID, unique only within the context of their region. Regions can be given prefix codes, typically “EUW”, “ASE” and “CUS”, but ultimately up to you to choose.
Upon the creation of an Order, this region code, suffixed with the Order ID, is stored as GlobalID on the order (e.g. ASE123).
Most Stencils and services expose this and/or the region code. If missing, it's possible to add. Some custom integrations also expose them, which can also be added if missing.
You cannot call EVA services with this GlobalID, as each region services their own endpoint. For example: it'd be misleading to call GetOrder on ASE123 on the EUW region endpoint.
CustomID
The CustomID is another identifier that can be set on various object, such as users or products. Its main purpose is to be visually used in your applications, in case your BackendID is only for system reference and you have an additional identifier that employees use to look up items (e.g. because it shows on product labels).
Products with different BackendIDs can have the same CustomID, for example when the latter replaces the first as a successor.
Barcodes
Adding barcodes to a product you import allows users to scan labels to look up items or add them to basket. You can set multiple barcodes on a single product.