API endpoints for managing manifests and their associated assets/pallets.
A manifest is a container that groups assets/pallets for tracking purposes.
- Get manifest asset loading details
Get manifest by external ID
Update manifest
Delete manifest by external ID
Get manifests
Create manifest
Update manifest status
Return a completed manifest
Add pallet record to manifest
Delete manifest pallet record
Update manifest gate assignment
Create or update manifest custom field
Asynchronously bulk-upsert Manifest fields (custom fields)
Update manifest asset loading status by record uuid
Update manifest asset loading status by pallet identifier
Update manifest asset loading status by marker value
Get manifest assets
Delete manifest custom field
Delete manifest asset invalid loading record by record uuid
Delete manifest asset invalid loading record by pallet identifier
Delete manifest asset invalid loading record by marker value
Upsert manifest assets
Add pallet record to manifest
Delete manifest pallet record
Update manifest asset loading status by pallet identifier
Delete manifest asset invalid loading record by pallet identifier
Get manifest asset loadin...
Zimark Integration API (v0)
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
- Mock server
https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/{manifestExternalId}/asset
https://api.zimark-staging.link/integration/rest/api/v1/manifest/{manifestExternalId}/asset
https://api.zimark.link/integration/rest/api/v1/manifest/{manifestExternalId}/asset
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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'- Mock server
https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/{manifestExternalId}/asset-loading
https://api.zimark-staging.link/integration/rest/api/v1/manifest/{manifestExternalId}/asset-loading
https://api.zimark.link/integration/rest/api/v1/manifest/{manifestExternalId}/asset-loading
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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'OK
Current loading status of the asset.
Enum"NOT_LOADED""LOADED""WRONGLY_LOADED""UNKNOWN_LOADING""UNLOADED""OFFLOADED"
Whether this pallet has departed the warehouse on a closed loading round. Present only when Partial Shipment is enabled for the organization.
The loading round during which the pallet was loaded; absent if never loaded or loaded before round tracking. Present only when Partial Shipment is enabled for the organization.
Link to the public evidence page for this loading's evidence. Absent when the loading has no evidence, and when the organization has no configured domain. The link expires — see the Integration API documentation for its lifetime.
- Mock server
https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/{manifestExternalId}/custom-field/{fieldKey}
https://api.zimark-staging.link/integration/rest/api/v1/manifest/{manifestExternalId}/custom-field/{fieldKey}
https://api.zimark.link/integration/rest/api/v1/manifest/{manifestExternalId}/custom-field/{fieldKey}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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'