Catalog API endpoints
Reset/delete catalog
Use this endpoint to reset/delete catalog for a branch.
This endpoint is ONLY meant to be used in case of data inconsistencies. Here is how you can carry this out in three steps:
- Use this Delete API to reset/delete the catalog (calling this API will not immediately delete the catalog. Instead, the old catalog will ONLY be deleted when a new catalog request is sent with diff=false).
- Push the entire catalog with diff=false.
- If a catalog push request is in progress, then delete API would result in a 403 error code.
delete/catalogs
Request
- Base URLhttps://apigateway.careemdash.com/pos/api/v1
- AuthOAuth 2Client credentialsToken URLhttps://identity.careem.com/tokenScopespos
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Headers
Authorizationstring required
User-Agentstring required
Brand-Idstring
Branch-Idstring required
Response
Catalog deleted successfully
Changes
No recorded changes to this operation across all 3 revisions of this API.