Skip to content
Download OpenAPI description
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

Request

Retrieves all assets associated with a specific manifest. Assets represent items, equipment, or materials included in the manifest work order.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

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

Responses

Ok

Body*/*Array [
createDatestring(date-time)
updateDatestring(date-time)
trackIdentifierstring

Business identifier of the asset (track) associated with the manifest.

trackobject(ManifestTrackV1Dto)

Track details associated with this manifest asset.

loadingStatusstring

Loading status of the asset in the manifest workflow.

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

Get manifest asset loading details

Request

Retrieves asset loading details for a manifest. Details contain the loading status, track and gate details of the asset per asset.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

Example: MAN-2024-001
curl -i -X GET \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/MAN-2024-001/asset-loading \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

OK

Body*/*Array [
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"
]

Request

Removes a specific custom field from a manifest by its key. The field and its value will be permanently deleted from the manifest.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

Example: MAN-2024-001
fieldKeystringrequired

Key of the custom field to delete

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

Responses

OK

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations