API endpoints for managing manifests and their associated assets/pallets.
A manifest is a container that groups assets/pallets for tracking purposes.
- Get one loading round by its round number
Get shipment by external id or uuid
Update a shipment
Soft-delete a shipment
List shipments (paginated, filterable)
Create shipment
Update shipment status (activate / reopen / reset / complete / cancel / partially ship)
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 pallet identifier
Update shipment asset loading status by marker value
Validate shipment (returns domain validation errors without mutating state)
List the shipment's loading rounds
List assets (pallets) 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 pallet identifier
Delete shipment asset invalid-loading record by marker value
Update shipment asset loading status by pallet identifier
Delete shipment asset invalid-loading record by pallet identifier
Get one loading round by...
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/shipment/{shipmentExternalId}/loading-round
https://api.zimark-staging.link/integration/rest/api/v1/shipment/{shipmentExternalId}/loading-round
https://api.zimark.link/integration/rest/api/v1/shipment/{shipmentExternalId}/loading-round
- 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/shipment/SHIP-2024-001/loading-round \
-H 'X-AUTH-KEY: YOUR_API_KEY_HERE'- Mock server
https://docs.zimark.link/_mock/api/integration/rest/api/v1/shipment/{shipmentExternalId}/loading-round/{roundNumber}
https://api.zimark-staging.link/integration/rest/api/v1/shipment/{shipmentExternalId}/loading-round/{roundNumber}
https://api.zimark.link/integration/rest/api/v1/shipment/{shipmentExternalId}/loading-round/{roundNumber}
- 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/shipment/SHIP-2024-001/loading-round/1 \
-H 'X-AUTH-KEY: YOUR_API_KEY_HERE'Request
Returns a flattened list of pallet records spanning every non-cancelled manifest attached to the shipment. Each entry includes the pallet, its loading status, and the owning manifest reference. Supports filtering by loadingStatus and manifest, and — when Partial Shipment is enabled — by shipped and roundNumber.
Security
X-AUTH-KEY
Query
Filter by departure state. Requires the Partial Shipment setting; otherwise 403 PARTIAL_SHIPMENT_DISABLED.
Filter by the loading round that carried the pallet. Requires the Partial Shipment setting; otherwise 403 PARTIAL_SHIPMENT_DISABLED.
Filter by loading status (multi-valued).
Items Enum"NOT_LOADED""LOADED""WRONGLY_LOADED""UNKNOWN_LOADING""UNLOADED""OFFLOADED"
- Mock server
https://docs.zimark.link/_mock/api/integration/rest/api/v1/shipment/{shipmentExternalId}/asset
https://api.zimark-staging.link/integration/rest/api/v1/shipment/{shipmentExternalId}/asset
https://api.zimark.link/integration/rest/api/v1/shipment/{shipmentExternalId}/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/shipment/SHIP-2024-001/asset?shipped=true&roundNumber=0&loadingStatus=NOT_LOADED&manifest=string' \
-H 'X-AUTH-KEY: YOUR_API_KEY_HERE'OK
Current loading status of the asset at the gate.
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.