Store API endpoints

Create a brand

Use this endpoint to create a brand.

post/brands

Request

Base URL
https://apigateway.careemdash.com/pos/api/v1
Auth
OAuth 2
Client credentials
Token URLhttps://identity.careem.com/token
Scopespos
TypeScript
https://skmtc.dev/careemnow/apis/careem-pos-api/docs/brands/post.ts
A function with typed inputs. Its response is checked against the schema.

Authorizationstring required

User-Agentstring required

idstring required

A unique brand ID string provided by vendor or restaurant.

namestring required

The body required to create a brand

{
  "id": "KFC",
  "name": "KFC"
}

Brand created successfully

idstring required

A unique brand ID string provided by vendor or restaurant. brand.

namestring required

The name of the brand.

state'UNMAPPED' | 'MAPPED' required

The state of this brand.

created_atstring required

Time RFC3339 format in UTC in which the brand has been updated

updated_atstring required

Time RFC3339 format in UTC in which the brand has been updated

{
  "id": "123004",
  "name": "KFC",
  "state": "MAPPED",
  "created_at": "2020-06-22T15:01:32.895Z",
  "updated_at": "2020-06-22T15:01:32.895Z"
}

No recorded changes to this operation across all 3 revisions of this API.