API reference
API overview
REST over HTTPS with JSON bodies. Every store endpoint lives under one base path and takes an OAuth 2.0 access token.
GEThttps://larm.sa/stores/{storeId}/v1/…
Start with OAuth 2.0 to get an access token, read Requests & responses for the envelope, pagination and concurrency rules, then call any endpoint below. The machine-readable contract is /openapi.json (OpenAPI 3.1).
Store
OAuth
Orders
Abandoned carts
Payments
Products
- GET
/productsList products - GET
/products/{id}Get a product - POST
/productsCreate a product - PATCH
/products/{id}/contentUpdate product content - GET
/products/{id}/pricesGet a product price - PATCH
/products/{id}/pricesUpdate a product price - GET
/products/{id}/mediaGet product media - PATCH
/products/{id}/mediaUpdate product media - GET
/products/{id}/seoGet product SEO - PATCH
/products/{id}/seoUpdate product SEO
Categories
Inventory
Pages
Coupons
Reviews
Analytics
Webhook subscriptions
- GET
/webhook-subscriptionsList webhook subscriptions - POST
/webhook-subscriptionsCreate a subscription - PATCH
/webhook-subscriptions/{id}Update a subscription - DELETE
/webhook-subscriptions/{id}Delete a subscription - POST
/webhook-subscriptions/{id}/rotate-secretRotate the signing secret - POST
/webhook-subscriptions/{id}/testSend a test webhook - POST
/webhook-subscriptions/{id}/replayReplay a time range