API endpoints for managing manifests and their associated assets/tracks.
A manifest is a container that groups assets/pallets for tracking purposes.
- Update shipment status (activate / complete / cancel)
Get shipment by external id or uuid
Update a shipment
Soft-delete a shipment
List shipments (paginated, filterable)
Create shipment
Attach one or more manifests to the shipment (all-or-nothing batch)
Detach one or more manifests from the shipment (all-or-nothing batch)
Assign (or change) the shipment's gate
Upsert a single custom field value on an existing shipment
Asynchronously bulk-upsert Shipment fields (custom fields)
Update shipment asset loading status by record uuid
Update shipment asset loading status by track identifier
Update shipment asset loading status by marker value
Validate shipment (returns domain validation errors without mutating state)
List assets (tracks) across all manifests in the shipment
Get shipment asset loading details
Delete shipment custom field
Delete shipment asset invalid-loading record by record uuid
Delete shipment asset invalid-loading record by track identifier
Delete shipment asset invalid-loading record by marker value
Update shipment status (a...
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
Bodyapplication/jsonrequired
Required. Caller-assigned shipment external identifier, unique per organization within the Shipment namespace. May collide with Manifest external identifiers (independent namespaces).
Gate to attach at create time. Accepts the gate external identifier OR internal UUID.
Required. List of manifest references to attach at create. Must be non-empty. Each manifest must be in PLANNED status and not already attached to another shipment.
- Mock server
https://docs.zimark.link/_mock/api/integration/rest/api/v1/shipment
https://your-org.zimark-staging.link/integration/rest/api/v1/shipment
https://your-org.zimark.link/integration/rest/api/v1/shipment
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.zimark.link/_mock/api/integration/rest/api/v1/shipment \
-H 'Content-Type: application/json' \
-H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
-d '{
"identifier": "string",
"gateIdentifier": "string",
"notes": "string",
"manifests": [
{
"manifestExternalId": "string",
"manifestUuid": "string"
}
],
"customFields": [
{
"deepLink": "string",
"fieldKey": "string",
"fieldValue": "string"
}
]
}'OK
Caller-assigned external identifier, unique per organization within the Shipment namespace.
Lifecycle status of the shipment.
Enum"PLANNED""TO_DO""IN_PROGRESS""COMPLETED""CANCELLED"
Planning view: total tracks (assets) currently included across this shipment's manifests, regardless of loading state. For Total/Loaded execution counts use totalAssetsCount and loadedAssetsCount.
Total assets attached to the shipment, excluding invalid loadings (WRONGLY_LOADED, UNKNOWN_LOADING) and records belonging to cancelled manifests.
Successfully loaded assets, excluding invalid loadings and records belonging to cancelled manifests.
Timestamp when the shipment transitioned to IN_PROGRESS, null if not yet activated.
Timestamp when the shipment transitioned to a terminal status (COMPLETED or CANCELLED), null if still active.
Request
Unified status-update endpoint mirroring ManifestIntegrationController#updateManifestStatus. Accepts IN_PROGRESS (activate; requires gate assigned first), COMPLETED (from IN_PROGRESS), or CANCELLED (from TO_DO or IN_PROGRESS). Unknown status values return 400. Invalid transitions return 400.
Security
X-AUTH-KEY
- Mock server
https://docs.zimark.link/_mock/api/integration/rest/api/v1/shipment/{shipmentExternalId}/status/{shipmentStatus}
https://your-org.zimark-staging.link/integration/rest/api/v1/shipment/{shipmentExternalId}/status/{shipmentStatus}
https://your-org.zimark.link/integration/rest/api/v1/shipment/{shipmentExternalId}/status/{shipmentStatus}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.zimark.link/_mock/api/integration/rest/api/v1/shipment/SHIP-2024-001/status/{shipmentStatus}' \
-H 'X-AUTH-KEY: YOUR_API_KEY_HERE'Bodyapplication/jsonrequired
List of manifest references to attach. Exactly one of manifestExternalId / manifestUuid must be set per reference. The entire batch is rolled back on any single validation failure.
- Mock server
https://docs.zimark.link/_mock/api/integration/rest/api/v1/shipment/{shipmentExternalId}/manifest
https://your-org.zimark-staging.link/integration/rest/api/v1/shipment/{shipmentExternalId}/manifest
https://your-org.zimark.link/integration/rest/api/v1/shipment/{shipmentExternalId}/manifest
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.zimark.link/_mock/api/integration/rest/api/v1/shipment/SHIP-2024-001/manifest \
-H 'Content-Type: application/json' \
-H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
-d '{
"manifests": [
{
"manifestExternalId": "string",
"manifestUuid": "string"
}
]
}'OK
Caller-assigned external identifier, unique per organization within the Shipment namespace.
Lifecycle status of the shipment.
Enum"PLANNED""TO_DO""IN_PROGRESS""COMPLETED""CANCELLED"
Planning view: total tracks (assets) currently included across this shipment's manifests, regardless of loading state. For Total/Loaded execution counts use totalAssetsCount and loadedAssetsCount.
Total assets attached to the shipment, excluding invalid loadings (WRONGLY_LOADED, UNKNOWN_LOADING) and records belonging to cancelled manifests.
Successfully loaded assets, excluding invalid loadings and records belonging to cancelled manifests.
Timestamp when the shipment transitioned to IN_PROGRESS, null if not yet activated.
Timestamp when the shipment transitioned to a terminal status (COMPLETED or CANCELLED), null if still active.