Brand

Version 1.0

The Brand Entity establishes a distinctive identity within our platform, offering a vital framework for merchants to showcase and differentiate their products. As an integral component of our ecosystem, the Brand Entity encapsulates essential information related to the identity, reputation, and characteristics of a brand. It serves as a central repository for key brand details, including the brand name, logo, description, and associated metadata.

# Endpoints
POST
/v1/brands# Create a single brand
GET
/v1/brands/987654321# Retrieve a single brand
PATCH
/v1/brands/987654321# Update a single brand
DELETE
/v1/brands/987654321# Delete a single brand

Brand Entity

  • Name
    id
    Type
    string
    Required
    Description

    Every brand is assigned a unique identifier - an unsigned 64-bit integer known as the Brand ID. This specific number is exclusive and distinct across the whole Qooly platform, ensuring an unparalleled level of uniqueness.

  • Name
    name
    Type
    varchar(255)
    Required
    Description

    This property indicates the name of the brand, representing its distinctive identity in the marketplace.

  • Name
    logo
    Type
    foreignId
    Description

    This serves as a unique, distinct identifier, specific to each logo in Qooly's system. As a distinct numerical value, the 'logo' provides a reliable reference to the individual logo associated with the brand.

  • Name
    created_at
    Type
    timestamp
    Description

    This property indicates the time in ISO_8601 when the brand was created.

  • Name
    updated_at
    Type
    timestamp
    Description

    This property indicates the time in ISO_8601 when the brand was last updated.

  • Name
    created_by
    Type
    foreignId
    Description

    This property indicates the user who created the brand.

  • Name
    updated_by
    Type
    foreignId
    Description

    This property indicates the user who updated the brand recently.

The Brand resource

JSON
{
  "id": "123456789",
  "name": "Sample Brand",
  "logo": "987654321",
  "created_at": "2024-01-07T12:30:00Z",
  "updated_at": "2024-01-07T14:45:00Z",
  "created_by": "789012345",
  "updated_by": "123456789"
}

Create a single brand

This endpoint allows you to create a single brand.

Required Fields

  • Name
    name
    Type
    varchar(255)
    Required
    Description
  • Name
    logo
    Type
    foreignId
    Required
    Description

Examples

Create a single brand

POST
/v1/brands
curl --request POST \
  --url https://api.qooly.io/v1/brands \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Sample Brand",
    "logo": "987654321"
  }'

Create a single brand

POST
/v1/brands
curl --request POST \
  --url https://api.qooly.io/v1/brands \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Sample Brand"
  }'

Create a single brand

POST
/v1/brands
curl --request POST \
  --url https://api.qooly.io/v1/brands \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Sample Brand",
    "logo": "987654321"
  }'
JSON
{
  "id": "123456789",
  "name": "Sample Brand",
  "logo": "987654321"
}

Retrieve a single brand

This endpoint allows you to retrieve a single brand.

Required Parameters

  • Name
    id
    Type
    string
    Required
    Description

Examples

Retrieve a single brand

GET
/v1/brands/987654321
curl --request GET \
  --url https://api.qooly.io/v1/brands/987654321

Retrieve a single brand

GET
/v1/brands/987654321
curl --request GET \
  --url https://api.qooly.io/v1/brands/987654321
JSON
{
  "id": "987654321",
  "name": "Sample Brand",
  "logo": "123456789"
}

Update a single brand

This endpoint allows you to update a single brand.

Required Parameters

  • Name
    id
    Type
    string
    Required
    Description

Examples

Update a single brand

PATCH
/v1/brands/987654321
curl --request PATCH \
  --url https://api.qooly.io/v1/brands/987654321 \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "New Brand Name",
    "logo": "https://example.com/new-logo.png"
  }'

Update a single brand

PATCH
/v1/brands/987654321
curl --request PATCH \
  --url https://api.qooly.io/v1/brands/987654321 \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "New Brand Name"
  }'
JSON
{
  "id": "987654321",
  "status": "ACTIVE",
  "name": "New Brand Name",
  "logo": "https://example.com/new-logo.png",
  "created_at": "2024-01-08T09:45:00Z",
  "created_by": "789012345",
}

Delete a single brand

This endpoint allows you to delete a single brand.

Required Parameters

  • Name
    id
    Type
    string
    Required
    Description

Examples

Delete a single brand

DELETE
/v1/brands/987654321
curl --request DELETE \
  --url https://api.qooly.io/v1/brands/987654321

Delete a single brand

DELETE
/v1/brands/987654321
curl --request DELETE \
  --url https://api.qooly.io/v1/brands/987654321
JSON
{}