Skip to content
Download OpenAPI description
Languages
Servers
Mock server

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

https://api.zimark-staging.link/

https://api.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/pallets.

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

Operations

Request

Add a pallet record with a manifest. A pallet associates your WMS pallet identifier with the corresponding Zimark marker, linking the WMS pallet ID to Zimark's scannable marker.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

Example: MAN-2024-001
palletIdentifierstringrequired

Unique identifier of the pallet record to associate with the manifest

Example: PALLET-123456
curl -i -X POST \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/MAN-2024-001/pallet-record/PALLET-123456 \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

OK

Request

Removes a specific pallet record association from a manifest. This does not delete the pallet record itself, only its association with the manifest.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

Example: MAN-2024-001
palletIdentifierstringrequired

Unique identifier of the pallet record to remove from the manifest

Example: PALLET-123456
curl -i -X DELETE \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/MAN-2024-001/pallet-record/PALLET-123456 \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

OK

Request

Associates a manifest with a specific gate location. Gates typically represent physical locations such as loading docks, entry/exit points, or work areas where the manifest operations take place.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

Example: MAN-2024-001
gateExternalIdstringrequired

Unique external identifier of the gate to assign

Example: GATE-A1
curl -i -X POST \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/MAN-2024-001/gate/GATE-A1 \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

OK

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

Pallet

The /track/… paths are deprecated aliases of the /pallet/… endpoints, kept for backward compatibility. They will be removed in a future release; use /pallet/… for new integrations.

Operations
Operations
Operations
Operations
Operations
Operations
Operations