# Zimark Integration API Version: v1 ## Servers ``` https://api.zimark-staging.link ``` Variables: ``` https://api.zimark.link ``` Variables: ## Security ### X-AUTH-KEY Type: apiKey In: header Name: X-AUTH-KEY ## Download OpenAPI description [Zimark Integration API](https://zimark-integration-api.redocly.app/_spec/api.yaml) ## User ### Update user - [PUT /integration/rest/api/v1/user/{uuid}](https://zimark-integration-api.redocly.app/api/user/updateuser.md) ### Delete user - [DELETE /integration/rest/api/v1/user/{uuid}](https://zimark-integration-api.redocly.app/api/user/deleteuser.md) ### Get users - [GET /integration/rest/api/v1/user](https://zimark-integration-api.redocly.app/api/user/getusers.md) ### Create user - [POST /integration/rest/api/v1/user](https://zimark-integration-api.redocly.app/api/user/createuser.md) ### Get authorities - [GET /integration/rest/api/v1/authority](https://zimark-integration-api.redocly.app/api/user/getauthorities.md) ### Reset user password - [DELETE /integration/rest/api/v1/user/{uuid}/reset-password](https://zimark-integration-api.redocly.app/api/user/resetpassword.md) ## Manifest ### Get manifest by external ID - [GET /integration/rest/api/v1/manifest/{manifestExternalId}](https://zimark-integration-api.redocly.app/api/manifest/getmanifestbyexternalid.md): Retrieves a single manifest by its unique external identifier. Returns the manifest details without the associated assets/tracks. ### Update manifest - [PUT /integration/rest/api/v1/manifest/{manifestExternalId}](https://zimark-integration-api.redocly.app/api/manifest/updatemanifest.md): 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. ### Get manifests - [GET /integration/rest/api/v1/manifest](https://zimark-integration-api.redocly.app/api/manifest/getmanifests.md): Retrieves a paginated list of manifests with optional filtering by status and gate. Supports sorting and pagination through query parameters. ### Create manifest - [POST /integration/rest/api/v1/manifest](https://zimark-integration-api.redocly.app/api/manifest/createmanifest.md): 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. ### Add track record to manifest - [POST /integration/rest/api/v1/manifest/{manifestExternalId}/track-record/{trackIdentifier}](https://zimark-integration-api.redocly.app/api/manifest/addtrackrecordtomanifest.md): 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. ### Delete manifest track record - [DELETE /integration/rest/api/v1/manifest/{manifestExternalId}/track-record/{trackIdentifier}](https://zimark-integration-api.redocly.app/api/manifest/deletemanifesttrackrecord.md): Removes a specific track record association from a manifest. This does not delete the track record itself, only its association with the manifest. ### Update manifest status - [POST /integration/rest/api/v1/manifest/{manifestExternalId}/status/{manifestStatus}](https://zimark-integration-api.redocly.app/api/manifest/updatemanifeststatus.md): Updates the status of a manifest. ### Update manifest gate assignment - [POST /integration/rest/api/v1/manifest/{manifestExternalId}/gate/{gateExternalId}](https://zimark-integration-api.redocly.app/api/manifest/createmanifestgate.md): 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. ### Create or update manifest custom field - [POST /integration/rest/api/v1/manifest/{manifestExternalId}/custom-field](https://zimark-integration-api.redocly.app/api/manifest/updatemanifestcustomfields.md): 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. ### Get manifest assets - [GET /integration/rest/api/v1/manifest/{manifestExternalId}/asset](https://zimark-integration-api.redocly.app/api/manifest/getmanifestassets.md): Retrieves all assets associated with a specific manifest. Assets represent items, equipment, or materials included in the manifest work order. ### Get manifest asset loading details - [GET /integration/rest/api/v1/manifest/{manifestExternalId}/asset-loading](https://zimark-integration-api.redocly.app/api/manifest/getmanifestassetloading.md): Retrieves asset loading details for a manifest. Details contain the loading status, track and gate details of the asset per asset. ### Delete manifest custom field - [DELETE /integration/rest/api/v1/manifest/{manifestExternalId}/custom-field/{fieldKey}](https://zimark-integration-api.redocly.app/api/manifest/deletemanifestcustomfield.md): Removes a specific custom field from a manifest by its key. The field and its value will be permanently deleted from the manifest. ### Upsert manifest assets (deprecated) - [POST /integration/rest/api/v1/manifest/{manifestExternalId}/upsert-assets](https://zimark-integration-api.redocly.app/api/manifest/upsertmanifestassets.md) ## Track ### Get track comments - [GET /integration/rest/api/v1/track/{trackId}/comments](https://zimark-integration-api.redocly.app/api/track/getcomments.md) ### Add track comment - [POST /integration/rest/api/v1/track/{trackId}/comments](https://zimark-integration-api.redocly.app/api/track/addtrackcomments.md) ### Reactivate track - [PATCH /integration/rest/api/v1/track/{trackId}/revert-retirement](https://zimark-integration-api.redocly.app/api/track/reverttrackretirement.md) ### Retire track - [PATCH /integration/rest/api/v1/track/{trackId}/retire](https://zimark-integration-api.redocly.app/api/track/retiretrack.md) ### Get track - [GET /integration/rest/api/v1/track](https://zimark-integration-api.redocly.app/api/track/gettracks.md) ### Get track activity timeline - [GET /integration/rest/api/v1/track/{trackId}/activity](https://zimark-integration-api.redocly.app/api/track/gettimeline.md) ### Delete track - [DELETE /integration/rest/api/v1/track/{trackId}](https://zimark-integration-api.redocly.app/api/track/deletetrack.md) ## Printing Batch ### Get batches - [GET /integration/rest/api/v1/scanner/{scannerUuid}/printing-batch](https://zimark-integration-api.redocly.app/api/printing-batch/getbatches.md) ### Create printing batch - [POST /integration/rest/api/v1/scanner/{scannerUuid}/printing-batch](https://zimark-integration-api.redocly.app/api/printing-batch/createbatch.md) ### Get printing batch - [GET /integration/rest/api/v1/scanner/{scannerUuid}/printing-batch/{batchUuid}](https://zimark-integration-api.redocly.app/api/printing-batch/getbatchbyuuid.md) ### Delete printing batch - [DELETE /integration/rest/api/v1/scanner/{scannerUuid}/printing-batch/{batchUuid}](https://zimark-integration-api.redocly.app/api/printing-batch/deletebatch.md) ### Complete printing batch - [GET /integration/rest/api/v1/scanner/{scannerUuid}/printing-batch/{batchUuid}/status/{status}](https://zimark-integration-api.redocly.app/api/printing-batch/updatebatchstatus.md) ## Calibration Integration ### Download calibration file (external) - [GET /integration/rest/api/v1/camera/{hardwareId}/calibration/{type}](https://zimark-integration-api.redocly.app/api/calibration-integration/downloadcalibration.md): Retrieve calibration file content. Requires X-Auth-Token header with CAMERA_READ scope. ### Upload calibration file (external) - [POST /integration/rest/api/v1/camera/{hardwareId}/calibration/{type}](https://zimark-integration-api.redocly.app/api/calibration-integration/uploadcalibration.md): Upload or overwrite a calibration file. Requires X-Auth-Token header with CAMERA_WRITE scope. Returns 201 for new uploads, 200 for overwrites. ### Delete calibration file (external) - [DELETE /integration/rest/api/v1/camera/{hardwareId}/calibration/{type}](https://zimark-integration-api.redocly.app/api/calibration-integration/deletecalibration.md): Delete calibration file. Requires X-Auth-Token header with CAMERA_WRITE scope. ## Scanner ### Get scanners - [GET /integration/rest/api/v1/scanner](https://zimark-integration-api.redocly.app/api/scanner/getscanners.md) ## Local Manager ### Get local managers - [GET /integration/rest/api/v1/local-manager](https://zimark-integration-api.redocly.app/api/local-manager/getlocalmanagers.md) ## Gate ### Get gates - [GET /integration/rest/api/v1/gate](https://zimark-integration-api.redocly.app/api/gate/getgates.md) ## Audit Log ### Get audit log records - [GET /integration/rest/api/v1/audit-log](https://zimark-integration-api.redocly.app/api/audit-log/getauditlogrecords.md) ## Alert Events ### Get alert event records - [GET /integration/rest/api/v1/alert-event](https://zimark-integration-api.redocly.app/api/alert-events/getalertevents.md) ## Agent ### Get agents - [GET /integration/rest/api/v1/agent](https://zimark-integration-api.redocly.app/api/agent/getagents.md)