Skip to content
/
Upsert a custom field val...

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

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

Delete pallet

Request

Security
X-AUTH-KEY
Path
palletIdstringrequired
curl -i -X DELETE \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/pallet/{palletId}' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Ok

Upsert a custom field value on a palletDeprecated

Request

Deprecated: legacy /track alias of POST /integration/rest/api/v1/pallet/{palletId}/custom-field, kept for backward compatibility and will be removed in a future release. Use that endpoint instead; request and response are identical.

Creates or updates the value for the given custom field key. A blank/null fieldValue clears the existing value. Returns 204 on success.

Security
X-AUTH-KEY
Path
palletIdstringrequired
Bodyapplication/jsonrequired
fieldKeystring[ 0 .. 512 ] charactersrequired

System key (name) of the custom field; must match a configured field.

Example: "CARRIER"
fieldValuestring[ 0 .. 512 ] characters

Value to set. For NUMERIC fields send the number as a string; for DATE fields send an ISO-8601 date-time. A blank/null value clears the existing value.

Example: "DHL Express"
curl -i -X POST \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/track/{palletId}/custom-field' \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "fieldKey": "CARRIER",
    "fieldValue": "DHL Express"
  }'

Responses

No content

Get pallet commentsDeprecated

Request

Deprecated: legacy /track alias of GET /integration/rest/api/v1/pallet/{palletId}/comments, kept for backward compatibility and will be removed in a future release. Use that endpoint instead; request and response are identical.

Security
X-AUTH-KEY
Path
palletIdstringrequired
curl -i -X GET \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/track/{palletId}/comments' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Ok

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

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

additionalInfostring

Additional information about the pallet

Example: "Pallet is in good condition"
authorobject(AuthorResponseV1Dto)

Author who created this metadata

attachmentsArray of objects(AttachmentV1Dto)

Attachments related to the pallet metadata

]

Gate

Operations

Client

Operations

Bulk Upsert Management

Operations

Audit Log

Operations

Alert Events

Operations

Printing Batch

Operations
Copyright 2026 Zimark Inc © All rights reserved.