| Type: ulid Length: 26
The unique ID assigned to each product brand which is generated
by our system using the ULID format. Each ID is
precisely 26 characters long, ensuring a unique and consistent
identifier for every product brand. This ULID is
automatically created by our system and is used to uniquely identify
and track each product brand in our database.
|
| Type: string Min: 1 Max: 255
This attribute represents the official name of the brand. This is the
name that is displayed to customers and used in all marketing materials.
It is crucial for identifying the brand across the business's platforms
and channels. The brand name is often the first point of contact between
the brand and potential customers, making it a significant component of
the brand's identity and perception in the marketplace. Please notice
that duplicate values are not allowed.
|
| Type: boolean Default: true
This value indicates whether the product brand is active or not. This flag can be used
to control the product brand's availability in runtime environments or listings without
deleting or removing the product brand from records. A true value means the product brand
is active and functioning, while a false value implies that the product brand is
deactivated or not in use.
|
| Type: string|null Max: 50
It's a unique identifier assigned to each product brand. It's
primary role is to distinguish one product brand from another, ensuring
that each product brand can be individually tracked and managed without
any confusion. Please notice that duplicate values are not allowed
and it's allowed to use alpha dash only [A-Za-z0-9-_]. The reference_id
value is used to Identify Resource when you consume any product brand endpoint with sending identify_by
query parameter with value reference_id.
|
| Type: string Min: 1 Max: 255
This attribute is a URL-friendly version of the brand name. It's used in
the web address to help users and search engines find the brand page easily.
For instance, if you have a brand named "Asfour Crystal" the slug might be
"asfour-crystal". It's a simplified version of the name and without spaces.
Slugs are important for website navigation and SEO .
A well-crafted slug makes it easier for customers to remember and type the
URL, and it helps improve the brand's visibility in search engine results.
Please notice that duplicate values are not allowed and it's allowed
to use alpha dash only [A-Za-z0-9-_]. If the slug value is not provided,
the Payiano system automatically generates one based on
the provided name attribute. This auto-generation of the slug ensures
consistency and convenience, eliminating the need for manual slug entry.
|
| Type: string|null Min: 1 Max: 10000
This attribute provides more detailed information about the product brand.
It's like a brief paragraph that explains what the brand is about and what
it includes. This attribute is important because it gives context and depth
to the brand name, offering users a clearer understanding of what's included
and potentially the types of customers the brand is aimed at. A good description
can also help in search optimization, making it easier for customers to find what
they're looking for through search engines.
|
| Type: boolean Default: false
This value indicates whether the product brand is deleted or not. This flag can be used to
control the product brand's availability in runtime without actual deleting or removing the
product brand from records. A true value means the product brand is deleted, while a false
value implies that the product brand is not deleted and functioning.
|
|
This attribute represents the total number of products that directly
fall under a specific product brand. This is a numerical value that provides
immediate insight into the size and scope of each brand.
|
|
The product brand metadata model details. Metadata serves as a tool
for keeping extra, organized details about a resource. For example,
you can use it to store a user's preferences like prefered color,
notes or any other data that aids in personalizing services, improving
customer relations, or optimizing internal workflows. This information
isn't utilized by Payiano – meaning it's not
involved in authorizing or declining transactions and remains invisible
to your users. Its value is entirely private for your internal
use, and we ensure it remains confidential, not shared with any
external parties.
|
| Type: array_of_objects Max: 50
This array consists of objects, each containing a key and a value.
These pairs of key-value are structured in a way that's more suitable
for programmatic access. You can add up to 50 objects.
| | Type: string Min: 1 Max: 50
It's a unique identifier to avoid confusion or data overlap.
The keys serve as identifiers for the corresponding values, making
it easier to retrieve specific pieces of information as needed.
| | Type: string Min: 1 Max: 255
The value is the actual data associated with that key. It could be
a simple string, a number, a URL, or any other data format that
conveys the necessary information.
|
| | Type: array_of_strings Max: 50
The list attribute is particularly useful for scenarios where
the data needs to be presented in a straightforward, unstructured
format. It's ideal for quick overviews, simple data logging, or
when the information does not require the more complex organization
that nested JSON objects provide. Please
notice that duplicate values are not allowed, you can add up
to 50 item and the max list item length is 255
characters.
|
|
| Type: datetime The created datetime of the product brand.
This attribute can be formatted as an ISO 8601
string or a UNIX timestamp in milliseconds,
depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or
1722572118554). By default, the format is UNIX
timestamp in milliseconds.
|
| Type: datetime The updated datetime of the product brand.
This attribute can be formatted as an ISO 8601
string or a UNIX timestamp in milliseconds,
depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or
1722572118554). By default, the format is UNIX
timestamp in milliseconds.
|
| Type: datetime|null The deleted datetime of the product brand.
This attribute can be formatted as an ISO 8601
string or a UNIX timestamp in milliseconds,
depending on the preferred datetime format specified in the request header (e.g., 2024-08-04T14:22:01Z or
1722572118554). By default, the format is UNIX
timestamp in milliseconds.
|