Skip to content
/
Get shipment asset loadin...

Zimark Integration API (v0)

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/

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

Manifest

API endpoints for managing manifests and their associated assets/pallets.

A manifest is a container that groups assets/pallets for tracking purposes.

Operations

Shipment

API endpoints for managing shipments (multi-manifest dispatch grouping). A shipment groups one or more manifests for dispatch at a single gate; only available to organizations configured with the shipment dispatch strategy.

Operations

List assets (pallets) across all manifests in the shipment

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
Path
shipmentExternalIdstringrequired

Shipment external identifier or uuid.

Example: SHIP-2024-001
Query
shippedboolean

Filter by departure state. Requires the Partial Shipment setting; otherwise 403 PARTIAL_SHIPMENT_DISABLED.

roundNumberinteger(int32)

Filter by the loading round that carried the pallet. Requires the Partial Shipment setting; otherwise 403 PARTIAL_SHIPMENT_DISABLED.

loadingStatusArray of strings

Filter by loading status (multi-valued).

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

Filter by owning manifest (external id or uuid). Records detached from any manifest match only when this filter is unset.

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'

Responses

OK

Body*/*Array [
palletIdentifierstring

Pallet identifier (WMS id).

palletobject(PalletV1Dto)

Pallet details.

loadingStatusstring

Current loading status of the asset at the gate.

Enum"NOT_LOADED""LOADED""WRONGLY_LOADED""UNKNOWN_LOADING""UNLOADED""OFFLOADED"
manifestobject(ShipmentManifestRefV1Dto)

The manifest this pallet belongs to within the shipment.

shippedboolean

Whether this pallet has departed the warehouse on a closed loading round. Present only when Partial Shipment is enabled for the organization.

roundNumberinteger(int32)

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.

trackIdentifierstringDeprecated
trackobject(PalletV1Dto)Deprecated

Pallet resource exposed via the integration API.

]

Get shipment asset loading details

Request

Retrieves asset-loading records for every pallet dispatched under the shipment, including manifest-linked rows (LOADED, NOT_LOADED, UNLOADED, OFFLOADED) and dispatched/unauthorized rows (WRONGLY_LOADED, UNKNOWN_LOADING). Each record carries the recordUuid required by the shipment DELETE asset-loading endpoints. Supports filtering by loadingStatus and manifest, and — when Partial Shipment is enabled — by shipped and roundNumber.

Security
X-AUTH-KEY
Path
shipmentExternalIdstringrequired

Shipment external identifier (preferred) or uuid.

Example: SHIP-2024-001
Query
shippedboolean

Filter by departure state. Requires the Partial Shipment setting; otherwise 403 PARTIAL_SHIPMENT_DISABLED.

roundNumberinteger(int32)

Filter by the loading round that carried the pallet. Requires the Partial Shipment setting; otherwise 403 PARTIAL_SHIPMENT_DISABLED.

loadingStatusArray of strings

Filter by loading status (multi-valued).

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

Filter by owning manifest (external id or uuid). Records detached from any manifest match only when this filter is unset.

curl -i -X GET \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/shipment/SHIP-2024-001/asset-loading?shipped=true&roundNumber=0&loadingStatus=NOT_LOADED&manifest=string' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

OK

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

Deep link URL to open this entity in Ops.App.

palletobject(ManifestPalletV1Dto)

Pallet associated with this loading record.

gateobject(GateV1Dto)

Gate where the loading action was performed.

palletIdentifierstring

Business identifier of the pallet 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"
shippedboolean

Whether this pallet has departed the warehouse on a closed loading round. Present only when Partial Shipment is enabled for the organization.

roundNumberinteger(int32)

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.

evidenceUrlstring

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.

trackIdentifierstringDeprecated
trackobject(ManifestPalletV1Dto)Deprecated
]

Delete shipment custom field

Request

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

Security
X-AUTH-KEY
Path
shipmentExternalIdstringrequired

Shipment external identifier or uuid.

Example: SHIP-2024-001
fieldKeystringrequired

Key of the custom field to delete.

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

Responses

No content

Pallet

The /track/… paths are deprecated aliases of the /pallet/… endpoints, kept for backward compatibility. They will be removed in a future release; use /pallet/… for new integrations.

Operations

Gate

Operations

Client

Operations

Bulk Upsert Management

Operations

Audit Log

Operations

Alert Events

Operations

Printing Batch

Operations
Copyright 2026 Zimark Inc © All rights reserved.