Archive

Archive inventory

post

Authorizations

ApiKey

AuthorizationstringRequired

Prefix the value with "ApiKey" to indicate the custom authorization type

Path parameters

inventoryIdstring · uuidRequired

The Inventory ID to add the tags to

Example: 123e4567-e89b-12d3-a456-426614174000

Query parameters

reasonstring · enumRequired

The reason the inventory is being archived

Example: GIFTEDPossible values:

Responses

200

Inventory archived successfully

application/json

400

Bad request

application/json

403

Forbidden

*/*

404

Inventory not found

application/json

post

/api/inventory/{inventoryId}/archive

HTTPcURLJavaScriptPython

POST /api/inventory/{inventoryId}/archive?reason=GIFTED HTTP/1.1
Host: apipub.firstbasehq.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "deployStatus": "ARCHIVED",
  "deployReason": "LOST_BY_WORKER"
}