storefront

Search the public Mystoq store directory (Algerian online shops). Filter by keyword (store name), wilaya, or plan. Returns store name, wilaya, storefront URL and plan tier. Public business listings only — no merchant personal data.

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "description": "Keyword in the store name."
    },
    "wilaya": {
      "type": "string",
      "description": "Wilaya filter: code (1-69) or name (e.g. \"16\", \"Alger\", \"الجزائر\")."
    },
    "limit": {
      "type": "integer",
      "description": "Max results (1-25, default 12)."
    },
    "offset": {
      "type": "integer",
      "description": "Pagination offset (default 0)."
    }
  }
}

Get a public Mystoq store by its slug: name, wilaya, storefront URL, plan tier and member-since. Public info only.

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "description": "Store slug, e.g. \"islem-uk\"."
    }
  },
  "required": [
    "slug"
  ]
}

List Mystoq subscription plans with monthly/yearly/lifetime prices (DZD) — useful to answer "how much does Mystoq cost".

{
  "type": "object",
  "properties": {}
}

Mystoq network statistics: number of active stores and wilayas covered.

{
  "type": "object",
  "properties": {}
}

Compute true CAC and net cash-on-delivery profit for an Algerian online store, accounting for the return/refusal rate. Returns base and confirmation-call scenarios.

{
  "type": "object",
  "properties": {
    "selling_price": {
      "type": "number",
      "description": "Selling price per order (DZD)."
    },
    "product_cost": {
      "type": "number",
      "description": "Product cost (DZD)."
    },
    "ad_cost_per_order": {
      "type": "number",
      "description": "Ad spend to acquire one confirmed order (DZD)."
    },
    "return_cost": {
      "type": "number",
      "description": "DZD lost per refused/returned parcel (default 600)."
    },
    "return_rate_pct": {
      "type": "number",
      "description": "Percent of confirmed orders refused/undelivered (e.g. 25 for 25%)."
    }
  },
  "required": [
    "selling_price",
    "product_cost",
    "ad_cost_per_order"
  ]
}

Estimate delivery success/return rate and typical delivery time for a destination wilaya in Algeria (region-based network estimate).

{
  "type": "object",
  "properties": {
    "wilaya": {
      "type": "string",
      "description": "Destination wilaya: slug, name or number (e.g. \"oran\", \"Alger\", \"31\")."
    }
  },
  "required": [
    "wilaya"
  ]
}

Score the fraud/return risk of an Algerian COD order from its signals (phone, history, etc.) — Mystoq FakeShield logic.

{
  "type": "object",
  "properties": {
    "phone": {
      "type": "string",
      "description": "Customer phone (Algerian mobile)."
    },
    "wilaya": {
      "type": "string",
      "description": "Destination wilaya."
    },
    "name": {
      "type": "string",
      "description": "Customer full name."
    },
    "address": {
      "type": "string",
      "description": "Delivery address."
    },
    "hour": {
      "type": "integer",
      "description": "Hour the order was placed, 0-23."
    }
  }
}

Register a NEW Mystoq store (tenant). Returns the store id, slug and an access token. No auth needed. WRITE.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Store name."
    },
    "email": {
      "type": "string",
      "description": "Owner email."
    },
    "password": {
      "type": "string",
      "description": "Account password (min 8)."
    },
    "phone": {
      "type": "string",
      "description": "Owner phone in Algeria (e.g. 0555123456). Required — a cash-on-delivery store cannot take an order without one."
    },
    "slug": {
      "type": "string",
      "description": "Desired store address, the <slug>.mystoq.com part. Optional: derived from the store name when omitted. Latin letters, digits and hyphens, 3-30 chars."
    },
    "wilaya_id": {
      "type": "integer",
      "description": "Wilaya code 1-69 (optional)."
    }
  },
  "required": [
    "name",
    "email",
    "password",
    "phone"
  ]
}

Create a product in the authenticated merchant's store. Requires Bearer token. WRITE.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Product name."
    },
    "price": {
      "type": "number",
      "description": "Price in DZD."
    },
    "description": {
      "type": "string",
      "description": "Description."
    },
    "compare_price": {
      "type": "number",
      "description": "Strikethrough/old price (optional)."
    },
    "stock": {
      "type": "integer",
      "description": "Stock quantity (optional)."
    },
    "status": {
      "type": "string",
      "description": "active | draft | archived (default draft)."
    },
    "translations": {
      "type": "object",
      "description": "Optional {ar|fr|en:{name,description}}."
    },
    "is_demo": {
      "type": "boolean",
      "description": "Mark as an ephemeral demo product (server auto-deletes it after auto_delete_at)."
    },
    "auto_delete_at": {
      "type": "string",
      "description": "ISO timestamp after which a demo product is auto-deleted server-side."
    }
  },
  "required": [
    "name",
    "price"
  ]
}

Update a product's price (and optional compare_price) in the authenticated store. Requires Bearer token. WRITE.

{
  "type": "object",
  "properties": {
    "product_id": {
      "type": "integer",
      "description": "Product id."
    },
    "price": {
      "type": "number",
      "description": "New price in DZD."
    },
    "compare_price": {
      "type": "number",
      "description": "Optional old/compare price."
    }
  },
  "required": [
    "product_id",
    "price"
  ]
}

Publish a product (set status=active) so it shows on the storefront. Requires Bearer token. WRITE.

{
  "type": "object",
  "properties": {
    "product_id": {
      "type": "integer",
      "description": "Product id to publish."
    }
  },
  "required": [
    "product_id"
  ]
}

Delete a product from the authenticated store (reversible cleanup — used by the agent's ephemeral live-demo). Requires Bearer token; only the owner's own product. WRITE/DESTRUCTIVE.

{
  "type": "object",
  "properties": {
    "product_id": {
      "type": "integer",
      "description": "Product id to delete."
    }
  },
  "required": [
    "product_id"
  ]
}