Skip to content
Download OpenAPI description
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
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Calibration Integration

External API for integration systems with token-based authentication

Operations
Operations

Get async bulk-upsert job status and progress

Request

Security
X-AUTH-KEY
Path
jobIdstringrequired
curl -i -X GET \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/bulk-upsert/{jobId}' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Ok

Body*/*
jobIdstring
statusstring
Enum"PENDING""IN_PROGRESS""SAVING""COMPLETE""FAILED"
totalItemsinteger(int32)
processedItemsinteger(int32)

Get the async bulk-upsert per-item results as NDJSON

Request

Security
X-AUTH-KEY
Path
jobIdstringrequired
curl -i -X GET \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/bulk-upsert/{jobId}/result' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

The per-item result as NDJSON (one JSON object per line) when the job is COMPLETE

Bodyapplication/x-ndjson
string(binary)
Response
application/x-ndjson
"string"