Skip to content
/
Update manifest asset loa...

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

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

Update manifest asset loading status by record uuid

Request

Updates a specific asset loading record status for a manifest.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

Example: MAN-2024-001
recordUuidstringrequired

Asset loading record uuid

Bodyapplication/jsonrequired
statusstringrequired
Enum"NOT_LOADED""LOADED""WRONGLY_LOADED""UNKNOWN_LOADING""UNLOADED""OFFLOADED"
gateExternalIdstring
curl -i -X PATCH \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/MAN-2024-001/asset-loading/{recordUuid}/status' \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "status": "NOT_LOADED",
    "gateExternalId": "string"
  }'

Responses

OK

Body*/*
createDatestring(date-time)
updateDatestring(date-time)
trackobject(ManifestTrackV1Dto)

Track associated with this loading record.

gateobject(GateV1Dto)

Gate where the loading action was performed.

trackIdentifierstring

Business identifier of the track linked to this record.

markerValuestring

Marker value captured during the loading operation.

loadedDatestring(date-time)

Date and time when the asset was marked as loaded.

loadingStatusstring

Current loading status of the asset.

Enum"NOT_LOADED""LOADED""WRONGLY_LOADED""UNKNOWN_LOADING""UNLOADED""OFFLOADED"

Update manifest asset loading status by track identifier

Request

Updates a manifest asset loading status by track identifier.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

Example: MAN-2024-001
trackIdentifierstringrequired

Track identifier (WMS id)

Example: TRACK-123456
Bodyapplication/jsonrequired
statusstringrequired
Enum"NOT_LOADED""LOADED""WRONGLY_LOADED""UNKNOWN_LOADING""UNLOADED""OFFLOADED"
gateExternalIdstring
curl -i -X PATCH \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/MAN-2024-001/asset-loading/track/TRACK-123456/status \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "status": "NOT_LOADED",
    "gateExternalId": "string"
  }'

Responses

OK

Body*/*
createDatestring(date-time)
updateDatestring(date-time)
trackobject(ManifestTrackV1Dto)

Track associated with this loading record.

gateobject(GateV1Dto)

Gate where the loading action was performed.

trackIdentifierstring

Business identifier of the track linked to this record.

markerValuestring

Marker value captured during the loading operation.

loadedDatestring(date-time)

Date and time when the asset was marked as loaded.

loadingStatusstring

Current loading status of the asset.

Enum"NOT_LOADED""LOADED""WRONGLY_LOADED""UNKNOWN_LOADING""UNLOADED""OFFLOADED"

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.