Skip to content

Item Printing

Users can print three types of materials related to their items: Labels, Breadcrumbs and Kanban Cards.

Labels and Breadcrumbs are associated with the item itself, while the Kanban Cards are associated with individual cards
associated with the item.

Printing for Kanban Cards is documented in the Kanban Card Lookup URL Generation document.

This document describes the printing of Labels and Breadcrumbs.

URL Format

The format of the URL used to Display an item in the UI is:

https://{base-url}/item/{id}

With:

  • base-url: The base URL for the Specific environment (Production, Staging, etc…)
  • id The eId unique identifier of the item in the system.

The Base URL for the different environments are:

Base URLs

Environment Base URL
Production live.app.arda.cards
Staging stage.alpha002.app.arda.cards
Development dev.alpha002.app.arda.cards

Obtaining the Kanban Card ID

The Item EId’s can be obtained from the Item Card API.

The general documentation for the API can be found at:

The eId field needed for the Lookup URL is at the path results[*].payload.eId. In the example above:

{
  [...]
  "results": [
    [...]
      "payload": {
        [...]
        "eId": "dfb54593-1031-4fe6-a756-38e424db49eb",
        [...]
      },
    [...]
  ]
}

Behavior of the UI Lookup

When the browser navigates to the Item Lookup URL, the UI should display the Item details page for the item with the specified eId.

If the back end does not return the item, it could be because:

  1. The item has never existed
  2. The user does not have access to the item (e.g. belongs to a different tenant)
  3. The item has been deleted.

The UI should display a “Item Not Found” message in these cases.

Potential Improvement

  • The UI could query the history of the Item to determine if it has been deleted and display the lastest version of the item with
    a Deleted marker.

Printing Labels and Breadcrumbs

Labels and Breadcrumbs can be printed using two routes in the Items Endpoint:

  • POST /v1/item/item/print-label?live-print=false to print labels
  • POST /v1/item/item/print-breadcrumb?live-print=false to print breadcrumbs

Both endpoints accept a JSON body with a list of Item RIds to print

Important

The RId is different from the EId used in the lookup URL. The RId is also available in the Item API response and
it identified a fixed version of the item so that the printed label or breadcrumb is ALWAYS reproducible.

Template used for printing

When printing a label or breadcrumb, the system uses the size specified in the fields of the Item:

  • labelSize for labels
  • breadcrumbSize for breadcrumbs

The system uses the values specified in the version identified by the RId used in the print request.

Configuration

Currently (Nov 2025), there are 4 different templates for each Label, Breadcrumb and Kanban Card that the user
can choose from. In the future, these will be configurable by tenant.

In the back end these templates are identified by:

  • SMALL
  • MEDIUM
  • LARGE
  • X_LARGE

The mapping between the type of label/breadcrumb/kanban card and the actual rendered image is captured in the
Template Mapping Spreadsheet

Template Authoring

The Information That a Label or Breadcrumb template can use for rendering the form is also described in the same
spreadsheet. The information will be sent to the template in the standard format that Documint uses with rows and columns.

Comments