Skip to content
/
Return a completed manife...

Zimark Integration API (v0)

Download OpenAPI description
api.json
api.yaml
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

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""PENDING_COMPLETION""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

Return a completed manifest

Request

Returns a COMPLETED manifest to the PLANNED status so it can be re-dispatched under the same external ID. The completed version is archived (kept COMPLETED, its ID released) and a new PLANNED manifest is created with the same external ID, pallets and custom fields; pallets marked for retirement are reactivated. Requires the organization's "Allow Manifest Return" setting to be enabled. Rejected with 409 when a pallet of the manifest has meanwhile been added to another active (PLANNED / IN_PROGRESS) manifest, since the return would put that pallet in two active manifests at once; remove it from the other manifest first. Returns the new manifest, whose external ID equals the requested one.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external id (or UUID) of the completed manifest to return.

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

Responses

Manifest returned; body is the new PLANNED manifest

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

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

externalIdentifierstring

External unique identifier for this manifest.

manifestStatusstring

Current status of the manifest.

Enum"PLANNED""TO_DO""IN_PROGRESS""PENDING_COMPLETION""COMPLETED""CANCELLED"
closeDatestring(date-time)

Timestamp when the manifest was closed/completed.

activateDatestring(date-time)

Timestamp when the manifest was activated.

palletsCountinteger(int32)

Planning view: total pallets (assets) currently included in this manifest, regardless of loading state. For Total/Loaded execution counts use totalAssetsCount and loadedAssetsCount.

totalAssetsCountinteger(int32)

Total assets attached to this manifest, excluding invalid loadings (WRONGLY_LOADED, UNKNOWN_LOADING).

loadedAssetsCountinteger(int32)

Successfully loaded assets in this manifest, excluding invalid loadings.

gateobject(GateV1Dto)

Assigned gate for this manifest (loading/unloading point).

customFieldsArray of objects(ManifestCustomFieldV1Dto)

Custom key–value fields attached to the manifest.

validationErrorsobject(ManifestValidationErrorsV1Dto)

Validation errors related to this manifest, if any.

proofOfShipmentUrlstring

URL to the proof-of-shipment document.

deletedboolean

Indicates whether the manifest is soft-deleted.

shipmentSummaryUrlstring

Public URL to the Shipment Summary page for this manifest. Present only when manifest status is COMPLETED. Does not expire.

autoCompleteAtstring(date-time)

Server-authoritative deadline when the manifest will auto-complete. Present only while the manifest is in PENDING_COMPLETION; omitted otherwise. Completion may occur later than this time if the system is temporarily holding auto-completion (e.g. gate out of service).

tracksCountinteger(int32)Deprecated

Add pallet record to manifest

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

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

Gate

Operations

Client

Operations

Bulk Upsert Management

Operations

Audit Log

Operations

Alert Events

Operations

Printing Batch

Operations
Copyright 2026 Zimark Inc © All rights reserved.