Skip to main content

Code upload overview

Overview​

Scantrust has been designed to efficiently manage a large volume of codes. As such, new codes are created asynchronously in the background through a workorder mechanism to ensure the system can support these quantities. The newly created codes can thereafter be downloaded in a zip archive, which are in the Scantrust Compact-12 format.

The Code Upload API allows brand owners to upload files containing their unique identifiers in any format, as long as they meet the length and allowed characters requirements outlined by the Scantrust system (see below). GS1 identifiers are also supported. When using the Code Upload API, users can assign different products to each code and choose the SCM fields that apply.

The code upload API can generate 2 types of codes:

  1. Serialized Identifiers (SID) codes: these codes are scantrust QR codes without the secure graphic. The brand owner can self-generate and download these codes and they do not require a printing partner.
  2. Secure Codes (SSC): these codes contain the copy-protection secure graphic and require a printing partner with calibrated equipment and substrate. These codes are generated and assigned to an existing workorder (or uploaded using a template) with a secure graphic, which is then printed by a printing partner

Pre Print VS Post Print VS Automatic​

When uploading SSC codes, you need to determine if the codes are uploaded after they have been printed (post print) or before (pre print). In general, Pre Print is the most common use-case.

For SIDs, post print should be avoided and Pre Print can be selected even if codes are uploaded after printing. This is because we do not need calibrated equipment for such codes.

Pre Print

  • Codes are uploaded before they are printed
  • All methods for uploading are supported
  • A workorder can exist in Pre Print mode but it can also be created automatically in several cases during the ingestion process

Post Print

  • Codes are uploaded after printing
  • A workorder must exist in Post Print mode
  • Only the add to workorder method is supported

Automatic

  • Only applicable when uploading using the add-sids method.
  • Limited as no workorder settings can be used

3 supported methods for uploading codes​

When using this method, a valid Ingestion Template is required. This template will be provided by a Scantrust engineer when onboarding your company. This template contains all settings required for an ingestion which makes the code upload itself very simple. The uploaded codes will be bundled in an automatically created workorder which is also supplied to your printing partner if applicable.

Documentation can be found here.

Supported code types:

  • Serialized Identifiers (SID) codes (Pre Print)
  • Secure Codes (SSC) (Pre Print)

Restrictions:

  • One upload generates 1 workorder
  • Post Print use-cases not supported

2. Add codes to workorder​

When using this method, a valid Pre Print or Post Print workorder is required. Such workorder needs to be created manually before uploading codes. When using the Post Print system, this is the only available method when uploading codes. A workorder will contain required printer settings which will be applied to your codes automatically.

Documentation can be found here.

Supported code types:

  • Serialized Identifiers (SID) codes (Pre Print + Post Print)
  • Secure Codes (SSC) (Pre Print + Post Print)

Restrictions:

  • A workorder must be created manually prior uploading
  • The workorder download will not be re-generated (Post Print)
  • Printing Partner is not notified (Post Print)

3. Add SIDs directly​

When using this method, SID codes can be added directly, without any template or workorder settings. Usually, using a Template (method 1) is recommended yet in some cases this method can be quick & useful when uploading your SID codes.

Documentation can be found here.

Supported code types:

  • Serialized Identifiers (SID) codes (Automatic)

Restrictions:

  • One workorder per upload (Automatic mode)
  • No workorder settings can be applied

Uploading Serialized Identifiers (SID) Codes​

Example CSV file with a header​

id,product,pallet_number,intended_market
abc12345,sku1,pal1,BE
def12345,sku1,pal1,NL
ghi12345,sku1,pal2,DE
jkl12345,sku1,pal2,FR
...
  • required: a column with header id containing the unique identifiers
    • each id must be between 6 and 36 characters. GS1 Identifiers are allowed to be longer.
    • each id can only contain valid characters (a-z, A-Z, 0-9, -, _). For example: aB1_3dZ97-x2 or 123abcd89XYZ
    • regex for the id: ^[A-Za-z0-9_-]{6,36}$
  • optional columns:
    • product containing a product-sku which already exists in the scantrust system
    • activation_status containing 0 (inactive), 1 (active) or 2 (blacklisted)
    • additional columns containing scm fields with the header as the scm key (ie. pallet_number etc.)

Steps to upload your codes​

  1. Determine the code type (SID/SSC)
  2. Determine the upload type (pre print / post print / automatic)
  3. Determine the method you want to use.
  4. Determine if you want to use the API directly / file upload / GUI
  5. Use the corresponding API doc to upload your codes
  6. Retrieve the codes via the workorder

UAT token permissions​

To access this API, a UAT token needs to be provided which has access to the following permissions:

  • workorder_view
  • workorder_download
  • workorder_sid_download
  • ingestion_view
  • ingestion_cancel
  • ingestion_code_create
  • product_view

The UAT token must be set in the header fields of all requests as described in Authentication & Tokens.