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

Removes a specific custom field from a manifest by its key. The field and its value will be permanently deleted from the manifest.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

Example: MAN-2024-001
fieldKeystringrequired

Key of the custom field to delete

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

Responses

OK

Delete manifest asset invalid loading record by record uuid

Request

Deletes an unassigned (non-expected) asset invalid loading record.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

Example: MAN-2024-001
recordUuidstringrequired

Asset loading record uuid

curl -i -X DELETE \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/MAN-2024-001/asset-loading/{recordUuid}' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

OK

Delete manifest asset invalid loading record by pallet identifier

Request

Deletes an unassigned (non-expected) asset invalid loading record by pallet identifier.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

Example: MAN-2024-001
palletIdentifierstringrequired

Pallet identifier (WMS id)

Example: PALLET-123456
curl -i -X DELETE \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/MAN-2024-001/asset-loading/pallet/PALLET-123456 \
  -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