Catalog API endpoints

Fetch catalog upload request status

Use this endpoint to fetch the status of a catalog upload request by its ID.

get/catalogs/status/{request_id}

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/catalogs/status/:request_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

request_idstring required

The request ID string for the catalog uploaded. This is given as response for a create/update catalog request.

Headers

Authorizationstring required

User-Agentstring required

Brand-Idstring

Branch-Idstring required

Response

Catalog status retrieved successfully

catalog_idstring

The unique string identifier for catalog which restaurant provided while creating/updating catalog.

status'COMPLETED' | 'FAILED' | 'PENDING'

The status of catalog upload processing.

reasonstring

This field will be empty if status is COMPLETED or PENDING. If status is FAILED, then this field will have the log/reason why catalog creation has failed.

Example response

{
  "status": "COMPLETED"
}

Changes

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