Skip to content
/
Asynchronously bulk-upser...

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

Add pallet comment

Request

Security
X-AUTH-KEY
Path
palletIdstringrequired
Bodyapplication/jsonrequired
additionalInfostring
attachmentsArray of objects(AttachmentV1Dto)
curl -i -X POST \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/pallet/{palletId}/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 Pallet 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/pallet/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
palletIdstringrequired
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/pallet/{palletId}/wms-location' \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "value": "string"
  }'

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.