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://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

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 → pallet → 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.

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
]

Validate shipment (returns domain validation errors without mutating state)

Request

Returns cancelled member manifests and per-manifest validation results (duplicated pallets, non-existing pallets, deactivated pallets) 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 pallets, non-existing pallets, deactivated pallets) for each non-cancelled attached manifest.

List the shipment's loading rounds

Request

Returns the shipment's loading rounds ordered by round number — one per truck loading cycle. Available only for organizations with the Partial Shipment setting enabled; otherwise 403 PARTIAL_SHIPMENT_DISABLED.

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/loading-round \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

OK

Body*/*Array [
roundNumberinteger(int32)

1-based sequential round number within the shipment.

statusstring

Round status: IN_PROGRESS (open), PARTIALLY_SHIPPED or COMPLETED (closed).

Enum"IN_PROGRESS""PARTIALLY_SHIPPED""COMPLETED"
checkInTimestring(date-time)

When the round opened (shipment activated on the gate).

checkOutTimestring(date-time)

When the round closed (partial shipment or completion); null while the round is open.

palletsLoadedinteger(int32)

Pallets loaded during this round (derived; live for the open round).

gateobject(GateV1Dto)

Gate the round took place on (short form).

]

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.