{"info":{"name":"Store Platform API","description":"Merchant REST API. Set the collection variables `baseUrl` (e.g. https://your-store.example.com/api/v1) and `apiKey` (a key from Dashboard → API & Webhooks).","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"auth":{"type":"bearer","bearer":[{"key":"token","value":"{{apiKey}}","type":"string"}]},"variable":[{"key":"baseUrl","value":"https://your-store.example.com/api/v1"},{"key":"apiKey","value":"sk_live_xxx"}],"item":[{"name":"Products & catalog","item":[{"name":"GET /products","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/products?page=1&limit=20&search=","host":["{{baseUrl}}"],"path":["products"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"20"},{"key":"search","value":""}]},"description":"List products (paginated). Scope: products:read"}},{"name":"GET /products/:id","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/products/:id","host":["{{baseUrl}}"],"path":["products",":id"]},"description":"Product with variants, images and stock. Scope: products:read"}},{"name":"POST /products","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/products","host":["{{baseUrl}}"],"path":["products"]},"description":"Create a product. Scope: products:write","body":{"mode":"raw","raw":"{\n  \"name\": \"Blue T-Shirt\",\n  \"price\": 79,\n  \"sku\": \"TS-BLUE\",\n  \"isActive\": true\n}","options":{"raw":{"language":"json"}}}}},{"name":"PATCH /products/:id","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/products/:id","host":["{{baseUrl}}"],"path":["products",":id"]},"description":"Update a product. Scope: products:write","body":{"mode":"raw","raw":"{\n  \"price\": 69\n}","options":{"raw":{"language":"json"}}}}},{"name":"DELETE /products/:id","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/products/:id","host":["{{baseUrl}}"],"path":["products",":id"]},"description":"Delete a product. Scope: products:write"}},{"name":"GET /categories","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/categories","host":["{{baseUrl}}"],"path":["categories"]},"description":"List categories. Scope: products:read"}},{"name":"POST /categories","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/categories","host":["{{baseUrl}}"],"path":["categories"]},"description":"Create a category. Scope: products:write","body":{"mode":"raw","raw":"{\n  \"name\": \"Apparel\"\n}","options":{"raw":{"language":"json"}}}}},{"name":"PATCH /categories/:id","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/categories/:id","host":["{{baseUrl}}"],"path":["categories",":id"]},"description":"Update a category. Scope: products:write","body":{"mode":"raw","raw":"{\n  \"name\": \"Menswear\"\n}","options":{"raw":{"language":"json"}}}}},{"name":"DELETE /categories/:id","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/categories/:id","host":["{{baseUrl}}"],"path":["categories",":id"]},"description":"Delete a category. Scope: products:write"}},{"name":"GET /brands","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/brands","host":["{{baseUrl}}"],"path":["brands"]},"description":"List brands. Scope: products:read"}},{"name":"POST /brands","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/brands","host":["{{baseUrl}}"],"path":["brands"]},"description":"Create a brand. Scope: products:write","body":{"mode":"raw","raw":"{\n  \"name\": \"Acme\"\n}","options":{"raw":{"language":"json"}}}}}]},{"name":"Inventory","item":[{"name":"GET /inventory/stock","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/inventory/stock","host":["{{baseUrl}}"],"path":["inventory","stock"]},"description":"On-hand quantities per variant. Scope: inventory:read"}},{"name":"GET /inventory/low-stock","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/inventory/low-stock","host":["{{baseUrl}}"],"path":["inventory","low-stock"]},"description":"Items at or below their threshold. Scope: inventory:read"}},{"name":"GET /inventory/movements","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/inventory/movements","host":["{{baseUrl}}"],"path":["inventory","movements"]},"description":"Inventory ledger (movements). Scope: inventory:read"}},{"name":"POST /inventory/adjust","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/inventory/adjust","host":["{{baseUrl}}"],"path":["inventory","adjust"]},"description":"Adjust stock with a reason. Scope: inventory:write","body":{"mode":"raw","raw":"{\n  \"variantId\": \"<variant id>\",\n  \"delta\": 10,\n  \"reason\": \"restock\"\n}","options":{"raw":{"language":"json"}}}}},{"name":"PATCH /inventory/threshold","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/inventory/threshold","host":["{{baseUrl}}"],"path":["inventory","threshold"]},"description":"Set the low-stock threshold. Scope: inventory:write","body":{"mode":"raw","raw":"{\n  \"variantId\": \"<variant id>\",\n  \"threshold\": 5\n}","options":{"raw":{"language":"json"}}}}}]},{"name":"Orders","item":[{"name":"GET /orders","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/orders?page=1&limit=20&status=","host":["{{baseUrl}}"],"path":["orders"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"20"},{"key":"status","value":""}]},"description":"List orders (paginated). Scope: orders:read"}},{"name":"GET /orders/:id","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/orders/:id","host":["{{baseUrl}}"],"path":["orders",":id"]},"description":"Order with items, totals, payment and shipping. Scope: orders:read"}},{"name":"GET /orders/:id/notifications","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/orders/:id/notifications","host":["{{baseUrl}}"],"path":["orders",":id","notifications"]},"description":"Notification log of the order. Scope: orders:read"}},{"name":"PATCH /orders/:id/status","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/orders/:id/status","host":["{{baseUrl}}"],"path":["orders",":id","status"]},"description":"Change status. Scope: orders:write","body":{"mode":"raw","raw":"{\n  \"status\": \"CONFIRMED\"\n}","options":{"raw":{"language":"json"}}}}},{"name":"PATCH /orders/:id/fulfillment","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/orders/:id/fulfillment","host":["{{baseUrl}}"],"path":["orders",":id","fulfillment"]},"description":"Set carrier / tracking number. Scope: orders:write","body":{"mode":"raw","raw":"{\n  \"carrier\": \"Aramex\",\n  \"trackingNumber\": \"1234567890\"\n}","options":{"raw":{"language":"json"}}}}},{"name":"POST /orders/:id/notify","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/orders/:id/notify","host":["{{baseUrl}}"],"path":["orders",":id","notify"]},"description":"Re-send a customer notification. Scope: orders:write","body":{"mode":"raw","raw":"{\n  \"event\": \"order.status_changed\"\n}","options":{"raw":{"language":"json"}}}}},{"name":"POST /orders/:id/cancel","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/orders/:id/cancel","host":["{{baseUrl}}"],"path":["orders",":id","cancel"]},"description":"Cancel an order. Scope: orders:write","body":{"mode":"raw","raw":"{\n  \"reason\": \"Customer request\"\n}","options":{"raw":{"language":"json"}}}}},{"name":"POST /orders/:id/refund","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/orders/:id/refund","host":["{{baseUrl}}"],"path":["orders",":id","refund"]},"description":"Refund an order. Scope: orders:write","body":{"mode":"raw","raw":"{\n  \"amount\": 50,\n  \"restock\": true,\n  \"note\": \"Damaged item\"\n}","options":{"raw":{"language":"json"}}}}}]},{"name":"Customers","item":[{"name":"GET /customers","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/customers?page=1&limit=20&search=","host":["{{baseUrl}}"],"path":["customers"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"20"},{"key":"search","value":""}]},"description":"List customers (paginated). Scope: customers:read"}},{"name":"GET /customers/:id","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/customers/:id","host":["{{baseUrl}}"],"path":["customers",":id"]},"description":"Customer with addresses and recent orders. Scope: customers:read"}},{"name":"POST /customers","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/customers","host":["{{baseUrl}}"],"path":["customers"]},"description":"Create a customer. Scope: customers:write","body":{"mode":"raw","raw":"{\n  \"name\": \"Sara Ahmed\",\n  \"email\": \"sara@example.com\",\n  \"phone\": \"+971500000000\"\n}","options":{"raw":{"language":"json"}}}}},{"name":"PATCH /customers/:id","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/customers/:id","host":["{{baseUrl}}"],"path":["customers",":id"]},"description":"Update a customer. Scope: customers:write","body":{"mode":"raw","raw":"{\n  \"marketingOptIn\": true\n}","options":{"raw":{"language":"json"}}}}},{"name":"GET /customers/:id/addresses","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/customers/:id/addresses","host":["{{baseUrl}}"],"path":["customers",":id","addresses"]},"description":"List a customer's addresses. Scope: customers:read"}},{"name":"POST /customers/:id/addresses","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/customers/:id/addresses","host":["{{baseUrl}}"],"path":["customers",":id","addresses"]},"description":"Add an address. Scope: customers:write","body":{"mode":"raw","raw":"{\n  \"label\": \"Home\",\n  \"city\": \"Riyadh\",\n  \"street\": \"King Fahd Rd\",\n  \"country\": \"SA\",\n  \"isDefault\": true\n}","options":{"raw":{"language":"json"}}}}},{"name":"DELETE /customers/:id/addresses/:addressId","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/customers/:id/addresses/:addressId","host":["{{baseUrl}}"],"path":["customers",":id","addresses",":addressId"]},"description":"Delete an address. Scope: customers:write"}}]},{"name":"Coupons","item":[{"name":"GET /coupons","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/coupons","host":["{{baseUrl}}"],"path":["coupons"]},"description":"List coupons. Scope: coupons:read"}},{"name":"GET /coupons/:id/usage","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/coupons/:id/usage","host":["{{baseUrl}}"],"path":["coupons",":id","usage"]},"description":"Coupon usage. Scope: coupons:read"}},{"name":"POST /coupons","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/coupons","host":["{{baseUrl}}"],"path":["coupons"]},"description":"Create a coupon. Scope: coupons:write","body":{"mode":"raw","raw":"{\n  \"code\": \"WELCOME10\",\n  \"type\": \"PERCENTAGE\",\n  \"value\": 10\n}","options":{"raw":{"language":"json"}}}}},{"name":"PATCH /coupons/:id","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/coupons/:id","host":["{{baseUrl}}"],"path":["coupons",":id"]},"description":"Update a coupon. Scope: coupons:write","body":{"mode":"raw","raw":"{\n  \"isActive\": false\n}","options":{"raw":{"language":"json"}}}}},{"name":"DELETE /coupons/:id","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/coupons/:id","host":["{{baseUrl}}"],"path":["coupons",":id"]},"description":"Delete a coupon. Scope: coupons:write"}}]},{"name":"Shipping","item":[{"name":"GET /shipping-methods","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/shipping-methods","host":["{{baseUrl}}"],"path":["shipping-methods"]},"description":"List shipping methods. Scope: shipping:read"}},{"name":"POST /shipping-methods","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/shipping-methods","host":["{{baseUrl}}"],"path":["shipping-methods"]},"description":"Create a shipping method. Scope: shipping:write","body":{"mode":"raw","raw":"{\n  \"name\": \"Standard\",\n  \"price\": 15\n}","options":{"raw":{"language":"json"}}}}},{"name":"PATCH /shipping-methods/:id","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/shipping-methods/:id","host":["{{baseUrl}}"],"path":["shipping-methods",":id"]},"description":"Update a shipping method. Scope: shipping:write","body":{"mode":"raw","raw":"{\n  \"price\": 20\n}","options":{"raw":{"language":"json"}}}}},{"name":"DELETE /shipping-methods/:id","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/shipping-methods/:id","host":["{{baseUrl}}"],"path":["shipping-methods",":id"]},"description":"Delete a shipping method. Scope: shipping:write"}}]},{"name":"Invoices","item":[{"name":"GET /invoices","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/invoices?page=1&limit=20","host":["{{baseUrl}}"],"path":["invoices"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"20"}]},"description":"List tax invoices (paginated). Scope: invoices:read"}},{"name":"GET /invoices/summary","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/invoices/summary","host":["{{baseUrl}}"],"path":["invoices","summary"]},"description":"Invoice totals over a period. Scope: invoices:read"}},{"name":"GET /invoices/:id","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/invoices/:id","host":["{{baseUrl}}"],"path":["invoices",":id"]},"description":"Get one invoice. Scope: invoices:read"}}]},{"name":"Media","item":[{"name":"GET /media","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/media","host":["{{baseUrl}}"],"path":["media"]},"description":"List media library items. Scope: media:read"}},{"name":"POST /media","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/media","host":["{{baseUrl}}"],"path":["media"]},"description":"Upload an image (multipart/form-data field \"file\"). Scope: media:write"}},{"name":"DELETE /media/:id","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/media/:id","host":["{{baseUrl}}"],"path":["media",":id"]},"description":"Delete a media item. Scope: media:write"}}]},{"name":"Webhooks","item":[{"name":"GET /integrations/webhooks","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/integrations/webhooks","host":["{{baseUrl}}"],"path":["integrations","webhooks"]},"description":"List webhooks. Scope: webhooks:manage"}},{"name":"POST /integrations/webhooks","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/integrations/webhooks","host":["{{baseUrl}}"],"path":["integrations","webhooks"]},"description":"Create a webhook (returns the secret once). Scope: webhooks:manage","body":{"mode":"raw","raw":"{\n  \"url\": \"https://example.com/hooks/store\",\n  \"events\": [\n    \"order.paid\",\n    \"order.created\"\n  ]\n}","options":{"raw":{"language":"json"}}}}},{"name":"PATCH /integrations/webhooks/:id","request":{"method":"PATCH","header":[{"key":"Accept","value":"application/json"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"{{baseUrl}}/integrations/webhooks/:id","host":["{{baseUrl}}"],"path":["integrations","webhooks",":id"]},"description":"Update url / events / isActive. Scope: webhooks:manage","body":{"mode":"raw","raw":"{\n  \"isActive\": false\n}","options":{"raw":{"language":"json"}}}}},{"name":"DELETE /integrations/webhooks/:id","request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/integrations/webhooks/:id","host":["{{baseUrl}}"],"path":["integrations","webhooks",":id"]},"description":"Delete a webhook and its deliveries. Scope: webhooks:manage"}},{"name":"POST /integrations/webhooks/:id/test","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/integrations/webhooks/:id/test","host":["{{baseUrl}}"],"path":["integrations","webhooks",":id","test"]},"description":"Send a ping event. Scope: webhooks:manage"}},{"name":"GET /integrations/webhooks/:id/deliveries","request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/integrations/webhooks/:id/deliveries","host":["{{baseUrl}}"],"path":["integrations","webhooks",":id","deliveries"]},"description":"Delivery log (paginated). Scope: webhooks:manage"}},{"name":"POST /integrations/webhooks/:id/deliveries/:deliveryId/redeliver","request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/integrations/webhooks/:id/deliveries/:deliveryId/redeliver","host":["{{baseUrl}}"],"path":["integrations","webhooks",":id","deliveries",":deliveryId","redeliver"]},"description":"Re-send a delivery. Scope: webhooks:manage"}}]}]}