Brands APIs

Modified on Wed, 1 Oct at 8:41 PM

Get List of Brands (Client Store)

Endpoint URL
GET https://api.tryoto.com/rest/v2/getBrandList

Available Packages: Starter Package, Scale Package, Enterprise Package, Marketplaces

This API endpoint provides access to a comprehensive list of brand (client store) details. This endpoint enables users to retrieve information about brands associated with their account, including key attributes such as brand name, store identifiers, and other relevant metadata.

Request Parameters: No request body parameters are required for this GET request.

Response: Upon a successful execution, the server responds with a 200 status code and a JSON object containing the following fields:

`success` (boolean) Indicates the success status of the request.

`clientStores` (array) An array of client store objects, each containing the following fields:

`companyId` (integer) The ID of the company.

`storeName` (string) The name of the store.

`ID` (integer) The ID of the store.

`wareHouseName` (string) The name of the warehouse.

`brandLogo` (string) The URL of the brand logo.

`defaultWarehouseId` (integer) The ID of the default warehouse.

In case of an empty response, the server still returns a 200 status code with an empty `clientStores` array.


Create Brand (Client Store)

Endpoint URL
POST https://api.tryoto.com/rest/v2/createBrand
Example Request Body

Here is an example of a request body:

{
  "storeName": "Brand A",
  "logo": "https://storage.googleapis.com/download/storage/v1/b/oto-files-stage/o/files%2F24772%2Fimport%2Fb58b6d41-af83-492c-a416-d4bb0d076be1.png?generation=1721804238908930&alt=media",
  "defaultWarehouseID": 16415,
  "stores": [
    {
      "storeName": "store A",
      "salesChannelCredentialsID": 4512
    }
  ]
}
Request Parameters
NameRequiredTypeDescription
storeNameyesstringThe name of the store
logonostringThe logo URL of the brand
defaultWarehouseIDnointegerThe ID of the default warehouse
storesnoarrayAn array of store objects containing the following fields
storeNamenostringThe name of the store
salesChannelCredentialsIDnointegerThe ID of the sales channel credentials

Available Packages: Starter Package, Scale Package, Enterprise Package, Marketplaces

This API endpoint allows you to add a new brand (client store) to the system. By using this endpoint, you can define and register a brand with essential details, enabling integration with various systems.

Request Parameters: |

``` json

{

"success": true,

"clientStoreId": 1193

}

```


Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article