Skip to content
/
Upsert a single custom fi...

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

Assign (or change) the shipment's gate

Request

Mirrors ManifestIntegrationController#createManifestGate. The gateExternalId path variable accepts the gate's external identifier (primary) or internal uuid (fallback). Must be called before transitioning the shipment to IN_PROGRESS.

Security
X-AUTH-KEY
Path
shipmentExternalIdstringrequired

Shipment external identifier or uuid.

Example: SHIP-2024-001
gateExternalIdstringrequired

Gate external identifier (preferred) or uuid.

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

Responses

No content

Upsert a single custom field value on an existing shipment

Request

Adds or updates a custom field value. The fieldKey must match a configured custom field. For numeric fields, the value must be parseable as a number. Blank values remove the field.

Security
X-AUTH-KEY
Path
shipmentExternalIdstringrequired

Shipment external identifier or uuid.

Example: SHIP-2024-001
Bodyapplication/jsonrequired
deepLinkstring

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

fieldKeystring[ 0 .. 512 ] charactersrequired

Unique key (name) of the custom field. This must match the configured field name.

fieldValuestring

Value of the custom field as a string. For numeric fields, send the number as a string.

curl -i -X POST \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/shipment/SHIP-2024-001/custom-field \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "deepLink": "string",
    "fieldKey": "string",
    "fieldValue": "string"
  }'

Responses

No content

Asynchronously bulk-upsert Shipment fields (custom fields)

Request

Security
X-AUTH-KEY
curl -i -X POST \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/shipment/bulk-upsert \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Accepted for processing; returns job id and PENDING status

Body*/*
jobIdstring
statusstring
Enum"PENDING""IN_PROGRESS""SAVING""COMPLETE""FAILED"
totalItemsinteger(int32)
processedItemsinteger(int32)

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.