Skip to main content
The Shops API is the foundation of Mutasib. Every product, staff member, and transaction belongs to a shop, so you’ll typically retrieve a shop before working with any other resource. All endpoints require a valid API token in the Authorization header.
Shops are created and administered from the Mutasib dashboard. The API exposes read and update operations on an existing shop.

Get a shop

Fetch the full details of a shop by its ID. GET /api/v1/shops/{shop_id}

Response — ShopOut

integer
Unique shop ID.
string
Display name of the shop.
string
Physical address of the shop.
string
Shop category (e.g. grocery, pharmacy, boutique).
string
Free-text shop description shown to customers.
string
Contact phone number for the shop.
boolean
Whether the shop is currently active.
string
Current subscription plan on the shop.
object
Feature flags and limits derived from the shop’s active plan.
string
ISO 8601 timestamp of when the shop was created.
string
ISO 8601 timestamp of the last update.

Update a shop

Update one or more fields on a shop. Send only the fields you want to change. PATCH /api/v1/shops/{shop_id}
string
New display name.
string
Updated physical address.
string
Updated category.
string
Updated shop description.
string
Updated contact phone number.
Returns the updated ShopOut object on success.