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://{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

Track

Operations

Upsert a custom field value on a track

Request

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
trackIdstringrequired
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/{trackId}/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 track comments

Request

Security
X-AUTH-KEY
Path
trackIdstringrequired
curl -i -X GET \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/track/{trackId}/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 track

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

Author who created this metadata

attachmentsArray of objects(AttachmentV1Dto)

Attachments related to the track metadata

]

Add track comment

Request

Security
X-AUTH-KEY
Path
trackIdstringrequired
Bodyapplication/jsonrequired
additionalInfostring
attachmentsArray of objects(AttachmentV1Dto)
curl -i -X POST \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/track/{trackId}/comments' \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "additionalInfo": "string",
    "attachments": [
      {
        "link": "string",
        "fileName": "string",
        "author": {
          "firstName": "string",
          "lastName": "string",
          "email": "string",
          "phoneNumber": "string"
        },
        "description": "string"
      }
    ]
  }'

Responses

Ok

Asynchronously bulk-upsert Track fields (SKU, Client, WMS Location, custom fields)

Request

Security
X-AUTH-KEY
curl -i -X POST \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/track/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)

Upsert or clear pallet WMS Location

Request

Security
X-AUTH-KEY
Path
trackIdstringrequired
Bodyapplication/jsonrequired
valuestring[ 0 .. 255 ] characters

WMS Location string. Null or blank clears the assignment.

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

Responses

Ok

Assign or clear pallet SKU

Request

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

Responses

Ok

Reactivate track

Request

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

Responses

Ok

Retire track

Request

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

Responses

Ok

Assign or clear pallet Client

Request

Security
X-AUTH-KEY
Path
trackIdstringrequired
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/{trackId}/client' \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "client": "string"
  }'

Responses

Ok

Get track

Request

Security
X-AUTH-KEY
Query
wmsIdstring
damagedTracksboolean
trackStatusstring
Enum"SCHEDULED_FOR_RETIREMENT""ACTIVE""NOT_ACTIVE""FLAGGED"
manifestExternalIdsArray of strings
skuArray of strings
clientArray of strings
wmsLocationArray of strings
qstring
createDateAfterinteger(int64)
createDateBeforeinteger(int64)
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?wmsId=string&damagedTracks=true&trackStatus=SCHEDULED_FOR_RETIREMENT&manifestExternalIds=string&sku=string&client=string&wmsLocation=string&q=string&createDateAfter=0&createDateBefore=0&pageNumber=0&pageSize=100&sort.sortBy=string&sort.direction=ASC' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Ok

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

Get track activity timeline

Request

Security
X-AUTH-KEY
Path
trackIdstringrequired
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/{trackId}/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(TrackActivityV1Dto)
pageRequestobject(PageRequest)
totalElementsinteger(int32)

Delete track

Request

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

Responses

Ok

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.