Skip to content
/
Update manifest gate assi...

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

Update manifest status

Request

Updates the status of a manifest. Returns 200 OK when the status is changed, or 204 No Content when the manifest is already in the requested status (no-op).

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

Example: MAN-2024-001
manifestStatusstringrequired

New status for the manifest

Enum"PLANNED""TO_DO""IN_PROGRESS""COMPLETED""CANCELLED"
Example: IN_PROGRESS
curl -i -X POST \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/MAN-2024-001/status/IN_PROGRESS \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Status updated

Update manifest gate assignment

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

Create or update manifest custom field

Request

Adds a new custom field to a manifest or updates an existing one. Custom fields allow storing additional metadata key-value pairs specific to your integration needs.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

Example: MAN-2024-001
Bodyapplication/jsonrequired
deepLinkstring

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

fieldKeystring

Unique key (name) of the custom field. This must match the configured field name.

fieldValuestring

Value of the custom field as a string. For numeric fields, send the number as a string.

curl -i -X POST \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/MAN-2024-001/custom-field \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "deepLink": "string",
    "fieldKey": "string",
    "fieldValue": "string"
  }'

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

Track

Operations

Gate

Operations

Client

Operations

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.