{ "openapi": "3.0.1", "info": { "title": "Sendy Store API", "version": "v1", "description": "The complete Sendy Store API, authenticated with an X-API-Key, served under /api/v1/store/integrations: orders, catalog, inventory, customers, discounts, wallet, tickets, social/website chat, delivery providers, and more. Generated from the live backend Swagger document — controller code is the source of truth." }, "servers": [ { "url": "https://api.sendyiq.com", "description": "Production" }, { "url": "https://stagging-api.sendyiq.com", "description": "Staging" } ], "security": [ { "Bearer": [] } ], "paths": { "/api/v1/store/integrations/orders": { "post": { "tags": [ "StoreOrders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationPushOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationPushOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IntegrationPushOrderRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "get": { "tags": [ "StoreOrders" ], "parameters": [ { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Status", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/orders/bulk": { "post": { "tags": [ "StoreOrders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationBulkRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationBulkRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IntegrationBulkRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/orders/{orderId}": { "put": { "tags": [ "StoreOrders" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationPushOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationPushOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IntegrationPushOrderRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "get": { "tags": [ "StoreOrders" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/orders/{orderId}/cancel": { "post": { "tags": [ "StoreOrders" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationCancelRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationCancelRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IntegrationCancelRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/orders/send-otp": { "post": { "tags": [ "StoreOrders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationSendOtpRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationSendOtpRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IntegrationSendOtpRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/orders/storefront": { "post": { "tags": [ "StoreOrders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationStorefrontOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationStorefrontOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IntegrationStorefrontOrderRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/delivery-companies": { "get": { "tags": [ "StoreOrders" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/orders/search/{publicId}": { "get": { "tags": [ "StoreOrders" ], "parameters": [ { "name": "publicId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/orders/{orderId}/items": { "get": { "tags": [ "StoreOrders" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/orders/{orderId}/qr": { "post": { "tags": [ "StoreOrders" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/orders/{orderId}/status": { "post": { "tags": [ "StoreOrders" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeOrderStatusBodyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeOrderStatusBodyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeOrderStatusBodyRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/orders/{orderId}/return-request": { "post": { "tags": [ "StoreOrders" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationCreateReturnRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationCreateReturnRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IntegrationCreateReturnRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/orders/{orderId}/return-requests": { "get": { "tags": [ "StoreOrders" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/return-requests/{returnRequestId}": { "get": { "tags": [ "StoreOrders" ], "parameters": [ { "name": "returnRequestId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/return-requests/{returnRequestId}/approve": { "post": { "tags": [ "StoreOrders" ], "parameters": [ { "name": "returnRequestId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/return-requests/{returnRequestId}/reject": { "post": { "tags": [ "StoreOrders" ], "parameters": [ { "name": "returnRequestId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationRejectReturnRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationRejectReturnRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IntegrationRejectReturnRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/catalog/products": { "get": { "tags": [ "StoreProducts" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StoreProducts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationUpsertProductRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationUpsertProductRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IntegrationUpsertProductRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/catalog/products/{productId}": { "delete": { "tags": [ "StoreProducts" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/catalog/inventory": { "get": { "tags": [ "StoreInventory" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/catalog/inventory/{inventoryItemId}": { "put": { "tags": [ "StoreInventory" ], "parameters": [ { "name": "inventoryItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationSetInventoryQuantityRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationSetInventoryQuantityRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IntegrationSetInventoryQuantityRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/products": { "get": { "tags": [ "StoreProducts" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StoreProducts" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreProductCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StoreProductCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/StoreProductCreateRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/products/{productId}": { "get": { "tags": [ "StoreProducts" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "put": { "tags": [ "StoreProducts" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreProductUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StoreProductUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/StoreProductUpdateRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "delete": { "tags": [ "StoreProducts" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/products/{productId}/images": { "get": { "tags": [ "StoreProducts" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StoreProducts" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "ProductId": { "type": "string", "format": "uuid" }, "Image": { "type": "string", "format": "binary" }, "Images": { "type": "array", "items": { "type": "string", "format": "binary" } } } }, "encoding": { "ProductId": { "style": "form" }, "Image": { "style": "form" }, "Images": { "style": "form" } } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/categories": { "get": { "tags": [ "StoreProductCategories" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StoreProductCategories" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "Name": { "type": "string" }, "ParentCategoryId": { "type": "string", "format": "uuid" }, "Description": { "type": "string" }, "Image": { "type": "string", "format": "binary" }, "SortOrder": { "type": "integer", "format": "int32" } } }, "encoding": { "Name": { "style": "form" }, "ParentCategoryId": { "style": "form" }, "Description": { "style": "form" }, "Image": { "style": "form" }, "SortOrder": { "style": "form" } } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/categories/{id}": { "get": { "tags": [ "StoreProductCategories" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "put": { "tags": [ "StoreProductCategories" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "Name": { "type": "string" }, "Description": { "type": "string" }, "Image": { "type": "string", "format": "binary" }, "SortOrder": { "type": "integer", "format": "int32" }, "IsActive": { "type": "boolean" } } }, "encoding": { "Name": { "style": "form" }, "Description": { "style": "form" }, "Image": { "style": "form" }, "SortOrder": { "style": "form" }, "IsActive": { "style": "form" } } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "delete": { "tags": [ "StoreProductCategories" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/inventory": { "get": { "tags": [ "StoreInventory" ], "parameters": [ { "name": "warehouse_id", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "include_inactive", "in": "query", "schema": { "type": "boolean" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StoreInventory" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInventoryItemRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateInventoryItemRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateInventoryItemRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/inventory/{itemId}": { "get": { "tags": [ "StoreInventory" ], "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "put": { "tags": [ "StoreInventory" ], "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInventoryItemRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateInventoryItemRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateInventoryItemRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "delete": { "tags": [ "StoreInventory" ], "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/warehouses": { "get": { "tags": [ "StoreWarehouses" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StoreWarehouses" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreWarehouseUpsertRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StoreWarehouseUpsertRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/StoreWarehouseUpsertRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/warehouses/{warehouseId}": { "get": { "tags": [ "StoreWarehouses" ], "parameters": [ { "name": "warehouseId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "put": { "tags": [ "StoreWarehouses" ], "parameters": [ { "name": "warehouseId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreWarehouseUpsertRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StoreWarehouseUpsertRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/StoreWarehouseUpsertRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "delete": { "tags": [ "StoreWarehouses" ], "parameters": [ { "name": "warehouseId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/package-sizes": { "get": { "tags": [ "StorePackageSizes" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StorePackageSizes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertPackageSizeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpsertPackageSizeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpsertPackageSizeRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/package-sizes/{id}": { "get": { "tags": [ "StorePackageSizes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "put": { "tags": [ "StorePackageSizes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertPackageSizeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpsertPackageSizeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpsertPackageSizeRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "delete": { "tags": [ "StorePackageSizes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/suppliers": { "get": { "tags": [ "StoreSuppliers" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StoreSuppliers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSupplierRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateSupplierRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateSupplierRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/suppliers/{id}": { "get": { "tags": [ "StoreSuppliers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "put": { "tags": [ "StoreSuppliers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSupplierRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateSupplierRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateSupplierRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "delete": { "tags": [ "StoreSuppliers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/purchase-orders": { "get": { "tags": [ "StorePurchaseOrders" ], "parameters": [ { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/PurchaseOrderStatus" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StorePurchaseOrders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePurchaseOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatePurchaseOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreatePurchaseOrderRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/purchase-orders/{id}": { "get": { "tags": [ "StorePurchaseOrders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "put": { "tags": [ "StorePurchaseOrders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePurchaseOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdatePurchaseOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdatePurchaseOrderRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "delete": { "tags": [ "StorePurchaseOrders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/purchase-orders/{id}/attachments": { "post": { "tags": [ "StorePurchaseOrders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddPurchaseOrderAttachmentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddPurchaseOrderAttachmentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddPurchaseOrderAttachmentRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/purchase-orders/{id}/attachments/{attachmentId}": { "delete": { "tags": [ "StorePurchaseOrders" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "attachmentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/customers": { "get": { "tags": [ "StoreCustomers" ], "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StoreCustomers" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomerRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCustomerRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateCustomerRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/customers/{id}": { "get": { "tags": [ "StoreCustomers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "put": { "tags": [ "StoreCustomers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "delete": { "tags": [ "StoreCustomers" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/discounts/codes": { "get": { "tags": [ "StoreDiscountCodes" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StoreDiscountCodes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDiscountCodeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDiscountCodeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDiscountCodeRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/discounts/codes/validate": { "get": { "tags": [ "StoreDiscountCodes" ], "parameters": [ { "name": "code", "in": "query", "schema": { "type": "string" } }, { "name": "orderValue", "in": "query", "schema": { "type": "number", "format": "double" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/discounts/codes/{id}": { "get": { "tags": [ "StoreDiscountCodes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "put": { "tags": [ "StoreDiscountCodes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDiscountCodeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDiscountCodeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDiscountCodeRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "delete": { "tags": [ "StoreDiscountCodes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/discounts/rules": { "get": { "tags": [ "StoreDiscountRules" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StoreDiscountRules" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDiscountRuleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDiscountRuleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateDiscountRuleRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/discounts/rules/{id}": { "get": { "tags": [ "StoreDiscountRules" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "put": { "tags": [ "StoreDiscountRules" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDiscountRuleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateDiscountRuleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateDiscountRuleRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "delete": { "tags": [ "StoreDiscountRules" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/expenses": { "get": { "tags": [ "StoreExpenses" ], "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "category", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StoreExpenses" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateExpenseRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateExpenseRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateExpenseRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/expenses/{id}": { "get": { "tags": [ "StoreExpenses" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "put": { "tags": [ "StoreExpenses" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateExpenseRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateExpenseRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateExpenseRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "delete": { "tags": [ "StoreExpenses" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/wallet": { "get": { "tags": [ "StoreWallet" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/wallet/transactions": { "get": { "tags": [ "StoreWallet" ], "parameters": [ { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/wallet/bank-details": { "put": { "tags": [ "StoreWallet" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBankDetailsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateBankDetailsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateBankDetailsRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/analytics/sales": { "get": { "tags": [ "StoreAnalytics" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Granularity", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/analytics/products": { "get": { "tags": [ "StoreAnalytics" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Granularity", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/analytics/customers": { "get": { "tags": [ "StoreAnalytics" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Granularity", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/analytics/expenses": { "get": { "tags": [ "StoreAnalytics" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Granularity", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/analytics/revenue": { "get": { "tags": [ "StoreAnalytics" ], "parameters": [ { "name": "From", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "To", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "Granularity", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/dashboard": { "get": { "tags": [ "StoreDashboard" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/dashboard/orders": { "get": { "tags": [ "StoreDashboard" ], "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "fulfillment_type", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/print-templates": { "get": { "tags": [ "StorePrintTemplates" ], "parameters": [ { "name": "type", "in": "query", "schema": { "$ref": "#/components/schemas/PrintTemplateType" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StorePrintTemplates" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertPrintTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpsertPrintTemplateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpsertPrintTemplateRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/print-templates/{id}": { "get": { "tags": [ "StorePrintTemplates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "put": { "tags": [ "StorePrintTemplates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertPrintTemplateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpsertPrintTemplateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpsertPrintTemplateRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "delete": { "tags": [ "StorePrintTemplates" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/settings": { "get": { "tags": [ "StoreSettings" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StoreSettings" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InitStoreSettingsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InitStoreSettingsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/InitStoreSettingsRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "put": { "tags": [ "StoreSettings" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateStoreSettingsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateStoreSettingsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateStoreSettingsRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/profile": { "get": { "tags": [ "StoreProfile" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "put": { "tags": [ "StoreProfile" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreUpdateProfileRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StoreUpdateProfileRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/StoreUpdateProfileRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/storefront": { "get": { "tags": [ "StoreStorefront" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "put": { "tags": [ "StoreStorefront" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "Description": { "type": "string" }, "CoverImage": { "type": "string", "format": "binary" }, "Niche": { "$ref": "#/components/schemas/StoreNiche" }, "BannerImage": { "type": "string", "format": "binary" }, "ContactEmail": { "type": "string" }, "WhatsAppNumber": { "type": "string" }, "TelegramHandle": { "type": "string" }, "FacebookUrl": { "type": "string" }, "InstagramUrl": { "type": "string" }, "TwitterUrl": { "type": "string" }, "SeoTitle": { "type": "string" }, "SeoDescription": { "type": "string" }, "SeoKeywords": { "type": "string" }, "Faqs": { "type": "string" }, "Policies": { "type": "string" }, "CustomDomain": { "type": "string" }, "TemplateId": { "type": "string", "format": "uuid" }, "TemplateKey": { "type": "string" }, "ColorPresetId": { "type": "string" }, "ThemeColors.Primary": { "type": "string" }, "ThemeColors.Secondary": { "type": "string" }, "ThemeColors.Accent": { "type": "string" }, "ThemeColors.Background": { "type": "string" }, "ThemeColors.Surface": { "type": "string" }, "ThemeColors.Text": { "type": "string" } } }, "encoding": { "Description": { "style": "form" }, "CoverImage": { "style": "form" }, "Niche": { "style": "form" }, "BannerImage": { "style": "form" }, "ContactEmail": { "style": "form" }, "WhatsAppNumber": { "style": "form" }, "TelegramHandle": { "style": "form" }, "FacebookUrl": { "style": "form" }, "InstagramUrl": { "style": "form" }, "TwitterUrl": { "style": "form" }, "SeoTitle": { "style": "form" }, "SeoDescription": { "style": "form" }, "SeoKeywords": { "style": "form" }, "Faqs": { "style": "form" }, "Policies": { "style": "form" }, "CustomDomain": { "style": "form" }, "TemplateId": { "style": "form" }, "TemplateKey": { "style": "form" }, "ColorPresetId": { "style": "form" }, "ThemeColors.Primary": { "style": "form" }, "ThemeColors.Secondary": { "style": "form" }, "ThemeColors.Accent": { "style": "form" }, "ThemeColors.Background": { "style": "form" }, "ThemeColors.Surface": { "style": "form" }, "ThemeColors.Text": { "style": "form" } } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/storefront/publish": { "post": { "tags": [ "StoreStorefront" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "delete": { "tags": [ "StoreStorefront" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/storefront/templates": { "get": { "tags": [ "StoreStorefront" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/storefront/template-entitlements": { "get": { "tags": [ "StoreStorefront" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/storefront/templates/{templateId}/apply": { "post": { "tags": [ "StoreStorefront" ], "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/storefront/domain/verify": { "post": { "tags": [ "StoreStorefront" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/storefront/images/{imageType}": { "delete": { "tags": [ "StoreStorefront" ], "parameters": [ { "name": "imageType", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/storefront/sections": { "put": { "tags": [ "StoreStorefront" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "Sections": { "type": "array", "items": { "$ref": "#/components/schemas/StorefrontSectionItem" } } } }, "encoding": { "Sections": { "style": "form" } } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/cashier/settings": { "get": { "tags": [ "StoreCashier" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "put": { "tags": [ "StoreCashier" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCashierSettingsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCashierSettingsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCashierSettingsRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/cashier/sessions": { "get": { "tags": [ "StoreCashier" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StoreCashier" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenCashierSessionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OpenCashierSessionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OpenCashierSessionRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/cashier/sessions/active": { "get": { "tags": [ "StoreCashier" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/cashier/sessions/{sessionId}/close": { "put": { "tags": [ "StoreCashier" ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloseCashierSessionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CloseCashierSessionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CloseCashierSessionRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/cashier/pinned": { "get": { "tags": [ "StoreCashier" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StoreCashier" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PinProductRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PinProductRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PinProductRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/cashier/pinned/{pinnedItemId}": { "delete": { "tags": [ "StoreCashier" ], "parameters": [ { "name": "pinnedItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/cashier/pinned/reorder": { "put": { "tags": [ "StoreCashier" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReorderPinnedItemsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReorderPinnedItemsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ReorderPinnedItemsRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/tickets": { "get": { "tags": [ "StoreTickets" ], "parameters": [ { "name": "Status", "in": "query", "schema": { "$ref": "#/components/schemas/TicketStatus" } }, { "name": "Category", "in": "query", "schema": { "$ref": "#/components/schemas/TicketCategory" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StoreTickets" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TicketCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TicketCreateRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/tickets/{ticketId}": { "get": { "tags": [ "StoreTickets" ], "parameters": [ { "name": "ticketId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "put": { "tags": [ "StoreTickets" ], "parameters": [ { "name": "ticketId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TicketUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TicketUpdateRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "delete": { "tags": [ "StoreTickets" ], "parameters": [ { "name": "ticketId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/chat/hub-token": { "post": { "tags": [ "StoreConversations" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/chat/conversations": { "get": { "tags": [ "StoreConversations" ], "parameters": [ { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "ChannelId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/chat/conversations/{conversationId}": { "get": { "tags": [ "StoreConversations" ], "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/chat/conversations/{conversationId}/messages": { "post": { "tags": [ "StoreConversations" ], "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationSendChatMessageRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationSendChatMessageRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IntegrationSendChatMessageRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/chat/conversations/{conversationId}/resolve": { "post": { "tags": [ "StoreConversations" ], "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/chat/conversations/{conversationId}/reopen": { "post": { "tags": [ "StoreConversations" ], "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/social/conversations": { "get": { "tags": [ "StoreConversations" ], "parameters": [ { "name": "Page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "PerPage", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "ChannelId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/social/conversations/{conversationId}": { "get": { "tags": [ "StoreConversations" ], "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/social/conversations/{conversationId}/messages": { "post": { "tags": [ "StoreConversations" ], "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendMessageRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SendMessageRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SendMessageRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/social/conversations/{conversationId}/resolve": { "post": { "tags": [ "StoreConversations" ], "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/social/conversations/{conversationId}/reopen": { "post": { "tags": [ "StoreConversations" ], "parameters": [ { "name": "conversationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/social/channels/website": { "post": { "tags": [ "StoreSocialChannels" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebsiteChannelRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateWebsiteChannelRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateWebsiteChannelRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/social/channels": { "get": { "tags": [ "StoreSocialChannels" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/social/channels/{channelId}": { "patch": { "tags": [ "StoreSocialChannels" ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSocialChannelRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateSocialChannelRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateSocialChannelRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "delete": { "tags": [ "StoreSocialChannels" ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/social/channels/{channelId}/toggle-agent": { "post": { "tags": [ "StoreSocialChannels" ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ToggleAgentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ToggleAgentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ToggleAgentRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/social/channels/{channelId}/rotate-token": { "post": { "tags": [ "StoreSocialChannels" ], "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/delivery-providers": { "get": { "tags": [ "StoreDeliveryProviders" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/delivery-providers/links": { "get": { "tags": [ "StoreDeliveryProviders" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StoreDeliveryProviders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkDeliveryProviderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LinkDeliveryProviderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LinkDeliveryProviderRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/delivery-providers/links/{linkId}": { "delete": { "tags": [ "StoreDeliveryProviders" ], "parameters": [ { "name": "linkId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/delivery-providers/orders/{orderId}/sync-status": { "post": { "tags": [ "StoreDeliveryProviders" ], "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/al-waseet/cities": { "get": { "tags": [ "StoreAlWaseet" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/al-waseet/regions": { "get": { "tags": [ "StoreAlWaseet" ], "parameters": [ { "name": "cityId", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/al-waseet/package-sizes": { "get": { "tags": [ "StoreAlWaseet" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/al-waseet/statuses": { "get": { "tags": [ "StoreAlWaseet" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/al-waseet/orders": { "get": { "tags": [ "StoreAlWaseet" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/al-waseet/orders/by-ids": { "post": { "tags": [ "StoreAlWaseet" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlWaseetGetOrdersByIdsRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlWaseetGetOrdersByIdsRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AlWaseetGetOrdersByIdsRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/al-waseet/orders/{qrId}": { "patch": { "tags": [ "StoreAlWaseet" ], "parameters": [ { "name": "qrId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlWaseetCreateOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AlWaseetCreateOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AlWaseetCreateOrderRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/al-waseet/invoices": { "get": { "tags": [ "StoreAlWaseet" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/al-waseet/invoices/{invoiceId}": { "get": { "tags": [ "StoreAlWaseet" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/al-waseet/invoices/{invoiceId}/receive": { "post": { "tags": [ "StoreAlWaseet" ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/boxy/orders": { "get": { "tags": [ "StoreBoxy" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/boxy/orders/by-custom-id/{customId}": { "get": { "tags": [ "StoreBoxy" ], "parameters": [ { "name": "customId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/boxy/orders/labels": { "get": { "tags": [ "StoreBoxy" ], "parameters": [ { "name": "orderUids", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/boxy/orders/{orderUid}/label": { "get": { "tags": [ "StoreBoxy" ], "parameters": [ { "name": "orderUid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/boxy/orders/{orderUid}/status": { "get": { "tags": [ "StoreBoxy" ], "parameters": [ { "name": "orderUid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/boxy/orders/{orderUid}/cancel": { "post": { "tags": [ "StoreBoxy" ], "parameters": [ { "name": "orderUid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/boxy/orders/{orderUid}": { "patch": { "tags": [ "StoreBoxy" ], "parameters": [ { "name": "orderUid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoxyCreateOrderRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoxyCreateOrderRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoxyCreateOrderRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "delete": { "tags": [ "StoreBoxy" ], "parameters": [ { "name": "orderUid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/boxy/pick-ups": { "get": { "tags": [ "StoreBoxy" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StoreBoxy" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoxyPickupRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoxyPickupRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoxyPickupRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/boxy/pick-ups/{pickupUid}": { "get": { "tags": [ "StoreBoxy" ], "parameters": [ { "name": "pickupUid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/boxy/pick-ups/{pickupUid}/labels": { "get": { "tags": [ "StoreBoxy" ], "parameters": [ { "name": "pickupUid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/boxy/pick-ups/bulk": { "post": { "tags": [ "StoreBoxy" ], "parameters": [ { "name": "filterUids", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/boxy/pick-ups/{pickupUid}/cancel": { "post": { "tags": [ "StoreBoxy" ], "parameters": [ { "name": "pickupUid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/boxy/pick-ups/bulk-cancel": { "post": { "tags": [ "StoreBoxy" ], "parameters": [ { "name": "filterUids", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/boxy/pick-up-locations": { "get": { "tags": [ "StoreBoxy" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StoreBoxy" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoxyPickupLocationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoxyPickupLocationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoxyPickupLocationRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/boxy/pick-up-locations/cash-dropoff": { "get": { "tags": [ "StoreBoxy" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/boxy/pick-up-locations/{locationUid}": { "get": { "tags": [ "StoreBoxy" ], "parameters": [ { "name": "locationUid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "patch": { "tags": [ "StoreBoxy" ], "parameters": [ { "name": "locationUid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoxyPickupLocationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BoxyPickupLocationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BoxyPickupLocationRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "delete": { "tags": [ "StoreBoxy" ], "parameters": [ { "name": "locationUid", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/boxy/regions": { "get": { "tags": [ "StoreBoxy" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/subscription": { "get": { "tags": [ "StoreSubscription" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/subscription/plans": { "get": { "tags": [ "StoreSubscription" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/subscription/upgrade-requests": { "post": { "tags": [ "StoreSubscription" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreSubscriptionUpgradeCreateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StoreSubscriptionUpgradeCreateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/StoreSubscriptionUpgradeCreateRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/subscription/upgrade-requests/{requestId}": { "get": { "tags": [ "StoreSubscription" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/subscription/upgrade-requests/{requestId}/verify": { "post": { "tags": [ "StoreSubscription" ], "parameters": [ { "name": "requestId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/kyc/upload": { "post": { "tags": [ "StoreKyc" ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "FirstDocumentType": { "$ref": "#/components/schemas/KycDocumentType" }, "FirstDocumentFront": { "type": "string", "format": "binary" }, "FirstDocumentBack": { "type": "string", "format": "binary" }, "SecondDocumentType": { "$ref": "#/components/schemas/KycDocumentType" }, "SecondDocumentFront": { "type": "string", "format": "binary" }, "SecondDocumentBack": { "type": "string", "format": "binary" } } }, "encoding": { "FirstDocumentType": { "style": "form" }, "FirstDocumentFront": { "style": "form" }, "FirstDocumentBack": { "style": "form" }, "SecondDocumentType": { "style": "form" }, "SecondDocumentFront": { "style": "form" }, "SecondDocumentBack": { "style": "form" } } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/rbac/users": { "get": { "tags": [ "StoreRbac" ], "parameters": [ { "name": "tenantType", "in": "query", "schema": { "type": "string" } }, { "name": "storeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "deliveryCompanyId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "branchId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StoreRbac" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantRbacCreateUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantRbacCreateUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TenantRbacCreateUserRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/rbac/users/{userId}": { "delete": { "tags": [ "StoreRbac" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/rbac/roles": { "get": { "tags": [ "StoreRbac" ], "parameters": [ { "name": "tenantType", "in": "query", "schema": { "type": "string" } }, { "name": "storeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "deliveryCompanyId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "branchId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StoreRbac" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantRbacRoleUpsertRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantRbacRoleUpsertRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TenantRbacRoleUpsertRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/rbac/roles/{roleId}": { "put": { "tags": [ "StoreRbac" ], "parameters": [ { "name": "roleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantRbacRoleUpsertRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantRbacRoleUpsertRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TenantRbacRoleUpsertRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "delete": { "tags": [ "StoreRbac" ], "parameters": [ { "name": "roleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/rbac/permissions": { "get": { "tags": [ "StoreRbac" ], "parameters": [ { "name": "tenantType", "in": "query", "schema": { "type": "string" } }, { "name": "storeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "deliveryCompanyId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "branchId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/rbac/roles/{roleId}/permissions": { "get": { "tags": [ "StoreRbac" ], "parameters": [ { "name": "roleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StoreRbac" ], "parameters": [ { "name": "roleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignRolePermissionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AssignRolePermissionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AssignRolePermissionRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/rbac/roles/{roleId}/permissions/{permissionId}": { "delete": { "tags": [ "StoreRbac" ], "parameters": [ { "name": "roleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "permissionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/rbac/users/{userId}/roles": { "get": { "tags": [ "StoreRbac" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StoreRbac" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignUserRoleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AssignUserRoleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AssignUserRoleRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/rbac/users/{userId}/roles/{roleId}": { "delete": { "tags": [ "StoreRbac" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "roleId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/api-keys": { "get": { "tags": [ "StoreApiKeys" ], "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StoreApiKeys" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreApiKeyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StoreApiKeyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/StoreApiKeyRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/api-keys/{apiKeyId}/revoke": { "post": { "tags": [ "StoreApiKeys" ], "parameters": [ { "name": "apiKeyId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/mcp/integration": { "get": { "tags": [ "StoreMcpIntegration" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/oauth-mcp/redirect-uris": { "get": { "tags": [ "StoreOAuthMcpRedirectUris" ], "parameters": [ { "name": "clientId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StoreOAuthMcpRedirectUris" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuthMcpClientRedirectUriWriteRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OAuthMcpClientRedirectUriWriteRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OAuthMcpClientRedirectUriWriteRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/oauth-mcp/redirect-uris/{id}": { "delete": { "tags": [ "StoreOAuthMcpRedirectUris" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/webhooks": { "get": { "tags": [ "StoreWebhooks" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] }, "post": { "tags": [ "StoreWebhooks" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreWebhookUpsertRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StoreWebhookUpsertRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/StoreWebhookUpsertRequest" } } } }, "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/webhooks/{subscriptionId}/rotate-secret": { "post": { "tags": [ "StoreWebhooks" ], "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/webhooks/{subscriptionId}/enable": { "post": { "tags": [ "StoreWebhooks" ], "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/webhooks/{subscriptionId}/disable": { "post": { "tags": [ "StoreWebhooks" ], "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/webhooks/{subscriptionId}": { "delete": { "tags": [ "StoreWebhooks" ], "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/webhooks/{subscriptionId}/deliveries": { "get": { "tags": [ "StoreWebhooks" ], "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/webhooks/deliveries/{deliveryId}/retry": { "post": { "tags": [ "StoreWebhooks" ], "parameters": [ { "name": "deliveryId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } }, "/api/v1/store/integrations/webhooks/event-types": { "get": { "tags": [ "StoreWebhooks" ], "responses": { "200": { "description": "Success" } }, "security": [ { "ApiKey": [] } ] } } }, "components": { "securitySchemes": { "Bearer": { "type": "http", "description": "Enter 'Bearer' followed by a space and your JWT token.", "scheme": "Bearer", "bearerFormat": "JWT" }, "ApiKey": { "type": "apiKey", "description": "Integration API key: {keyId}.{secret}", "name": "X-API-Key", "in": "header" } }, "schemas": { "AddPurchaseOrderAttachmentRequest": { "type": "object", "properties": { "fileName": { "type": "string", "nullable": true }, "fileUrl": { "type": "string", "nullable": true }, "fileSize": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "AlWaseetCreateOrderRequest": { "type": "object", "properties": { "clientName": { "type": "string", "nullable": true }, "clientMobile": { "type": "string", "nullable": true }, "clientMobile2": { "type": "string", "nullable": true }, "cityId": { "type": "integer", "format": "int32" }, "regionId": { "type": "integer", "format": "int32" }, "location": { "type": "string", "nullable": true }, "typeName": { "type": "string", "nullable": true }, "itemsNumber": { "type": "integer", "format": "int32" }, "price": { "type": "integer", "format": "int32" }, "packageSize": { "type": "integer", "format": "int32" }, "replacement": { "type": "integer", "format": "int32" }, "merchantNotes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AlWaseetGetOrdersByIdsRequest": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "AssignRolePermissionRequest": { "type": "object", "properties": { "permissionId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "AssignUserRoleRequest": { "type": "object", "properties": { "roleId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "BoxyContactInfo": { "type": "object", "properties": { "fullName": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "secondaryPhone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "addressText": { "type": "string", "nullable": true }, "regionName": { "type": "string", "nullable": true }, "provinceCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BoxyCreateOrderRequest": { "type": "object", "properties": { "isFragile": { "type": "boolean" }, "readyToPickUp": { "type": "boolean" }, "shipmentFeeType": { "type": "string", "nullable": true }, "paymentType": { "type": "string", "nullable": true }, "pickUpType": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "size": { "type": "string", "nullable": true }, "customId": { "type": "string", "nullable": true }, "feeCustomerPayable": { "type": "integer", "format": "int32", "nullable": true }, "savedPickUpAddressUid": { "type": "string", "nullable": true }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/BoxyProductItem" }, "nullable": true }, "contact": { "$ref": "#/components/schemas/BoxyContactInfo" } }, "additionalProperties": false }, "BoxyPickupLocationRequest": { "type": "object", "properties": { "fullName": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "default": { "type": "boolean" }, "regionUid": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "addressText": { "type": "string", "nullable": true }, "lng": { "type": "string", "nullable": true }, "lat": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BoxyPickupRequest": { "type": "object", "properties": { "orderUids": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "BoxyProductItem": { "type": "object", "properties": { "title": { "type": "string", "nullable": true }, "price": { "type": "integer", "format": "int32" }, "quantity": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ChangeOrderStatusBodyRequest": { "type": "object", "properties": { "status": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CloseCashierSessionRequest": { "type": "object", "properties": { "closingCash": { "type": "number", "format": "double", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateCustomerRequest": { "type": "object", "properties": { "fullName": { "type": "string", "nullable": true }, "primaryPhone": { "type": "string", "nullable": true }, "secondaryPhone": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "addressArea": { "type": "string", "nullable": true }, "addressProvince": { "type": "string", "nullable": true }, "latitude": { "type": "number", "format": "double", "nullable": true }, "longitude": { "type": "number", "format": "double", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateDiscountCodeRequest": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "discountType": { "$ref": "#/components/schemas/DiscountType" }, "discountValue": { "type": "number", "format": "double" }, "minOrderValue": { "type": "number", "format": "double", "nullable": true }, "maxUses": { "type": "integer", "format": "int32", "nullable": true }, "perUserLimit": { "type": "integer", "format": "int32", "nullable": true }, "startsAt": { "type": "string", "format": "date-time", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true }, "isActive": { "type": "boolean" }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateDiscountRuleRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "discountType": { "$ref": "#/components/schemas/DiscountType" }, "discountValue": { "type": "number", "format": "double" }, "categoryId": { "type": "string", "format": "uuid", "nullable": true }, "channels": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" } }, "additionalProperties": false }, "CreateExpenseRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" }, "expenseType": { "type": "string", "nullable": true }, "category": { "type": "string", "nullable": true }, "group": { "type": "string", "nullable": true }, "expenseDate": { "type": "string", "format": "date-time" }, "description": { "type": "string", "nullable": true }, "paymentStatus": { "$ref": "#/components/schemas/PaymentStatus" }, "paymentMethod": { "$ref": "#/components/schemas/PaymentMethod" }, "supplierId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "CreateInventoryItemRequest": { "type": "object", "properties": { "storeProductId": { "type": "string", "format": "uuid" }, "warehouseId": { "type": "string", "format": "uuid" }, "quantityOnHand": { "type": "number", "format": "double" } }, "additionalProperties": false }, "CreatePurchaseOrderRequest": { "type": "object", "properties": { "supplierId": { "type": "string", "format": "uuid", "nullable": true }, "referenceNumber": { "type": "string", "nullable": true }, "orderDate": { "type": "string", "format": "date-time" }, "expectedDeliveryDate": { "type": "string", "format": "date-time", "nullable": true }, "notes": { "type": "string", "nullable": true }, "additionalFees": { "type": "number", "format": "double" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderItemRequest" }, "nullable": true } }, "additionalProperties": false }, "CreateSupplierRequest": { "type": "object", "properties": { "fullName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "primaryPhone": { "type": "string", "nullable": true }, "secondaryPhone": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateWebsiteChannelRequest": { "type": "object", "properties": { "displayName": { "type": "string", "nullable": true }, "aiProviderCode": { "type": "string", "nullable": true }, "aiModelCode": { "type": "string", "nullable": true }, "systemPromptOverride": { "type": "string", "nullable": true }, "isAgentEnabled": { "type": "boolean" } }, "additionalProperties": false }, "DiscountType": { "enum": [ "percentage", "fixedAmount" ], "type": "string" }, "InitStoreSettingsRequest": { "type": "object", "properties": { "currencyCode": { "type": "string", "nullable": true }, "timezone": { "type": "string", "nullable": true }, "industry": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "taxEnabled": { "type": "boolean" }, "taxRate": { "type": "number", "format": "double", "nullable": true }, "taxNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IntegrationBulkRequest": { "type": "object", "properties": { "orders": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationPushOrderRequest" }, "nullable": true } }, "additionalProperties": false }, "IntegrationCancelRequest": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IntegrationCreateReturnRequest": { "type": "object", "properties": { "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IntegrationPushOrderRequest": { "type": "object", "properties": { "customerName": { "type": "string", "nullable": true }, "customerPhone": { "type": "string", "nullable": true }, "customerAddress": { "type": "string", "nullable": true }, "addressProvinceCode": { "type": "string", "nullable": true }, "addressAreaId": { "type": "string", "format": "uuid" }, "deliveryLat": { "type": "number", "format": "double", "nullable": true }, "deliveryLng": { "type": "number", "format": "double", "nullable": true }, "orderValue": { "type": "number", "format": "double", "nullable": true }, "deliveryFee": { "type": "number", "format": "double", "nullable": true }, "externalRef": { "type": "string", "nullable": true }, "fulfillmentType": { "type": "string", "nullable": true }, "deliveryMode": { "type": "string", "nullable": true }, "paymentMethod": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IntegrationRejectReturnRequest": { "type": "object", "properties": { "notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IntegrationSendChatMessageRequest": { "type": "object", "properties": { "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IntegrationSendOtpRequest": { "type": "object", "properties": { "phone": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IntegrationSetInventoryQuantityRequest": { "type": "object", "properties": { "quantityOnHand": { "type": "number", "format": "double" } }, "additionalProperties": false }, "IntegrationStorefrontOrderItemRequest": { "type": "object", "properties": { "sku": { "type": "string", "nullable": true }, "quantity": { "type": "integer", "format": "int32" }, "unitPrice": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "IntegrationStorefrontOrderRequest": { "type": "object", "properties": { "customerName": { "type": "string", "nullable": true }, "customerPhone": { "type": "string", "nullable": true }, "customerAddress": { "type": "string", "nullable": true }, "addressProvinceCode": { "type": "string", "nullable": true }, "addressAreaId": { "type": "string", "format": "uuid", "nullable": true }, "deliveryLat": { "type": "number", "format": "double", "nullable": true }, "deliveryLng": { "type": "number", "format": "double", "nullable": true }, "externalRef": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationStorefrontOrderItemRequest" }, "nullable": true }, "otpCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IntegrationUpsertProductRequest": { "type": "object", "properties": { "sku": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isActive": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "KycDocumentType": { "enum": [ "nationalIdCard", "residenceCard" ], "type": "string" }, "LinkDeliveryProviderRequest": { "type": "object", "properties": { "providerId": { "type": "string", "format": "uuid" }, "username": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OAuthMcpClientRedirectUriWriteRequest": { "type": "object", "properties": { "clientId": { "type": "string", "nullable": true }, "redirectUri": { "type": "string", "nullable": true } }, "additionalProperties": false }, "OpenCashierSessionRequest": { "type": "object", "properties": { "openingCash": { "type": "number", "format": "double" }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentMethod": { "enum": [ "cash", "online", "onlineOnDelivery" ], "type": "string" }, "PaymentStatus": { "enum": [ "pending", "paid", "failed", "refunded" ], "type": "string" }, "PinProductRequest": { "type": "object", "properties": { "storeProductId": { "type": "string", "format": "uuid" }, "sortOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PrintTemplateType": { "enum": [ "invoice", "shippingLabel", "receipt" ], "type": "string" }, "PurchaseOrderItemRequest": { "type": "object", "properties": { "storeProductId": { "type": "string", "format": "uuid" }, "quantity": { "type": "number", "format": "double" }, "unitCost": { "type": "number", "format": "double" }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PurchaseOrderStatus": { "enum": [ "draft", "sent", "partiallyReceived", "received", "cancelled" ], "type": "string" }, "QiCardBrowserInfo": { "type": "object", "properties": { "browserAcceptHeader": { "type": "string", "nullable": true }, "browserIp": { "type": "string", "nullable": true }, "browserJavaEnabled": { "type": "boolean" }, "browserLanguage": { "type": "string", "nullable": true }, "browserUserAgent": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReorderPinnedItemsRequest": { "type": "object", "properties": { "orderedProductIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "SendMessageRequest": { "type": "object", "properties": { "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StoreApiKeyRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "scopes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "StoreNiche": { "enum": [ "general", "flowers", "electronics", "clothing", "food", "pharmacy", "beauty", "books" ], "type": "string" }, "StoreProductCreateRequest": { "type": "object", "properties": { "sku": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "categoryId": { "type": "string", "format": "uuid", "nullable": true }, "barcode": { "type": "string", "nullable": true }, "baseCode": { "type": "string", "nullable": true }, "brand": { "type": "string", "nullable": true }, "unit": { "type": "string", "nullable": true }, "costPrice": { "type": "number", "format": "double", "nullable": true }, "salePrice": { "type": "number", "format": "double", "nullable": true }, "lowStockLimit": { "type": "integer", "format": "int32", "nullable": true }, "isFeatured": { "type": "boolean" }, "isDiscounted": { "type": "boolean" }, "weightKg": { "type": "number", "format": "double", "nullable": true }, "lengthCm": { "type": "number", "format": "double", "nullable": true }, "widthCm": { "type": "number", "format": "double", "nullable": true }, "heightCm": { "type": "number", "format": "double", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "StoreProductUpdateRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "defaultUnitPrice": { "type": "number", "format": "double", "nullable": true }, "isActive": { "type": "boolean", "nullable": true }, "categoryId": { "type": "string", "format": "uuid", "nullable": true }, "barcode": { "type": "string", "nullable": true }, "baseCode": { "type": "string", "nullable": true }, "brand": { "type": "string", "nullable": true }, "unit": { "type": "string", "nullable": true }, "costPrice": { "type": "number", "format": "double", "nullable": true }, "salePrice": { "type": "number", "format": "double", "nullable": true }, "lowStockLimit": { "type": "integer", "format": "int32", "nullable": true }, "isFeatured": { "type": "boolean", "nullable": true }, "isDiscounted": { "type": "boolean", "nullable": true }, "weightKg": { "type": "number", "format": "double", "nullable": true }, "lengthCm": { "type": "number", "format": "double", "nullable": true }, "widthCm": { "type": "number", "format": "double", "nullable": true }, "heightCm": { "type": "number", "format": "double", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "StoreSubscriptionUpgradeCreateRequest": { "type": "object", "properties": { "planId": { "type": "string", "format": "uuid", "nullable": true }, "planCode": { "type": "string", "nullable": true }, "returnUrl": { "type": "string", "nullable": true }, "browserInfo": { "$ref": "#/components/schemas/QiCardBrowserInfo" } }, "additionalProperties": false }, "StoreUpdateProfileRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "lat": { "type": "number", "format": "double", "nullable": true }, "lng": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "StoreWarehouseUpsertRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "lat": { "type": "number", "format": "double", "nullable": true }, "lng": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "StoreWebhookUpsertRequest": { "type": "object", "properties": { "url": { "type": "string", "nullable": true }, "eventTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isEnabled": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "StorefrontSectionItem": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "title": { "type": "string", "nullable": true }, "titleAr": { "type": "string", "nullable": true }, "subtitle": { "type": "string", "nullable": true }, "subtitleAr": { "type": "string", "nullable": true }, "image": { "type": "string", "format": "binary", "nullable": true }, "ctaLabel": { "type": "string", "nullable": true }, "ctaLink": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TenantRbacCreateUserRequest": { "type": "object", "properties": { "fullName": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "storeId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "TenantRbacRoleUpsertRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "storeId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "TicketCategory": { "enum": [ "unspecified", "driver", "delivery", "lastMile", "logistics", "store", "inventory", "merchant", "catalog", "channel", "api", "other" ], "type": "string" }, "TicketCreateRequest": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/TicketStatus" }, "priority": { "$ref": "#/components/schemas/TicketPriority" }, "category": { "$ref": "#/components/schemas/TicketCategory" }, "assignedUserId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "TicketPriority": { "enum": [ "low", "normal", "high", "urgent" ], "type": "string" }, "TicketStatus": { "enum": [ "open", "pending", "inProgress", "new", "closed", "resolved" ], "type": "string" }, "TicketUpdateRequest": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/TicketStatus" }, "priority": { "$ref": "#/components/schemas/TicketPriority" }, "category": { "$ref": "#/components/schemas/TicketCategory" }, "assignedUserId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "ToggleAgentRequest": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "additionalProperties": false }, "UpdateBankDetailsRequest": { "type": "object", "properties": { "bankName": { "type": "string", "nullable": true }, "accountNumber": { "type": "string", "nullable": true }, "iban": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateCashierSettingsRequest": { "type": "object", "properties": { "requireCashCount": { "type": "boolean", "nullable": true }, "cashRounding": { "type": "string", "nullable": true }, "openingCashDefault": { "type": "number", "format": "double", "nullable": true }, "receiptFooterNote": { "type": "string", "nullable": true }, "quickCashAmounts": { "type": "array", "items": { "type": "number", "format": "double" }, "nullable": true } }, "additionalProperties": false }, "UpdateCustomerRequest": { "type": "object", "properties": { "fullName": { "type": "string", "nullable": true }, "primaryPhone": { "type": "string", "nullable": true }, "secondaryPhone": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "addressArea": { "type": "string", "nullable": true }, "addressProvince": { "type": "string", "nullable": true }, "latitude": { "type": "number", "format": "double", "nullable": true }, "longitude": { "type": "number", "format": "double", "nullable": true }, "notes": { "type": "string", "nullable": true }, "isActive": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpdateDiscountCodeRequest": { "type": "object", "properties": { "discountType": { "$ref": "#/components/schemas/DiscountType" }, "discountValue": { "type": "number", "format": "double", "nullable": true }, "minOrderValue": { "type": "number", "format": "double", "nullable": true }, "maxUses": { "type": "integer", "format": "int32", "nullable": true }, "perUserLimit": { "type": "integer", "format": "int32", "nullable": true }, "startsAt": { "type": "string", "format": "date-time", "nullable": true }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true }, "isActive": { "type": "boolean", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateDiscountRuleRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "discountType": { "$ref": "#/components/schemas/DiscountType" }, "discountValue": { "type": "number", "format": "double", "nullable": true }, "categoryId": { "type": "string", "format": "uuid", "nullable": true }, "channels": { "type": "string", "nullable": true }, "isActive": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpdateExpenseRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double", "nullable": true }, "expenseType": { "type": "string", "nullable": true }, "category": { "type": "string", "nullable": true }, "group": { "type": "string", "nullable": true }, "expenseDate": { "type": "string", "format": "date-time", "nullable": true }, "description": { "type": "string", "nullable": true }, "paymentStatus": { "$ref": "#/components/schemas/PaymentStatus" }, "paymentMethod": { "$ref": "#/components/schemas/PaymentMethod" }, "supplierId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "UpdateInventoryItemRequest": { "type": "object", "properties": { "quantityOnHand": { "type": "number", "format": "double" }, "reorderLevel": { "type": "number", "format": "double", "nullable": true }, "isActive": { "type": "boolean" }, "warehouseId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "UpdatePurchaseOrderRequest": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/PurchaseOrderStatus" }, "notes": { "type": "string", "nullable": true }, "additionalFees": { "type": "number", "format": "double", "nullable": true }, "expectedDeliveryDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "UpdateSocialChannelRequest": { "type": "object", "properties": { "displayName": { "type": "string", "nullable": true }, "accessToken": { "type": "string", "nullable": true }, "appSecret": { "type": "string", "nullable": true }, "aiProviderCode": { "type": "string", "nullable": true }, "aiModelCode": { "type": "string", "nullable": true }, "systemPromptOverride": { "type": "string", "nullable": true }, "tokenExpiresAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "UpdateStoreSettingsRequest": { "type": "object", "properties": { "currencyCode": { "type": "string", "nullable": true }, "timezone": { "type": "string", "nullable": true }, "industry": { "type": "string", "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "taxEnabled": { "type": "boolean", "nullable": true }, "taxRate": { "type": "number", "format": "double", "nullable": true }, "taxNumber": { "type": "string", "nullable": true }, "includeShippingInRevenue": { "type": "boolean", "nullable": true }, "allowNegativeStock": { "type": "boolean", "nullable": true }, "enablePackageWeight": { "type": "boolean", "nullable": true }, "enablePackageDimensions": { "type": "boolean", "nullable": true }, "defaultPackageSizeId": { "type": "string", "format": "uuid", "nullable": true }, "defaultDeliveryCompanyId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "UpdateSupplierRequest": { "type": "object", "properties": { "fullName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "primaryPhone": { "type": "string", "nullable": true }, "secondaryPhone": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "isActive": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "UpsertPackageSizeRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "lengthCm": { "type": "number", "format": "double" }, "widthCm": { "type": "number", "format": "double" }, "heightCm": { "type": "number", "format": "double" }, "weightKg": { "type": "number", "format": "double", "nullable": true }, "isDefault": { "type": "boolean" } }, "additionalProperties": false }, "UpsertPrintTemplateRequest": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "templateType": { "$ref": "#/components/schemas/PrintTemplateType" }, "fieldVisibility": { "type": "object", "additionalProperties": { "type": "boolean" }, "nullable": true }, "isDefault": { "type": "boolean" } }, "additionalProperties": false } } } }