Update a Brand name

Brand

Operations

Get the list of brands of a Company

Request

Get the list of brands of a Company

Security

Bearer

Query

OwnerCompanyIdstring(uuid)required

IncludeInactiveboolean

LanguageCodestring

curl -i -X GET \
  'https://www.developers.traceone.com/api/brands?OwnerCompanyId=497f6eca-6276-4993-bfeb-53cbbbba6f08&IncludeInactive=true&LanguageCode=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/jsonArray [

idstring(uuid)

brandNamestring or null

ownerCompanyIdstring(uuid)

isActiveboolean

externalCodestring or null

modifiedBystring or null

modifiedAtstring or null

createdBystring or null

createdAtstring or null

brandNameVariantsArray of objects or null(List`1)

]

Response

application/json

[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "brandName": "string",
    "ownerCompanyId": "10e96248-c873-4e93-b748-bc36e39510eb",
    "isActive": true,
    "externalCode": "string",
    "modifiedBy": "string",
    "modifiedAt": "string",
    "createdBy": "string",
    "createdAt": "string",
    "brandNameVariants": [ … ]
  }
]

Create a new Brand

Request

Create a new Brand for a Company

Security

Bearer

Body

ownerCompanyIdstring(uuid)required

brandNamestringnon-emptyrequired

brandNameVariantsArray of objects or null(List`1)

externalCodestringnon-emptyrequired

curl -i -X POST \
  https://www.developers.traceone.com/api/brands \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '{
    "ownerCompanyId": "10e96248-c873-4e93-b748-bc36e39510eb",
    "brandName": "string",
    "brandNameVariants": [
      {
        "name": "string",
        "languageCode": "string"
      }
    ],
    "externalCode": "string"
  }'

Responses

Success

Bodyapplication/json

brandIdstring(uuid)

Response

application/json

{
  "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5"
}

Archive a Brand

Request

Archive a Brand for the Current Company

Security

Bearer

Path

idstring(uuid)required

curl -i -X DELETE \
  'https://www.developers.traceone.com/api/brands/{id}/enable' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json

brandIdstring(uuid)

Response

application/json

{
  "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5"
}

Unarchive a Brand

Request

Unarchive a Brand for the Current Company

Security

Bearer

Path

idstring(uuid)required

curl -i -X POST \
  'https://www.developers.traceone.com/api/brands/{id}/enable' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json

brandIdstring(uuid)

Response

application/json

{
  "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5"
}