# 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)