Skip to content
/
Get manifest by external...

Zimark Integration API (v1)

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/

User

Operations

Manifest

Operations

Get manifest by external ID

Request

Retrieves a single manifest by its unique external identifier. Returns the manifest details without the associated assets/tracks.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external id of the manifest. External id is often an id based on the WMS Zimark is integrated with, e.g. an order id.

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

Responses

Ok

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

External unique identifier for this manifest.

manifestStatusstring

Current status of the manifest.

Enum"PLANNED""TO_DO""IN_PROGRESS""COMPLETED""CANCELLED"
closeDatestring(date-time)

Timestamp when the manifest was closed/completed.

activateDatestring(date-time)

Timestamp when the manifest was activated.

tracksCountinteger(int32)

Total number of assets (tracks) currently included in this manifest.

gateobject(GateV1Dto)

Gate details used by the Zimark Integration API.

customFieldsArray of objects(ManifestCustomFieldV1Dto)

Custom key–value fields attached to the manifest.

validationErrorsobject(ManifestValidationErrorsV1Dto)

Container for validation issues detected when processing a manifest.

proofOfShipmentUrlstring

URL to the proof-of-shipment document.

deletedboolean

Indicates whether the manifest is soft-deleted.

Update manifest

Request

Updates an existing manifest's assets and/or custom fields.This update endpoint uses a declarative updates, meaning Zimark will automatically handle deleting, adding, or updating assets and/or custom fields for you.

For updating other properties like status and gate assignment, use the specific endpoints.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external id of the manifest. AnE eternal id is often an id based on the WMS Zimark is integrated with, e.g. an order id.

Example: MAN-2024-001
Bodyapplication/jsonrequired
assetsArray of strings

Optional list of asset (track) identifiers to set or update for the manifest.

customFieldsArray of objects(ManifestCustomFieldV1Dto)

Optional custom fields to set or update for the manifest.

curl -i -X PUT \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/MAN-2024-001 \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "assets": [
      "string"
    ],
    "customFields": [
      {
        "fieldKey": "string",
        "fieldValue": "string"
      }
    ]
  }'

Responses

OK

Get manifests

Request

Retrieves a paginated list of manifests with optional filtering by status and gate. Supports sorting and pagination through query parameters.

Security
X-AUTH-KEY
Query
manifestStatusesArray of strings
Items Enum"PLANNED""TO_DO""IN_PROGRESS""COMPLETED""CANCELLED"
gateUuidstring
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/manifest?manifestStatuses=PLANNED&gateUuid=string&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(ManifestV1Dto)
pageRequestobject(PageRequest)
totalElementsinteger(int32)

Create manifest

Request

Creates a new manifest with the provided details including external ID, status, gate, custom fields, and optional asset associations.Returns the created manifest's internal and external identifiers.

Security
X-AUTH-KEY
Bodyapplication/jsonrequired
identifierstringrequired

External unique identifier for the manifest to create.

assetsArray of stringsrequired

Initial list of asset (track) identifiers to include in the manifest.

customFieldsArray of objects(ManifestCustomFieldV1Dto)

Optional custom fields to set on the manifest upon creation.

gateExternalIdstring

Optional external identifier of the gate to associate with the manifest.

curl -i -X POST \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "identifier": "string",
    "assets": [
      "string"
    ],
    "customFields": [
      {
        "fieldKey": "string",
        "fieldValue": "string"
      }
    ],
    "gateExternalId": "string"
  }'

Responses

OK

Body*/*
uuidstring

Add track record to manifest

Request

Add a track record with a manifest. A track associates your WMS pallet identifier with the corresponding Zimark marker, linking the WMS pallet ID to Zimark's scannable marker.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

Example: MAN-2024-001
trackIdentifierstringrequired

Unique identifier of the track record to associate with the manifest

Example: TRACK-123456
curl -i -X POST \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/MAN-2024-001/track-record/TRACK-123456 \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

OK

Delete manifest track record

Request

Removes a specific track record association from a manifest. This does not delete the track record itself, only its association with the manifest.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

Example: MAN-2024-001
trackIdentifierstringrequired

Unique identifier of the track record to remove from the manifest

Example: TRACK-123456
curl -i -X DELETE \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/MAN-2024-001/track-record/TRACK-123456 \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

OK

Update manifest status

Request

Updates the status of a manifest.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

Example: MAN-2024-001
manifestStatusstringrequired

New status for the manifest

Enum"PLANNED""TO_DO""IN_PROGRESS""COMPLETED""CANCELLED"
Example: IN_PROGRESS
curl -i -X POST \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/MAN-2024-001/status/IN_PROGRESS \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

OK

Update manifest gate assignment

Request

Associates a manifest with a specific gate location. Gates typically represent physical locations such as loading docks, entry/exit points, or work areas where the manifest operations take place.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

Example: MAN-2024-001
gateExternalIdstringrequired

Unique external identifier of the gate to assign

Example: GATE-A1
curl -i -X POST \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/MAN-2024-001/gate/GATE-A1 \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

OK

Create or update manifest custom field

Request

Adds a new custom field to a manifest or updates an existing one. Custom fields allow storing additional metadata key-value pairs specific to your integration needs.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

Example: MAN-2024-001
Bodyapplication/jsonrequired
fieldKeystring

Unique key (name) of the custom field. This must match the configured field name.

fieldValuestring

Value of the custom field as a string. For numeric fields, send the number as a string.

curl -i -X POST \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/MAN-2024-001/custom-field \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "fieldKey": "string",
    "fieldValue": "string"
  }'

Responses

OK

Get manifest assets

Request

Retrieves all assets associated with a specific manifest. Assets represent items, equipment, or materials included in the manifest work order.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

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

Responses

Ok

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

Business identifier of the asset (track) associated with the manifest.

trackobject(ManifestTrackV1Dto)

Track associated with this loading record.

loadingStatusstring

Loading status of the asset in the manifest workflow.

Enum"NOT_LOADED""LOADED""WRONGLY_LOADED""UNKNOWN_LOADING""UNLOADED""OFFLOADED"
]

Get manifest asset loading details

Request

Retrieves asset loading details for a manifest. Details contain the loading status, track and gate details of the asset per asset.

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

Example: MAN-2024-001
curl -i -X GET \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/MAN-2024-001/asset-loading \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

Responses

OK

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

Track associated with this loading record.

gateobject(GateV1Dto)

Gate details used by the Zimark Integration API.

trackIdentifierstring

Business identifier of the track 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"
]

Delete manifest custom field

Request

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

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired

Unique external identifier of the manifest

Example: MAN-2024-001
fieldKeystringrequired

Key of the custom field to delete

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

Responses

OK

Upsert manifest assetsDeprecated

Request

Security
X-AUTH-KEY
Path
manifestExternalIdstringrequired
Bodyapplication/jsonrequired
assetsArray of stringsrequired

List of asset (track) identifiers to add or update on the manifest.

customFieldsArray of objects(ManifestCustomFieldV1Dto)

Optional custom fields to apply to the manifest during the upsert operation.

curl -i -X POST \
  'https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/{manifestExternalId}/upsert-assets' \
  -H 'Content-Type: application/json' \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "assets": [
      "string"
    ],
    "customFields": [
      {
        "fieldKey": "string",
        "fieldValue": "string"
      }
    ]
  }'

Responses

Ok

Body*/*
uuidstring

Track

Operations

Printing Batch

Operations

Calibration Integration

Operations

Scanner

Operations

Local Manager

Operations

Gate

Operations

Audit Log

Operations

Alert Events

Operations

Agent

Operations
Copyright 2025 Zimark Inc © All rights reserved.