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

Get shipment by external id or uuid

Request

Resolution order: external identifier first, UUID fallback. Soft-deleted shipments return 404.

Security
X-AUTH-KEY
Path
shipmentExternalIdstringrequired

Shipment external identifier (preferred) or uuid.

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

Responses

OK

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

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

externalIdentifierstring

Caller-assigned external identifier, unique per organization within the Shipment namespace.

statusstring

Lifecycle status of the shipment.

Enum"PLANNED""TO_DO""IN_PROGRESS""COMPLETED""CANCELLED"
gateobject(GateV1Dto)

Gate currently assigned to the shipment, if any.

manifestsArray of objects(ShipmentManifestRefV1Dto)

Manifests currently attached to the shipment.

tracksCountinteger(int64)

Planning view: total tracks (assets) currently included across this shipment's manifests, regardless of loading state. For Total/Loaded execution counts use totalAssetsCount and loadedAssetsCount.

totalAssetsCountinteger(int64)

Total assets attached to the shipment, excluding invalid loadings (WRONGLY_LOADED, UNKNOWN_LOADING) and records belonging to cancelled manifests.

loadedAssetsCountinteger(int64)

Successfully loaded assets, excluding invalid loadings and records belonging to cancelled manifests.

notesstring

Optional free-text notes.

activateDatestring(date-time)

Timestamp when the shipment transitioned to IN_PROGRESS, null if not yet activated.

closeDatestring(date-time)

Timestamp when the shipment transitioned to a terminal status (COMPLETED or CANCELLED), null if still active.

deletedboolean

Soft-delete flag. Deleted shipments are excluded from list and get endpoints.

customFieldsArray of objects(ShipmentCustomFieldV1Dto)

Custom field values set on this shipment. Omitted when the organization's dispatch strategy is not SHIPMENT.

Update a shipment

Request

Partial update. Fields omitted (null) are left unchanged. The manifests list, when present, uses full-replacement semantics.

Security
X-AUTH-KEY
Path
shipmentExternalIdstringrequired

Shipment external identifier or uuid.

Bodyapplication/jsonrequired
identifierstring[ 0 .. 255 ] characters

Caller-assigned shipment external identifier. Immutable — supplying a different value than the current value returns 400. May be omitted (null) on update.

gateIdentifierstring[ 0 .. 255 ] characters

Gate to assign (accepts external identifier or uuid). Set to empty string to clear the gate assignment.

notesstring[ 0 .. 1000 ] characters

Free-text notes.

manifestsArray of objects(ManifestReferenceV1Dto)

Full-replacement manifest list. When present, replaces the current set; omitted manifests are detached. When null, the manifest list is left unchanged. An empty list is rejected with 400 — a shipment must always contain at least one manifest.

customFieldsArray of objects(ShipmentCustomFieldV1Dto)

Full-replacement custom field list. When present, replaces the current set; omitted keys are removed. When null, custom fields are left unchanged. Blank values are ignored.

curl -i -X PUT \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/shipment/{shipmentExternalId}' \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "identifier": "string",
    "gateIdentifier": "string",
    "notes": "string",
    "manifests": [
      {
        "manifestExternalId": "string",
        "manifestUuid": "string"
      }
    ],
    "customFields": [
      {
        "deepLink": "string",
        "fieldKey": "string",
        "fieldValue": "string"
      }
    ]
  }'

Responses

OK

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

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

externalIdentifierstring

Caller-assigned external identifier, unique per organization within the Shipment namespace.

statusstring

Lifecycle status of the shipment.

Enum"PLANNED""TO_DO""IN_PROGRESS""COMPLETED""CANCELLED"
gateobject(GateV1Dto)

Gate currently assigned to the shipment, if any.

manifestsArray of objects(ShipmentManifestRefV1Dto)

Manifests currently attached to the shipment.

tracksCountinteger(int64)

Planning view: total tracks (assets) currently included across this shipment's manifests, regardless of loading state. For Total/Loaded execution counts use totalAssetsCount and loadedAssetsCount.

totalAssetsCountinteger(int64)

Total assets attached to the shipment, excluding invalid loadings (WRONGLY_LOADED, UNKNOWN_LOADING) and records belonging to cancelled manifests.

loadedAssetsCountinteger(int64)

Successfully loaded assets, excluding invalid loadings and records belonging to cancelled manifests.

notesstring

Optional free-text notes.

activateDatestring(date-time)

Timestamp when the shipment transitioned to IN_PROGRESS, null if not yet activated.

closeDatestring(date-time)

Timestamp when the shipment transitioned to a terminal status (COMPLETED or CANCELLED), null if still active.

deletedboolean

Soft-delete flag. Deleted shipments are excluded from list and get endpoints.

customFieldsArray of objects(ShipmentCustomFieldV1Dto)

Custom field values set on this shipment. Omitted when the organization's dispatch strategy is not SHIPMENT.

Soft-delete a shipment

Request

Allowed from any non-terminal state including IN_PROGRESS. Detaches all manifests and releases the external identifier for reuse.

Security
X-AUTH-KEY
Path
shipmentExternalIdstringrequired

Shipment external identifier or uuid.

curl -i -X DELETE \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/shipment/{shipmentExternalId}' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

No content

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.