Skip to content

Zimark Integration API (v0)

Download OpenAPI description
api.json
api.yaml
Languages
Servers
Mock server

https://docs.zimark.link/_mock/api/

https://{organizationSubdomain}.zimark-staging.link/

https://{organizationSubdomain}.zimark.link/

Zimarker

Allocate zimarker code(s) on demand for the calling organization, each with a printable, inline base64 marker image. Allocation is synchronous, atomic, and exactly-once per organization.

Render a zimarker code's marker image on demand. Public, stateless, and addressable by code at a stable URL — no authentication required.

Operations

Manifest

API endpoints for managing manifests and their associated assets/tracks.

A manifest is a container that groups assets/pallets for tracking purposes.

Operations

Shipment

API endpoints for managing shipments (multi-manifest dispatch grouping). A shipment groups one or more manifests for dispatch at a single gate; only available to organizations configured with the shipment dispatch strategy.

Operations

Track

Operations

Gate

Operations

Client

Operations

Get client

Request

Resolves clientId as external ID first, then internal UUID.

Security
X-AUTH-KEY
Path
clientIdstringrequired
curl -i -X GET \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/client/{clientId}' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Ok

Body*/*
createDatestring(date-time)
updateDatestring(date-time)
deepLinkstring

Deep link URL to open this entity in Ops.App.

displayNamestring

Customer-visible display name. Unique per organization (case-insensitive).

externalIdstring

Customer-side external identifier. Unique per organization (case-insensitive).

Update client

Request

Security
X-AUTH-KEY
Path
clientIdstringrequired
Bodyapplication/jsonrequired
displayNamestring

New display name (required, unique per org, max 255).

externalIdstring

New external identifier (required, unique per org, max 255).

curl -i -X PUT \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/client/{clientId}' \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "displayName": "string",
    "externalId": "string"
  }'

Responses

Ok

Body*/*
createDatestring(date-time)
updateDatestring(date-time)
deepLinkstring

Deep link URL to open this entity in Ops.App.

displayNamestring

Customer-visible display name. Unique per organization (case-insensitive).

externalIdstring

Customer-side external identifier. Unique per organization (case-insensitive).

Delete client

Request

Soft-deletes; blocked with clientHasAssignedPallets when assigned to any non-deleted pallet.

Security
X-AUTH-KEY
Path
clientIdstringrequired
curl -i -X DELETE \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/client/{clientId}' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Deleted

List clients

Request

Paginated; optional q does a case-insensitive contains-match across displayName and externalId. Default sort: displayName ascending.

Security
X-AUTH-KEY
Query
qstring

Free-text search across displayName and externalId

Default "*"
pageNumberinteger(int32)

Page number (1-based)

pageSizeinteger(int32)<= 100

Page size

sort.sortBystring

Sorting field

sort.directionstring

Sorting direction

Enum"ASC""DESC"
curl -i -X GET \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/client?q=*&pageNumber=0&pageSize=100&sort.sortBy=string&sort.direction=ASC' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Ok

Body*/*
contentArray of objects(ClientV1Dto)
pageRequestobject(PageRequest)
totalElementsinteger(int32)

Create client

Request

Creates a Client with displayName + externalId; both must be unique within the organization (case-insensitive). Requires the Pallet Data Extensions / Client feature to be enabled.

Security
X-AUTH-KEY
Bodyapplication/jsonrequired
displayNamestring

Display name (required, unique per org, max 255).

externalIdstring

External identifier (required, unique per org, max 255).

curl -i -X POST \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/client \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "displayName": "string",
    "externalId": "string"
  }'

Responses

Ok

Body*/*
createDatestring(date-time)
updateDatestring(date-time)
deepLinkstring

Deep link URL to open this entity in Ops.App.

displayNamestring

Customer-visible display name. Unique per organization (case-insensitive).

externalIdstring

Customer-side external identifier. Unique per organization (case-insensitive).

Scanner

Operations

Printing Batch

Operations

Agent

Operations

Local Manager

Operations

User

Operations

Audit Log

Operations

Alert Events

Operations

Calibration Integration

External API for integration systems with token-based authentication

Operations

Bulk Upsert Management

Operations
Copyright 2026 Zimark Inc © All rights reserved.