Skip to content
/
List shipments (paginated...

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

Soft-delete a shipment

Request

Allowed from any non-terminal state, including IN_PROGRESS and PENDING_COMPLETION. Detaches all manifests and releases the external identifier for reuse.

Security
X-AUTH-KEY
Path
shipmentExternalIdstringrequired

Shipment external identifier or uuid.

curl -i -X DELETE \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/shipment/{shipmentExternalId}' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

No content

List shipments (paginated, filterable)

Request

Returns a paginated list of shipments for the authenticated caller's organization. Supports filtering by status (multi-valued, including the read-only PENDING_COMPLETION state), gate (by UUID or external id), free-text, and three independent date ranges (created, activated, closed). Null-date semantics: when any bound is supplied on activateDate or closeDate, shipments whose corresponding date field is null are excluded.

Security
X-AUTH-KEY
Query
statusesArray of strings

Filter by shipment status (multi-valued). PENDING_COMPLETION is supported for reads, for example statuses=PENDING_COMPLETION.

Items Enum"PLANNED""TO_DO""IN_PROGRESS""PARTIALLY_SHIPPED""PENDING_COMPLETION""COMPLETED""CANCELLED"
Example: statuses=PENDING_COMPLETION
gatestring

Filter by gate identifier (accepts external id or uuid).

activateDateAfterinteger(int64)

Activated-date range lower bound (epoch millis, inclusive). Shipments with null activateDate are excluded when any bound is supplied.

activateDateBeforeinteger(int64)

Activated-date range upper bound (epoch millis, inclusive).

closeDateAfterinteger(int64)

Closed-date range lower bound (epoch millis, inclusive). Shipments with null closeDate are excluded when any bound is supplied.

closeDateBeforeinteger(int64)

Closed-date range upper bound (epoch millis, inclusive).

qstring
createDateAfterinteger(int64)
createDateBeforeinteger(int64)
pageNumberinteger(int32)

Page number (1-based)

pageSizeinteger(int32)<= 100

Page size

sort.sortBystring

Sorting field

sort.directionstring

Sorting direction

Enum"ASC""DESC"
curl -i -X GET \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/shipment?statuses=PENDING_COMPLETION&gate=string&activateDateAfter=0&activateDateBefore=0&closeDateAfter=0&closeDateBefore=0&q=string&createDateAfter=0&createDateBefore=0&pageNumber=0&pageSize=100&sort.sortBy=string&sort.direction=ASC' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

OK

Body*/*
contentArray of objects(ShipmentV1Dto)
pageRequestobject(PageRequest)
totalElementsinteger(int32)

Create shipment

Request

Creates a new shipment in status TO_DO. Optional external identifier, optional gate (by external id or uuid), optional notes, optional manifest list. Returns the full shipment payload.

Security
X-AUTH-KEY
Bodyapplication/jsonrequired
identifierstring[ 0 .. 255 ] charactersrequired

Required. Caller-assigned shipment external identifier, unique per organization within the Shipment namespace. May collide with Manifest external identifiers (independent namespaces).

gateIdentifierstring[ 0 .. 255 ] characters

Gate to attach at create time. Accepts the gate external identifier OR internal UUID.

notesstring[ 0 .. 1000 ] characters

Free-text notes attached to the shipment.

manifestsArray of objects(ManifestReferenceV1Dto)non-emptyrequired

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.

manifests[].​manifestExternalIdstring[ 0 .. 255 ] characters

Caller-assigned manifest external identifier.

manifests[].​manifestUuidstring

Internal manifest identifier (uuid).

customFieldsArray of objects(ShipmentCustomFieldV1Dto)

Optional custom field values to set on the shipment. Each entry must reference a configured field key.

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"
      }
    ]
  }'

Responses

OK

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

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

externalIdentifierstring

Caller-assigned external identifier, unique per organization within the Shipment namespace.

statusstring

Lifecycle status of the shipment. PENDING_COMPLETION is a readable system-managed state, not a manual write target.

Enum"PLANNED""TO_DO""IN_PROGRESS""PARTIALLY_SHIPPED""PENDING_COMPLETION""COMPLETED""CANCELLED"
gateobject(GateV1Dto)

Gate currently assigned to the shipment, if any.

manifestsArray of objects(ShipmentManifestRefV1Dto)

Manifests currently attached to the shipment.

palletsCountinteger(int64)

Planning view: total pallets (assets) currently included across this shipment's manifests, regardless of loading state. For Total/Loaded execution counts use totalAssetsCount and loadedAssetsCount.

totalAssetsCountinteger(int64)

Total assets attached to the shipment, excluding invalid loadings (WRONGLY_LOADED, UNKNOWN_LOADING) and records belonging to cancelled manifests.

loadedAssetsCountinteger(int64)

Successfully loaded assets, excluding invalid loadings and records belonging to cancelled manifests.

notesstring

Optional free-text notes.

activateDatestring(date-time)

Timestamp when the shipment transitioned to IN_PROGRESS, null if not yet activated.

closeDatestring(date-time)

Timestamp when the shipment transitioned to a terminal status (COMPLETED or CANCELLED), null if still active.

autoCompleteAtstring(int64)read-only

Stored server-authoritative auto-completion deadline, serialized as epoch milliseconds. Present only while the shipment is in PENDING_COMPLETION; omitted otherwise.

Example: 1800000060000
deletedboolean

Soft-delete flag. Deleted shipments are excluded from list and get endpoints.

customFieldsArray of objects(ShipmentCustomFieldV1Dto)

Custom field values set on this shipment. Omitted when the organization's dispatch strategy is not SHIPMENT.

departedAssetsCountinteger(int64)

Pallets that have departed on closed loading rounds. Present only when Partial Shipment is enabled for the organization.

currentRoundNumberinteger(int32)

Round number of the currently open loading round; absent when no round is open. Present only when Partial Shipment is enabled for the organization.

roundsCountinteger(int32)

Total loading rounds recorded for the shipment. Present only when Partial Shipment is enabled for the organization.

proofOfShipmentUrlstring

Link to the public evidence page of the shipment's Proof of Shipment. Absent until the shipment is COMPLETED and a Proof of Shipment has been recorded, and when the organization has no configured domain. Not included in the shipment list. The link expires — see the Integration API documentation for its lifetime.

shipmentSummaryUrlstring

Link to the public Shipment Summary page of this shipment. Present only once the shipment is COMPLETED, and absent when the organization has no configured domain. The link expires — see the Integration API documentation for its lifetime.

tracksCountinteger(int64)Deprecated

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.