Skip to content
/
List the shipment's loadi...

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

Validate shipment (returns domain validation errors without mutating state)

Request

Returns cancelled member manifests and per-manifest validation results (duplicated pallets, non-existing pallets, deactivated pallets) without modifying the shipment.

Security
X-AUTH-KEY
Path
shipmentExternalIdstringrequired

Shipment external identifier or uuid.

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

Responses

OK

Body*/*
canceledManifestsArray of objects(ShipmentManifestRefV1Dto)

Manifests that are in CANCELLED status while still attached to the shipment.

manifestValidationsArray of objects(ManifestValidationErrorsV1Dto)

Per-manifest validation results (duplicated pallets, non-existing pallets, deactivated pallets) for each non-cancelled attached manifest.

List the shipment's loading rounds

Request

Returns the shipment's loading rounds ordered by round number — one per truck loading cycle. Available only for organizations with the Partial Shipment setting enabled; otherwise 403 PARTIAL_SHIPMENT_DISABLED.

Security
X-AUTH-KEY
Path
shipmentExternalIdstringrequired

Shipment external identifier or uuid.

Example: SHIP-2024-001
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'

Responses

OK

Body*/*Array [
roundNumberinteger(int32)

1-based sequential round number within the shipment.

statusstring

Round status: IN_PROGRESS (open), PARTIALLY_SHIPPED or COMPLETED (closed).

Enum"IN_PROGRESS""PARTIALLY_SHIPPED""COMPLETED"
checkInTimestring(date-time)

When the round opened (shipment activated on the gate).

checkOutTimestring(date-time)

When the round closed (partial shipment or completion); null while the round is open.

palletsLoadedinteger(int32)

Pallets loaded during this round (derived; live for the open round).

gateobject(GateV1Dto)

Gate the round took place on (short form).

]

Get one loading round by its round number

Request

Returns a single loading round of the shipment, addressed by its 1-based round number. Available only for organizations with the Partial Shipment setting enabled; otherwise 403 PARTIAL_SHIPMENT_DISABLED.

Security
X-AUTH-KEY
Path
shipmentExternalIdstringrequired

Shipment external identifier or uuid.

Example: SHIP-2024-001
roundNumberinteger(int32)required

1-based round number.

Example: 1
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'

Responses

OK

Body*/*
roundNumberinteger(int32)

1-based sequential round number within the shipment.

statusstring

Round status: IN_PROGRESS (open), PARTIALLY_SHIPPED or COMPLETED (closed).

Enum"IN_PROGRESS""PARTIALLY_SHIPPED""COMPLETED"
checkInTimestring(date-time)

When the round opened (shipment activated on the gate).

checkOutTimestring(date-time)

When the round closed (partial shipment or completion); null while the round is open.

palletsLoadedinteger(int32)

Pallets loaded during this round (derived; live for the open round).

gateobject(GateV1Dto)

Gate the round took place on (short form).

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.