Skip to content
/
Get manifest assets

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 asset loading status by marker value

Request

Updates a manifest asset loading status by marker value.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

Example: MAN-2024-001
markerValuestringrequired

Marker value

Example: 33123456123
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/marker/33123456123/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.

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"

Get manifest assets

Request

Retrieves all assets associated with a specific manifest. Assets represent items, equipment, or materials included in the manifest work order.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

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

trackIdentifierstring

Business identifier of the asset (track) associated with the manifest.

trackobject(ManifestTrackV1Dto)

Track details associated with this manifest asset.

loadingStatusstring

Loading status of the asset in the manifest workflow.

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

Get manifest asset loading details

Request

Retrieves asset loading details for a manifest. Details contain the loading status, track and gate details of the asset per asset.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

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

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.