Skip to main content
POST
/
v3
/
brands
Add Brand
curl --request POST \
  --url https://api.{tenant}.getomneo.com/api/v3/brands \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "handle": "<string>",
  "external_id": "<string>",
  "external_code": "<string>",
  "is_system": true,
  "description": "<string>",
  "short_description": "<string>",
  "url": "<string>",
  "image_url": "<string>",
  "internal_note": "<string>",
  "meta": [
    "<string>"
  ]
}
'
{
  "data": {
    "id": 123,
    "name": "<string>",
    "handle": "<string>",
    "external_id": "<string>",
    "external_code": "<string>",
    "is_system": true,
    "description": "<string>",
    "short_description": "<string>",
    "url": "<string>",
    "image_url": "<string>",
    "internal_note": "<string>",
    "meta": [
      "<unknown>"
    ],
    "departments": [
      {
        "id": 123,
        "name": "<string>",
        "handle": "<string>",
        "external_id": "<string>",
        "external_code": "<string>",
        "description": "<string>",
        "short_description": "<string>",
        "url": "<string>",
        "image_url": "<string>",
        "internal_note": "<string>",
        "meta": [
          "<unknown>"
        ],
        "brand_id": 123,
        "location_id": 123,
        "brand": {
          "name": "<string>",
          "handle": "<string>"
        },
        "created_at": "<string>",
        "updated_at": "<string>"
      }
    ],
    "created_at": "<string>",
    "updated_at": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.omneo.io/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json
​
name
string
required
​
handle
string
required
​
external_id
string | null
​
external_code
string | null
​
is_system
boolean | null
​
description
string | null
​
short_description
string | null
​
url
string | null
​
image_url
string | null
​
internal_note
string | null
​
meta
string[] | null

Response

Brand

​
data
Brand · object
required