Skip to content

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

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

Activate manifests on a Multi-Manifest Gate

Request

Activates one or more PLANNED manifests on a Multi-Manifest Gate simultaneously. Fails if the gate is not MULTI_MANIFEST, any manifest is not PLANNED, or any asset is shared within the batch or with a manifest already active on the gate.

Security
X-AUTH-KEY
Path
gateExternalIdstringrequired

External identifier of the gate

Example: GATE-A1
Bodyapplication/jsonrequired
manifestExternalIdsArray of stringsnon-emptyrequired

External identifiers of the manifests to activate. All must be in PLANNED status and must not share assets with each other or with manifests already active on the gate.

Example: ["MAN-2024-001","MAN-2024-002"]
curl -i -X POST \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/gate/GATE-A1/manifest/activate \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "manifestExternalIds": [
      "MAN-2024-001",
      "MAN-2024-002"
    ]
  }'

Responses

Activated. Returns the gate's active manifests.

Body*/*Array [
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""COMPLETED""CANCELLED"
closeDatestring(date-time)

Timestamp when the manifest was closed/completed.

activateDatestring(date-time)

Timestamp when the manifest was activated.

tracksCountinteger(int32)

Planning view: total tracks (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.

]

Resolve a gate-level loading issue

Request

Manually resolves a gate-level loading issue (marks the asset as unloaded). Returns the updated issue.

Security
X-AUTH-KEY
Path
gateExternalIdstringrequired

External identifier of the gate

Example: GATE-A1
issueIdstringrequired

Identifier of the gate-level issue to resolve

curl -i -X POST \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/gate/GATE-A1/issue/{issueId}/resolve' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Resolved

Body*/*
idstring

Unique identifier of the issue.

typestring

Issue type.

Enum"UNKNOWN_LOADING""WRONGLY_LOADED_TRACK"
statusstring

Issue status.

Enum"ACTIVE""RESOLVED""CLOSED"
trackCodestring

Track code of the offending asset. Null for Unknown Loading.

wmsIdstring

WMS id of the offending asset. Null for Unknown Loading.

markerCodestring

Marker code captured for the issue, if any.

createdAtstring(date-time)

When the issue was created.

evidenceReferencesArray of strings

Evidence references (evidence uuids) attached to the issue, if any.

Get gates

Request

Security
X-AUTH-KEY
Query
externalIdentifierstring
gateTypestring
Enum"SINGLE_MANIFEST""MULTI_MANIFEST"
qstring
createDateAfterinteger(int64)
createDateBeforeinteger(int64)
pageNumberinteger(int32)

Page number (1-based)

pageSizeinteger(int32)<= 100

Page size

sort.sortBystring

Sorting field

sort.directionstring

Sorting direction

Enum"ASC""DESC"
curl -i -X GET \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/gate?externalIdentifier=string&gateType=SINGLE_MANIFEST&q=string&createDateAfter=0&createDateBefore=0&pageNumber=0&pageSize=100&sort.sortBy=string&sort.direction=ASC' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Ok

Body*/*
contentArray of objects(GateV1Dto)
pageRequestobject(PageRequest)
totalElementsinteger(int32)

List active manifests on a gate

Request

Returns all currently active manifests on a Multi-Manifest Gate, each with its loading progress (loadedAssetsCount / totalAssetsCount).

Security
X-AUTH-KEY
Path
gateExternalIdstringrequired

External identifier of the gate

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

Responses

Ok

Body*/*Array [
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""COMPLETED""CANCELLED"
closeDatestring(date-time)

Timestamp when the manifest was closed/completed.

activateDatestring(date-time)

Timestamp when the manifest was activated.

tracksCountinteger(int32)

Planning view: total tracks (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.

]

List gate-level loading issues

Request

Returns the open gate-level loading issues (UNKNOWN_LOADING and WRONGLY_LOADED_TRACK) for the gate. These issues are scoped to the gate and are not part of any manifest-level response.

Security
X-AUTH-KEY
Path
gateExternalIdstringrequired

External identifier of the gate

Example: GATE-A1
curl -i -X GET \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/gate/GATE-A1/issue \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Ok

Body*/*Array [
idstring

Unique identifier of the issue.

typestring

Issue type.

Enum"UNKNOWN_LOADING""WRONGLY_LOADED_TRACK"
statusstring

Issue status.

Enum"ACTIVE""RESOLVED""CLOSED"
trackCodestring

Track code of the offending asset. Null for Unknown Loading.

wmsIdstring

WMS id of the offending asset. Null for Unknown Loading.

markerCodestring

Marker code captured for the issue, if any.

createdAtstring(date-time)

When the issue was created.

evidenceReferencesArray of strings

Evidence references (evidence uuids) attached to the issue, if any.

]

List gate loading records

Request

Returns per-asset loading rows across all active manifests on the gate, unified with gate-level loading issues. Optional filters: q (matches WMS id or track code), status, and manifest (manifest uuid).

Security
X-AUTH-KEY
Path
gateExternalIdstringrequired

External identifier of the gate

Example: GATE-A1
Query
qstring

Free-text filter on WMS id or track code

statusArray of strings

Filter by loading status

Items Enum"NOT_LOADED""LOADED""WRONGLY_LOADED""UNKNOWN_LOADING""UNLOADED""OFFLOADED"
manifestArray of strings

Filter by manifest uuid

curl -i -X GET \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/gate/GATE-A1/asset-loading?q=string&status=NOT_LOADED&manifest=string' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Ok

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

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

trackobject(ManifestTrackV1Dto)

Track associated with this loading record.

gateobject(GateV1Dto)

Gate where the loading action was performed.

trackIdentifierstring

Business identifier of the track 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"
]

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.