Skip to content
/
Assign or clear pallet Cl...

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

Retire palletDeprecated

Request

Deprecated: legacy /track alias of PATCH /integration/rest/api/v1/pallet/{palletId}/retire, 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
Query
forceboolean
Default false
curl -i -X PATCH \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/track/{palletId}/retire?force=false' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Ok

Assign or clear pallet ClientDeprecated

Request

Deprecated: legacy /track alias of PATCH /integration/rest/api/v1/pallet/{palletId}/client, 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
Bodyapplication/jsonrequired
clientstring[ 0 .. 255 ] characters

Client external ID or UUID. Null or blank clears the assignment.

curl -i -X PATCH \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/track/{palletId}/client' \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "client": "string"
  }'

Responses

Ok

Get pallet activity timelineDeprecated

Request

Deprecated: legacy /track alias of GET /integration/rest/api/v1/pallet/{palletId}/activity, 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
Query
pageNumberinteger(int32)

Page number (1-based)

pageSizeinteger(int32)<= 100

Page size

sort.sortBystring

Sorting field

sort.directionstring

Sorting direction

Enum"ASC""DESC"
curl -i -X GET \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/track/{palletId}/activity?pageNumber=0&pageSize=100&sort.sortBy=string&sort.direction=ASC' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Ok

Body*/*
contentArray of objects(PalletActivityV1Dto)
pageRequestobject(PageRequest)
totalElementsinteger(int32)

Gate

Operations

Client

Operations

Bulk Upsert Management

Operations

Audit Log

Operations

Alert Events

Operations

Printing Batch

Operations
Copyright 2026 Zimark Inc © All rights reserved.