Skip to content
/
Create manifest

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

Get manifests

Request

Retrieves a paginated list of manifests with optional filtering by status and gate. Supports sorting and pagination through query parameters.

Security
X-AUTH-KEY
Query
manifestStatusesArray of strings
Items Enum"PLANNED""TO_DO""IN_PROGRESS""PENDING_COMPLETION""COMPLETED""CANCELLED"
gateUuidstring
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/manifest?manifestStatuses=PLANNED&gateUuid=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(ManifestV1Dto)
pageRequestobject(PageRequest)
totalElementsinteger(int32)

Create manifest

Request

Creates a new manifest with the provided details including external ID, status, gate, custom fields, and optional asset associations.Returns the created manifest's internal and external identifiers.

Security
X-AUTH-KEY
Bodyapplication/jsonrequired
identifierstringnon-emptyrequired

External unique identifier for the manifest to create.

assetsArray of stringsnon-emptyrequired

Initial list of asset (pallet) identifiers to include in the manifest.

customFieldsArray of objects(ManifestCustomFieldV1Dto)

Optional custom fields to set on the manifest upon creation.

gateExternalIdstring

Optional external identifier of the gate to associate with the manifest.

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

Responses

OK

Body*/*
uuidstring

Update manifest status

Request

Updates the status of a manifest. Returns 200 OK when the status is changed, or 204 No Content when the manifest is already in the requested status (no-op).

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

Example: MAN-2024-001
manifestStatusstringrequired

New status for the manifest

Enum"PLANNED""TO_DO""IN_PROGRESS""PENDING_COMPLETION""COMPLETED""CANCELLED"
Example: IN_PROGRESS
curl -i -X POST \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/MAN-2024-001/status/IN_PROGRESS \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

Status updated

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.