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

Tags

PreviousInventoryNextAssignment
  • POSTAdd tags to inventory
  • DELETERemove tag from inventory

Remove tag from inventory

delete
Authorizations
Path parameters
inventoryIdstring · uuidRequired

The Inventory ID to remove the tag from

Example: 123e4567-e89b-12d3-a456-426614174000
tagIdstring · uuidRequired

The Tag ID to remove

Example: 123e4567-e89b-12d3-a456-426614174000
Responses
200
Tag successfully removed from inventory
application/json
400
Bad request
application/json
403
Forbidden
*/*
404
Inventory or Tag not found
application/json
delete
DELETE /api/inventory/{inventoryId}/tags/{tagId} HTTP/1.1
Host: apipub.firstbasehq.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "id": "8e0caa73-cc71-4aa4-88eb-fca494de8e20",
  "label": "Engineering"
}

Add tags to inventory

post
Authorizations
Path parameters
inventoryIdstring · uuidRequired

The Inventory ID to add the tags to

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

Request body

labelsstring[]Required

Set of labels to be added as tags

Example: ["Tag 1","Tag 2"]
Responses
200
Tags added successfully
application/json
400
Bad request
application/json
403
Forbidden
*/*
404
Inventory not found
application/json
409
Tag already exists for the inventory
application/json
post
POST /api/inventory/{inventoryId}/tags HTTP/1.1
Host: apipub.firstbasehq.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "labels": [
    "Tag 1",
    "Tag 2"
  ]
}
[
  {
    "id": "8e0caa73-cc71-4aa4-88eb-fca494de8e20",
    "label": "Engineering"
  }
]