Skip to content
/
Reactivate pallet

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

Assign or clear pallet SKU

Request

Security
X-AUTH-KEY
Path
palletIdstringrequired
Bodyapplication/jsonrequired
valuestring[ 0 .. 255 ] characters
curl -i -X PATCH \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/pallet/{palletId}/sku' \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "value": "string"
  }'

Responses

Ok

Reactivate pallet

Request

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

Responses

Ok

Retire pallet

Request

Security
X-AUTH-KEY
Path
palletIdstringrequired
Query
forceboolean
Default false
curl -i -X PATCH \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/pallet/{palletId}/retire?force=false' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Ok

Gate

Operations

Client

Operations

Bulk Upsert Management

Operations

Audit Log

Operations

Alert Events

Operations

Printing Batch

Operations
Copyright 2026 Zimark Inc © All rights reserved.