Skip to content
/
Add pallet record to mani...

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

Upsert manifest assetsDeprecated

Request

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired
Bodyapplication/jsonrequired
assetsArray of stringsnon-emptyrequired

List of asset (pallet) identifiers to add or update on the manifest.

customFieldsArray of objects(ManifestCustomFieldV1Dto)

Optional custom fields to apply to the manifest during the upsert operation.

curl -i -X POST \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/{manifestExternalId}/upsert-assets' \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "assets": [
      "string"
    ],
    "customFields": [
      {
        "deepLink": "string",
        "fieldKey": "string",
        "fieldValue": "string"
      }
    ]
  }'

Responses

Ok

Body*/*
uuidstring

Add pallet record to manifestDeprecated

Request

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

Add a pallet record with a manifest. A pallet associates your WMS pallet identifier with the corresponding Zimark marker, linking the WMS pallet ID to Zimark's scannable marker.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

Example: MAN-2024-001
palletIdentifierstringrequired

Unique identifier of the pallet record to associate with the manifest

Example: PALLET-123456
curl -i -X POST \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/MAN-2024-001/track-record/PALLET-123456 \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

OK

Delete manifest pallet recordDeprecated

Request

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

Removes a specific pallet record association from a manifest. This does not delete the pallet record itself, only its association with the manifest.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

Example: MAN-2024-001
palletIdentifierstringrequired

Unique identifier of the pallet record to remove from the manifest

Example: PALLET-123456
curl -i -X DELETE \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/MAN-2024-001/track-record/PALLET-123456 \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

OK

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

Gate

Operations

Client

Operations

Bulk Upsert Management

Operations

Audit Log

Operations

Alert Events

Operations

Printing Batch

Operations
Copyright 2026 Zimark Inc © All rights reserved.