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

Get manifest by external ID

Request

Retrieves a single manifest by its unique external identifier. Returns the manifest details without the associated assets/tracks.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external id of the manifest. External id is often an id based on the WMS Zimark is integrated with, e.g. an order id.

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

External unique identifier for this manifest.

manifestStatusstring

Current status of the manifest.

Enum"PLANNED""TO_DO""IN_PROGRESS""COMPLETED""CANCELLED"
closeDatestring(date-time)

Timestamp when the manifest was closed/completed.

activateDatestring(date-time)

Timestamp when the manifest was activated.

tracksCountinteger(int32)

Planning view: total tracks (assets) currently included in this manifest, regardless of loading state. For Total/Loaded execution counts use totalAssetsCount and loadedAssetsCount.

totalAssetsCountinteger(int32)

Total assets attached to this manifest, excluding invalid loadings (WRONGLY_LOADED, UNKNOWN_LOADING).

loadedAssetsCountinteger(int32)

Successfully loaded assets in this manifest, excluding invalid loadings.

gateobject(GateV1Dto)

Assigned gate for this manifest (loading/unloading point).

customFieldsArray of objects(ManifestCustomFieldV1Dto)

Custom key–value fields attached to the manifest.

validationErrorsobject(ManifestValidationErrorsV1Dto)

Validation errors related to this manifest, if any.

proofOfShipmentUrlstring

URL to the proof-of-shipment document.

deletedboolean

Indicates whether the manifest is soft-deleted.

shipmentSummaryUrlstring

Public URL to the Shipment Summary page for this manifest. Present only when manifest status is COMPLETED. Does not expire.

Update manifest

Request

Updates an existing manifest's assets and/or custom fields.This update endpoint uses a declarative updates, meaning Zimark will automatically handle deleting, adding, or updating assets and/or custom fields for you.

For updating other properties like status and gate assignment, use the specific endpoints.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external id of the manifest. AnE eternal id is often an id based on the WMS Zimark is integrated with, e.g. an order id.

Example: MAN-2024-001
Bodyapplication/jsonrequired
assetsArray of strings

Optional list of asset (track) identifiers to set or update for the manifest.

customFieldsArray of objects(ManifestCustomFieldV1Dto)

Optional custom fields to set or update for the manifest.

curl -i -X PUT \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/MAN-2024-001 \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "assets": [
      "string"
    ],
    "customFields": [
      {
        "deepLink": "string",
        "fieldKey": "string",
        "fieldValue": "string"
      }
    ]
  }'

Responses

OK

Delete manifest by external ID

Request

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external id of the manifest. External id is often an id based on the WMS Zimark is integrated with, e.g. an order id.

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

Responses

Ok

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.