Skip to content
/
Validate shipment (return...

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

Update shipment asset loading status by marker value

Request

Updates every asset-loading record in the shipment matching the marker value, with a Zimark-code fallback (marker → track → WMS id → records). Multi-manifest fan-out applies when the resolved WMS id is shared across manifests.

Security
X-AUTH-KEY
Path
shipmentExternalIdstringrequired

Shipment external identifier (preferred) or uuid.

Example: SHIP-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/shipment/SHIP-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*/*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"
]

Validate shipment (returns domain validation errors without mutating state)

Request

Returns cancelled member manifests and per-manifest validation results (duplicated tracks, non-existing tracks, deactivated tracks) without modifying the shipment.

Security
X-AUTH-KEY
Path
shipmentExternalIdstringrequired

Shipment external identifier or uuid.

Example: SHIP-2024-001
curl -i -X GET \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/shipment/SHIP-2024-001/validate \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

OK

Body*/*
canceledManifestsArray of objects(ShipmentManifestRefV1Dto)

Manifests that are in CANCELLED status while still attached to the shipment.

manifestValidationsArray of objects(ManifestValidationErrorsV1Dto)

Per-manifest validation results (duplicated tracks, non-existing tracks, deactivated tracks) for each non-cancelled attached manifest.

List assets (tracks) across all manifests in the shipment

Request

Returns a flattened list of track records spanning every non-cancelled manifest attached to the shipment. Each entry includes the track, its loading status, and the owning manifest reference.

Security
X-AUTH-KEY
Path
shipmentExternalIdstringrequired

Shipment external identifier or uuid.

Example: SHIP-2024-001
curl -i -X GET \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/shipment/SHIP-2024-001/asset \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

OK

Body*/*Array [
trackIdentifierstring

Track identifier (WMS id).

trackobject(TrackV1Dto)

Track details.

loadingStatusstring

Current loading status of the asset at the gate.

Enum"NOT_LOADED""LOADED""WRONGLY_LOADED""UNKNOWN_LOADING""UNLOADED""OFFLOADED"
manifestobject(ShipmentManifestRefV1Dto)

The manifest this track belongs to within the shipment.

]

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.