Firstbase API
  • INTRODUCTION
    • REST API
    • Use Cases
      • User Management
      • Asset Management
      • Catalog and Ordering
  • GETTING STARTED
    • Generating your API Key
    • Authentication
    • Making requests
    • Pagination
    • Rate Limiting
    • Deprecations - WIP
    • Filtering - WIP
  • API Reference
    • Catalog
      • Skus
    • Inventory
      • Tags
      • Assignment
      • Archive
    • Orders
    • Shipments
    • Packages
    • Users
    • Specification
Powered by GitBook
On this page
  1. API Reference
  2. Inventory

Archive

PreviousAssignmentNextOrders

Archive inventory

post
Authorizations
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
POST /api/inventory/{inventoryId}/archive HTTP/1.1
Host: apipub.firstbasehq.com
Authorization: YOUR_API_KEY
Accept: */*

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