Skip to content
/
Attach one or more manife...

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 status (activate / complete / cancel)

Request

Unified status-update endpoint mirroring ManifestIntegrationController#updateManifestStatus. Accepts IN_PROGRESS (activate; requires gate assigned first), COMPLETED (from IN_PROGRESS), or CANCELLED (from TO_DO or IN_PROGRESS). Unknown status values return 400. Invalid transitions return 400.

Security
X-AUTH-KEY
Path
shipmentExternalIdstringrequired

Shipment external identifier or uuid.

Example: SHIP-2024-001
shipmentStatusstringrequired

Target shipment status.

Enum"PLANNED""TO_DO""IN_PROGRESS""COMPLETED""CANCELLED"
curl -i -X POST \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/shipment/SHIP-2024-001/status/{shipmentStatus}' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

No content

Attach one or more manifests to the shipment (all-or-nothing batch)

Request

All supplied manifests must exist, must be in PLANNED status, and must not be attached to another shipment. If any fails validation, the entire batch is rolled back.

Security
X-AUTH-KEY
Path
shipmentExternalIdstringrequired

Shipment external identifier or uuid.

Example: SHIP-2024-001
Bodyapplication/jsonrequired
manifestsArray of objects(ManifestReferenceV1Dto)non-emptyrequired

List of manifest references to attach. Exactly one of manifestExternalId / manifestUuid must be set per reference. The entire batch is rolled back on any single validation failure.

manifests[].​manifestExternalIdstring[ 0 .. 255 ] characters

Caller-assigned manifest external identifier.

manifests[].​manifestUuidstring

Internal manifest identifier (uuid).

curl -i -X POST \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/shipment/SHIP-2024-001/manifest \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "manifests": [
      {
        "manifestExternalId": "string",
        "manifestUuid": "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.

Detach one or more manifests from the shipment (all-or-nothing batch)

Request

All supplied manifests must be currently attached to the shipment. If any is not attached, the entire batch is rejected.

Security
X-AUTH-KEY
Path
shipmentExternalIdstringrequired

Shipment external identifier or uuid.

Bodyapplication/jsonrequired
manifestsArray of objects(ManifestReferenceV1Dto)non-emptyrequired

List of manifest references to detach. The entire batch is rolled back on any single validation failure.

manifests[].​manifestExternalIdstring[ 0 .. 255 ] characters

Caller-assigned manifest external identifier.

manifests[].​manifestUuidstring

Internal manifest identifier (uuid).

curl -i -X DELETE \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/shipment/{shipmentExternalId}/manifest' \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "manifests": [
      {
        "manifestExternalId": "string",
        "manifestUuid": "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.

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.