Skip to content
/
Update manifest gate assi...

Zimark Integration API (v1)

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/

Calibration Integration

External API for integration systems with token-based authentication

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

Update manifest status

Request

Updates the status of a manifest.

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""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

OK

Update manifest gate assignment

Request

Associates a manifest with a specific gate location. Gates typically represent physical locations such as loading docks, entry/exit points, or work areas where the manifest operations take place.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

Example: MAN-2024-001
gateExternalIdstringrequired

Unique external identifier of the gate to assign

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

Responses

OK

Create or update manifest custom field

Request

Adds a new custom field to a manifest or updates an existing one. Custom fields allow storing additional metadata key-value pairs specific to your integration needs.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

Example: MAN-2024-001
Bodyapplication/jsonrequired
fieldKeystring

Unique key (name) of the custom field. This must match the configured field name.

fieldValuestring

Value of the custom field as a string. For numeric fields, send the number as a string.

curl -i -X POST \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/MAN-2024-001/custom-field \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "fieldKey": "string",
    "fieldValue": "string"
  }'

Responses

OK

User

Operations

Track

Operations

Printing Batch

Operations

Local Manager

Operations

Scanner

Operations

Gate

Operations

Audit Log

Operations

Alert Events

Operations

Agent

Operations
Copyright 2025 Zimark Inc © All rights reserved.