{ "openapi": "3.1.0", "info": { "title": "Adyvance public API", "version": "2026-10-01", "description": "Org-bound REST API for integrations (INTEGRATION-05). Authenticate with `Authorization: Bearer ady_live_…` (or `ady_test_…`). A key can do what its scopes allow AND what its creator can do right now. Money is integer paisa. Versioning is additive within /v1; deprecated operations send Deprecation and Sunset headers." }, "servers": [ { "url": "https://app.adyvance.com/_public/v1", "description": "Production" } ], "security": [ { "bearer": [] } ], "paths": { "/orgs/{orgId}/stores/{storeId}/orders": { "get": { "operationId": "public.orders.list", "summary": "List orders", "x-permission": "orders.read", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque keyset cursor from `next_cursor`", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Page size (1–100)", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "status", "in": "query", "required": false, "description": "Order status", "schema": { "type": "string", "enum": [ "draft", "pending", "confirmed", "processing", "ready", "shipped", "delivered", "completed", "cancelled", "returned" ] } }, { "name": "payment_status", "in": "query", "required": false, "description": "Payment status", "schema": { "type": "string", "enum": [ "unpaid", "partial", "paid", "refunded", "partially_refunded", "awaiting_verification", "overpaid" ] } } ], "responses": { "200": { "description": "Success", "headers": { "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } }, "Ady-Livemode": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderList" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key's scopes (or its creator's live permissions) do not allow this", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found, or outside the key's organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (120 requests / 60 s per key, or the key's own lower limit)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/orgs/{orgId}/stores/{storeId}/orders/{orderId}": { "get": { "operationId": "public.orders.get", "summary": "Get an order", "x-permission": "orders.read", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": { "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } }, "Ady-Livemode": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key's scopes (or its creator's live permissions) do not allow this", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found, or outside the key's organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (120 requests / 60 s per key, or the key's own lower limit)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "operationId": "public.orders.update", "summary": "Update an order's note or tags (If-Match: the order's version)", "x-permission": "orders.update", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderPatch" } } } }, "responses": { "200": { "description": "Success", "headers": { "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } }, "Ady-Livemode": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderSummary" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key's scopes (or its creator's live permissions) do not allow this", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found, or outside the key's organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (120 requests / 60 s per key, or the key's own lower limit)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/orgs/{orgId}/stores/{storeId}/products": { "get": { "operationId": "public.products.list", "summary": "List products", "x-permission": "products.read", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque keyset cursor from `next_cursor`", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Page size (1–100)", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "q", "in": "query", "required": false, "description": "Search text", "schema": { "type": "string", "maxLength": 200 } } ], "responses": { "200": { "description": "Success", "headers": { "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } }, "Ady-Livemode": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductList" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key's scopes (or its creator's live permissions) do not allow this", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found, or outside the key's organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (120 requests / 60 s per key, or the key's own lower limit)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "public.products.create", "summary": "Create a product (Idempotency-Key required)", "x-permission": "products.write", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "1–128 characters; a retry with the same key and body replays the stored response", "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCreate" } } } }, "responses": { "201": { "description": "Success", "headers": { "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } }, "Ady-Livemode": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key's scopes (or its creator's live permissions) do not allow this", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found, or outside the key's organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (120 requests / 60 s per key, or the key's own lower limit)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/orgs/{orgId}/stores/{storeId}/products/{productId}": { "get": { "operationId": "public.products.get", "summary": "Get a product", "x-permission": "products.read", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": { "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } }, "Ady-Livemode": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key's scopes (or its creator's live permissions) do not allow this", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found, or outside the key's organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (120 requests / 60 s per key, or the key's own lower limit)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "operationId": "public.products.update", "summary": "Update a product (If-Match: the product's version)", "x-permission": "products.write", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductPatch" } } } }, "responses": { "200": { "description": "Success", "headers": { "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } }, "Ady-Livemode": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key's scopes (or its creator's live permissions) do not allow this", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found, or outside the key's organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (120 requests / 60 s per key, or the key's own lower limit)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/orgs/{orgId}/stores/{storeId}/customers": { "get": { "operationId": "public.customers.list", "summary": "List customers", "x-permission": "customers.read", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque keyset cursor from `next_cursor`", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Page size (1–100)", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "q", "in": "query", "required": false, "description": "Name, email or phone", "schema": { "type": "string", "maxLength": 100 } } ], "responses": { "200": { "description": "Success", "headers": { "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } }, "Ady-Livemode": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerList" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key's scopes (or its creator's live permissions) do not allow this", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found, or outside the key's organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (120 requests / 60 s per key, or the key's own lower limit)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/orgs/{orgId}/stores/{storeId}/customers/{customerId}": { "get": { "operationId": "public.customers.get", "summary": "Get a customer", "x-permission": "customers.read", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": { "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } }, "Ady-Livemode": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Customer" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key's scopes (or its creator's live permissions) do not allow this", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found, or outside the key's organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (120 requests / 60 s per key, or the key's own lower limit)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/orgs/{orgId}/stores/{storeId}/inventory": { "get": { "operationId": "public.inventory.list", "summary": "List inventory levels", "x-permission": "inventory.read", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "required": false, "description": "Opaque keyset cursor from `next_cursor`", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": false, "description": "Page size (1–100)", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "low", "in": "query", "required": false, "description": "Only low or out of stock", "schema": { "type": "string", "enum": [ "true", "false" ] } } ], "responses": { "200": { "description": "Success", "headers": { "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } }, "Ady-Livemode": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryList" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key's scopes (or its creator's live permissions) do not allow this", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found, or outside the key's organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (120 requests / 60 s per key, or the key's own lower limit)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/orgs/{orgId}/stores/{storeId}/orders/{orderId}/transitions": { "post": { "operationId": "public.orders.transition", "summary": "Change an order's status (Idempotency-Key required)", "x-permission": "orders.update", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "1–128 characters; a retry with the same key and body replays the stored response", "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderTransition" } } } }, "responses": { "200": { "description": "Success", "headers": { "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } }, "Ady-Livemode": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderSummary" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key's scopes (or its creator's live permissions) do not allow this", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found, or outside the key's organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (120 requests / 60 s per key, or the key's own lower limit)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/orgs/{orgId}/stores/{storeId}/variants/{variantId}": { "patch": { "operationId": "public.variants.update", "summary": "Update a variant's price, SKU or availability (If-Match: the product's version)", "x-permission": "products.write", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "variantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariantPatch" } } } }, "responses": { "200": { "description": "Success", "headers": { "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } }, "Ady-Livemode": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": {} } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key's scopes (or its creator's live permissions) do not allow this", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found, or outside the key's organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (120 requests / 60 s per key, or the key's own lower limit)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/orgs/{orgId}/stores/{storeId}/categories": { "get": { "operationId": "public.categories.list", "summary": "List product categories", "x-permission": "products.read", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": { "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } }, "Ady-Livemode": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ], "additionalProperties": {} } } }, "required": [ "data" ], "additionalProperties": {} } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key's scopes (or its creator's live permissions) do not allow this", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found, or outside the key's organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (120 requests / 60 s per key, or the key's own lower limit)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/orgs/{orgId}/inventory/adjustments": { "post": { "operationId": "public.inventory.adjust", "summary": "Adjust stock or set it to a count (Idempotency-Key required)", "x-permission": "inventory.adjust", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "1–128 characters; a retry with the same key and body replays the stored response", "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryAdjustment" } } } }, "responses": { "201": { "description": "Success", "headers": { "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } }, "Ady-Livemode": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "variant_id": { "type": "string" }, "on_hand": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "variant_id", "on_hand" ], "additionalProperties": {} } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key's scopes (or its creator's live permissions) do not allow this", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found, or outside the key's organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (120 requests / 60 s per key, or the key's own lower limit)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/orgs/{orgId}/webhooks": { "get": { "operationId": "public.webhooks.list", "summary": "List webhook endpoints", "x-permission": "webhooks.manage", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "headers": { "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } }, "Ady-Livemode": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointList" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key's scopes (or its creator's live permissions) do not allow this", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found, or outside the key's organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (120 requests / 60 s per key, or the key's own lower limit)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "public.webhooks.create", "summary": "Create a webhook endpoint", "x-permission": "webhooks.manage", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "description": "1–128 characters; a retry with the same key and body replays the stored response", "schema": { "type": "string", "minLength": 1, "maxLength": 128 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookCreate" } } } }, "responses": { "201": { "description": "Success", "headers": { "RateLimit-Limit": { "schema": { "type": "integer" } }, "RateLimit-Remaining": { "schema": { "type": "integer" } }, "RateLimit-Reset": { "schema": { "type": "integer" } }, "Ady-Livemode": { "schema": { "type": "string", "enum": [ "true", "false" ] } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointCreated" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing, invalid, revoked or expired API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The key's scopes (or its creator's live permissions) do not allow this", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found, or outside the key's organization", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (120 requests / 60 s per key, or the key's own lower limit)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "securitySchemes": { "bearer": { "type": "http", "scheme": "bearer", "bearerFormat": "ady_live_ / ady_test_ API key" } }, "schemas": { "Customer": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "phone": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "orders_count": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "ltv_paisa": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Integer paisa (1 NPR = 100 paisa)" }, "last_order_at": { "anyOf": [ { "type": "string", "description": "ISO-8601 UTC timestamp" }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "created_at": { "type": "string", "description": "ISO-8601 UTC timestamp" } }, "required": [ "id", "name", "phone", "email", "tags", "orders_count", "ltv_paisa", "last_order_at", "version", "created_at" ], "additionalProperties": {} }, "CustomerList": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "phone": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "orders_count": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "ltv_paisa": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Integer paisa (1 NPR = 100 paisa)" }, "last_order_at": { "anyOf": [ { "type": "string", "description": "ISO-8601 UTC timestamp" }, { "type": "null" } ] }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "created_at": { "type": "string", "description": "ISO-8601 UTC timestamp" } }, "required": [ "id", "name", "phone", "email", "tags", "orders_count", "ltv_paisa", "last_order_at", "version", "created_at" ], "additionalProperties": {} } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "data", "next_cursor" ], "additionalProperties": {} }, "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "fields": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false }, "InventoryAdjustment": { "type": "object", "properties": { "variant_id": { "type": "string" }, "location_id": { "type": "string" }, "delta": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "set_to": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "reason": { "type": "string", "enum": [ "adjust", "stock_in", "count", "return" ] }, "note": { "type": "string", "maxLength": 500 } }, "required": [ "variant_id", "reason" ], "additionalProperties": false }, "InventoryList": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "variant_id": { "type": "string" }, "product_id": { "type": "string" }, "sku": { "type": [ "string", "null" ] }, "on_hand": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "reserved": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "available": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "state": { "type": "string", "enum": [ "in_stock", "low", "out_of_stock", "untracked" ] }, "levels": { "type": "array", "items": { "type": "object", "properties": { "location_id": { "type": "string" }, "on_hand": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "reserved": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "available": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updated_at": { "anyOf": [ { "type": "string", "description": "ISO-8601 UTC timestamp" }, { "type": "null" } ] } }, "required": [ "location_id", "on_hand", "reserved", "available", "updated_at" ], "additionalProperties": false } } }, "required": [ "variant_id", "product_id", "sku", "on_hand", "reserved", "available", "state", "levels" ], "additionalProperties": {} } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "data", "next_cursor" ], "additionalProperties": {} }, "Order": { "type": "object", "properties": { "id": { "type": "string" }, "number": { "type": "string" }, "channel": { "type": "string", "enum": [ "web", "pos", "manual", "headless", "marketplace", "ai" ] }, "status": { "type": "string", "enum": [ "draft", "pending", "confirmed", "processing", "ready", "shipped", "delivered", "completed", "cancelled", "returned" ] }, "payment_status": { "type": "string", "enum": [ "unpaid", "partial", "paid", "refunded", "partially_refunded", "awaiting_verification", "overpaid" ] }, "fulfilment_status": { "type": "string" }, "payment_method": { "type": "string" }, "customer_id": { "type": [ "string", "null" ] }, "contact": { "type": "object", "properties": { "name": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": [ "string", "null" ] } }, "required": [ "name", "phone", "email" ], "additionalProperties": false }, "total_paisa": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Integer paisa (1 NPR = 100 paisa)" }, "due_paisa": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Integer paisa (1 NPR = 100 paisa)" }, "is_test": { "type": "boolean" }, "placed_at": { "anyOf": [ { "type": "string", "description": "ISO-8601 UTC timestamp" }, { "type": "null" } ] }, "updated_at": { "type": "string", "description": "ISO-8601 UTC timestamp" }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totals": { "type": "object", "properties": { "subtotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Integer paisa (1 NPR = 100 paisa)" }, "discount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Integer paisa (1 NPR = 100 paisa)" }, "delivery": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Integer paisa (1 NPR = 100 paisa)" }, "surcharge": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Integer paisa (1 NPR = 100 paisa)" }, "tax": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Integer paisa (1 NPR = 100 paisa)" }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Integer paisa (1 NPR = 100 paisa)" } }, "required": [ "subtotal", "discount", "delivery", "surcharge", "tax", "total" ], "additionalProperties": {} }, "lines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "variant_id": { "type": "string" }, "title": { "type": "string" }, "qty": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "unit_price_paisa": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Integer paisa (1 NPR = 100 paisa)" }, "line_total_paisa": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Integer paisa (1 NPR = 100 paisa)" } }, "required": [ "id", "variant_id", "title", "qty", "unit_price_paisa", "line_total_paisa" ], "additionalProperties": {} } } }, "required": [ "id", "number", "channel", "status", "payment_status", "fulfilment_status", "payment_method", "customer_id", "contact", "total_paisa", "due_paisa", "is_test", "placed_at", "updated_at", "version", "totals", "lines" ], "additionalProperties": {} }, "OrderList": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "number": { "type": "string" }, "channel": { "type": "string", "enum": [ "web", "pos", "manual", "headless", "marketplace", "ai" ] }, "status": { "type": "string", "enum": [ "draft", "pending", "confirmed", "processing", "ready", "shipped", "delivered", "completed", "cancelled", "returned" ] }, "payment_status": { "type": "string", "enum": [ "unpaid", "partial", "paid", "refunded", "partially_refunded", "awaiting_verification", "overpaid" ] }, "fulfilment_status": { "type": "string" }, "payment_method": { "type": "string" }, "customer_id": { "type": [ "string", "null" ] }, "contact": { "type": "object", "properties": { "name": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": [ "string", "null" ] } }, "required": [ "name", "phone", "email" ], "additionalProperties": false }, "total_paisa": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Integer paisa (1 NPR = 100 paisa)" }, "due_paisa": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Integer paisa (1 NPR = 100 paisa)" }, "is_test": { "type": "boolean" }, "placed_at": { "anyOf": [ { "type": "string", "description": "ISO-8601 UTC timestamp" }, { "type": "null" } ] }, "updated_at": { "type": "string", "description": "ISO-8601 UTC timestamp" }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "number", "channel", "status", "payment_status", "fulfilment_status", "payment_method", "customer_id", "contact", "total_paisa", "due_paisa", "is_test", "placed_at", "updated_at", "version" ], "additionalProperties": {} } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "data", "next_cursor" ], "additionalProperties": {} }, "OrderPatch": { "type": "object", "properties": { "note": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] }, "tags": { "maxItems": 20, "type": "array", "items": { "type": "string", "maxLength": 40 } } }, "additionalProperties": false }, "OrderSummary": { "type": "object", "properties": { "id": { "type": "string" }, "number": { "type": "string" }, "channel": { "type": "string", "enum": [ "web", "pos", "manual", "headless", "marketplace", "ai" ] }, "status": { "type": "string", "enum": [ "draft", "pending", "confirmed", "processing", "ready", "shipped", "delivered", "completed", "cancelled", "returned" ] }, "payment_status": { "type": "string", "enum": [ "unpaid", "partial", "paid", "refunded", "partially_refunded", "awaiting_verification", "overpaid" ] }, "fulfilment_status": { "type": "string" }, "payment_method": { "type": "string" }, "customer_id": { "type": [ "string", "null" ] }, "contact": { "type": "object", "properties": { "name": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": [ "string", "null" ] } }, "required": [ "name", "phone", "email" ], "additionalProperties": false }, "total_paisa": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Integer paisa (1 NPR = 100 paisa)" }, "due_paisa": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Integer paisa (1 NPR = 100 paisa)" }, "is_test": { "type": "boolean" }, "placed_at": { "anyOf": [ { "type": "string", "description": "ISO-8601 UTC timestamp" }, { "type": "null" } ] }, "updated_at": { "type": "string", "description": "ISO-8601 UTC timestamp" }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "number", "channel", "status", "payment_status", "fulfilment_status", "payment_method", "customer_id", "contact", "total_paisa", "due_paisa", "is_test", "placed_at", "updated_at", "version" ], "additionalProperties": {} }, "OrderTransition": { "type": "object", "properties": { "to": { "type": "string", "enum": [ "draft", "pending", "confirmed", "processing", "ready", "shipped", "delivered", "completed", "cancelled", "returned" ] }, "reason": { "type": "string", "maxLength": 500 } }, "required": [ "to" ], "additionalProperties": false }, "Product": { "type": "object", "properties": { "id": { "type": "string" }, "store_id": { "type": "string" }, "title": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "string" }, "channels": { "type": "array", "items": { "type": "string" } }, "variants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "sku": { "type": [ "string", "null" ] }, "price_paisa": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Integer paisa (1 NPR = 100 paisa)" }, "compare_at_paisa": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Integer paisa (1 NPR = 100 paisa)" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "title", "sku", "price_paisa", "compare_at_paisa", "active", "version" ], "additionalProperties": {} } }, "created_at": { "type": "string", "description": "ISO-8601 UTC timestamp" }, "updated_at": { "type": "string", "description": "ISO-8601 UTC timestamp" }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "store_id", "title", "slug", "status", "channels", "variants", "created_at", "updated_at", "version" ], "additionalProperties": {} }, "ProductCreate": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 200 }, "status": { "type": "string", "enum": [ "draft", "active", "archived", "unlisted" ] }, "description_html": { "type": "string", "maxLength": 60000 }, "variants": { "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "price_paisa": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Integer paisa (1 NPR = 100 paisa)" }, "sku": { "type": "string" } }, "required": [ "price_paisa" ], "additionalProperties": {} } } }, "required": [ "title", "variants" ], "additionalProperties": {} }, "ProductList": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "string" }, "channels": { "type": "array", "items": { "type": "string" } }, "price_min_paisa": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Integer paisa (1 NPR = 100 paisa)" }, "price_max_paisa": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Integer paisa (1 NPR = 100 paisa)" }, "variant_count": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "image": { "anyOf": [ { "type": "object", "properties": { "asset_id": { "type": "string" } }, "required": [ "asset_id" ], "additionalProperties": {} }, { "type": "null" } ] }, "updated_at": { "type": "string", "description": "ISO-8601 UTC timestamp" }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "title", "slug", "status", "channels", "price_min_paisa", "price_max_paisa", "variant_count", "image", "updated_at", "version" ], "additionalProperties": {} } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "data", "next_cursor" ], "additionalProperties": {} }, "ProductPatch": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 200 } }, "additionalProperties": {} }, "VariantPatch": { "type": "object", "properties": { "price_paisa": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Integer paisa (1 NPR = 100 paisa)" }, "compare_at_paisa": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991, "description": "Integer paisa (1 NPR = 100 paisa)" }, { "type": "null" } ] }, "sku": { "type": [ "string", "null" ] }, "active": { "type": "boolean" } }, "additionalProperties": {} }, "WebhookCreate": { "type": "object", "properties": { "url": { "type": "string", "description": "https only; validated against the SSRF policy" }, "events": { "minItems": 1, "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "product.created", "product.updated", "product.deleted", "inventory.movement", "inventory.level_changed", "order.created", "order.status_changed", "order.edited", "payment.state_changed", "customer.created", "pos.sale_completed", "order.confirmed", "order.cancelled", "payment_session.expired", "refund.created", "shipment.booked", "shipment.state_changed", "return.created", "return.refunded", "return.closed", "invoice.issued", "cod.remittance_posted", "settlement.matched", "import.completed", "export.completed", "inventory.transfer_sent", "inventory.transfer_received", "pos.shift_closed", "customer.updated", "customer.anonymized", "consent.changed", "subscription.changed", "wallet.balance_changed", "campaign.completed", "stock_alert.triggered" ] }, { "type": "string", "const": "*" } ] } }, "description": { "type": "string", "maxLength": 200 } }, "required": [ "url", "events" ], "additionalProperties": false }, "WebhookEndpointCreated": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "description": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "state": { "type": "string", "enum": [ "active", "disabled", "auto_disabled" ] }, "consecutive_failures": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "created_at": { "type": "string", "description": "ISO-8601 UTC timestamp" }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "secret": { "description": "`whsec_…`, returned once. An Idempotency-Key replay returns null here.", "type": [ "string", "null" ] } }, "required": [ "id", "url", "description", "events", "state", "consecutive_failures", "created_at", "version", "secret" ], "additionalProperties": {} }, "WebhookEndpointList": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "description": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "state": { "type": "string", "enum": [ "active", "disabled", "auto_disabled" ] }, "consecutive_failures": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "created_at": { "type": "string", "description": "ISO-8601 UTC timestamp" }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "url", "description", "events", "state", "consecutive_failures", "created_at", "version" ], "additionalProperties": {} } }, "next_cursor": { "type": [ "string", "null" ] } }, "required": [ "data", "next_cursor" ], "additionalProperties": {} } } } }