Skip to content
/
Get manifests

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/

Calibration Integration

External API for integration systems with token-based authentication

Operations

Manifest

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

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

Operations

Delete manifest by external ID

Request

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 DELETE \
  https://docs.zimark.link/_mock/api/integration/rest/api/v1/manifest/MAN-2024-001 \
  -H 'X-AUTH-KEY: YOUR_API_KEY_HERE'

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
identifierstringnon-emptyrequired

External unique identifier for the manifest to create.

assetsArray of stringsnon-emptyrequired

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

User

Operations

Track

Operations

Printing Batch

Operations

Local Manager

Operations

Scanner

Operations

Gate

Operations

Audit Log

Operations

Alert Events

Operations

Agent

Operations
Copyright 2025 Zimark Inc © All rights reserved.