Skip to content
/
Update manifest asset loa...

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

Asynchronously bulk-upsert Manifest fields (custom fields)

Request

Security
X-AUTH-KEY
curl -i -X POST \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/bulk-upsert \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Accepted for processing; returns job id and PENDING status

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

Update manifest asset loading status by record uuid

Request

Updates a specific asset loading record status for a manifest.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

Example: MAN-2024-001
recordUuidstringrequired

Asset loading record uuid

Bodyapplication/jsonrequired
statusstringrequired
Enum"NOT_LOADED""LOADED""WRONGLY_LOADED""UNKNOWN_LOADING""UNLOADED""OFFLOADED"
gateExternalIdstring
curl -i -X PATCH \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/MAN-2024-001/asset-loading/{recordUuid}/status' \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "status": "NOT_LOADED",
    "gateExternalId": "string"
  }'

Responses

OK

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

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

palletobject(ManifestPalletV1Dto)

Pallet associated with this loading record.

gateobject(GateV1Dto)

Gate where the loading action was performed.

palletIdentifierstring

Business identifier of the pallet linked to this record.

markerValuestring

Marker value captured during the loading operation.

loadedDatestring(date-time)

Date and time when the asset was marked as loaded.

loadingStatusstring

Current loading status of the asset.

Enum"NOT_LOADED""LOADED""WRONGLY_LOADED""UNKNOWN_LOADING""UNLOADED""OFFLOADED"
shippedboolean

Whether this pallet has departed the warehouse on a closed loading round. Present only when Partial Shipment is enabled for the organization.

roundNumberinteger(int32)

The loading round during which the pallet was loaded; absent if never loaded or loaded before round tracking. Present only when Partial Shipment is enabled for the organization.

evidenceUrlstring

Link to the public evidence page for this loading's evidence. Absent when the loading has no evidence, and when the organization has no configured domain. The link expires — see the Integration API documentation for its lifetime.

trackIdentifierstringDeprecated
trackobject(ManifestPalletV1Dto)Deprecated

Update manifest asset loading status by pallet identifier

Request

Updates a manifest asset loading status 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
Bodyapplication/jsonrequired
statusstringrequired
Enum"NOT_LOADED""LOADED""WRONGLY_LOADED""UNKNOWN_LOADING""UNLOADED""OFFLOADED"
gateExternalIdstring
curl -i -X PATCH \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/MAN-2024-001/asset-loading/pallet/PALLET-123456/status \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "status": "NOT_LOADED",
    "gateExternalId": "string"
  }'

Responses

OK

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

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

palletobject(ManifestPalletV1Dto)

Pallet associated with this loading record.

gateobject(GateV1Dto)

Gate where the loading action was performed.

palletIdentifierstring

Business identifier of the pallet linked to this record.

markerValuestring

Marker value captured during the loading operation.

loadedDatestring(date-time)

Date and time when the asset was marked as loaded.

loadingStatusstring

Current loading status of the asset.

Enum"NOT_LOADED""LOADED""WRONGLY_LOADED""UNKNOWN_LOADING""UNLOADED""OFFLOADED"
shippedboolean

Whether this pallet has departed the warehouse on a closed loading round. Present only when Partial Shipment is enabled for the organization.

roundNumberinteger(int32)

The loading round during which the pallet was loaded; absent if never loaded or loaded before round tracking. Present only when Partial Shipment is enabled for the organization.

evidenceUrlstring

Link to the public evidence page for this loading's evidence. Absent when the loading has no evidence, and when the organization has no configured domain. The link expires — see the Integration API documentation for its lifetime.

trackIdentifierstringDeprecated
trackobject(ManifestPalletV1Dto)Deprecated

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.