{ "openapi": "3.1.1", "info": { "title": "Ecomiq Admin API", "version": "1.0.0", "description": "Back-office API for organizations, stores, catalog, inventory, customers, orders, fulfillment, shipping, payments, promotions, and webhooks." }, "paths": { "/v1/api-keys": { "get": { "tags": [ "Platform & Identity" ], "summary": "List API keys", "description": "Returns the API keys visible to the current user. Plaintext key values are never returned.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKeyDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "api_key:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "API Keys", "operationId": "getV1ApiKeys", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "post": { "tags": [ "Platform & Identity" ], "summary": "Create an API key", "description": "Creates an API key and returns its plaintext value once. This does not create an OAuth application, and documented Admin, Storefront, and Auth operations do not accept this key.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyRequest" }, "example": { "name": "ERP de producción", "isTestMode": false, "scopes": [ "api_admin" ], "allowedIps": [ "203.0.113.10" ], "expiresAt": null, "applicationUrl": "https://erp.example.com" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "api_key:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "API Keys", "operationId": "postV1ApiKeys", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/api-keys/{id}": { "delete": { "tags": [ "Platform & Identity" ], "summary": "Revoke an API key", "description": "Revokes the selected API key so it can no longer authenticate requests.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "api_key:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "API Keys", "operationId": "deleteV1ApiKeysId", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/organizations": { "post": { "tags": [ "Platform & Identity" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Organizations", "summary": "Create organization", "operationId": "postV1Organizations", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Platform & Identity" ], "description": "Returns the list of organizations for the current user", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Organizations", "summary": "List organizations", "operationId": "getV1Organizations", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/stores": { "post": { "tags": [ "Platform & Identity" ], "description": "Create a new store", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateStoreRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreItemDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Stores", "summary": "Create store", "operationId": "postV1Stores", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Platform & Identity" ], "description": "Retrieve list of stores", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Stores", "summary": "List stores", "operationId": "getV1Stores", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/stores/{slug}": { "get": { "tags": [ "Platform & Identity" ], "operationId": "GetStoreBySlug", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" }, "description": "URL-friendly identifier." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreContextDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [], "x-ecomiq-anonymous": true, "x-ecomiq-resource": "Stores", "summary": "Get store by slug", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/stores/{storeId}": { "get": { "tags": [ "Platform & Identity" ], "operationId": "GetStoreById", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreContextDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Stores", "summary": "Get store by ID", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/stores/{storeId}/select": { "post": { "tags": [ "Platform & Identity" ], "description": "Retrieve list of stores", "parameters": [ { "name": "storeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Stores", "summary": "Select store", "operationId": "postV1StoresStoreidSelect", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/stores/domain/{domain}": { "get": { "tags": [ "Platform & Identity" ], "operationId": "GetStoreByDomain", "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "alternativeDomain", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreContextDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [], "x-ecomiq-anonymous": true, "x-ecomiq-resource": "Stores", "summary": "Get store by domain", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/stores/domains": { "post": { "tags": [ "Platform & Identity" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreDomainRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreDomainDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Stores", "summary": "Create store domain", "operationId": "postV1StoresDomains", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Platform & Identity" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StoreDomainDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Stores", "summary": "List store domains", "operationId": "getV1StoresDomains", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/stores/domains/{domainId}": { "delete": { "tags": [ "Platform & Identity" ], "parameters": [ { "name": "domainId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Stores", "summary": "Delete store domain", "operationId": "deleteV1StoresDomainsDomainid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/stores/exists/{slug}": { "get": { "tags": [ "Platform & Identity" ], "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" }, "description": "URL-friendly identifier." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreSlugCheckDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Stores", "summary": "Check store exists", "operationId": "getV1StoresExistsSlug", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/stores/settings": { "get": { "tags": [ "Platform & Identity" ], "description": "Get store settings", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreSettingsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Stores", "summary": "Get store settings", "operationId": "getV1StoresSettings", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Platform & Identity" ], "description": "Update store settings", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreSettingsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreSettingsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Stores", "summary": "Update store settings", "operationId": "putV1StoresSettings", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/stores/settings/snapshot/refresh": { "post": { "tags": [ "Platform & Identity" ], "description": "Refresh store settings snapshot in Redis and Cloudflare KV", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Stores", "summary": "Refresh store settings snapshot", "operationId": "postV1StoresSettingsSnapshotRefresh", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/stores/slug": { "patch": { "tags": [ "Platform & Identity" ], "description": "Update store slug and its default platform subdomain", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreSlugRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreSlugDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Stores", "summary": "Update store slug", "operationId": "patchV1StoresSlug", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/brands": { "post": { "tags": [ "Catalog" ], "summary": "Create brand", "description": "Create a new brand in the catalog", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Brands", "operationId": "postV1CatalogBrands", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Catalog" ], "summary": "List brands", "description": "Retrieve a paginated list of brands with optional filtering", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "ids", "in": "query", "schema": { "type": "array" } }, { "name": "isActive", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedItemsOfBrandDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Brands", "operationId": "getV1CatalogBrands", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/brands/{brandId}": { "delete": { "tags": [ "Catalog" ], "summary": "Delete a brand", "description": "Delete an existing brand (only if it has no associated products)", "parameters": [ { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:delete" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Brands", "operationId": "deleteV1CatalogBrandsBrandid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Catalog" ], "summary": "Get brand by ID", "description": "Retrieve a specific brand by its ID", "parameters": [ { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Brands", "operationId": "getV1CatalogBrandsBrandid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Catalog" ], "summary": "Update a brand", "description": "Update an existing brand", "parameters": [ { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Brands", "operationId": "putV1CatalogBrandsBrandid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/brands/exports": { "post": { "tags": [ "Catalog" ], "summary": "Queue a brands export", "description": "Queues a brand export. Returns a job; the file becomes downloadable once it completes.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrandExportRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Brands", "operationId": "postV1CatalogBrandsExports", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/brands/import": { "post": { "tags": [ "Catalog" ], "summary": "Queue a brands import", "description": "Queues a brand import from a file. Returns a job you poll for progress.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "assetId": { "type": [ "null", "string" ] } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "assetId": { "type": [ "null", "string" ] } } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Brands", "operationId": "postV1CatalogBrandsImport", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/brands/suggests": { "get": { "tags": [ "Catalog" ], "summary": "Suggests brands", "description": "Retrieve a suggest of brands", "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BrandItemDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Brands", "operationId": "getV1CatalogBrandsSuggests", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/categories": { "post": { "tags": [ "Catalog" ], "description": "Create a new category in the catalog", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Categories", "summary": "Create category", "operationId": "postV1CatalogCategories", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Catalog" ], "summary": "List categories", "description": "Retrieve a paginated list of categories with optional parent filtering", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "parentId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "ids", "in": "query", "schema": { "type": "array" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfCategoryDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Categories", "operationId": "getV1CatalogCategories", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/categories/{categoryId}": { "delete": { "tags": [ "Catalog" ], "summary": "Delete a category", "description": "Delete an existing category (only if it has no subcategories or associated products)", "parameters": [ { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:delete" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Categories", "operationId": "deleteV1CatalogCategoriesCategoryid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Catalog" ], "summary": "Get category by ID", "description": "Retrieve a specific category by its ID", "parameters": [ { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Categories", "operationId": "getV1CatalogCategoriesCategoryid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Catalog" ], "summary": "Update a category", "description": "Update an existing category", "parameters": [ { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Categories", "operationId": "putV1CatalogCategoriesCategoryid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/categories/exports": { "post": { "tags": [ "Catalog" ], "summary": "Queue a categories export", "description": "Queues a category export. Returns a job; the file becomes downloadable once it completes.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Command" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Categories", "operationId": "postV1CatalogCategoriesExports", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/categories/import": { "post": { "tags": [ "Catalog" ], "summary": "Queue a categories import", "description": "Queues a category import from a file. Returns a job you poll for progress.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "assetId": { "type": [ "null", "string" ] } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "assetId": { "type": [ "null", "string" ] } } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Categories", "operationId": "postV1CatalogCategoriesImport", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/categories/suggests": { "get": { "tags": [ "Catalog" ], "summary": "Suggest categories", "description": "Retrieve a suggest of categories", "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryItemDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Categories", "operationId": "getV1CatalogCategoriesSuggests", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/categories/tree": { "get": { "tags": [ "Catalog" ], "summary": "Get categories tree", "description": "Retrieve a hierarchical tree of categories", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryTreeDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Categories", "operationId": "getV1CatalogCategoriesTree", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Catalog" ], "summary": "Update categories tree", "description": "Update the hierarchical structure of categories", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoryTreeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Categories", "operationId": "putV1CatalogCategoriesTree", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/collections": { "post": { "tags": [ "Catalog" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Collections", "summary": "Create collection", "operationId": "postV1CatalogCollections", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Catalog" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "type", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfCollectionType" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfCollectionStatus" } }, { "name": "types", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfCollectionType" } } }, { "name": "statuses", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfCollectionStatus" } } }, { "name": "excludeTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfCollectionType" } } }, { "name": "excludeStatuses", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfCollectionStatus" } } }, { "name": "ids", "in": "query", "schema": { "type": "array" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfCollectionItemDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Collections", "summary": "List collections", "operationId": "getV1CatalogCollections", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/collections/{collectionId}": { "delete": { "tags": [ "Catalog" ], "parameters": [ { "name": "collectionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:delete" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Collections", "summary": "Delete collection", "operationId": "deleteV1CatalogCollectionsCollectionid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Catalog" ], "summary": "Get collection", "description": "Returns collection metadata, rules, overrides and counts. Product rows are available separately through the paginated collection products endpoint.", "parameters": [ { "name": "collectionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Collections", "operationId": "getV1CatalogCollectionsCollectionid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Catalog" ], "parameters": [ { "name": "collectionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Collections", "summary": "Update collection", "operationId": "putV1CatalogCollectionsCollectionid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/collections/{collectionId}/products": { "get": { "tags": [ "Catalog" ], "summary": "List collection products", "description": "Returns a paginated product summary for a collection. Use this endpoint to render collection products instead of loading raw product IDs from the collection detail.", "parameters": [ { "name": "collectionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfCollectionProductItemDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Collections", "operationId": "getV1CatalogCollectionsCollectionidProducts", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Catalog" ], "summary": "Set collection products", "description": "Replaces the manual product assignments for a static collection. Use product IDs only on write operations.", "parameters": [ { "name": "collectionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetCollectionProductsRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Collections", "operationId": "putV1CatalogCollectionsCollectionidProducts", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/collections/exports": { "post": { "tags": [ "Catalog" ], "summary": "Queue a collections export", "description": "Queues a collection export. Returns a job; the file becomes downloadable once it completes.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Command" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Collections", "operationId": "postV1CatalogCollectionsExports", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/collections/import": { "post": { "tags": [ "Catalog" ], "summary": "Queue a collections import", "description": "Queues a collection import from a file. Returns a job you poll for progress.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "assetId": { "type": [ "null", "string" ] } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "assetId": { "type": [ "null", "string" ] } } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Collections", "operationId": "postV1CatalogCollectionsImport", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/collections/preview-count": { "post": { "tags": [ "Catalog" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Collections", "summary": "Create collection preview count", "operationId": "postV1CatalogCollectionsPreviewCount", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/price-history": { "get": { "tags": [ "Catalog" ], "summary": "List price history", "description": "Returns how a product's price changed over time, with the date of each change.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "productId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "variantId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "reason", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfPriceChangeReason" } }, { "name": "fromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "toDate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfPriceHistoryDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Price History", "operationId": "getV1CatalogPriceHistory", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/price-lists": { "post": { "tags": [ "Catalog" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceListRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Price Lists", "summary": "Create price list", "operationId": "postV1CatalogPriceLists", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Catalog" ], "parameters": [ { "name": "productId", "in": "query", "schema": { "type": [ "null", "string" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PriceListDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Price Lists", "summary": "List price lists", "operationId": "getV1CatalogPriceLists", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/price-lists/{priceListId}": { "put": { "tags": [ "Catalog" ], "parameters": [ { "name": "priceListId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceListRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Price Lists", "summary": "Update price list", "operationId": "putV1CatalogPriceListsPricelistid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/product-reviews": { "get": { "tags": [ "Catalog" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "productId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "customerId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "rating", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfReviewDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Product Reviews", "summary": "List product reviews", "operationId": "getV1CatalogProductReviews", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/product-reviews/{reviewId}": { "get": { "tags": [ "Catalog" ], "parameters": [ { "name": "reviewId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Product Reviews", "summary": "Get product review", "operationId": "getV1CatalogProductReviewsReviewid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/product-reviews/{reviewId}/status": { "patch": { "tags": [ "Catalog" ], "parameters": [ { "name": "reviewId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewStatusRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Product Reviews", "summary": "Update product review status", "operationId": "patchV1CatalogProductReviewsReviewidStatus", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products": { "post": { "tags": [ "Catalog" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCreateRequest" }, "example": { "name": "Polo de algodón", "sku": "POL-001", "price": 89, "minOrderQuantity": 1, "isDigital": false } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "summary": "Create product", "operationId": "postV1CatalogProducts", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Catalog" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "productIds", "in": "query", "schema": { "type": "array" } }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfProductStatus" } } }, { "name": "excludeStatus", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfProductStatus" } } }, { "name": "includeArchived", "in": "query", "schema": { "type": "boolean" } }, { "name": "categoryIds", "in": "query", "schema": { "type": "array" } }, { "name": "excludeCategoryIds", "in": "query", "schema": { "type": "array" } }, { "name": "brandIds", "in": "query", "schema": { "type": "array" } }, { "name": "excludeBrandIds", "in": "query", "schema": { "type": "array" } }, { "name": "storeIds", "in": "query", "schema": { "type": "array" } }, { "name": "sellerIds", "in": "query", "schema": { "type": "array" } }, { "name": "excludeSellerIds", "in": "query", "schema": { "type": "array" } }, { "name": "skuIds", "in": "query", "schema": { "type": "array" } }, { "name": "skus", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "types", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfProductType" } } }, { "name": "excludeTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfProductType" } } }, { "name": "isFeatured", "in": "query", "schema": { "type": "boolean" } }, { "name": "ean", "in": "query", "schema": { "type": "string" } }, { "name": "minPrice", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "maxPrice", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "minOnHand", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "maxOnHand", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "minAvailable", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "tags", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "excludeTags", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "includeVariants", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeTotalCount", "in": "query", "schema": { "type": "boolean" } }, { "name": "projection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfProductListProjection" } }, { "name": "channelId", "in": "query", "schema": { "type": [ "null", "string" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfProductItemDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "summary": "List products", "operationId": "getV1CatalogProducts", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products/{productId}": { "delete": { "tags": [ "Catalog" ], "summary": "Delete a product", "description": "Delete an existing product", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:delete" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "operationId": "deleteV1CatalogProductsProductid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Catalog" ], "summary": "Get product by ID", "description": "Retrieve a specific product by ID", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "operationId": "getV1CatalogProductsProductid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Catalog" ], "operationId": "UpdateProduct", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductUpdateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Success" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "summary": "Update product", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products/{productId}/activity": { "get": { "tags": [ "Catalog" ], "summary": "List product activity", "description": "Returns the audit trail of a product: what changed, when and who changed it.", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "variantId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "locationId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "source", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfProductActivitySource" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfProductActivityItemDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "operationId": "getV1CatalogProductsProductidActivity", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products/{productId}/commission": { "get": { "tags": [ "Catalog" ], "summary": "Get product commission", "description": "Returns the commission that applies to a product, resolved from the rules configured for its seller and category.", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCommissionDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "operationId": "getV1CatalogProductsProductidCommission", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products/{productId}/modifier-groups": { "post": { "tags": [ "Catalog" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateModifierGroupRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "summary": "Create product modifier group", "operationId": "postV1CatalogProductsProductidModifierGroups", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products/{productId}/modifier-groups/{id}": { "delete": { "tags": [ "Catalog" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:delete" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "summary": "Delete product modifier group", "operationId": "deleteV1CatalogProductsProductidModifierGroupsId", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Catalog" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateModifierGroupRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "summary": "Update product modifier group", "operationId": "putV1CatalogProductsProductidModifierGroupsId", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products/{productId}/price-lists": { "get": { "tags": [ "Catalog" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PriceListDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "summary": "List product price lists", "operationId": "getV1CatalogProductsProductidPriceLists", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products/{productId}/reviews": { "post": { "tags": [ "Catalog" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "summary": "Create product review", "operationId": "postV1CatalogProductsProductidReviews", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products/{productId}/size-guide": { "get": { "tags": [ "Catalog" ], "summary": "Get product size guide", "description": "Returns the size guide that applies to a product, whether attached directly or inherited from an assignment.", "operationId": "GetProductSizeGuide", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "gender", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfCatalogGender" } }, { "name": "measurementType", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSizeGuideMeasurementType" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SizeGuideItemDto" } } } }, "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Catalog" ], "summary": "Set product size guide", "description": "Attaches a size guide to a product. Replaces any guide already attached.", "operationId": "SetProductSizeGuide", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSizeGuideRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products/{productId}/variants": { "post": { "tags": [ "Catalog" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVariantRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "summary": "Create product variant", "operationId": "postV1CatalogProductsProductidVariants", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Catalog" ], "summary": "List product variants", "description": "Lists the variants of a product with their own SKU, price and stock.", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "optionKey", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "optionValue", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfProductVariantListItemDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "operationId": "getV1CatalogProductsProductidVariants", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products/{productId}/variants/{variantId}": { "delete": { "tags": [ "Catalog" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "variantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:delete" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "summary": "Delete product variant", "operationId": "deleteV1CatalogProductsProductidVariantsVariantid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Catalog" ], "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "variantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVariantRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Success" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "summary": "Update product variant", "operationId": "putV1CatalogProductsProductidVariantsVariantid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products/batch/delete": { "post": { "tags": [ "Catalog" ], "summary": "Queue a product batch delete", "description": "Queues the deletion of several products. Returns immediately with a job; deletion happens in the background.", "operationId": "BatchDeleteProducts", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductDeleteBatchRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueuedOperationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:delete" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products/batch/prices": { "post": { "tags": [ "Catalog" ], "operationId": "BatchUpdateProductPrices", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductPriceBatchRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueuedOperationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "summary": "Batch update product prices", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products/batch/status": { "patch": { "tags": [ "Catalog" ], "operationId": "BatchUpdateProductStatus", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductStatusBatchRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueuedOperationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "summary": "Batch update product status", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products/batch/status-by-filters": { "patch": { "tags": [ "Catalog" ], "operationId": "BatchUpdateFilteredProductStatus", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductStatusFilterBatchRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueuedOperationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "summary": "Batch update filtered product status", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products/count": { "get": { "tags": [ "Catalog" ], "summary": "Count products", "description": "Returns how many products match a filter, without returning them. Cheaper than paging through a listing when you only need the number.", "operationId": "CountProducts", "parameters": [ { "name": "productIds", "in": "query", "schema": { "type": "array" } }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfProductStatus" } } }, { "name": "excludeStatus", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfProductStatus" } } }, { "name": "includeArchived", "in": "query", "schema": { "type": "boolean" } }, { "name": "categoryIds", "in": "query", "schema": { "type": "array" } }, { "name": "excludeCategoryIds", "in": "query", "schema": { "type": "array" } }, { "name": "brandIds", "in": "query", "schema": { "type": "array" } }, { "name": "excludeBrandIds", "in": "query", "schema": { "type": "array" } }, { "name": "storeIds", "in": "query", "schema": { "type": "array" } }, { "name": "sellerIds", "in": "query", "schema": { "type": "array" } }, { "name": "excludeSellerIds", "in": "query", "schema": { "type": "array" } }, { "name": "skuIds", "in": "query", "schema": { "type": "array" } }, { "name": "skus", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "types", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfProductType" } } }, { "name": "excludeTypes", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfProductType" } } }, { "name": "isFeatured", "in": "query", "schema": { "type": "boolean" } }, { "name": "ean", "in": "query", "schema": { "type": "string" } }, { "name": "minPrice", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "maxPrice", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "minOnHand", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "maxOnHand", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "minAvailable", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "tags", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "excludeTags", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "limit", "in": "query", "schema": { "type": "string" }, "description": "Maximum number of results to return." }, { "name": "savedViewId", "in": "query", "schema": { "type": [ "null", "string" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductCountDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products/exports": { "post": { "tags": [ "Catalog" ], "summary": "Queue a products export", "description": "Queues a product export. Returns a job; the file becomes downloadable once it completes.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Command" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "operationId": "postV1CatalogProductsExports", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products/import-assets": { "post": { "tags": [ "Catalog" ], "summary": "Upload a product import asset", "description": "Uploads an image referenced by a product import, so the import file can point at it by name.", "operationId": "UploadProductImportAsset", "parameters": [ { "name": "FileName", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductImportAssetResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "411": { "description": "Length Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "413": { "description": "Payload Too Large", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products/import-schema": { "get": { "tags": [ "Catalog" ], "summary": "Get products import schema", "operationId": "GetProductImportSchema", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductImportSchemaDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products/import-template": { "get": { "tags": [ "Catalog" ], "summary": "Download products import template", "description": "Downloads the spreadsheet template for product imports, with the expected columns already in place.", "operationId": "DownloadProductImportTemplate", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products/imports": { "post": { "tags": [ "Catalog" ], "summary": "Queue a product import", "description": "Queues a product import from an uploaded file. Returns a job you poll for progress and errors; nothing is written synchronously.", "operationId": "ImportProducts", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportProductsRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products/moderation/decide": { "post": { "tags": [ "Catalog" ], "summary": "Approve or reject seller products", "description": "Approves or rejects seller products in bulk. Rejected products stay unpublished with the reason attached.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModerationDecisionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModerationDecisionResultDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "operationId": "postV1CatalogProductsModerationDecide", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products/moderation/summary": { "get": { "tags": [ "Catalog" ], "summary": "Summarize seller products pending review", "description": "Returns how many seller products are waiting for review, so a marketplace operator can see the queue at a glance.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModerationSummaryDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "operationId": "getV1CatalogProductsModerationSummary", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products/reindex": { "post": { "tags": [ "Catalog" ], "summary": "Queue a search reindex for every product of the store", "description": "Queues a search reindex of every product in the store. Use it after a bulk change, when the catalog and the search index have drifted apart.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReindexStoreProductsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "operationId": "postV1CatalogProductsReindex", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products/spreadsheet": { "post": { "tags": [ "Catalog" ], "summary": "Create a product spreadsheet session", "description": "Opens a bulk edit session over a filtered set of products. The session id is then used to page through the rows.", "operationId": "CreateProductSpreadsheet", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSpreadsheetRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSpreadsheetDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products/spreadsheet/{id}": { "get": { "tags": [ "Catalog" ], "summary": "Get a product spreadsheet page", "description": "Returns one page of an open product bulk edit session.", "operationId": "GetProductSpreadsheet", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfProductItemDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products/spreadsheet/save": { "post": { "tags": [ "Catalog" ], "operationId": "SaveProductSpreadsheet", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductSpreadsheetSaveRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueuedOperationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:update", "inventory:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "summary": "Save product spreadsheet", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/products/suggest": { "get": { "tags": [ "Catalog" ], "parameters": [ { "name": "Search", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "SellerId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "Limit", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSuggestItemDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Products", "summary": "List product suggest", "operationId": "getV1CatalogProductsSuggest", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/recommendations": { "get": { "tags": [ "Catalog" ], "parameters": [ { "name": "ProductId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "Category", "in": "query", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductRecommendationDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Recommendations", "summary": "List recommendations", "operationId": "getV1CatalogRecommendations", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/size-guides": { "post": { "tags": [ "Catalog" ], "summary": "Create size guide", "description": "Creates a size guide. It only becomes visible on a product page once it is assigned.", "operationId": "CreateSizeGuide", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSizeGuideRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Size Guides", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Catalog" ], "summary": "List size guides", "description": "Lists the size guides defined for the store.", "operationId": "ListSizeGuides", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "Gender", "in": "query", "schema": { "type": "string" } }, { "name": "MeasurementType", "in": "query", "schema": { "type": "string" } }, { "name": "Status", "in": "query", "schema": { "type": "string" } }, { "name": "ProductId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "CategoryId", "in": "query", "schema": { "type": [ "null", "string" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfSizeGuideSummaryDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Size Guides", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/size-guides/{sizeGuideId}": { "delete": { "tags": [ "Catalog" ], "summary": "Delete size guide", "description": "Deletes a size guide and removes it from the products using it.", "operationId": "DeleteSizeGuide", "parameters": [ { "name": "sizeGuideId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:delete" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Size Guides", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Catalog" ], "summary": "Get size guide", "description": "Returns one size guide with its measurement table.", "operationId": "GetSizeGuide", "parameters": [ { "name": "sizeGuideId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SizeGuideDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Size Guides", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Catalog" ], "summary": "Update size guide", "description": "Updates a size guide. The change applies to every product it is assigned to.", "operationId": "UpdateSizeGuide", "parameters": [ { "name": "sizeGuideId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SizeGuideRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Size Guides", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/size-guides/{sizeGuideId}/assignments": { "post": { "tags": [ "Catalog" ], "summary": "Assign size guide", "description": "Assigns a size guide to a set of products, categories or brands, so new products inherit it.", "operationId": "AssignSizeGuide", "parameters": [ { "name": "sizeGuideId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SizeGuideAssignmentInput" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Size Guides", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/size-guides/{sizeGuideId}/assignments/{assignmentId}": { "delete": { "tags": [ "Catalog" ], "summary": "Remove size guide assignment", "description": "Removes an assignment rule. Products keep any guide attached to them directly.", "operationId": "RemoveSizeGuideAssignment", "parameters": [ { "name": "sizeGuideId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "assignmentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Size Guides", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/size-guides/exports": { "post": { "tags": [ "Catalog" ], "summary": "Queue a size guides export", "description": "Queues a size guide export. Returns a job; the file becomes downloadable once it completes.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SizeGuideExportRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Size Guides", "operationId": "postV1CatalogSizeGuidesExports", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/size-guides/import": { "post": { "tags": [ "Catalog" ], "summary": "Queue a size guides import", "description": "Queues a size guide import from a file. Returns a job you poll for progress.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "assetId": { "type": [ "null", "string" ] } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "assetId": { "type": [ "null", "string" ] } } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Size Guides", "operationId": "postV1CatalogSizeGuidesImport", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/skus/availability": { "get": { "tags": [ "Catalog" ], "operationId": "CheckSkuAvailability", "parameters": [ { "name": "sku", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Stock keeping unit (SKU)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "SKUs", "summary": "Check SKU availability", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/specifications": { "post": { "tags": [ "Catalog" ], "summary": "Create specification", "description": "Create a new product specification", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSpecificationRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Specifications", "operationId": "postV1CatalogSpecifications", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Catalog" ], "summary": "List specifications", "description": "Retrieve a paginated list of specifications with optional filtering. Use 'ids' param to fetch specific specifications by their IDs (comma-separated).", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "level", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSpecificationLevel" } }, { "name": "type", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSpecificationType" } }, { "name": "ids", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfSpecificationDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Specifications", "operationId": "getV1CatalogSpecifications", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/specifications/{id}": { "delete": { "tags": [ "Catalog" ], "summary": "Delete an specification", "description": "Delete an existing specification", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:delete" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Specifications", "operationId": "deleteV1CatalogSpecificationsId", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Catalog" ], "summary": "Get specification by ID", "description": "Retrieve a specific specification by its ID", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpecificationDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Specifications", "operationId": "getV1CatalogSpecificationsId", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Catalog" ], "summary": "Update an specification", "description": "Update an existing specification", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSpecificationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Specifications", "operationId": "putV1CatalogSpecificationsId", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/specifications/suggests": { "get": { "tags": [ "Catalog" ], "summary": "Suggests specifications", "description": "Retrieve a suggests of specifications", "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SpecificationItemDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Specifications", "operationId": "getV1CatalogSpecificationsSuggests", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/spreadsheet/save": { "post": { "tags": [ "Catalog" ], "operationId": "SaveCatalogSpreadsheet", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogSpreadsheetSaveRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueuedOperationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Spreadsheet", "summary": "Save spreadsheet", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/variants/{variantId}": { "get": { "tags": [ "Catalog" ], "parameters": [ { "name": "variantId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogVariantModel" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Variants", "summary": "Get variant", "operationId": "getV1CatalogVariantsVariantid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/variants/spreadsheet": { "post": { "tags": [ "Catalog" ], "summary": "Create a variant spreadsheet session", "description": "Opens a bulk edit session over variants, the same way the product one works but at variant level.", "operationId": "CreateVariantSpreadsheet", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariantSpreadsheetRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VariantSpreadsheetDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read", "inventory:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Variants", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/catalog/variants/spreadsheet/{id}": { "get": { "tags": [ "Catalog" ], "summary": "Get a variant spreadsheet page", "description": "Returns one page of an open variant bulk edit session.", "operationId": "GetVariantSpreadsheet", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfVariantSpreadsheetRowDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read", "inventory:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Variants", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/channels/{channelId}/products/{productId}/publish": { "post": { "tags": [ "Catalog" ], "summary": "Publish a product to a channel", "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "channel:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Channels", "operationId": "postV1ChannelsChannelidProductsProductidPublish", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/channels/{channelId}/publication/publish": { "post": { "tags": [ "Catalog" ], "summary": "Queue publication for ready listings", "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishReadyResultDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "channel:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Channels", "operationId": "postV1ChannelsChannelidPublicationPublish", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/channels/{channelId}/publication/readiness": { "get": { "tags": [ "Catalog" ], "summary": "Get publication readiness", "parameters": [ { "name": "channelId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicationReadinessDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "channel:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Channels", "operationId": "getV1ChannelsChannelidPublicationReadiness", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/channels/listings": { "post": { "tags": [ "Catalog" ], "summary": "Create listing", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateListingRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "channel:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Channels", "operationId": "postV1ChannelsListings", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Catalog" ], "summary": "List listings", "parameters": [ { "name": "channelId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "listingType", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfListingType" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfListingStatus" } }, { "name": "take", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelListingSummaryDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "channel:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Channels", "operationId": "getV1ChannelsListings", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/channels/listings/{id}": { "get": { "tags": [ "Catalog" ], "summary": "Get listing by id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelListingDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "channel:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Channels", "operationId": "getV1ChannelsListingsId", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/channels/listings/{id}/price": { "patch": { "tags": [ "Catalog" ], "summary": "Update listing price", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateListingPriceRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "channel:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Channels", "operationId": "patchV1ChannelsListingsIdPrice", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/channels/listings/{id}/publish": { "post": { "tags": [ "Catalog" ], "summary": "Queue publication for a listing", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "channel:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Channels", "operationId": "postV1ChannelsListingsIdPublish", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/channels/listings/{id}/unpublish": { "post": { "tags": [ "Catalog" ], "summary": "Unpublish a listing", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "channel:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Channels", "operationId": "postV1ChannelsListingsIdUnpublish", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/channels/products/{productId}/publications": { "get": { "tags": [ "Catalog" ], "summary": "List product publications", "parameters": [ { "name": "productId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductPublicationDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Channels", "operationId": "getV1ChannelsProductsProductidPublications", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/channels/products/publications": { "get": { "tags": [ "Catalog" ], "summary": "List product publications for a set of products", "parameters": [ { "name": "productIds", "in": "query", "required": true, "schema": { "type": "array" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductPublicationsDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "catalog:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Channels", "operationId": "getV1ChannelsProductsPublications", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/notifications/templates": { "post": { "tags": [ "Catalog" ], "summary": "Create template", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTemplateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResultOflong" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": {} } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "notification:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Notifications", "operationId": "postV1NotificationsTemplates", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Catalog" ], "operationId": "ListTemplates", "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "channel", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfNotificationChannel" } }, { "name": "groups", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "key", "in": "query", "schema": { "type": "string" } }, { "name": "locale", "in": "query", "schema": { "type": "string" } }, { "name": "scope", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfTemplateScope" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginatedItemsOfTemplateItemDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "notification:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Notifications", "summary": "List templates", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/notifications/templates/{id}": { "put": { "tags": [ "Catalog" ], "summary": "UpdateDraftTemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTemplateRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "notification:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Notifications", "operationId": "putV1NotificationsTemplatesId", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/notifications/templates/{id}/publish": { "post": { "tags": [ "Catalog" ], "summary": "PublishTemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "notification:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Notifications", "operationId": "postV1NotificationsTemplatesIdPublish", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/notifications/templates/{templateId}": { "get": { "tags": [ "Catalog" ], "operationId": "GetTemplateById", "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "notification:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Notifications", "summary": "Get template by ID", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/notifications/templates/{templateId}/versions": { "get": { "tags": [ "Catalog" ], "operationId": "ListTemplateVersionsById", "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfTemplateDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "notification:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Notifications", "summary": "List template versions by ID", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/notifications/templates/{templateKey}": { "get": { "tags": [ "Catalog" ], "operationId": "GetTemplate", "parameters": [ { "name": "templateKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "channel", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/QueryEnumOfNotificationChannel" } }, { "name": "locale", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "notification:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Notifications", "summary": "Get template", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/notifications/templates/{templateKey}/versions": { "get": { "tags": [ "Catalog" ], "operationId": "ListTemplateVersionsByKey", "parameters": [ { "name": "templateKey", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "channel", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfNotificationChannel" } }, { "name": "locale", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfTemplateDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "notification:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Notifications", "summary": "List template versions by key", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/notifications/templates/groups": { "get": { "tags": [ "Catalog" ], "operationId": "ListTemplateGroups", "parameters": [ { "name": "scope", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfTemplateScope" } }, { "name": "channel", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfNotificationChannel" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfTemplateDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "notification:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Notifications", "summary": "List template groups", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/inventory": { "get": { "tags": [ "Inventory" ], "summary": "List physical inventory levels", "description": "Lists the physical stock of each SKU by location. Physical stock is what is on the shelf, before reservations are subtracted.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "searchTerm", "in": "query", "schema": { "type": "string" } }, { "name": "inventoryIds", "in": "query", "schema": { "type": "array" } }, { "name": "locationIds", "in": "query", "schema": { "type": "array" } }, { "name": "brandIds", "in": "query", "schema": { "type": "array" } }, { "name": "categoryIds", "in": "query", "schema": { "type": "array" } }, { "name": "productStatus", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "minOnHand", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "maxOnHand", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "minAvailable", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "maxAvailable", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "minCommitted", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "maxCommitted", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "isLowStock", "in": "query", "schema": { "type": "boolean" } }, { "name": "isInStock", "in": "query", "schema": { "type": "boolean" } }, { "name": "trackInventory", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeTotalCount", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfInventoryListDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "inventory:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Inventory", "operationId": "getV1Inventory", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/inventory/adjust": { "post": { "tags": [ "Inventory" ], "summary": "Adjust inventory stock", "description": "Changes the physical stock of a SKU by a delta and records the reason. This is the entry point for counts, losses and corrections.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryAdjustmentRequest" }, "example": { "variantId": "7204558912004325377", "locationId": "7204558912004325378", "target": "onHand", "mode": "adjust", "quantity": 5, "reason": "restock", "note": "Ingreso de cinco unidades.", "expectedVersion": 3 } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryLevelModel" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "inventory:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Inventory", "operationId": "postV1InventoryAdjust", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/inventory/availability": { "post": { "tags": [ "Inventory" ], "summary": "Check availability", "description": "Checks whether a set of SKUs can be fulfilled in the requested quantity. Ask before promising stock, not after.", "operationId": "GetInventoryAvailability", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryAvailabilityQueryDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryAvailabilityModel" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "inventory:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Inventory", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/inventory/batch/stock": { "post": { "tags": [ "Inventory" ], "summary": "Queue a batch inventory stock update", "description": "Queues a stock update over many SKUs. Returns a job; the write happens in the background.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryStockBatchRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryOperationDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "inventory:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Inventory", "operationId": "postV1InventoryBatchStock", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/inventory/consume-reserved": { "post": { "tags": [ "Inventory" ], "summary": "Consume reserved stock", "description": "Turns a reservation into an actual exit. Physical stock drops and the reservation closes.", "operationId": "ConsumeReservedInventory", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsumeReservedInventoryDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "inventory:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Inventory", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/inventory/count": { "get": { "tags": [ "Inventory" ], "summary": "Count inventory items", "description": "Returns how many inventory items match a filter, without returning them.", "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "inventoryIds", "in": "query", "schema": { "type": "array" } }, { "name": "locationIds", "in": "query", "schema": { "type": "array" } }, { "name": "brandIds", "in": "query", "schema": { "type": "array" } }, { "name": "categoryIds", "in": "query", "schema": { "type": "array" } }, { "name": "productStatus", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "minOnHand", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "maxOnHand", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "minAvailable", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "maxAvailable", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "minCommitted", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "maxCommitted", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "isInStock", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryCountDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "inventory:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Inventory", "operationId": "getV1InventoryCount", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/inventory/exports": { "post": { "tags": [ "Inventory" ], "summary": "Queue an inventory export", "description": "Queues an inventory export. Returns a job; the file becomes downloadable once it completes.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryExportRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryOperationDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "inventory:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Inventory", "operationId": "postV1InventoryExports", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/inventory/import": { "post": { "tags": [ "Inventory" ], "summary": "Queue an inventory import", "description": "Queues an inventory import from a file. Returns a job you poll for progress and errors.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "allOf": [ { "type": "object", "properties": { "assetId": { "type": [ "null", "string" ] } } }, { "type": "object", "properties": { "reason": { "$ref": "#/components/schemas/TransactionReason" } } }, { "type": "object", "properties": { "note": { "type": "string" } } } ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "allOf": [ { "type": "object", "properties": { "assetId": { "type": [ "null", "string" ] } } }, { "type": "object", "properties": { "reason": { "$ref": "#/components/schemas/TransactionReason" } } }, { "type": "object", "properties": { "note": { "type": "string" } } } ] } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "inventory:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Inventory", "operationId": "postV1InventoryImport", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/inventory/levels": { "post": { "tags": [ "Inventory" ], "summary": "Get stock levels", "description": "Returns the stock of specific SKUs broken down into on hand, committed and available.", "operationId": "GetInventoryLevels", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryLevelsQueryDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryLevelModel" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "inventory:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Inventory", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/inventory/release": { "post": { "tags": [ "Inventory" ], "summary": "Release stock", "description": "Frees a reservation. The units go back to available without changing physical stock.", "operationId": "ReleaseInventory", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseInventoryDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "inventory:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Inventory", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/inventory/reserve": { "post": { "tags": [ "Inventory" ], "summary": "Reserve stock", "description": "Holds stock for an order without removing it. Reserved units stop counting as available while the hold lasts.", "operationId": "ReserveInventory", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReserveInventoryDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "inventory:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Inventory", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/inventory/totals": { "post": { "tags": [ "Inventory" ], "summary": "Get stock totals", "description": "Returns stock totals across locations, without the per-location breakdown.", "operationId": "GetInventoryTotals", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryTotalsQueryDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryTotalsModel" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "inventory:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Inventory", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/inventory/transactions": { "get": { "tags": [ "Inventory" ], "summary": "List inventory transactions", "description": "Returns the ledger of stock movements: what moved, when, why and by how much.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "productId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "variantId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "locationId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "reason", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfTransactionReason" } }, { "name": "referenceId", "in": "query", "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "toDate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfInventoryTransactionDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "inventory:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Inventory", "operationId": "getV1InventoryTransactions", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/customers": { "post": { "tags": [ "Customers" ], "summary": "Create customer", "description": "Create a new customer", "operationId": "CreateCustomer", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCustomerRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerCreatedDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "customer:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Customers", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Customers" ], "summary": "List customers", "description": "Get a paginated list of customers with optional filtering", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "isActive", "in": "query", "schema": { "type": "boolean" } }, { "name": "isVerified", "in": "query", "schema": { "type": "boolean" } }, { "name": "customerType", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfCustomerType" } } }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfCustomerStatus" } } }, { "name": "groupId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "customerIds", "in": "query", "schema": { "type": "array" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfCustomerDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "customer:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Customers", "operationId": "getV1Customers", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/customers/{customerId}/addresses": { "post": { "tags": [ "Customers" ], "summary": "Create customer address", "description": "Add a new address to a customer", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerAddressRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "customer:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Customers", "operationId": "postV1CustomersCustomeridAddresses", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Customers" ], "summary": "List customer addresses", "description": "Get all addresses for a customer", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAddressDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "customer:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Customers", "operationId": "getV1CustomersCustomeridAddresses", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/customers/{customerId}/addresses/{addressId}": { "delete": { "tags": [ "Customers" ], "summary": "Delete customer address", "description": "Delete a customer address", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "addressId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "customer:delete" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Customers", "operationId": "deleteV1CustomersCustomeridAddressesAddressid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Customers" ], "summary": "Update customer address", "description": "Update an existing customer address", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "addressId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerAddressRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "customer:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Customers", "operationId": "putV1CustomersCustomeridAddressesAddressid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/customers/{id}": { "delete": { "tags": [ "Customers" ], "summary": "Delete customer", "description": "Delete a customer (soft delete)", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "customer:delete" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Customers", "operationId": "deleteV1CustomersId", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Customers" ], "summary": "Get customer", "description": "Get a customer by ID", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "customer:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Customers", "operationId": "getV1CustomersId", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Customers" ], "summary": "Update customer", "description": "Update an existing customer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCustomerRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "customer:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Customers", "operationId": "putV1CustomersId", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/customers/exports": { "post": { "tags": [ "Customers" ], "summary": "Queue a customers export", "description": "Queues a customer export. Returns a job; the file becomes downloadable once it completes.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerExportRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "customer:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Customers", "operationId": "postV1CustomersExports", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/customers/groups": { "post": { "tags": [ "Customers" ], "summary": "Create customer group", "description": "Creates a customer group. Members are added separately.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerGroupRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerGroupDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "customer_group:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Customers", "operationId": "postV1CustomersGroups", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Customers" ], "summary": "List customer groups", "description": "Lists the customer groups. Groups drive segmented pricing and promotions.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "isActive", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfCustomerGroupDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "customer_group:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Customers", "operationId": "getV1CustomersGroups", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/customers/groups/{id}": { "delete": { "tags": [ "Customers" ], "summary": "Delete customer group", "description": "Deletes a customer group. Its members are not deleted, only their membership.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "customer_group:delete" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Customers", "operationId": "deleteV1CustomersGroupsId", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Customers" ], "summary": "Get customer group", "description": "Returns one customer group with its member count.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerGroupDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "customer_group:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Customers", "operationId": "getV1CustomersGroupsId", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Customers" ], "summary": "Update customer group", "description": "Updates a customer group's name and settings, without touching its members.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerGroupRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "customer_group:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Customers", "operationId": "putV1CustomersGroupsId", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/customers/groups/{id}/members": { "post": { "tags": [ "Customers" ], "summary": "Add customers to a customer group", "description": "Adds customers to a group. Customers already in it are ignored.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerGroupMembersRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerGroupMembershipChangeDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "customer_group:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Customers", "operationId": "postV1CustomersGroupsIdMembers", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/customers/groups/{id}/members/remove": { "post": { "tags": [ "Customers" ], "summary": "Remove customers from a customer group", "description": "Removes customers from a group without deleting the customers.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerGroupMembersRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerGroupMembershipRemovalDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "customer_group:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Customers", "operationId": "postV1CustomersGroupsIdMembersRemove", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/customers/import": { "post": { "tags": [ "Customers" ], "summary": "Queue a customers import", "description": "Queues a customer import from a file. Returns a job you poll for progress and errors.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "assetId": { "type": [ "null", "string" ] } } } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "assetId": { "type": [ "null", "string" ] } } } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueuedOperationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "customer:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Customers", "operationId": "postV1CustomersImport", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/customers/spreadsheet": { "post": { "tags": [ "Customers" ], "operationId": "CreateCustomerSpreadsheet", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerSpreadsheetRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerSpreadsheetDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "customer:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Customers", "summary": "Create customer spreadsheet", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/customers/spreadsheet/{id}": { "get": { "tags": [ "Customers" ], "operationId": "GetCustomerSpreadsheet", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfCustomerDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "customer:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Customers", "summary": "Get customer spreadsheet", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/customers/spreadsheet/save": { "post": { "tags": [ "Customers" ], "operationId": "SaveCustomerSpreadsheet", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerSpreadsheetSaveRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueuedOperationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "customer:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Customers", "summary": "Save customer spreadsheet", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/carts": { "get": { "tags": [ "Orders" ], "operationId": "ListCarts", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfCartStatus" } } }, { "name": "email", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfCartListItemDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Carts", "summary": "List carts", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/carts/{cartId}": { "get": { "tags": [ "Orders" ], "operationId": "GetCart", "parameters": [ { "name": "cartId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CartDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Carts", "summary": "Get cart", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/carts/shipping/pickup-options": { "get": { "tags": [ "Orders" ], "summary": "Get pickup options for checkout", "description": "Returns the pickup points the shopper can collect from, as an alternative to delivery.", "operationId": "GetPickupOptions", "parameters": [ { "name": "ShippingMethodId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PickupOptionsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [], "x-ecomiq-anonymous": true, "x-ecomiq-resource": "Carts", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/order-bumps": { "post": { "tags": [ "Orders" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderBumpUpsertRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "promotion:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Order Bumps", "summary": "Create order bump", "operationId": "postV1OrderBumps", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Orders" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderBumpDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "promotion:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Order Bumps", "summary": "List order bumps", "operationId": "getV1OrderBumps", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/order-bumps/{orderBumpId}": { "delete": { "tags": [ "Orders" ], "parameters": [ { "name": "orderBumpId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "promotion:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Order Bumps", "summary": "Delete order bump", "operationId": "deleteV1OrderBumpsOrderbumpid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Orders" ], "parameters": [ { "name": "orderBumpId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderBumpDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "promotion:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Order Bumps", "summary": "Get order bump", "operationId": "getV1OrderBumpsOrderbumpid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Orders" ], "parameters": [ { "name": "orderBumpId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderBumpUpsertRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "promotion:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Order Bumps", "summary": "Update order bump", "operationId": "putV1OrderBumpsOrderbumpid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/order-drafts": { "post": { "tags": [ "Orders" ], "operationId": "CreateOrderDraft", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrderDraftRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrderDraftDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "draft:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Order Drafts", "summary": "Create order draft", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Orders" ], "operationId": "ListOrderDrafts", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfOrderDraftStatus" } } }, { "name": "customerId", "in": "query", "schema": { "type": [ "null", "string" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfOrderDraftListItemDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "draft:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Order Drafts", "summary": "List order drafts", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/order-drafts/{draftId}": { "get": { "tags": [ "Orders" ], "operationId": "GetOrderDraft", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDraftDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "draft:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Order Drafts", "summary": "Get order draft", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "patch": { "tags": [ "Orders" ], "operationId": "UpdateOrderDraft", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrderDraftRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDraftDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "draft:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Order Drafts", "summary": "Update order draft", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/order-drafts/{draftId}/cancel": { "post": { "tags": [ "Orders" ], "operationId": "CancelOrderDraft", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelOrderDraftRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDraftDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "draft:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Order Drafts", "summary": "Cancel order draft", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/order-drafts/{draftId}/convert": { "post": { "tags": [ "Orders" ], "operationId": "ConvertOrderDraftToOrder", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConvertOrderDraftRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDraftConversionDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "draft:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Order Drafts", "summary": "Convert order draft to order", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/order-drafts/{draftId}/items": { "post": { "tags": [ "Orders" ], "operationId": "AddItemToOrderDraft", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddOrderDraftItemRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDraftDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "draft:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Order Drafts", "summary": "Add item to order draft", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/order-drafts/{draftId}/items/{itemId}": { "delete": { "tags": [ "Orders" ], "operationId": "RemoveItemFromOrderDraft", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDraftDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "draft:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Order Drafts", "summary": "Remove item from order draft", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "patch": { "tags": [ "Orders" ], "operationId": "UpdateOrderDraftItem", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrderDraftItemRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDraftDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "draft:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Order Drafts", "summary": "Update order draft item", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/order-drafts/{draftId}/share": { "post": { "tags": [ "Orders" ], "operationId": "CreateOrderDraftShareLink", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CreateOrderDraftShareLinkRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDraftShareDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "draft:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Order Drafts", "summary": "Create order draft share link", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/order-drafts/{draftId}/shipping-method": { "delete": { "tags": [ "Orders" ], "operationId": "ClearOrderDraftShippingMethod", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sellerId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "shippingProfileId", "in": "query", "schema": { "type": [ "null", "string" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDraftDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "draft:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Order Drafts", "summary": "Clear order draft shipping method", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Orders" ], "operationId": "SetOrderDraftShippingMethod", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetOrderDraftShippingMethodRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDraftDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "draft:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Order Drafts", "summary": "Set order draft shipping method", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/order-drafts/{draftId}/shipping-options": { "get": { "tags": [ "Orders" ], "operationId": "ListOrderDraftShippingOptions", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sellerId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "shippingProfileId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "scheduledDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "scheduledTime", "in": "query", "schema": { "type": "string", "format": "time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingEstimateOptionModel" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "draft:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Order Drafts", "summary": "List order draft shipping options", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/order-drafts/{draftId}/status": { "patch": { "tags": [ "Orders" ], "operationId": "UpdateOrderDraftStatus", "parameters": [ { "name": "draftId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDraftStatusRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDraftDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "draft:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Order Drafts", "summary": "Update order draft status", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders": { "get": { "tags": [ "Orders" ], "operationId": "ListOrders", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfOrderStatus" } } }, { "name": "state", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfOrderState" } } }, { "name": "fulfillmentStatus", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfOrderFulfillmentStatus" } } }, { "name": "returnStatus", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfOrderReturnStatus" } } }, { "name": "locationId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "orderIds", "in": "query", "schema": { "type": "array" } }, { "name": "customerId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "conciliated", "in": "query", "schema": { "type": "boolean" } }, { "name": "dateFrom", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "dateTo", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfOrderListItemDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "List orders", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/{orderId}": { "get": { "tags": [ "Orders" ], "operationId": "GetOrder", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "include", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Get order", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/{orderId}/activity": { "get": { "tags": [ "Orders" ], "operationId": "ListOrderActivity", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTrackingDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "List order activity", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/{orderId}/cancel": { "post": { "tags": [ "Orders" ], "operationId": "CancelOrder", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderCancelRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Cancel order", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/{orderId}/claims": { "post": { "tags": [ "Orders" ], "operationId": "CreateOrderClaim", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrderClaimRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderClaimDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Create order claim", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/{orderId}/close": { "post": { "tags": [ "Orders" ], "operationId": "CloseOrder", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Close order", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/{orderId}/confirm": { "post": { "tags": [ "Orders" ], "operationId": "ConfirmOrder", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Confirm order", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/{orderId}/custom-status": { "post": { "tags": [ "Orders" ], "operationId": "AddOrderCustomStatus", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderCustomStatusRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Add order custom status", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/{orderId}/delivery": { "post": { "tags": [ "Orders" ], "operationId": "DeliverOrder", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderTrackingRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Deliver order", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/{orderId}/in-progress": { "post": { "tags": [ "Orders" ], "operationId": "SetOrderInProgress", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderCommentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Set order in progress", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/{orderId}/in-transit": { "post": { "tags": [ "Orders" ], "operationId": "SetOrderInTransit", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderTrackingRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Set order in transit", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/{orderId}/invalidate": { "post": { "tags": [ "Orders" ], "operationId": "InvalidateOrder", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Invalidate order", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/{orderId}/invoice": { "post": { "tags": [ "Orders" ], "operationId": "InvoiceOrder", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderInvoiceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "invoice:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Invoice order", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/{orderId}/items/{itemId}/cancel": { "post": { "tags": [ "Orders" ], "operationId": "CancelOrderItem", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderCancelRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Cancel order item", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/{orderId}/items/{itemId}/delivery": { "post": { "tags": [ "Orders" ], "operationId": "DeliverOrderItem", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItemTrackingRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Deliver order item", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/{orderId}/items/{itemId}/in-transit": { "post": { "tags": [ "Orders" ], "operationId": "SetOrderItemInTransit", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderTrackingRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Set order item in transit", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/{orderId}/items/{itemId}/invoice": { "post": { "tags": [ "Orders" ], "operationId": "InvoiceOrderItem", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderInvoiceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "invoice:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Invoice order item", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/{orderId}/items/{itemId}/return": { "post": { "tags": [ "Orders" ], "operationId": "ReturnOrderItem", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItemReturnRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Return order item", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/{orderId}/notes": { "patch": { "tags": [ "Orders" ], "operationId": "UpdateOrderNotes", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderNotesRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Update order notes", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/{orderId}/packages": { "get": { "tags": [ "Orders" ], "operationId": "ListOrderPackages", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderPackageItemDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "List order packages", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/{orderId}/ready-to-pickup": { "post": { "tags": [ "Orders" ], "operationId": "SetOrderReadyToPickUp", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderReadyToPickUpRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Set order ready to pick up", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/{orderId}/return": { "post": { "tags": [ "Orders" ], "operationId": "ReturnOrder", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderReturnRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Return order", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/{orderId}/return-status": { "put": { "tags": [ "Orders" ], "operationId": "UpdateOrderReturnStatus", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderReturnStatusRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Update order return status", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/{orderId}/transactions": { "get": { "tags": [ "Orders" ], "operationId": "ListOrderTransactions", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "List order transactions", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/batch": { "post": { "tags": [ "Orders" ], "operationId": "CreateOrders", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrdersRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrderResult" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Create orders", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/batch/conciliation": { "patch": { "tags": [ "Orders" ], "operationId": "BatchUpdateOrderConciliation", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOrderConciliationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOrderConciliationDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Batch update order conciliation", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/claims": { "get": { "tags": [ "Orders" ], "operationId": "ListOrderClaims", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "orderId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfOrderClaimStatus" } }, { "name": "type", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfOrderClaimType" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfOrderClaimListItemDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "List order claims", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/claims/{claimId}": { "get": { "tags": [ "Orders" ], "operationId": "GetOrderClaim", "parameters": [ { "name": "claimId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderClaimDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Get order claim", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/claims/{claimId}/notes": { "post": { "tags": [ "Orders" ], "operationId": "AddOrderClaimNote", "parameters": [ { "name": "claimId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderClaimNoteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderClaimDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Add order claim note", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/claims/{claimId}/status": { "patch": { "tags": [ "Orders" ], "operationId": "UpdateOrderClaimStatus", "parameters": [ { "name": "claimId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrderClaimStatusRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderClaimDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Update order claim status", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/exports": { "post": { "tags": [ "Orders" ], "summary": "Queue an orders export", "description": "Queues an order export. Returns a job; the file becomes downloadable once it completes.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderExportRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "operationId": "postV1OrdersExports", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/group/{orderGroup}": { "get": { "tags": [ "Orders" ], "operationId": "GetOrdersByGroup", "parameters": [ { "name": "orderGroup", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderGroupDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Get orders by group", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/items": { "get": { "tags": [ "Orders" ], "operationId": "ListOrderItems", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfOrderStatus" } } }, { "name": "state", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfOrderState" } } }, { "name": "fulfillmentStatus", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfOrderFulfillmentStatus" } } }, { "name": "returnStatus", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfOrderReturnStatus" } } }, { "name": "itemStatus", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfOrderStatus" } } }, { "name": "locationId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "orderIds", "in": "query", "schema": { "type": "array" } }, { "name": "itemIds", "in": "query", "schema": { "type": "array" } }, { "name": "customerId", "in": "query", "schema": { "type": [ "null", "string" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfOrderItemListItemDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "List order items", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/items/spreadsheet/save": { "post": { "tags": [ "Orders" ], "operationId": "SaveOrderItemSpreadsheet", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderItemSpreadsheetSaveRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueuedOperationResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Save order item spreadsheet", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/package-status": { "post": { "tags": [ "Orders" ], "operationId": "SetOrderPackageStatus", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetOrderPackageStatusRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Set order package status", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/schedule-count": { "post": { "tags": [ "Orders" ], "operationId": "GetOrderScheduleCount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderScheduleCountRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderScheduleCountDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Get order schedule count", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/shipment": { "post": { "tags": [ "Orders" ], "operationId": "UpdateOrderShipment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrderShipmentDto" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Update order shipment", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/spreadsheet": { "post": { "tags": [ "Orders" ], "operationId": "CreateOrderSpreadsheet", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderSpreadsheetRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderSpreadsheetDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Create order spreadsheet", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/spreadsheet/{id}": { "get": { "tags": [ "Orders" ], "operationId": "GetOrderSpreadsheet", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfOrderItemListItemDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Get order spreadsheet", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/status/batch": { "post": { "tags": [ "Orders" ], "summary": "Queue a batch order status update", "description": "Queues a status change over many orders. Returns a job; transitions that are not valid for an order are reported per order.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchOrderStatusRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "order:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "operationId": "postV1OrdersStatusBatch", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/fulfillment/locations": { "post": { "tags": [ "Fulfillment & Shipping" ], "summary": "Create location", "description": "Create a new fulfillment location for the store", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLocationRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "operationId": "postV1FulfillmentLocations", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "List locations", "description": "Retrieve a paginated list of fulfillment locations", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "isActive", "in": "query", "schema": { "type": "boolean" } }, { "name": "sellerId", "in": "query", "schema": { "type": [ "null", "string" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfLocationDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "operationId": "getV1FulfillmentLocations", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/fulfillment/locations/{id}": { "delete": { "tags": [ "Fulfillment & Shipping" ], "summary": "Delete a location", "description": "Delete an existing fulfillment location", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "operationId": "deleteV1FulfillmentLocationsId", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "Get location by ID", "description": "Retrieve a specific fulfillment location by its ID", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "operationId": "getV1FulfillmentLocationsId", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Fulfillment & Shipping" ], "summary": "Update a location", "description": "Update an existing fulfillment location", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLocationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "operationId": "putV1FulfillmentLocationsId", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/fulfillment/locations/default": { "put": { "tags": [ "Fulfillment & Shipping" ], "summary": "Set default location", "description": "Returns the store's default location, creating it if none exists. Useful when bootstrapping a store.", "operationId": "GetOrCreateDefaultLocation", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationModel" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/fulfillment/orders": { "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "List fulfillment orders", "description": "Lists the work to be fulfilled. One customer order becomes several fulfillment orders when its items ship from different locations.", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "orderId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "locationId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfFulfillmentOrderStatus" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfFulfillmentOrderListItemDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipment:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "operationId": "getV1FulfillmentOrders", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/fulfillment/orders/{id}": { "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "Get fulfillment order", "description": "Returns one fulfillment order with its items, its assigned location and its state.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FulfillmentOrderDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipment:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "operationId": "getV1FulfillmentOrdersId", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/fulfillment/orders/{id}/assign": { "post": { "tags": [ "Fulfillment & Shipping" ], "summary": "Assign fulfillment order", "description": "Assigns the fulfillment order to a location, which becomes responsible for preparing it.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignFulfillmentOrderRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FulfillmentOrderDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipment:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "operationId": "postV1FulfillmentOrdersIdAssign", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/fulfillment/orders/{id}/cancel": { "post": { "tags": [ "Fulfillment & Shipping" ], "summary": "Cancel fulfillment order", "description": "Cancels the fulfillment. Any stock reserved for it is released.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FulfillmentOrderDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipment:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "operationId": "postV1FulfillmentOrdersIdCancel", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/fulfillment/orders/{id}/deliver": { "post": { "tags": [ "Fulfillment & Shipping" ], "summary": "Deliver fulfillment order", "description": "Confirms delivery to the customer. Closes a delivery fulfillment.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FulfillmentOrderDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipment:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "operationId": "postV1FulfillmentOrdersIdDeliver", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/fulfillment/orders/{id}/in-progress": { "post": { "tags": [ "Fulfillment & Shipping" ], "summary": "Set fulfillment order in progress", "description": "Marks that preparation has started. Use it to distinguish what is being picked from what is still queued.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FulfillmentOrderDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipment:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "operationId": "postV1FulfillmentOrdersIdInProgress", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/fulfillment/orders/{id}/label": { "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "Get shipment label", "description": "Returns the shipping label, ready to print.", "operationId": "GetFulfillmentOrderLabel", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." }, { "name": "shipmentId", "in": "query", "schema": { "type": [ "null", "string" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "byte" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipment:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/fulfillment/orders/{id}/packing-slip": { "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "Get packing slip", "description": "Returns the packing slip that goes inside the box.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." }, { "name": "shipmentId", "in": "query", "schema": { "type": [ "null", "string" ] } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipment:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "operationId": "getV1FulfillmentOrdersIdPackingSlip", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/fulfillment/orders/{id}/pick-up": { "post": { "tags": [ "Fulfillment & Shipping" ], "summary": "Pick up fulfillment order", "description": "Confirms the customer collected the order. Closes a pickup fulfillment.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FulfillmentOrderDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipment:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "operationId": "postV1FulfillmentOrdersIdPickUp", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/fulfillment/orders/{id}/ready-to-pickup": { "post": { "tags": [ "Fulfillment & Shipping" ], "summary": "Set fulfillment order ready to pick up", "description": "Marks the order as ready for the customer to collect. Only for pickup, not for delivery.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FulfillmentOrderDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipment:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "operationId": "postV1FulfillmentOrdersIdReadyToPickup", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/fulfillment/orders/{id}/ship": { "post": { "tags": [ "Fulfillment & Shipping" ], "summary": "Ship fulfillment order", "description": "Marks the order as shipped. From here it is tracked by its shipment.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipFulfillmentOrderRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FulfillmentOrderDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipment:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "operationId": "postV1FulfillmentOrdersIdShip", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/fulfillment/orders/{id}/shipment": { "post": { "tags": [ "Fulfillment & Shipping" ], "summary": "Create shipment", "description": "Creates the shipment for a fulfillment order, with its carrier and tracking number.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFulfillmentShipmentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FulfillmentShipmentModel" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipment:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "operationId": "postV1FulfillmentOrdersIdShipment", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/fulfillment/orders/{id}/shipments/{shipmentId}/label": { "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "Get shipment label", "operationId": "GetFulfillmentShipmentLabel", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." }, { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "byte" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipment:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/fulfillment/orders/{id}/shipments/{shipmentId}/packing-slip": { "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "Get packing slip", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." }, { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipment:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "operationId": "getV1FulfillmentOrdersIdShipmentsShipmentidPackingSlip", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/fulfillment/orders/{id}/shipments/{shipmentId}/tracking": { "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "Get shipment tracking", "operationId": "GetFulfillmentShipmentTracking", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." }, { "name": "shipmentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentTrackingDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipment:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/fulfillment/orders/{id}/tracking": { "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "Get shipment tracking", "description": "Returns the tracking events of a shipment as reported by the carrier.", "operationId": "GetFulfillmentOrderTracking", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." }, { "name": "shipmentId", "in": "query", "schema": { "type": [ "null", "string" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentTrackingDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipment:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/fulfillment/orders/tracking/{trackingNumber}": { "get": { "tags": [ "Fulfillment & Shipping" ], "operationId": "GetFulfillmentOrderByTracking", "parameters": [ { "name": "trackingNumber", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "tenantId", "in": "query", "schema": { "type": [ "null", "string" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FulfillmentOrderSummaryModel" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipment:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "summary": "Get fulfillment order by tracking", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/fulfillment/packages": { "post": { "tags": [ "Fulfillment & Shipping" ], "summary": "Create package", "description": "Creates a package format.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "operationId": "postV1FulfillmentPackages", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "List packages", "description": "Lists the package formats defined for the store. They are used to pick a box and estimate shipping.", "parameters": [ { "name": "includeInactive", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PackageDetailsDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "operationId": "getV1FulfillmentPackages", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/fulfillment/packages/{id}": { "delete": { "tags": [ "Fulfillment & Shipping" ], "summary": "Delete package", "description": "Deletes a package format.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "operationId": "deleteV1FulfillmentPackagesId", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "Get package", "description": "Returns one package format with its dimensions and weight.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "operationId": "getV1FulfillmentPackagesId", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Fulfillment & Shipping" ], "summary": "Update package", "description": "Updates a package format. Shipments already created keep the dimensions they were made with.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "operationId": "putV1FulfillmentPackagesId", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/fulfillment/routing/preview": { "post": { "tags": [ "Fulfillment & Shipping" ], "summary": "Preview routing", "description": "Shows which locations would fulfill an order and how it would split, without committing anything.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingPreviewRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutingPreviewDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "operationId": "postV1FulfillmentRoutingPreview", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/fulfillment/settings": { "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "Get fulfillment settings", "description": "Returns the fulfillment rules of the store: how orders are routed and split.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FulfillmentSettingsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "operationId": "getV1FulfillmentSettings", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Fulfillment & Shipping" ], "summary": "Update fulfillment settings", "description": "Updates the fulfillment rules. Applies to orders created from here on; existing ones keep their routing.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FulfillmentSettingsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FulfillmentSettingsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Fulfillment", "operationId": "putV1FulfillmentSettings", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/geo/areas": { "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "List areas", "description": "Lists the geographic areas used to group districts for shipping.", "parameters": [ { "name": "countryCode", "in": "query", "schema": { "type": "string" }, "description": "ISO 3166-1 alpha-2 country code, for example `PE`." }, { "name": "type", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfAreaLevel" } }, { "name": "parentId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "parentCode", "in": "query", "schema": { "type": "string" } }, { "name": "source", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GeoAreaModel" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [], "x-ecomiq-anonymous": true, "x-ecomiq-resource": "Geo", "operationId": "getV1GeoAreas", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/geo/areas/{id}": { "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "Get area", "description": "Returns one area with the districts it covers.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoAreaModel" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [], "x-ecomiq-anonymous": true, "x-ecomiq-resource": "Geo", "operationId": "getV1GeoAreasId", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/geo/countries": { "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "List countries", "description": "Lists the countries available for addresses and shipping.", "parameters": [ { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GeoCountryModel" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [], "x-ecomiq-anonymous": true, "x-ecomiq-resource": "Geo", "operationId": "getV1GeoCountries", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/geo/resolve": { "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "Resolve area by source code", "description": "Finds which area a location belongs to, from a source code.", "parameters": [ { "name": "CountryCode", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "Source", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "Code", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoAreaModel" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [], "x-ecomiq-anonymous": true, "x-ecomiq-resource": "Geo", "operationId": "getV1GeoResolve", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/{orderId}/fulfillment-orders": { "delete": { "tags": [ "Fulfillment & Shipping" ], "operationId": "CancelFulfillmentOrdersByOrder", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipment:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Cancel fulfillment orders by order", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Fulfillment & Shipping" ], "operationId": "ListFulfillmentOrdersByOrder", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FulfillmentOrderSummaryModel" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipment:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "List fulfillment orders by order", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/{orderId}/label": { "get": { "tags": [ "Fulfillment & Shipping" ], "operationId": "GetOrderLabel", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "byte" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipment:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Get order label", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/{orderId}/shipment": { "post": { "tags": [ "Fulfillment & Shipping" ], "operationId": "CreateShipment", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CreateOrderShipmentRequestDto" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrderShipmentDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipment:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Create shipment", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/orders/{orderId}/tracking": { "get": { "tags": [ "Fulfillment & Shipping" ], "operationId": "GetOrderTracking", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderShipmentTrackingDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipment:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Orders", "summary": "Get order tracking", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/shipping/coverage": { "get": { "tags": [ "Fulfillment & Shipping" ], "operationId": "ListShippingCoverage", "parameters": [ { "name": "isActive", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingCoverageDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Coverage", "summary": "List shipping coverage", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/shipping/customizations": { "post": { "tags": [ "Fulfillment & Shipping" ], "operationId": "CreateShippingCustomization", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingCustomizationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingCustomizationDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Customizations", "summary": "Create shipping customization", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Fulfillment & Shipping" ], "operationId": "ListShippingCustomizations", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingCustomizationDetailsDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Customizations", "summary": "List shipping customizations", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/shipping/customizations/{id}": { "delete": { "tags": [ "Fulfillment & Shipping" ], "operationId": "DeleteShippingCustomization", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:delete" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Customizations", "summary": "Delete shipping customization", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Fulfillment & Shipping" ], "operationId": "GetShippingCustomization", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingCustomizationDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Customizations", "summary": "Get shipping customization", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Fulfillment & Shipping" ], "operationId": "UpdateShippingCustomization", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingCustomizationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingCustomizationDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Customizations", "summary": "Update shipping customization", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/shipping/holidays": { "post": { "tags": [ "Fulfillment & Shipping" ], "summary": "Create holiday", "description": "Create a new holiday in the system", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HolidayRequest" } } }, "required": true }, "responses": { "201": { "description": "Created" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipping_settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Holidays", "operationId": "postV1ShippingHolidays", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "List holidays", "description": "Get a paginated list of holidays with optional filtering", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "isActive", "in": "query", "schema": { "type": "boolean" } }, { "name": "year", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfHolidayDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Holidays", "operationId": "getV1ShippingHolidays", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/shipping/holidays/{id}": { "delete": { "tags": [ "Fulfillment & Shipping" ], "summary": "Delete a holiday", "description": "Delete an existing holiday", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipping_settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Holidays", "operationId": "deleteV1ShippingHolidaysId", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "Get a holiday by ID", "description": "Returns one non-working day.", "operationId": "GetHoliday", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HolidayDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Holidays", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Fulfillment & Shipping" ], "summary": "Update holiday", "description": "Updates a non-working day. Delivery estimates skip these dates.", "operationId": "UpdateHoliday", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HolidayRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipping_settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Holidays", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/shipping/methods": { "post": { "tags": [ "Fulfillment & Shipping" ], "summary": "Create shipping method", "description": "Create a new shipping method", "operationId": "CreateShippingMethod", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingMethodRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Methods", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "List shipping methods", "description": "Get a paginated list of shipping methods with optional filtering", "operationId": "ListShippingMethods", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "isActive", "in": "query", "schema": { "type": "boolean" } }, { "name": "visibleInCheckout", "in": "query", "schema": { "type": "boolean" } }, { "name": "onlyAvailable", "in": "query", "schema": { "type": "boolean" } }, { "name": "postalCode", "in": "query", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfShippingMethodType" } }, { "name": "shippingProfileId", "in": "query", "schema": { "type": [ "null", "string" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfShippingMethodDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Methods", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/shipping/methods/{id}": { "delete": { "tags": [ "Fulfillment & Shipping" ], "summary": "Delete shipping method", "description": "Delete an existing shipping method", "operationId": "DeleteShippingMethod", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:delete" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Methods", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "Get shipping method", "description": "Get a shipping method by ID", "operationId": "GetShippingMethod", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingMethodDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Methods", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Fulfillment & Shipping" ], "summary": "Update shipping method", "description": "Update an existing shipping method", "operationId": "UpdateShippingMethod", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingMethodRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Methods", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/shipping/methods/{id}/rates": { "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "Get shipping method rates", "description": "Get paginated rates for a specific shipping method", "operationId": "GetShippingMethodRates", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "isActive", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfShippingRateDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Methods", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/shipping/methods/slots": { "post": { "tags": [ "Fulfillment & Shipping" ], "operationId": "ListShippingMethodSlots", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingMethodSlotsInputModel" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingMethodSlotsModel" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Methods", "summary": "List shipping method slots", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/shipping/pickup-points": { "post": { "tags": [ "Fulfillment & Shipping" ], "summary": "Create pickup point", "description": "Creates a pickup point where customers can collect their orders.", "operationId": "CreatePickupPoint", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePickupPointRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Pickup Points", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "List pickup points", "description": "Get a paginated list of pickup points with optional filtering", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "isActive", "in": "query", "schema": { "type": "boolean" } }, { "name": "locationId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "city", "in": "query", "schema": { "type": "string" } }, { "name": "zone", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfPickupPointDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Pickup Points", "operationId": "getV1ShippingPickupPoints", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/shipping/pickup-points/{id}": { "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "Get a pickup point by ID", "description": "Returns one pickup point with its address and opening hours.", "operationId": "GetPickupPoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PickupPointDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Pickup Points", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Fulfillment & Shipping" ], "summary": "Update pickup point", "description": "Updates a pickup point.", "operationId": "UpdatePickupPoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePickupPointRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Pickup Points", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/shipping/profiles": { "post": { "tags": [ "Fulfillment & Shipping" ], "operationId": "CreateShippingProfile", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingProfileRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingProfileModel" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Profiles", "summary": "Create shipping profile", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Fulfillment & Shipping" ], "operationId": "ListShippingProfiles", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingProfileModel" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Profiles", "summary": "List shipping profiles", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/shipping/profiles/{id}": { "delete": { "tags": [ "Fulfillment & Shipping" ], "operationId": "DeleteShippingProfile", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:delete" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Profiles", "summary": "Delete shipping profile", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Fulfillment & Shipping" ], "operationId": "GetShippingProfile", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingProfileModel" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Profiles", "summary": "Get shipping profile", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Fulfillment & Shipping" ], "operationId": "UpdateShippingProfile", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateShippingProfileRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingProfileModel" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Profiles", "summary": "Update shipping profile", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/shipping/rates": { "post": { "tags": [ "Fulfillment & Shipping" ], "summary": "Create shipping rate", "description": "Creates a shipping rate inside a zone: what it costs to reach that area under given conditions.", "operationId": "CreateShippingRate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingRateRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Rates", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "List shipping rates", "description": "Get a paginated list of shipping rates with optional filtering", "operationId": "ListShippingRates", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "shippingMethodId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "isActive", "in": "query", "schema": { "type": "boolean" } }, { "name": "type", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfShippingRateType" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfShippingRateDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Rates", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/shipping/rates/{id}": { "delete": { "tags": [ "Fulfillment & Shipping" ], "summary": "Delete shipping rate", "description": "Delete an existing shipping rate", "operationId": "DeleteShippingRate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:delete" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Rates", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "Get shipping rate", "description": "Get a shipping rate by ID", "operationId": "GetShippingRate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingRateDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Rates", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Fulfillment & Shipping" ], "summary": "Update shipping rate", "description": "Updates a shipping rate. Carts already quoted keep the price they were given.", "operationId": "UpdateShippingRate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingRateRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Rates", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/shipping/rates/available": { "post": { "tags": [ "Fulfillment & Shipping" ], "operationId": "ListAvailableShippingRates", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingEstimateModel" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingEstimateOptionModel" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Rates", "summary": "List available shipping rates", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/shipping/rates/import": { "post": { "tags": [ "Fulfillment & Shipping" ], "summary": "Import shipping rates from asset or JSON rows", "description": "Imports shipping rates in bulk, from an uploaded file or from rows sent inline.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingRateImportRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingRateImportDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Rates", "operationId": "postV1ShippingRatesImport", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/shipping/rates/live-quotes": { "post": { "tags": [ "Fulfillment & Shipping" ], "summary": "Get live shipping quotes from carrier", "description": "Get real-time shipping rate quotes from an external carrier via shipping method connection", "operationId": "GetLiveShippingQuotes", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveShippingQuoteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingQuoteResult" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Rates", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/shipping/rates/template": { "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "Download shipping rates import template", "description": "Downloads the spreadsheet template for importing shipping rates.", "operationId": "DownloadShippingRatesTemplate", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Rates", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/shipping/settings": { "get": { "tags": [ "Fulfillment & Shipping" ], "operationId": "GetShippingSettings", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingSettingsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Settings", "summary": "Get shipping settings", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Fulfillment & Shipping" ], "operationId": "UpdateShippingSettings", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingSettingsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingSettingsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipping_settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Settings", "summary": "Update shipping settings", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/shipping/zones": { "post": { "tags": [ "Fulfillment & Shipping" ], "summary": "Create shipping zone", "description": "Create a new shipping zone by country, province, city, district or postal codes", "operationId": "CreateShippingZone", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingZoneRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipping_settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Zones", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "List shipping zones", "description": "Get a paginated list of shipping zones with optional filtering", "operationId": "ListShippingZones", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "isActive", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfShippingZoneDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Zones", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/shipping/zones/{id}": { "get": { "tags": [ "Fulfillment & Shipping" ], "summary": "Get shipping zone", "description": "Get a shipping zone by ID", "operationId": "GetShippingZone", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingZoneDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Zones", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Fulfillment & Shipping" ], "summary": "Update shipping zone", "description": "Updates a shipping zone: the set of areas that share the same rates.", "operationId": "UpdateShippingZone", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippingZoneRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found" }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "shipping_settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Zones", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/taxes/overrides": { "post": { "tags": [ "Fulfillment & Shipping" ], "operationId": "CreateTaxOverride", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxOverrideRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxOverrideDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Overrides", "summary": "Create tax override", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Fulfillment & Shipping" ], "operationId": "ListTaxOverrides", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxOverrideDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Overrides", "summary": "List tax overrides", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/taxes/overrides/{id}": { "delete": { "tags": [ "Fulfillment & Shipping" ], "operationId": "DeleteTaxOverride", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Success" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:delete" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Overrides", "summary": "Delete tax override", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Fulfillment & Shipping" ], "operationId": "GetTaxOverride", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxOverrideDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Overrides", "summary": "Get tax override", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Fulfillment & Shipping" ], "operationId": "UpdateTaxOverride", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxOverrideRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxOverrideDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Overrides", "summary": "Update tax override", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/taxes/regions": { "post": { "tags": [ "Fulfillment & Shipping" ], "operationId": "CreateTaxRegion", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxRegionRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxRegionDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Regions", "summary": "Create tax region", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Fulfillment & Shipping" ], "operationId": "ListTaxRegions", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRegionItemDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Regions", "summary": "List tax regions", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/taxes/regions/{id}": { "delete": { "tags": [ "Fulfillment & Shipping" ], "operationId": "DeleteTaxRegion", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Success" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:delete" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Regions", "summary": "Delete tax region", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Fulfillment & Shipping" ], "operationId": "GetTaxRegion", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxRegionDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Regions", "summary": "Get tax region", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Fulfillment & Shipping" ], "operationId": "UpdateTaxRegion", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxRegionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxRegionDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Regions", "summary": "Update tax region", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/taxes/settings": { "get": { "tags": [ "Fulfillment & Shipping" ], "operationId": "GetTaxSettings", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxSettingsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Settings", "summary": "Get tax settings", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Fulfillment & Shipping" ], "operationId": "UpdateTaxSettings", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxSettingsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaxSettingsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Settings", "summary": "Update tax settings", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/billing/current/ai-credits/activity": { "get": { "tags": [ "Payments & Finance" ], "summary": "List AI credit activity", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfAiCreditActivityItemDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "billing:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Billing", "operationId": "getV1BillingCurrentAiCreditsActivity", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/billing/current/ai-credits/balance": { "get": { "tags": [ "Payments & Finance" ], "summary": "Get the current AI credit balance", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiCreditBalanceDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "billing:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Billing", "operationId": "getV1BillingCurrentAiCreditsBalance", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/billing/current/ai-credits/catalog": { "get": { "tags": [ "Payments & Finance" ], "summary": "Get the current AI credit catalog", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiCreditCatalogDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "billing:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Billing", "operationId": "getV1BillingCurrentAiCreditsCatalog", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/billing/current/ai-credits/checkouts": { "post": { "tags": [ "Payments & Finance" ], "summary": "Create an AI credit checkout", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiCreditCheckoutRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiCreditCheckoutDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "billing:manage" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Billing", "operationId": "postV1BillingCurrentAiCreditsCheckouts", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/billing/current/checkouts/{sessionId}": { "get": { "tags": [ "Payments & Finance" ], "summary": "Get an active billing checkout", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingCheckoutDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "billing:manage" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Billing", "operationId": "getV1BillingCurrentCheckoutsSessionid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/billing/current/checkouts/{sessionId}/confirm": { "post": { "tags": [ "Payments & Finance" ], "summary": "Confirm an embedded billing checkout", "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmBillingCheckoutRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingCheckoutConfirmationDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "billing:manage" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Billing", "operationId": "postV1BillingCurrentCheckoutsSessionidConfirm", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/billing/current/history": { "get": { "tags": [ "Payments & Finance" ], "summary": "List current billing history", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfBillingHistoryItemDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "billing:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Billing", "operationId": "getV1BillingCurrentHistory", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/billing/current/plan-purchases": { "post": { "tags": [ "Payments & Finance" ], "summary": "Create a billing plan purchase", "operationId": "CreatePlanPurchase", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingPlanPurchaseRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanPurchaseDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "billing:manage" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Billing", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/billing/current/subscription": { "get": { "tags": [ "Payments & Finance" ], "summary": "Get the current billing subscription", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrentBillingSubscriptionDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "billing:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Billing", "operationId": "getV1BillingCurrentSubscription", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/billing/current/subscription/cancel": { "post": { "tags": [ "Payments & Finance" ], "summary": "Cancel the current billing subscription", "operationId": "CancelBillingSubscription", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingSubscriptionDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "billing:manage" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Billing", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/billing/current/usage": { "get": { "tags": [ "Payments & Finance" ], "summary": "Get current billing usage", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingUsageDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "billing:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Billing", "operationId": "getV1BillingCurrentUsage", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/billing/plans": { "get": { "tags": [ "Payments & Finance" ], "summary": "List available billing plans", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BillingPlanDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [], "x-ecomiq-anonymous": true, "x-ecomiq-resource": "Billing", "operationId": "getV1BillingPlans", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/payments/{paymentTransactionId}/cancel": { "post": { "tags": [ "Payments & Finance" ], "operationId": "CancelPayment", "parameters": [ { "name": "paymentTransactionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelPaymentRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "payment:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Payments", "summary": "Cancel payment", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/payments/{paymentTransactionId}/capture": { "post": { "tags": [ "Payments & Finance" ], "operationId": "CapturePayment", "parameters": [ { "name": "paymentTransactionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CapturePaymentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartPaymentResultModel" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "payment:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Payments", "summary": "Capture payment", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/payments/methods": { "get": { "tags": [ "Payments & Finance" ], "operationId": "ListPaymentMethods", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodModel" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "payment:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Payments", "summary": "List payment methods", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Payments & Finance" ], "operationId": "UpdatePaymentMethods", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethodsRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "payment:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Payments", "summary": "Update payment methods", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/payments/refund": { "post": { "tags": [ "Payments & Finance" ], "operationId": "RefundPayment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundPaymentRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "payment:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Payments", "summary": "Refund payment", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/payments/settings": { "get": { "tags": [ "Payments & Finance" ], "operationId": "GetPaymentSettings", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentSettingsModel" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "payment:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Payments", "summary": "Get payment settings", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Payments & Finance" ], "operationId": "UpdatePaymentSettings", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentSettingsRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "payment:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Payments", "summary": "Update payment settings", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/payments/start": { "post": { "tags": [ "Payments & Finance" ], "operationId": "StartPayment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartPaymentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartPaymentResultModel" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "payment:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Payments", "summary": "Start payment", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/sellers": { "post": { "tags": [ "Payments & Finance" ], "summary": "Create seller", "description": "Create a new seller in the catalog", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSellerRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Sellers", "operationId": "postV1Sellers", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Payments & Finance" ], "summary": "List sellers", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfSellerStatus" } } }, { "name": "includeInternal", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfSellerItemDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Sellers", "operationId": "getV1Sellers", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/sellers/{id}": { "delete": { "tags": [ "Payments & Finance" ], "summary": "Delete a seller", "description": "Delete an existing seller", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:delete" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Sellers", "operationId": "deleteV1SellersId", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Payments & Finance" ], "summary": "Get seller by ID", "description": "Retrieve a specific seller by its ID", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SellerDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Sellers", "operationId": "getV1SellersId", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Payments & Finance" ], "summary": "Update a seller", "description": "Update an existing seller", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSellerRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Sellers", "operationId": "putV1SellersId", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/sellers/{sellerId}/commissions": { "get": { "tags": [ "Payments & Finance" ], "summary": "List seller commissions", "parameters": [ { "name": "sellerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SellerCommissionDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Sellers", "operationId": "getV1SellersSelleridCommissions", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Payments & Finance" ], "summary": "Replace seller commissions", "parameters": [ { "name": "sellerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSellerCommissionsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SellerCommissionDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Sellers", "operationId": "putV1SellersSelleridCommissions", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/sellers/{sellerId}/invitations": { "post": { "tags": [ "Payments & Finance" ], "summary": "Invite a seller member", "description": "Invites someone to a seller with a given role.", "parameters": [ { "name": "sellerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InviteSellerMemberRequest" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "member:invite" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Sellers", "operationId": "postV1SellersSelleridInvitations", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Payments & Finance" ], "summary": "List seller invitations", "description": "Lists the pending invitations of a seller.", "parameters": [ { "name": "sellerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfInvitationStatus" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvitationItemDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "member:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Sellers", "operationId": "getV1SellersSelleridInvitations", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/sellers/{sellerId}/invitations/{invitationId}": { "delete": { "tags": [ "Payments & Finance" ], "summary": "Delete a seller invitation", "description": "Revokes a pending invitation. The link stops working.", "parameters": [ { "name": "sellerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invitationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "member:delete" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Sellers", "operationId": "deleteV1SellersSelleridInvitationsInvitationid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/sellers/{sellerId}/invitations/{invitationId}/resend": { "post": { "tags": [ "Payments & Finance" ], "summary": "Resend a seller invitation", "description": "Sends the invitation email again and extends its expiry.", "parameters": [ { "name": "sellerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "invitationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "member:invite" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Sellers", "operationId": "postV1SellersSelleridInvitationsInvitationidResend", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/sellers/{sellerId}/members": { "get": { "tags": [ "Payments & Finance" ], "summary": "List seller members", "description": "Lists the people with access to a seller.", "parameters": [ { "name": "sellerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfMemberStatus" } } }, { "name": "emails", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "names", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "roles", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "isOwner", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfMemberItemDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "member:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Sellers", "operationId": "getV1SellersSelleridMembers", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/sellers/{sellerId}/members/{memberId}": { "delete": { "tags": [ "Payments & Finance" ], "summary": "Remove a member's access to a seller", "description": "Removes a person's access to a seller. Their user account is not deleted.", "parameters": [ { "name": "sellerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "member:delete" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Sellers", "operationId": "deleteV1SellersSelleridMembersMemberid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/sellers/{sellerId}/roles": { "get": { "tags": [ "Payments & Finance" ], "summary": "List seller roles", "description": "Lists the roles a seller member can hold.", "parameters": [ { "name": "sellerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RoleItemDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "role:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Sellers", "operationId": "getV1SellersSelleridRoles", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/sellers/{sellerId}/scopes": { "get": { "tags": [ "Payments & Finance" ], "summary": "List seller scopes", "parameters": [ { "name": "sellerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SellerScopeDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Sellers", "operationId": "getV1SellersSelleridScopes", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Payments & Finance" ], "summary": "Replace seller scopes", "parameters": [ { "name": "sellerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSellerScopesRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SellerScopeDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "settings:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Sellers", "operationId": "putV1SellersSelleridScopes", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/coupons": { "get": { "tags": [ "Promotions" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfPromotionStatus" } } }, { "name": "type", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfPromotionType" } }, { "name": "target", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfPromotionTarget" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfPromotionItemDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "promotion:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Coupons", "summary": "List coupons", "operationId": "getV1Coupons", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "post": { "tags": [ "Promotions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromotionUpsertRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "promotion:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Coupons", "summary": "Create coupon", "operationId": "postV1Coupons", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/coupons/{couponId}": { "get": { "tags": [ "Promotions" ], "parameters": [ { "name": "couponId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromotionDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "promotion:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Coupons", "summary": "Get coupon", "operationId": "getV1CouponsCouponid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Promotions" ], "parameters": [ { "name": "couponId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromotionUpsertRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "promotion:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Coupons", "summary": "Update coupon", "operationId": "putV1CouponsCouponid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/coupons/{couponId}/codes": { "post": { "tags": [ "Promotions" ], "parameters": [ { "name": "couponId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePromotionCodeRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromotionCodeDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "promotion:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Coupons", "summary": "Create coupon code", "operationId": "postV1CouponsCouponidCodes", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/coupons/{couponId}/codes/batch": { "post": { "tags": [ "Promotions" ], "summary": "Queue a coupon codes batch creation", "description": "Queues the generation of a batch of coupon codes. Returns a job; the codes are created in the background.", "parameters": [ { "name": "couponId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePromotionCodesRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromotionOperationDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "promotion:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Coupons", "operationId": "postV1CouponsCouponidCodesBatch", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/discounts": { "get": { "tags": [ "Promotions" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QueryEnumOfPromotionStatus" } } }, { "name": "type", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfPromotionType" } }, { "name": "target", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfPromotionTarget" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfPromotionItemDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "promotion:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Discounts", "summary": "List discounts", "operationId": "getV1Discounts", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "post": { "tags": [ "Promotions" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromotionUpsertRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "string", "format": "uuid" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "promotion:create" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Discounts", "summary": "Create discount", "operationId": "postV1Discounts", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/discounts/{discountId}": { "get": { "tags": [ "Promotions" ], "parameters": [ { "name": "discountId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromotionDetailsDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "promotion:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Discounts", "summary": "Get discount", "operationId": "getV1DiscountsDiscountid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Promotions" ], "parameters": [ { "name": "discountId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PromotionUpsertRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "promotion:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Discounts", "summary": "Update discount", "operationId": "putV1DiscountsDiscountid", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/webhooks/deliveries": { "get": { "tags": [ "Webhooks" ], "summary": "List webhook deliveries", "description": "Get webhook delivery history for the current store", "operationId": "ListWebhookDeliveries", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" }, "description": "Maximum number of results to return." }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Opaque cursor from the previous response. Omit it on the first page." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Free-text filter. Which fields it covers depends on the resource." }, { "name": "sortBy", "in": "query", "schema": { "type": "string" }, "description": "Field to sort by. Accepted values depend on the resource." }, { "name": "sortDirection", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfSortDirection" }, "description": "Sort direction: `asc` or `desc`." }, { "name": "endpointId", "in": "query", "schema": { "type": [ "null", "string" ] } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/QueryEnumOfWebhookDeliveryStatus" } }, { "name": "eventType", "in": "query", "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "toDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "sellerId", "in": "query", "schema": { "type": [ "null", "string" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CursorPaginatedItemsOfWebhookDeliveryDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "connection:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Webhooks", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/webhooks/deliveries/{id}": { "get": { "tags": [ "Webhooks" ], "summary": "Get webhook delivery", "description": "Get webhook delivery detail for the current store", "operationId": "GetWebhookDelivery", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDeliveryDetailDto" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "connection:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Webhooks", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/webhooks/deliveries/{id}/retry": { "post": { "tags": [ "Webhooks" ], "summary": "Retry webhook delivery", "description": "Re-enqueue a failed webhook delivery with its original payload", "operationId": "RetryWebhookDelivery", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "connection:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Webhooks", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/webhooks/endpoints": { "post": { "tags": [ "Webhooks" ], "summary": "Create webhook endpoint", "description": "Register a new webhook endpoint to receive system events", "operationId": "CreateWebhookEndpoint", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointRequest" }, "example": { "name": "Pedidos al ERP", "url": "https://erp.example.com/webhooks/ecomiq", "eventTypes": [ "order.confirmed", "catalog.product.updated" ], "secret": "whsec_replace_with_a_random_secret" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "connection:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Webhooks", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "get": { "tags": [ "Webhooks" ], "summary": "List webhook endpoints", "description": "Get all registered webhook endpoints for the current store", "operationId": "ListWebhookEndpoints", "parameters": [ { "name": "sellerId", "in": "query", "schema": { "type": [ "null", "string" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEndpointDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "connection:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Webhooks", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/webhooks/endpoints/{id}": { "delete": { "tags": [ "Webhooks" ], "summary": "Delete webhook endpoint", "description": "Delete a webhook endpoint", "operationId": "DeleteWebhookEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "connection:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Webhooks", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Webhooks" ], "summary": "Update webhook endpoint", "description": "Update an existing webhook endpoint", "operationId": "UpdateWebhookEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "connection:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Webhooks", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/webhooks/endpoints/{id}/disable": { "post": { "tags": [ "Webhooks" ], "summary": "Disable webhook endpoint", "description": "Disable a webhook endpoint", "operationId": "DisableWebhookEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "connection:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Webhooks", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/webhooks/endpoints/{id}/enable": { "post": { "tags": [ "Webhooks" ], "summary": "Enable webhook endpoint", "description": "Enable a webhook endpoint", "operationId": "EnableWebhookEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "connection:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Webhooks", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/webhooks/endpoints/{id}/pause": { "post": { "tags": [ "Webhooks" ], "summary": "Pause webhook endpoint", "description": "Pause a webhook endpoint without deleting it", "operationId": "PauseWebhookEndpoint", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier of the resource." } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "connection:update" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Webhooks", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/webhooks/events": { "get": { "tags": [ "Webhooks" ], "summary": "List webhook events", "description": "Get all supported webhook events and their payload details", "operationId": "ListWebhookEvents", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEventModel" } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "connection:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Webhooks", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/v1/webhooks/events/{eventType}": { "get": { "tags": [ "Webhooks" ], "summary": "Get webhook event", "description": "Get the detail of a supported webhook event", "operationId": "GetWebhookEvent", "parameters": [ { "name": "eventType", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEventModel" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] } ], "x-ecomiq-permissions": [ "connection:read" ], "x-ecomiq-permission-logic": "any", "x-ecomiq-anonymous": false, "x-ecomiq-resource": "Webhooks", "x-ecomiq-surface": "admin", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } } }, "components": { "schemas": { "AddOrderDraftItemRequest": { "required": [ "quantity" ], "type": "object", "properties": { "variantId": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "subtitle": { "type": [ "null", "string" ] }, "thumbnail": { "type": [ "null", "string" ] }, "quantity": { "type": "integer", "format": "int32" }, "unitPrice": { "type": [ "null", "number" ], "format": "double" }, "discount": { "type": "number", "format": "double" }, "shipping": { "type": "number", "format": "double" }, "tax": { "type": "number", "format": "double" }, "warranty": { "type": "number", "format": "double" }, "requiresShipping": { "type": "boolean" }, "isTaxInclusive": { "type": "boolean" }, "metadata": { "type": [ "null", "object" ] } } }, "Address": { "required": [ "address1", "city", "countryCode" ], "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "company": { "type": [ "null", "string" ] }, "address1": { "type": "string" }, "address2": { "type": [ "null", "string" ] }, "city": { "type": "string" }, "countryCode": { "type": "string", "description": "ISO 3166-1 alpha-2 country code, for example `PE`." }, "province": { "type": [ "null", "string" ] }, "postalCode": { "type": [ "null", "string" ] }, "district": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "latitude": { "type": [ "null", "number" ], "format": "double" }, "longitude": { "type": [ "null", "number" ], "format": "double" }, "metadata": { "type": [ "null", "object" ] } } }, "AiCreditActivityItemDto": { "required": [ "id", "type", "source", "creditChange", "balanceAfter", "createdOn", "requestId", "capability", "provider", "model", "inputTokens", "outputTokens", "usageStatus" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "type": { "$ref": "#/components/schemas/AiCreditTransactionType" }, "source": { "$ref": "#/components/schemas/AiCreditTransactionSource" }, "creditChange": { "type": "integer", "format": "int64" }, "balanceAfter": { "type": "integer", "format": "int64" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "requestId": { "type": [ "null", "string" ] }, "capability": { "type": [ "null", "string" ] }, "provider": { "type": [ "null", "string" ] }, "model": { "type": [ "null", "string" ] }, "inputTokens": { "type": [ "null", "integer" ], "format": "int64" }, "outputTokens": { "type": [ "null", "integer" ], "format": "int64" }, "usageStatus": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AiUsageStatus" } ] } } }, "AiCreditBalanceDto": { "required": [ "accountId", "monthlyCreditAllowance", "monthlyCreditsUsed", "purchasedCreditBalance", "reservedCredits", "availableCredits", "cycleStartsOn", "cycleEndsOn" ], "type": "object", "properties": { "accountId": { "type": "string" }, "monthlyCreditAllowance": { "type": "integer", "format": "int64" }, "monthlyCreditsUsed": { "type": "integer", "format": "int64" }, "purchasedCreditBalance": { "type": "integer", "format": "int64" }, "reservedCredits": { "type": "integer", "format": "int64" }, "availableCredits": { "type": "integer", "format": "int64" }, "cycleStartsOn": { "type": "string", "format": "date-time" }, "cycleEndsOn": { "type": "string", "format": "date-time" } } }, "AiCreditCatalogDto": { "required": [ "currencyCode", "creditValue", "creditPacks", "customCreditPack" ], "type": "object", "properties": { "currencyCode": { "type": "string", "description": "ISO 4217 currency code, for example `PEN`." }, "creditValue": { "type": "number", "format": "double" }, "creditPacks": { "type": "array", "items": { "$ref": "#/components/schemas/AiCreditPackDto" } }, "customCreditPack": { "$ref": "#/components/schemas/CustomAiCreditPackDto" } } }, "AiCreditCheckoutDto": { "required": [ "sessionId", "packCode", "credits", "baseAmount", "discountRate", "discountAmount", "amount", "currencyCode", "paymentProvider", "checkoutUrl" ], "type": "object", "properties": { "sessionId": { "type": "string" }, "packCode": { "type": "string" }, "credits": { "type": "integer", "format": "int64" }, "baseAmount": { "type": "number", "format": "double" }, "discountRate": { "type": "number", "format": "double" }, "discountAmount": { "type": "number", "format": "double" }, "amount": { "type": "number", "format": "double" }, "currencyCode": { "type": "string", "description": "ISO 4217 currency code, for example `PEN`." }, "paymentProvider": { "type": "string" }, "checkoutUrl": { "type": [ "null", "string" ] }, "checkout": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BillingCheckoutDto" } ] } } }, "AiCreditCheckoutRequest": { "required": [ "packCode" ], "type": "object", "properties": { "packCode": { "type": [ "null", "string" ] }, "customCredits": { "type": [ "null", "integer" ], "format": "int64" } } }, "AiCreditPackDto": { "required": [ "code", "name", "credits", "basePrice", "discountRate", "discountAmount", "price", "currencyCode", "isCustom" ], "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "credits": { "type": "integer", "format": "int64" }, "basePrice": { "type": "number", "format": "double" }, "discountRate": { "type": "number", "format": "double" }, "discountAmount": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "currencyCode": { "type": "string", "description": "ISO 4217 currency code, for example `PEN`." }, "isCustom": { "type": "boolean" } } }, "AiCreditTransactionSource": { "enum": [ "unknown", "planAllowance", "productFormAssistant", "seoGenerator", "imageGenerator", "chatAgent", "aiCreditPurchase", "adminAdjustment" ], "type": "string" }, "AiCreditTransactionType": { "enum": [ "grant", "usage", "purchase", "refund", "adjustment", "reservation", "release" ], "type": "string" }, "AiUsageStatus": { "enum": [ "pending", "succeeded", "failed", "rejected", "cancelled" ], "type": [ "null", "string" ] }, "ApiKeyDto": { "required": [ "id", "name", "prefix", "keySuffix" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "name": { "type": "string" }, "prefix": { "type": "string" }, "keySuffix": { "type": "string" }, "applicationUrl": { "type": [ "null", "string" ] }, "isActive": { "type": "boolean" }, "isTestMode": { "type": "boolean" }, "expiresAt": { "type": [ "null", "string" ], "format": "date-time" }, "lastUsedAt": { "type": [ "null", "string" ], "format": "date-time" }, "scopes": { "type": "array", "items": { "type": "string" } }, "allowedIps": { "type": "array", "items": { "type": "string" } }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "createdBy": { "type": [ "null", "string" ], "format": "uuid" }, "userId": { "type": [ "null", "string" ], "format": "uuid" } } }, "AreaLevel": { "enum": [ "level1", "level2", "level3" ], "type": "string" }, "AssignFulfillmentOrderRequest": { "required": [ "locationId" ], "type": "object", "properties": { "locationId": { "type": "string" } } }, "BatchOrderConciliationDto": { "required": [ "matchedCount", "updatedCount", "failedOrderIds", "failedOrderNumbers" ], "type": "object", "properties": { "matchedCount": { "type": "integer", "format": "int32" }, "updatedCount": { "type": "integer", "format": "int32" }, "failedOrderIds": { "type": "array" }, "failedOrderNumbers": { "type": "array", "items": { "type": "string" } } } }, "BatchOrderConciliationRequest": { "type": "object", "properties": { "orderIds": { "type": [ "null", "array" ] }, "orderNumbers": { "type": [ "null", "array" ], "items": { "type": "string" } }, "conciliated": { "type": "boolean" }, "conciliationAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "BatchOrderStatusRequest": { "required": [ "targetStatus" ], "type": "object", "properties": { "targetStatus": { "$ref": "#/components/schemas/OrderStatus" }, "search": { "type": [ "null", "string" ], "description": "Free-text filter. Which fields it covers depends on the resource." }, "status": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrderStatus" } ] }, "state": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrderState" } ] }, "fulfillmentStatus": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrderFulfillmentStatus" } ] }, "returnStatus": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrderReturnStatus" } ] }, "locationId": { "type": [ "null", "string" ] }, "customerId": { "type": [ "null", "string" ] }, "conciliated": { "type": [ "null", "boolean" ] }, "dateFrom": { "type": [ "null", "string" ], "format": "date-time" }, "dateTo": { "type": [ "null", "string" ], "format": "date-time" }, "orderIds": { "type": [ "null", "array" ] }, "orderNumbers": { "type": [ "null", "array" ], "items": { "type": "string" } }, "comment": { "type": [ "null", "string" ] }, "trackingNumber": { "type": [ "null", "string" ] }, "trackingLink": { "type": [ "null", "string" ] }, "carrierName": { "type": [ "null", "string" ] }, "invoiceNumber": { "type": [ "null", "string" ] }, "invoiceLink": { "type": [ "null", "string" ] }, "cancelReason": { "type": [ "null", "string" ] }, "cancelReasonType": { "type": [ "null", "string" ] } } }, "BillingCheckoutConfirmationDto": { "required": [ "sessionId", "kind", "status", "paymentProvider" ], "type": "object", "properties": { "sessionId": { "type": "string" }, "kind": { "$ref": "#/components/schemas/BillingCheckoutKind" }, "status": { "$ref": "#/components/schemas/BillingCheckoutStatus" }, "paymentProvider": { "type": "string" }, "externalResourceUrl": { "type": [ "null", "string" ] }, "qrCode": { "type": [ "null", "string" ] }, "reference": { "type": [ "null", "string" ] }, "expiresAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "BillingCheckoutDto": { "required": [ "sessionId", "kind", "status", "mode", "paymentProvider", "amount", "currencyCode", "description", "isEmbedded", "publicKey", "checkoutUrl", "customerEmail" ], "type": "object", "properties": { "sessionId": { "type": "string" }, "kind": { "$ref": "#/components/schemas/BillingCheckoutKind" }, "status": { "$ref": "#/components/schemas/BillingCheckoutStatus" }, "mode": { "type": "string" }, "paymentProvider": { "type": "string" }, "amount": { "type": "number", "format": "double" }, "currencyCode": { "type": "string", "description": "ISO 4217 currency code, for example `PEN`." }, "description": { "type": "string" }, "isEmbedded": { "type": "boolean" }, "publicKey": { "type": [ "null", "string" ] }, "checkoutUrl": { "type": [ "null", "string" ] }, "customerEmail": { "type": [ "null", "string" ] }, "tax": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BillingTaxBreakdownDto" } ] }, "receipt": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BillingReceiptDeliveryDto" } ] }, "paymentMethod": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BillingPaymentMethodDto" } ] }, "externalResourceUrl": { "type": [ "null", "string" ] }, "qrCode": { "type": [ "null", "string" ] }, "reference": { "type": [ "null", "string" ] }, "expiresAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "BillingCheckoutKind": { "enum": [ "planPurchase", "aiCreditPurchase" ], "type": "string" }, "BillingCheckoutStatus": { "enum": [ "pending", "checkoutCreated", "paid", "failed", "cancelled", "expired" ], "type": "string" }, "BillingHistoryItemDto": { "required": [ "id", "kind", "description", "amount", "currencyCode", "status", "paymentProvider", "createdOn", "paidOn", "providerPaymentId", "receiptUrl" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "kind": { "$ref": "#/components/schemas/BillingCheckoutKind" }, "description": { "type": "string" }, "amount": { "type": "number", "format": "double" }, "currencyCode": { "type": "string", "description": "ISO 4217 currency code, for example `PEN`." }, "status": { "$ref": "#/components/schemas/BillingCheckoutStatus" }, "paymentProvider": { "type": "string" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "paidOn": { "type": [ "null", "string" ], "format": "date-time" }, "providerPaymentId": { "type": [ "null", "string" ] }, "receiptUrl": { "type": [ "null", "string" ] } } }, "BillingInformationDto": { "required": [ "isComplete" ], "type": "object", "properties": { "accountHolder": { "type": [ "null", "string" ] }, "documentNumber": { "type": [ "null", "string" ], "description": "National identity or tax document number." }, "bankName": { "type": [ "null", "string" ] }, "accountType": { "type": [ "null", "string" ] }, "accountNumber": { "type": [ "null", "string" ] }, "interbankAccountNumber": { "type": [ "null", "string" ] }, "isComplete": { "type": "boolean" } } }, "BillingPaymentMethodDto": { "required": [ "providerId", "brand", "lastFour", "expirationMonth", "expirationYear", "canReuse" ], "type": "object", "properties": { "providerId": { "type": "string" }, "brand": { "type": [ "null", "string" ] }, "lastFour": { "type": [ "null", "string" ] }, "expirationMonth": { "type": [ "null", "integer" ], "format": "int32" }, "expirationYear": { "type": [ "null", "integer" ], "format": "int32" }, "canReuse": { "type": "boolean" } } }, "BillingPlanDto": { "required": [ "type", "name", "price", "annualPrice", "annualMonthlyPrice", "annualDiscountRate", "enableApi", "storageLimitBytes", "monthlyTransferLimitBytes", "maxUploadSizeBytes", "maxStores", "maxMembers", "maxProducts", "maxCategories", "maxBrands", "maxAttributes", "maxCollections", "monthlyAiCreditAllowance", "activityLogRetentionDays", "webhookSuccessRetentionDays", "webhookFailedRetentionDays" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/BillingPlanType" }, "name": { "type": "string" }, "price": { "type": "number", "format": "double" }, "annualPrice": { "type": "number", "format": "double" }, "annualMonthlyPrice": { "type": "number", "format": "double" }, "annualDiscountRate": { "type": "number", "format": "double" }, "enableApi": { "type": "boolean" }, "storageLimitBytes": { "type": "integer", "format": "int64" }, "monthlyTransferLimitBytes": { "type": "integer", "format": "int64" }, "maxUploadSizeBytes": { "type": "integer", "format": "int64" }, "maxStores": { "type": "integer", "format": "int32" }, "maxMembers": { "type": "integer", "format": "int32" }, "maxProducts": { "type": "integer", "format": "int32" }, "maxCategories": { "type": "integer", "format": "int32" }, "maxBrands": { "type": "integer", "format": "int32" }, "maxAttributes": { "type": "integer", "format": "int32" }, "maxCollections": { "type": "integer", "format": "int32" }, "monthlyAiCreditAllowance": { "type": "integer", "format": "int64" }, "activityLogRetentionDays": { "type": "integer", "format": "int32" }, "webhookSuccessRetentionDays": { "type": "integer", "format": "int32" }, "webhookFailedRetentionDays": { "type": "integer", "format": "int32" } } }, "BillingPlanPurchaseRequest": { "required": [ "plan" ], "type": "object", "properties": { "plan": { "$ref": "#/components/schemas/BillingPlanType" }, "billingInterval": { "enum": [ "month", "year" ], "type": [ "null", "string" ] } } }, "BillingPlanType": { "enum": [ "none", "free", "pro", "premium" ], "type": "string" }, "BillingReceiptDeliveryDto": { "required": [ "documentType", "deliveryMethod", "emailRequired" ], "type": "object", "properties": { "documentType": { "type": "string", "description": "Kind of identity or tax document." }, "deliveryMethod": { "type": "string" }, "emailRequired": { "type": "boolean" } } }, "BillingSubscriptionDto": { "required": [ "id", "plan", "status", "amount", "currencyCode", "billingInterval", "startedOn", "currentPeriodStartsOn", "currentPeriodEndsOn", "cancelAtPeriodEnd", "cancelledOn", "paymentGraceEndsOn", "failedPaymentCount", "lastPaymentError" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "plan": { "$ref": "#/components/schemas/BillingPlanType" }, "status": { "$ref": "#/components/schemas/BillingSubscriptionStatus" }, "amount": { "type": "number", "format": "double" }, "currencyCode": { "type": "string", "description": "ISO 4217 currency code, for example `PEN`." }, "billingInterval": { "type": "string" }, "startedOn": { "type": "string", "format": "date-time" }, "currentPeriodStartsOn": { "type": [ "null", "string" ], "format": "date-time" }, "currentPeriodEndsOn": { "type": [ "null", "string" ], "format": "date-time" }, "cancelAtPeriodEnd": { "type": "boolean" }, "cancelledOn": { "type": [ "null", "string" ], "format": "date-time" }, "paymentGraceEndsOn": { "type": [ "null", "string" ], "format": "date-time" }, "failedPaymentCount": { "type": "integer", "format": "int32" }, "lastPaymentError": { "type": [ "null", "string" ] } } }, "BillingSubscriptionStatus": { "enum": [ "incomplete", "active", "pastDue", "cancelled" ], "type": "string" }, "BillingTaxBreakdownDto": { "required": [ "label", "rate", "subtotalAmount", "taxAmount", "totalAmount", "included" ], "type": "object", "properties": { "label": { "type": "string" }, "rate": { "type": "number", "format": "double" }, "subtotalAmount": { "type": "number", "format": "double" }, "taxAmount": { "type": "number", "format": "double" }, "totalAmount": { "type": "number", "format": "double" }, "included": { "type": "boolean" } } }, "BillingUsageDto": { "required": [ "currentPlan", "usage" ], "type": "object", "properties": { "currentPlan": { "$ref": "#/components/schemas/BillingPlanType" }, "usage": { "type": "array", "items": { "$ref": "#/components/schemas/PlanUsageDto" } } } }, "BrandDetailsDto": { "required": [ "id", "storeId", "name", "slug", "order", "createdOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string", "description": "URL-friendly identifier." }, "logo": { "type": [ "null", "string" ] }, "icon": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "metaTitle": { "type": [ "null", "string" ] }, "metaDescription": { "type": [ "null", "string" ] }, "keywords": { "type": [ "null", "array" ], "items": { "type": "string" } }, "order": { "type": "integer", "format": "int32" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "BrandExportRequest": { "type": "object", "properties": { "format": { "type": "string" }, "search": { "type": [ "null", "string" ], "description": "Free-text filter. Which fields it covers depends on the resource." }, "brandIds": { "type": [ "null", "array" ] }, "status": { "type": [ "null", "array" ] }, "template": { "type": "boolean" } } }, "BrandItemDto": { "required": [ "id", "storeId", "name", "slug", "order" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string", "description": "URL-friendly identifier." }, "icon": { "type": [ "null", "string" ] }, "keywords": { "type": [ "null", "array" ], "items": { "type": "string" } }, "order": { "type": "integer", "format": "int32" } } }, "BrandRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": [ "null", "string" ], "description": "URL-friendly identifier." }, "logo": { "type": [ "null", "string" ] }, "icon": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "metaTitle": { "type": [ "null", "string" ] }, "metaDescription": { "type": [ "null", "string" ] }, "keywords": { "type": [ "null", "array" ], "items": { "type": "string" } }, "order": { "type": "integer", "format": "int32" } } }, "CancelOrderDraftRequest": { "required": [ "reason" ], "type": "object", "properties": { "reason": { "type": [ "null", "string" ] } } }, "CancelPaymentRequest": { "required": [ "message" ], "type": "object", "properties": { "message": { "type": [ "null", "string" ] } } }, "CapturePaymentRequest": { "required": [ "amount" ], "type": "object", "properties": { "amount": { "type": [ "null", "number" ], "format": "double" } } }, "CartAttribution": { "type": "object", "properties": { "campaignId": { "type": [ "null", "string" ] }, "utmSource": { "type": [ "null", "string" ] }, "utmMedium": { "type": [ "null", "string" ] }, "utmCampaign": { "type": [ "null", "string" ] }, "referralCode": { "type": [ "null", "string" ] } } }, "CartBundleItemDto": { "required": [ "productId", "variantId", "productName", "variantName", "sku", "brand", "imageUrl", "quantity" ], "type": "object", "properties": { "productId": { "type": "string" }, "variantId": { "type": "string" }, "productName": { "type": "string" }, "variantName": { "type": [ "null", "string" ] }, "sku": { "type": [ "null", "string" ], "description": "Stock keeping unit (SKU)." }, "brand": { "type": [ "null", "string" ] }, "imageUrl": { "type": [ "null", "string" ] }, "quantity": { "type": "integer", "format": "int32" } } }, "CartDetailsDto": { "required": [ "id", "cartNumber", "storeId", "regionId", "customerId", "salesChannelId", "email", "phone", "firstName", "lastName", "identificationType", "identificationNumber", "entityTaxId", "entityName", "currencyCode", "cartStatus", "completedAt", "shippingAddress", "billingAddress", "source", "sourceIdentifier", "notes", "tags", "attribution", "instructions", "requestContext", "geolocation", "externalDataJson", "promotionCodes", "items", "shippingMethods", "totals", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "cartNumber": { "type": "string" }, "storeId": { "type": "string" }, "regionId": { "type": [ "null", "string" ] }, "customerId": { "type": [ "null", "string" ] }, "salesChannelId": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] }, "identificationType": { "type": [ "null", "string" ] }, "identificationNumber": { "type": [ "null", "string" ] }, "entityTaxId": { "type": [ "null", "string" ] }, "entityName": { "type": [ "null", "string" ] }, "currencyCode": { "type": "string", "description": "ISO 4217 currency code, for example `PEN`." }, "cartStatus": { "$ref": "#/components/schemas/CartStatus" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time" }, "shippingAddress": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Address" } ] }, "billingAddress": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Address" } ] }, "source": { "type": [ "null", "string" ] }, "sourceIdentifier": { "type": [ "null", "string" ] }, "notes": { "type": [ "null", "string" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "attribution": { "$ref": "#/components/schemas/CartAttribution" }, "instructions": { "$ref": "#/components/schemas/CartInstructions" }, "requestContext": { "$ref": "#/components/schemas/CartRequestContext" }, "geolocation": { "$ref": "#/components/schemas/CartGeolocation" }, "externalDataJson": { "type": "string" }, "promotionCodes": { "type": "array", "items": { "type": "string" } }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CartItemDetailsDto" } }, "shippingMethods": { "type": "array", "items": { "$ref": "#/components/schemas/CartShippingMethodDto" } }, "totals": { "$ref": "#/components/schemas/CartTotals" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "CartGeolocation": { "type": "object", "properties": { "countryCode": { "type": [ "null", "string" ], "description": "ISO 3166-1 alpha-2 country code, for example `PE`." }, "region": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "postalCode": { "type": [ "null", "string" ] }, "latitude": { "type": [ "null", "number" ], "format": "double" }, "longitude": { "type": [ "null", "number" ], "format": "double" }, "accuracyMeters": { "type": [ "null", "number" ], "format": "double" }, "source": { "type": [ "null", "string" ] } } }, "CartInstructions": { "type": "object", "properties": { "giftMessage": { "type": [ "null", "string" ] }, "specialInstructions": { "type": [ "null", "string" ] } } }, "CartItemAdjustmentDto": { "required": [ "id", "description", "code", "amount", "type", "isTaxInclusive", "integrationId", "promotionId" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "description": { "type": [ "null", "string" ] }, "code": { "type": [ "null", "string" ] }, "amount": { "type": "number", "format": "double" }, "type": { "$ref": "#/components/schemas/CartItemAdjustmentType" }, "isTaxInclusive": { "type": "boolean" }, "integrationId": { "type": [ "null", "string" ] }, "promotionId": { "type": [ "null", "string" ] } } }, "CartItemAdjustmentType": { "enum": [ "discount", "warranty", "other" ], "type": "string" }, "CartItemDetailsDto": { "required": [ "id", "title", "subtitle", "thumbnail", "quantity", "productId", "sellerId", "shippingProfileId", "variantId", "unitPrice", "compareAtUnitPrice", "requiresShipping", "isDiscountable", "isGiftcard", "externalItemId", "giftWrapping", "giftMessage", "personalizedMessage", "customizationJson", "originalPrice", "priceAdjustmentReason", "bundleItems", "externalDataJson", "modifiers", "adjustments", "taxLines" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "title": { "type": "string" }, "subtitle": { "type": [ "null", "string" ] }, "thumbnail": { "type": [ "null", "string" ] }, "quantity": { "type": "integer", "format": "int32" }, "productId": { "type": [ "null", "string" ] }, "sellerId": { "type": [ "null", "string" ] }, "shippingProfileId": { "type": [ "null", "string" ] }, "variantId": { "type": [ "null", "string" ] }, "unitPrice": { "type": "number", "format": "double" }, "compareAtUnitPrice": { "type": [ "null", "number" ], "format": "double" }, "requiresShipping": { "type": "boolean" }, "isDiscountable": { "type": "boolean" }, "isGiftcard": { "type": "boolean" }, "externalItemId": { "type": [ "null", "string" ] }, "giftWrapping": { "type": "boolean" }, "giftMessage": { "type": [ "null", "string" ] }, "personalizedMessage": { "type": [ "null", "string" ] }, "customizationJson": { "type": "string" }, "originalPrice": { "type": [ "null", "number" ], "format": "double" }, "priceAdjustmentReason": { "type": [ "null", "string" ] }, "bundleItems": { "type": "array", "items": { "$ref": "#/components/schemas/CartBundleItemDto" } }, "externalDataJson": { "type": "string" }, "modifiers": { "type": "array", "items": { "$ref": "#/components/schemas/CartItemModifierDto" } }, "adjustments": { "type": "array", "items": { "$ref": "#/components/schemas/CartItemAdjustmentDto" } }, "taxLines": { "type": "array", "items": { "$ref": "#/components/schemas/CartItemTaxDto" } } } }, "CartItemModifierDto": { "required": [ "id", "modifierGroupId", "modifierGroupName", "modifierOptionId", "modifierOptionName", "priceDelta" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "modifierGroupId": { "type": "string" }, "modifierGroupName": { "type": "string" }, "modifierOptionId": { "type": "string" }, "modifierOptionName": { "type": "string" }, "priceDelta": { "type": "number", "format": "double" } } }, "CartItemTaxDto": { "required": [ "id", "description", "code", "rate", "integrationId", "taxRateId" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "description": { "type": [ "null", "string" ] }, "code": { "type": "string" }, "rate": { "type": "number", "format": "double" }, "integrationId": { "type": [ "null", "string" ] }, "taxRateId": { "type": [ "null", "string" ] } } }, "CartItemTotals": { "required": [ "subtotal", "discount", "tax", "warranty" ], "type": "object", "properties": { "subtotal": { "type": "number", "format": "double" }, "discount": { "type": "number", "format": "double" }, "tax": { "type": "number", "format": "double" }, "warranty": { "type": "number", "format": "double" }, "total": { "type": "number", "format": "double" } } }, "CartListItemDto": { "required": [ "id", "storeId", "regionId", "customerId", "salesChannelId", "email", "phone", "firstName", "lastName", "currencyCode", "status", "completedAt", "itemCount", "quantity", "shippingMethodCount", "totals", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "regionId": { "type": [ "null", "string" ] }, "customerId": { "type": [ "null", "string" ] }, "salesChannelId": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] }, "currencyCode": { "type": "string", "description": "ISO 4217 currency code, for example `PEN`." }, "status": { "$ref": "#/components/schemas/CartStatus" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time" }, "itemCount": { "type": "integer", "format": "int32" }, "quantity": { "type": "integer", "format": "int32" }, "shippingMethodCount": { "type": "integer", "format": "int32" }, "totals": { "$ref": "#/components/schemas/CartTotals" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "CartRequestContext": { "type": "object", "properties": { "createdFrom": { "type": [ "null", "string" ] }, "platform": { "type": [ "null", "string" ] }, "deviceId": { "type": [ "null", "string" ] }, "sessionId": { "type": [ "null", "string" ] }, "userAgent": { "type": [ "null", "string" ] }, "ipAddress": { "type": [ "null", "string" ] } } }, "CartShippingMethodAdjustmentDto": { "required": [ "id", "description", "code", "amount", "isTaxInclusive", "integrationId", "promotionId" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "description": { "type": [ "null", "string" ] }, "code": { "type": [ "null", "string" ] }, "amount": { "type": "number", "format": "double" }, "isTaxInclusive": { "type": "boolean" }, "integrationId": { "type": [ "null", "string" ] }, "promotionId": { "type": [ "null", "string" ] } } }, "CartShippingMethodDto": { "required": [ "id", "name", "description", "amount", "isTaxInclusive", "sellerId", "shippingProfileId", "shippingMethodId", "connectionId", "providerName", "trackingCode", "estimatedDays", "zoneCode", "locationId", "pickupPointId", "scheduledDate", "scheduledTime", "data", "adjustments", "taxLines" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "amount": { "type": "number", "format": "double" }, "isTaxInclusive": { "type": "boolean" }, "sellerId": { "type": [ "null", "string" ] }, "shippingProfileId": { "type": [ "null", "string" ] }, "shippingMethodId": { "type": [ "null", "string" ] }, "connectionId": { "type": [ "null", "string" ] }, "providerName": { "type": [ "null", "string" ] }, "trackingCode": { "type": [ "null", "string" ] }, "estimatedDays": { "type": [ "null", "integer" ], "format": "int32" }, "zoneCode": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ] }, "pickupPointId": { "type": [ "null", "string" ] }, "scheduledDate": { "type": [ "null", "string" ], "format": "date" }, "scheduledTime": { "type": [ "null", "string" ], "format": "time" }, "data": { "type": "object" }, "adjustments": { "type": "array", "items": { "$ref": "#/components/schemas/CartShippingMethodAdjustmentDto" } }, "taxLines": { "type": "array", "items": { "$ref": "#/components/schemas/CartShippingMethodTaxDto" } } } }, "CartShippingMethodTaxDto": { "required": [ "id", "description", "code", "rate", "integrationId", "taxRateId" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "description": { "type": [ "null", "string" ] }, "code": { "type": "string" }, "rate": { "type": "number", "format": "double" }, "integrationId": { "type": [ "null", "string" ] }, "taxRateId": { "type": [ "null", "string" ] } } }, "CartShippingTotals": { "required": [ "subtotal", "discount", "tax" ], "type": "object", "properties": { "subtotal": { "type": "number", "format": "double" }, "discount": { "type": "number", "format": "double" }, "tax": { "type": "number", "format": "double" }, "total": { "type": "number", "format": "double" } } }, "CartStatus": { "enum": [ "inProgress", "pending", "completed", "abandoned", "cancelled", "expired", "failed" ], "type": "string" }, "CartTotals": { "required": [ "items", "shipping", "total" ], "type": "object", "properties": { "items": { "$ref": "#/components/schemas/CartItemTotals" }, "shipping": { "$ref": "#/components/schemas/CartShippingTotals" }, "total": { "type": "number", "format": "double" } } }, "CatalogGender": { "enum": [ "unisex", "men", "women", "kids", "baby" ], "type": "string" }, "CatalogInventoryModel": { "required": [ "id", "locationId", "onHand", "committed", "available", "incoming", "unavailable", "version", "createdOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "locationId": { "type": "string" }, "onHand": { "type": "integer", "format": "int32" }, "committed": { "type": "integer", "format": "int32" }, "available": { "type": "integer", "format": "int32" }, "incoming": { "type": "integer", "format": "int32" }, "unavailable": { "type": "integer", "format": "int32" }, "version": { "type": "integer", "format": "int64" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "CatalogSpreadsheetBrandUpdateRequest": { "type": "object", "properties": { "brandId": { "type": "string" }, "body": { "$ref": "#/components/schemas/BrandRequest" } } }, "CatalogSpreadsheetCategoryUpdateRequest": { "type": "object", "properties": { "categoryId": { "type": "string" }, "body": { "$ref": "#/components/schemas/CategoryRequest" } } }, "CatalogSpreadsheetSaveRequest": { "type": "object", "properties": { "brandUpdates": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogSpreadsheetBrandUpdateRequest" } }, "categoryUpdates": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogSpreadsheetCategoryUpdateRequest" } }, "specificationUpdates": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogSpreadsheetSpecificationUpdateRequest" } }, "sizeGuideUpdates": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogSpreadsheetSizeGuideUpdateRequest" } } } }, "CatalogSpreadsheetSizeGuideUpdateRequest": { "required": [ "name" ], "type": "object", "properties": { "sizeGuideId": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": [ "null", "string" ], "description": "URL-friendly identifier." }, "gender": { "$ref": "#/components/schemas/CatalogGender" }, "measurementType": { "$ref": "#/components/schemas/SizeGuideMeasurementType" }, "unit": { "$ref": "#/components/schemas/SizeGuideUnit" }, "status": { "$ref": "#/components/schemas/SizeGuideStatus" }, "priority": { "type": "integer", "format": "int32" } } }, "CatalogSpreadsheetSpecificationUpdateRequest": { "type": "object", "properties": { "specificationId": { "type": "string" }, "body": { "$ref": "#/components/schemas/UpdateSpecificationRequest" } } }, "CatalogVariantImageModel": { "required": [ "imageId", "order", "isPrimary" ], "type": "object", "properties": { "imageId": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "isPrimary": { "type": "boolean" } } }, "CatalogVariantModel": { "required": [ "variantId", "tenantId", "storeId", "productId", "productName", "productDescription", "productSlug", "productType", "productTypeId", "productIsDigital", "productTaxIncluded", "productStatus", "productImage", "thumbnail", "tags", "variantName", "variantSku", "variantStatus", "variantIsDigital", "allowBackorders", "onHand", "committed", "available", "order", "isDefault", "price", "currency", "lowStockThreshold", "weight", "width", "height", "length", "unitOfMeasure", "requiresShipping", "trackInventory", "images", "options", "inventories", "variantOptionValues", "modifierGroups", "createdOn" ], "type": "object", "properties": { "variantId": { "type": "string" }, "tenantId": { "type": "string" }, "storeId": { "type": "string" }, "productId": { "type": "string" }, "sellerId": { "type": [ "null", "string" ] }, "packageId": { "type": [ "null", "string" ] }, "shippingProfileId": { "type": [ "null", "string" ] }, "productName": { "type": "string" }, "productDescription": { "type": "string" }, "productSlug": { "type": "string" }, "productType": { "type": "string" }, "productTypeId": { "type": "integer", "format": "int32" }, "productIsDigital": { "type": "boolean" }, "productTaxIncluded": { "type": "boolean" }, "productStatus": { "type": "string" }, "productImage": { "type": "string" }, "thumbnail": { "type": "string" }, "brandId": { "type": [ "null", "string" ] }, "brandName": { "type": [ "null", "string" ] }, "categoryId": { "type": [ "null", "string" ] }, "categoryName": { "type": [ "null", "string" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "variantName": { "type": "string" }, "variantSku": { "type": "string" }, "variantBarcode": { "type": [ "null", "string" ] }, "variantStatus": { "type": "string" }, "variantIsDigital": { "type": "boolean" }, "allowBackorders": { "type": "boolean" }, "onHand": { "type": "integer", "format": "int32" }, "committed": { "type": "integer", "format": "int32" }, "available": { "type": "integer", "format": "int32" }, "order": { "type": "integer", "format": "int32" }, "isDefault": { "type": "boolean" }, "upc": { "type": [ "null", "string" ] }, "mpn": { "type": [ "null", "string" ] }, "countryOfOrigin": { "type": [ "null", "string" ] }, "hsCode": { "type": [ "null", "string" ] }, "price": { "type": "number", "format": "double" }, "compareAtPrice": { "type": [ "null", "number" ], "format": "double" }, "costPrice": { "type": [ "null", "number" ], "format": "double" }, "currency": { "type": "string" }, "lowStockThreshold": { "type": "integer", "format": "int32" }, "weight": { "type": "number", "format": "double" }, "width": { "type": "number", "format": "double" }, "height": { "type": "number", "format": "double" }, "length": { "type": "number", "format": "double" }, "unitOfMeasure": { "type": "string" }, "requiresShipping": { "type": "boolean" }, "trackInventory": { "type": "boolean" }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogVariantImageModel" } }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogVariantOptionModel" } }, "inventories": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogInventoryModel" } }, "variantOptionValues": { "type": "object", "additionalProperties": { "type": "string" } }, "modifierGroups": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogVariantModifierGroupModel" } }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "CatalogVariantModifierGroupModel": { "required": [ "modifierGroupId", "name", "isRequired", "selectionType", "minSelections", "order", "status", "options" ], "type": "object", "properties": { "modifierGroupId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "isRequired": { "type": "boolean" }, "selectionType": { "type": "string" }, "minSelections": { "type": "integer", "format": "int32" }, "maxSelections": { "type": [ "null", "integer" ], "format": "int32" }, "order": { "type": "integer", "format": "int32" }, "status": { "type": "string" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogVariantModifierOptionModel" } } } }, "CatalogVariantModifierOptionModel": { "required": [ "modifierOptionId", "name", "priceDelta", "isDefault", "order", "status" ], "type": "object", "properties": { "modifierOptionId": { "type": "string" }, "name": { "type": "string" }, "priceDelta": { "type": "number", "format": "double" }, "isDefault": { "type": "boolean" }, "imageUrl": { "type": [ "null", "string" ] }, "order": { "type": "integer", "format": "int32" }, "status": { "type": "string" } } }, "CatalogVariantOptionModel": { "required": [ "name", "key", "value" ], "type": "object", "properties": { "name": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } } }, "CategoryDetailsDto": { "required": [ "id", "storeId", "name", "slug", "order", "path", "requiresSizeGuide", "createdOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string", "description": "URL-friendly identifier." }, "logo": { "type": [ "null", "string" ] }, "icon": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "metaTitle": { "type": [ "null", "string" ] }, "metaDescription": { "type": [ "null", "string" ] }, "keywords": { "type": [ "null", "array" ], "items": { "type": "string" } }, "order": { "type": "integer", "format": "int32" }, "parentId": { "type": [ "null", "string" ] }, "path": { "type": "string" }, "requiresSizeGuide": { "type": "boolean" }, "commissionPercentage": { "type": [ "null", "number" ], "format": "double" }, "commissionFixedFee": { "type": [ "null", "number" ], "format": "double" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "CategoryItemDto": { "required": [ "id", "storeId", "name", "slug", "order", "path", "requiresSizeGuide" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string", "description": "URL-friendly identifier." }, "icon": { "type": [ "null", "string" ] }, "order": { "type": "integer", "format": "int32" }, "parentId": { "type": [ "null", "string" ] }, "path": { "type": "string" }, "requiresSizeGuide": { "type": "boolean" }, "commissionPercentage": { "type": [ "null", "number" ], "format": "double" }, "commissionFixedFee": { "type": [ "null", "number" ], "format": "double" } } }, "CategoryRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": [ "null", "string" ], "description": "URL-friendly identifier." }, "logo": { "type": [ "null", "string" ] }, "icon": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "metaTitle": { "type": [ "null", "string" ] }, "metaDescription": { "type": [ "null", "string" ] }, "keywords": { "type": [ "null", "array" ], "items": { "type": "string" } }, "order": { "type": "integer", "format": "int32" }, "parentId": { "type": [ "null", "string" ] }, "requiresSizeGuide": { "type": "boolean" }, "commissionPercentage": { "type": [ "null", "number" ], "format": "double" }, "commissionFixedFee": { "type": [ "null", "number" ], "format": "double" } } }, "CategoryTreeDto": { "required": [ "id", "storeId", "name", "slug", "order", "path", "requiresSizeGuide", "level", "hasChildren", "children" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string", "description": "URL-friendly identifier." }, "logo": { "type": [ "null", "string" ] }, "icon": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "order": { "type": "integer", "format": "int32" }, "parentId": { "type": [ "null", "string" ] }, "path": { "type": "string" }, "requiresSizeGuide": { "type": "boolean" }, "commissionPercentage": { "type": [ "null", "number" ], "format": "double" }, "commissionFixedFee": { "type": [ "null", "number" ], "format": "double" }, "level": { "type": "integer", "format": "int32" }, "hasChildren": { "type": "boolean" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryTreeDto" } } } }, "CategoryTreeItemRequest": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "parentId": { "type": [ "null", "string" ] }, "order": { "type": "integer", "format": "int32" }, "children": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryTreeItemRequest" } } } }, "CategoryTreeRequest": { "type": "object", "properties": { "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryTreeItemRequest" } } } }, "ChannelListingDto": { "required": [ "id", "channelId", "productId", "listingType", "externalId", "externalUrl", "status", "price", "compareAtPrice", "syncInventory", "lastSyncAt", "lastSyncError", "lastSyncErrorCode", "readinessStatus", "readinessIssues", "readinessUpdatedAt", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "channelId": { "type": "string" }, "productId": { "type": "string" }, "listingType": { "type": "string" }, "externalId": { "type": [ "null", "string" ] }, "externalUrl": { "type": [ "null", "string" ] }, "status": { "type": "string" }, "price": { "type": "number", "format": "double" }, "compareAtPrice": { "type": [ "null", "number" ], "format": "double" }, "syncInventory": { "type": "boolean" }, "lastSyncAt": { "type": [ "null", "string" ], "format": "date-time" }, "lastSyncError": { "type": [ "null", "string" ] }, "lastSyncErrorCode": { "type": [ "null", "string" ] }, "readinessStatus": { "type": "string" }, "readinessIssues": { "type": "array", "items": { "$ref": "#/components/schemas/ListingReadinessIssueDto" } }, "readinessUpdatedAt": { "type": [ "null", "string" ], "format": "date-time" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "ChannelListingSummaryDto": { "required": [ "id", "channelId", "productId", "listingType", "externalId", "externalUrl", "status", "price", "compareAtPrice", "lastSyncAt", "lastSyncError", "lastSyncErrorCode", "readinessStatus", "readinessIssues", "readinessUpdatedAt", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "channelId": { "type": "string" }, "productId": { "type": "string" }, "listingType": { "type": "string" }, "externalId": { "type": [ "null", "string" ] }, "externalUrl": { "type": [ "null", "string" ] }, "status": { "type": "string" }, "price": { "type": "number", "format": "double" }, "compareAtPrice": { "type": [ "null", "number" ], "format": "double" }, "lastSyncAt": { "type": [ "null", "string" ], "format": "date-time" }, "lastSyncError": { "type": [ "null", "string" ] }, "lastSyncErrorCode": { "type": [ "null", "string" ] }, "readinessStatus": { "type": "string" }, "readinessIssues": { "type": "array", "items": { "$ref": "#/components/schemas/ListingReadinessIssueDto" } }, "readinessUpdatedAt": { "type": [ "null", "string" ], "format": "date-time" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "CheckoutBuyerType": { "enum": [ "any", "individual", "company" ], "type": "string" }, "CollectionDetailsDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string", "description": "URL-friendly identifier." }, "description": { "type": [ "null", "string" ] }, "status": { "$ref": "#/components/schemas/CollectionStatus" }, "image": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CollectionImageDto" } ] }, "type": { "$ref": "#/components/schemas/CollectionType" }, "dynamicOperator": { "$ref": "#/components/schemas/ConditionOperator" }, "validFrom": { "type": [ "null", "string" ], "format": "date-time" }, "validTo": { "type": [ "null", "string" ], "format": "date-time" }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionRuleDto" } }, "includeCollectionIds": { "type": "array" }, "excludeCollectionIds": { "type": "array" }, "includeProductIds": { "type": "array" }, "excludeProductIds": { "type": "array" }, "pins": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionPinDto" } }, "productCount": { "type": "integer", "format": "int32" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "CollectionImageDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "url": { "type": "string" } } }, "CollectionItemDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string", "description": "URL-friendly identifier." }, "status": { "$ref": "#/components/schemas/CollectionStatus" }, "image": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CollectionImageDto" } ] }, "type": { "$ref": "#/components/schemas/CollectionType" }, "dynamicOperator": { "$ref": "#/components/schemas/ConditionOperator" }, "validFrom": { "type": [ "null", "string" ], "format": "date-time" }, "validTo": { "type": [ "null", "string" ], "format": "date-time" }, "ruleCount": { "type": "integer", "format": "int32" }, "overrideCount": { "type": "integer", "format": "int32" }, "productCount": { "type": "integer", "format": "int32" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "CollectionPinDto": { "type": "object", "properties": { "productId": { "type": "string" }, "position": { "type": "integer", "format": "int32" } } }, "CollectionPinModel": { "type": "object", "properties": { "productId": { "type": "string" }, "position": { "type": "integer", "format": "int32" } } }, "CollectionProductItemDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "name": { "type": "string" }, "slug": { "type": "string", "description": "URL-friendly identifier." }, "sku": { "type": [ "null", "string" ], "description": "Stock keeping unit (SKU)." }, "price": { "type": "number", "format": "double" }, "compareAtPrice": { "type": [ "null", "number" ], "format": "double" }, "currency": { "type": "string" }, "imageUrl": { "type": [ "null", "string" ] }, "status": { "$ref": "#/components/schemas/ProductStatus" }, "sortOrder": { "type": "integer", "format": "int32" }, "isPinned": { "type": "boolean" } } }, "CollectionRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": [ "null", "string" ], "description": "URL-friendly identifier." }, "description": { "type": [ "null", "string" ] }, "status": { "$ref": "#/components/schemas/CollectionStatus" }, "image": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CollectionImageDto" } ] }, "type": { "$ref": "#/components/schemas/CollectionType" }, "dynamicOperator": { "$ref": "#/components/schemas/ConditionOperator" }, "validFrom": { "type": [ "null", "string" ], "format": "date-time" }, "validTo": { "type": [ "null", "string" ], "format": "date-time" }, "rules": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CollectionRuleModel" } }, "includeCollectionIds": { "type": [ "null", "array" ] }, "excludeCollectionIds": { "type": [ "null", "array" ] }, "includeProductIds": { "type": [ "null", "array" ] }, "excludeProductIds": { "type": [ "null", "array" ] }, "pins": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CollectionPinModel" } } } }, "CollectionRuleDto": { "type": "object", "properties": { "field": { "$ref": "#/components/schemas/CollectionRuleField" }, "operator": { "$ref": "#/components/schemas/RuleOperator" }, "path": { "type": [ "null", "string" ] }, "value": { "type": "string" } } }, "CollectionRuleField": { "enum": [ "price", "compareAtPrice", "brand", "categoryId", "tag", "variantSku", "variantStock", "variantCompareAtPrice", "metafield", "title", "vendor", "type", "status", "variantWeight", "variantTitle", "collection" ], "type": "string" }, "CollectionRuleModel": { "required": [ "value" ], "type": "object", "properties": { "field": { "$ref": "#/components/schemas/CollectionRuleField" }, "operator": { "$ref": "#/components/schemas/RuleOperator" }, "path": { "type": [ "null", "string" ] }, "value": { "type": "string" } } }, "CollectionStatus": { "enum": [ "draft", "active" ], "type": "string" }, "CollectionType": { "enum": [ "static", "dynamic" ], "type": "string" }, "Command": { "type": "object", "properties": { "format": { "type": "string" }, "search": { "type": [ "null", "string" ], "description": "Free-text filter. Which fields it covers depends on the resource." }, "status": { "type": [ "null", "array" ] }, "excludeStatus": { "type": [ "null", "array" ] }, "includeArchived": { "type": [ "null", "boolean" ] }, "categoryIds": { "type": [ "null", "array" ] }, "excludeCategoryIds": { "type": [ "null", "array" ] }, "brandIds": { "type": [ "null", "array" ] }, "excludeBrandIds": { "type": [ "null", "array" ] }, "sellerIds": { "type": [ "null", "array" ] }, "excludeSellerIds": { "type": [ "null", "array" ] }, "productIds": { "type": [ "null", "array" ] }, "skuIds": { "type": [ "null", "array" ] }, "skus": { "type": [ "null", "array" ], "items": { "type": "string" } }, "types": { "type": [ "null", "array" ] }, "excludeTypes": { "type": [ "null", "array" ] }, "isFeatured": { "type": [ "null", "boolean" ] }, "ean": { "type": [ "null", "string" ] }, "minPrice": { "type": [ "null", "number" ], "format": "double" }, "maxPrice": { "type": [ "null", "number" ], "format": "double" }, "minOnHand": { "type": [ "null", "integer" ], "format": "int32" }, "maxOnHand": { "type": [ "null", "integer" ], "format": "int32" }, "minAvailable": { "type": [ "null", "integer" ], "format": "int32" }, "tags": { "type": [ "null", "array" ], "items": { "type": "string" } }, "excludeTags": { "type": [ "null", "array" ], "items": { "type": "string" } }, "template": { "type": "boolean" } } }, "ConditionOperator": { "enum": [ "and", "or" ], "type": "string" }, "ConfirmBillingCheckoutRequest": { "required": [ "token", "paymentMethodId", "installments", "issuerId", "identificationType", "identificationNumber" ], "type": "object", "properties": { "token": { "type": [ "null", "string" ] }, "paymentMethodId": { "type": [ "null", "string" ] }, "installments": { "type": "integer", "format": "int32" }, "issuerId": { "type": [ "null", "string" ] }, "identificationType": { "type": [ "null", "string" ] }, "identificationNumber": { "type": [ "null", "string" ] }, "payerEmail": { "type": [ "null", "string" ] }, "savedPaymentMethodId": { "type": [ "null", "string" ] }, "savePaymentMethod": { "type": "boolean", "default": true }, "deviceSessionId": { "type": [ "null", "string" ] } } }, "ConsumeReservedInventoryDto": { "required": [ "storeId", "locationId", "locationName", "lines", "note", "userId", "userEmail", "userName" ], "type": "object", "properties": { "storeId": { "type": "string" }, "locationId": { "type": "string" }, "locationName": { "type": "string" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryStockLineModel" } }, "note": { "type": [ "null", "string" ] }, "userId": { "type": [ "null", "string" ], "format": "uuid" }, "userEmail": { "type": [ "null", "string" ] }, "userName": { "type": [ "null", "string" ] } } }, "ConvertOrderDraftRequest": { "type": "object", "properties": { "invoiceType": { "enum": [ "ticket", "invoice" ], "type": "string", "default": "ticket" } } }, "CreateApiKeyRequest": { "required": [ "name", "isTestMode", "scopes", "allowedIps", "expiresAt", "applicationUrl" ], "type": "object", "properties": { "name": { "type": "string" }, "isTestMode": { "type": "boolean" }, "scopes": { "type": [ "null", "array" ], "items": { "type": "string" } }, "allowedIps": { "type": [ "null", "array" ], "items": { "type": "string" } }, "expiresAt": { "type": [ "null", "string" ], "format": "date-time" }, "applicationUrl": { "type": [ "null", "string" ] } } }, "CreateApiKeyResponse": { "required": [ "apiKey", "plaintextKey" ], "type": "object", "properties": { "apiKey": { "$ref": "#/components/schemas/ApiKeyDto" }, "plaintextKey": { "type": "string" } } }, "CreateCustomerRequest": { "required": [ "email", "firstName", "lastName", "customerType", "countryIsoCode" ], "type": "object", "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "customerType": { "$ref": "#/components/schemas/CustomerType" }, "countryIsoCode": { "type": "string" }, "phone": { "type": [ "null", "string" ] }, "identificationNumber": { "type": [ "null", "string" ] }, "identificationType": { "type": [ "null", "string" ] }, "entityName": { "type": [ "null", "string" ] }, "userId": { "type": [ "null", "string" ], "format": "uuid" }, "gender": { "enum": [ "male", "female", "other" ], "type": "string", "default": "other" }, "role": { "type": [ "null", "string" ] }, "companyName": { "type": [ "null", "string" ] }, "dateOfBirth": { "type": [ "null", "string" ], "format": "date" } } }, "CreatedOrderModel": { "required": [ "orderId", "orderNumber", "orderGroup" ], "type": "object", "properties": { "orderId": { "type": "string" }, "orderNumber": { "type": "string" }, "orderGroup": { "type": [ "null", "string" ] } } }, "CreateFulfillmentShipmentRequest": { "type": "object", "properties": { "packageId": { "type": [ "null", "string" ] }, "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/FulfillmentShipmentLineModel" } } } }, "CreateListingRequest": { "required": [ "channelId", "productId", "price" ], "type": "object", "properties": { "channelId": { "type": "string" }, "productId": { "type": "string" }, "price": { "type": "number", "format": "double" }, "compareAtPrice": { "type": [ "null", "number" ], "format": "double" }, "syncInventory": { "type": "boolean", "default": true } } }, "CreateLocationRequest": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "type": { "$ref": "#/components/schemas/LocationType" }, "address": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "state": { "type": [ "null", "string" ] }, "country": { "type": [ "null", "string" ] }, "postalCode": { "type": [ "null", "string" ] }, "latitude": { "type": [ "null", "number" ], "format": "double" }, "longitude": { "type": [ "null", "number" ], "format": "double" }, "phone": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "isDefault": { "type": "boolean" }, "useForFulfillment": { "type": "boolean" }, "supportsShipping": { "type": "boolean" }, "supportsLocalDelivery": { "type": "boolean" }, "supportsPickup": { "type": "boolean" }, "isPhysicalStore": { "type": "boolean" }, "supportsPos": { "type": "boolean" }, "priority": { "type": "integer", "format": "int32" }, "pickupInstructions": { "type": [ "null", "string" ] }, "pickupLeadTimeInMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "pickupSlotInMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "pickupDailyCapacity": { "type": [ "null", "integer" ], "format": "int32" }, "localDeliveryInstructions": { "type": [ "null", "string" ] }, "localDeliveryLeadTimeInMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "localDeliverySlotInMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "localDeliveryDailyCapacity": { "type": [ "null", "integer" ], "format": "int32" }, "localDeliveryFee": { "type": [ "null", "number" ], "format": "double" }, "localDeliveryFreeFromAmount": { "type": [ "null", "number" ], "format": "double" }, "localDeliveryMinHours": { "type": [ "null", "integer" ], "format": "int32" }, "localDeliveryMaxHours": { "type": [ "null", "integer" ], "format": "int32" }, "localDeliveryPostalCodes": { "type": "array", "items": { "type": "string" } }, "localDeliveryZones": { "type": "array", "items": { "$ref": "#/components/schemas/LocalDeliveryZoneRequest" } }, "schedules": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/LocationScheduleRequest" } } } }, "CreateModifierGroupRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "isRequired": { "type": "boolean" }, "selectionType": { "$ref": "#/components/schemas/ModifierSelectionType" }, "minSelections": { "type": "integer", "format": "int32" }, "maxSelections": { "type": [ "null", "integer" ], "format": "int32" }, "order": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ModifierGroupStatus" }, "options": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CreateModifierOptionRequest" } } } }, "CreateModifierOptionRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "priceDelta": { "type": "number", "format": "double", "default": 0 }, "isDefault": { "type": "boolean", "default": false }, "imageUrl": { "type": [ "null", "string" ] }, "order": { "type": "integer", "format": "int32", "default": 0 }, "status": { "enum": [ "active", "inactive" ], "type": "string", "default": "active" } } }, "CreateOrderClaimRequest": { "required": [ "type", "subject", "description", "contactEmail", "contactPhone" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/OrderClaimType" }, "subject": { "type": "string" }, "description": { "type": "string" }, "contactEmail": { "type": [ "null", "string" ] }, "contactPhone": { "type": [ "null", "string" ] } } }, "CreateOrderDraftDto": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." } } }, "CreateOrderDraftRequest": { "required": [ "currencyCode", "customerId", "cartId", "email", "phone", "firstName", "lastName", "identificationType", "identificationNumber", "entityTaxId", "entityName", "source", "notes" ], "type": "object", "properties": { "currencyCode": { "type": "string", "description": "ISO 4217 currency code, for example `PEN`." }, "customerId": { "type": [ "null", "string" ] }, "cartId": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] }, "identificationType": { "type": [ "null", "string" ] }, "identificationNumber": { "type": [ "null", "string" ] }, "entityTaxId": { "type": [ "null", "string" ] }, "entityName": { "type": [ "null", "string" ] }, "source": { "type": [ "null", "string" ] }, "notes": { "type": [ "null", "string" ] } } }, "CreateOrderDraftShareLinkRequest": { "type": "object", "properties": { "shareExpiresAt": { "type": [ "null", "string" ], "format": "date-time" }, "allowAnonymousShareAccess": { "type": "boolean", "default": true } } }, "CreateOrderItemModel": { "required": [ "title", "qty", "unitPrice", "subTotal", "discount", "shipping", "tax", "warranty", "total" ], "type": "object", "properties": { "title": { "type": "string" }, "qty": { "type": "number", "format": "double" }, "unitPrice": { "type": "number", "format": "double" }, "subTotal": { "type": "number", "format": "double" }, "discount": { "type": "number", "format": "double" }, "shipping": { "type": "number", "format": "double" }, "tax": { "type": "number", "format": "double" }, "warranty": { "type": "number", "format": "double" }, "total": { "type": "number", "format": "double" }, "productId": { "type": [ "null", "string" ] }, "categoryId": { "type": [ "null", "string" ] }, "brandId": { "type": [ "null", "string" ] }, "sellerId": { "type": [ "null", "string" ] }, "shippingProfileId": { "type": [ "null", "string" ] }, "variantId": { "type": [ "null", "string" ] }, "externalItemId": { "type": [ "null", "string" ] }, "skuId": { "type": [ "null", "string" ] }, "sku": { "type": [ "null", "string" ], "description": "Stock keeping unit (SKU)." }, "locationId": { "type": [ "null", "string" ] }, "subtitle": { "type": [ "null", "string" ] }, "thumbnail": { "type": [ "null", "string" ] }, "productTitle": { "type": [ "null", "string" ] }, "productDescription": { "type": [ "null", "string" ] }, "productType": { "type": [ "null", "string" ] }, "productTypeId": { "type": [ "null", "string" ] }, "productCollection": { "type": [ "null", "string" ] }, "productHandle": { "type": [ "null", "string" ] }, "variantSku": { "type": [ "null", "string" ] }, "variantBarcode": { "type": [ "null", "string" ] }, "variantTitle": { "type": [ "null", "string" ] }, "variantOptionValues": { "type": "object" }, "brand": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "height": { "type": "number", "format": "double" }, "length": { "type": "number", "format": "double" }, "width": { "type": "number", "format": "double" }, "weight": { "type": "number", "format": "double" }, "requiresShipping": { "type": "boolean" }, "isDiscountable": { "type": "boolean" }, "isGiftcard": { "type": "boolean" }, "isTaxInclusive": { "type": "boolean" }, "isCustomPrice": { "type": "boolean" }, "metadata": { "type": "object" }, "modifiers": { "type": "array", "items": { "$ref": "#/components/schemas/CreateOrderItemModifierModel" } } } }, "CreateOrderItemModifierModel": { "required": [ "modifierGroupId", "modifierGroupName", "modifierOptionId", "modifierOptionName", "priceDelta" ], "type": "object", "properties": { "modifierGroupId": { "type": "string" }, "modifierGroupName": { "type": "string" }, "modifierOptionId": { "type": "string" }, "modifierOptionName": { "type": "string" }, "priceDelta": { "type": "number", "format": "double" } } }, "CreateOrderModel": { "required": [ "tenantId", "storeId", "cartId", "currencyCode", "shippingAddress", "billingAddress" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ], "description": "Unique identifier of the resource." }, "tenantId": { "type": "string" }, "storeId": { "type": "string" }, "cartId": { "type": "string" }, "currencyCode": { "type": "string", "description": "ISO 4217 currency code, for example `PEN`." }, "userId": { "type": [ "null", "string" ], "format": "uuid" }, "orderNumber": { "type": [ "null", "string" ] }, "orderGroup": { "type": [ "null", "string" ] }, "sellerId": { "type": [ "null", "string" ] }, "customerId": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "source": { "type": [ "null", "string" ] }, "sourceIdentifier": { "type": [ "null", "string" ] }, "couponCode": { "type": [ "null", "string" ] }, "promotion": { "type": [ "null", "string" ] }, "shippingPromotion": { "type": [ "null", "string" ] }, "invoiceType": { "$ref": "#/components/schemas/OrderInvoiceType" }, "shippingAddress": { "$ref": "#/components/schemas/Address" }, "billingAddress": { "$ref": "#/components/schemas/Address" }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "identificationType": { "type": [ "null", "string" ] }, "identificationNumber": { "type": [ "null", "string" ] }, "entityTaxId": { "type": [ "null", "string" ] }, "entityName": { "type": [ "null", "string" ] }, "tags": { "type": [ "null", "string" ] }, "integrationTags": { "type": [ "null", "string" ] }, "notes": { "type": [ "null", "string" ] }, "attribution": { "$ref": "#/components/schemas/OrderAttribution" }, "instructions": { "$ref": "#/components/schemas/OrderInstructions" }, "requestContext": { "$ref": "#/components/schemas/OrderRequestContext" }, "externalDataJson": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CreateOrderItemModel" } }, "shippingMethods": { "type": "array", "items": { "$ref": "#/components/schemas/CreateOrderShippingMethodModel" } }, "payment": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CreateOrderPaymentModel" } ] }, "transaction": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CreateOrderTransactionModel" } ] } } }, "CreateOrderPaymentModel": { "required": [ "paymentMethod", "paymentCode", "amount" ], "type": "object", "properties": { "paymentMethod": { "type": "string" }, "paymentCode": { "type": "string" }, "amount": { "type": "number", "format": "double" }, "cardNumber": { "type": [ "null", "string" ] }, "cardType": { "type": [ "null", "string" ] }, "installments": { "type": [ "null", "integer" ], "format": "int32" }, "authorizationCode": { "type": [ "null", "string" ] }, "transactionReference": { "type": [ "null", "string" ] }, "metadata": { "type": "object" } } }, "CreateOrderPaymentRequestModel": { "required": [ "paymentMethodCode", "externalRef" ], "type": "object", "properties": { "paymentMethodCode": { "type": "string" }, "externalRef": { "type": [ "null", "string" ] }, "receiptUrl": { "type": [ "null", "string" ] }, "token": { "type": [ "null", "string" ] }, "providerPaymentMethodId": { "type": [ "null", "string" ] } } }, "CreateOrderResult": { "required": [ "orders", "payment" ], "type": "object", "properties": { "orders": { "type": "array", "items": { "$ref": "#/components/schemas/CreatedOrderModel" } }, "payment": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrderPaymentResultModel" } ] } } }, "CreateOrderShipmentDto": { "required": [ "success", "shipmentId", "trackingNumber", "trackingLink", "labelUrl", "message" ], "type": "object", "properties": { "success": { "type": "boolean" }, "shipmentId": { "type": [ "null", "string" ] }, "trackingNumber": { "type": [ "null", "string" ] }, "trackingLink": { "type": [ "null", "string" ] }, "labelUrl": { "type": [ "null", "string" ] }, "message": { "type": [ "null", "string" ] } } }, "CreateOrderShipmentItemModel": { "required": [ "orderItemId", "quantity" ], "type": "object", "properties": { "orderItemId": { "type": "string" }, "quantity": { "type": "number", "format": "double" } } }, "CreateOrderShipmentRequestDto": { "type": "object", "properties": { "packageId": { "type": [ "null", "string" ] }, "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CreateOrderShipmentItemModel" } } } }, "CreateOrderShippingMethodModel": { "required": [ "name", "subtotal", "discountTotal", "taxTotal", "total" ], "type": "object", "properties": { "name": { "type": "string" }, "subtotal": { "type": "number", "format": "double" }, "discountTotal": { "type": "number", "format": "double" }, "taxTotal": { "type": "number", "format": "double" }, "total": { "type": "number", "format": "double" }, "isTaxInclusive": { "type": "boolean" }, "sellerId": { "type": [ "null", "string" ] }, "shippingProfileId": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "shippingMethodId": { "type": [ "null", "string" ] }, "connectionId": { "type": [ "null", "string" ] }, "allowSplitFulfillment": { "type": "boolean" }, "providerName": { "type": [ "null", "string" ] }, "trackingCode": { "type": [ "null", "string" ] }, "estimatedDays": { "type": [ "null", "integer" ], "format": "int32" }, "zoneCode": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ] }, "pickupPointId": { "type": [ "null", "string" ] }, "scheduledDate": { "type": [ "null", "string" ], "format": "date" }, "scheduledTime": { "type": [ "null", "string" ], "format": "time" }, "data": { "type": "object" } } }, "CreateOrdersRequest": { "required": [ "orders" ], "type": "object", "properties": { "orders": { "type": "array", "items": { "$ref": "#/components/schemas/CreateOrderModel" } }, "paymentRequest": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CreateOrderPaymentRequestModel" } ] } } }, "CreateOrderTransactionModel": { "required": [ "type", "amount", "paymentMethod" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/OrderTransactionType" }, "amount": { "type": "number", "format": "double" }, "paymentMethod": { "type": "string" }, "transactionReference": { "type": [ "null", "string" ] }, "transactionReferenceDocumentLink": { "type": [ "null", "string" ] } } }, "CreateOrganizationRequest": { "required": [ "name", "storeName", "firstName", "lastName", "organizationId", "countryCode", "currencyCode", "languageCode", "timeZone" ], "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "storeName": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": [ "null", "string" ] }, "organizationId": { "type": [ "null", "string" ] }, "countryCode": { "type": [ "null", "string" ], "description": "ISO 3166-1 alpha-2 country code, for example `PE`." }, "currencyCode": { "type": [ "null", "string" ], "description": "ISO 4217 currency code, for example `PEN`." }, "languageCode": { "type": [ "null", "string" ], "description": "ISO 639-1 language code, for example `es`." }, "timeZone": { "type": [ "null", "string" ], "description": "IANA time zone name, for example `America/Lima`." }, "storeType": { "enum": [ "b2C", "marketplace", "retail", "b2B", "social", "hub", "restaurant" ], "type": [ "null", "string" ] }, "createSampleData": { "type": "boolean", "default": false } } }, "CreatePickupPointRequest": { "required": [ "name", "address" ], "type": "object", "properties": { "name": { "type": "string" }, "address": { "type": "string" }, "locationId": { "type": [ "null", "string" ] }, "connectionId": { "type": [ "null", "string" ] }, "isExternal": { "type": "boolean" }, "externalId": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "zone": { "type": [ "null", "string" ] }, "postalCode": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "contactPerson": { "type": [ "null", "string" ] }, "instructions": { "type": [ "null", "string" ] }, "deliveryTimeInMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "leadTimeInMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "schedule": { "type": "array", "items": { "$ref": "#/components/schemas/PickupPointScheduleRequest" } }, "latitude": { "type": [ "null", "number" ], "format": "double" }, "longitude": { "type": [ "null", "number" ], "format": "double" } } }, "CreatePromotionCodeRequest": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string" }, "usageLimit": { "type": [ "null", "integer" ], "format": "int32" } } }, "CreatePromotionCodesRequest": { "required": [ "codes" ], "type": "object", "properties": { "codes": { "type": "array", "items": { "type": "string" } }, "usageLimit": { "type": [ "null", "integer" ], "format": "int32" } } }, "CreateSellerRequest": { "required": [ "name", "slug", "countryCode", "currencyCode" ], "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": [ "null", "string" ], "description": "URL-friendly identifier." }, "countryCode": { "type": "string", "description": "ISO 3166-1 alpha-2 country code, for example `PE`." }, "currencyCode": { "type": "string", "description": "ISO 4217 currency code, for example `PEN`." }, "description": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "emailNotification": { "type": [ "null", "string" ] }, "legalName": { "type": [ "null", "string" ] }, "taxId": { "type": [ "null", "string" ] }, "businessLicense": { "type": [ "null", "string" ] }, "legalAddress": { "type": [ "null", "string" ] }, "contactPerson": { "type": [ "null", "string" ] }, "contactEmail": { "type": [ "null", "string" ] }, "logo": { "type": [ "null", "string" ] }, "commissionPercent": { "type": [ "null", "number" ], "format": "double" }, "exchangeRate": { "type": [ "null", "number" ], "format": "double" }, "ownerEmail": { "type": [ "null", "string" ] }, "ownerFirstName": { "type": [ "null", "string" ] }, "ownerLastName": { "type": [ "null", "string" ] }, "billingInfo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UpdateBillingInformationRequest" } ] } } }, "CreateSizeGuideRequest": { "type": "object", "properties": { "assignments": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SizeGuideAssignmentInput" } }, "name": { "type": "string" }, "slug": { "type": [ "null", "string" ], "description": "URL-friendly identifier." }, "description": { "type": [ "null", "string" ] }, "imageUrl": { "type": [ "null", "string" ] }, "gender": { "$ref": "#/components/schemas/CatalogGender" }, "measurementType": { "$ref": "#/components/schemas/SizeGuideMeasurementType" }, "unit": { "$ref": "#/components/schemas/SizeGuideUnit" }, "status": { "$ref": "#/components/schemas/SizeGuideStatus" }, "priority": { "type": "integer", "format": "int32" }, "notes": { "type": [ "null", "string" ] }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/SizeGuideRowItemDto" } } } }, "CreateSpecificationRequest": { "required": [ "name", "key" ], "type": "object", "properties": { "name": { "type": "string" }, "key": { "type": "string" }, "aliases": { "type": [ "null", "array" ], "items": { "type": "string" } }, "description": { "type": [ "null", "string" ] }, "isMultiple": { "type": "boolean" }, "isRequired": { "type": "boolean" }, "isFilterable": { "type": "boolean" }, "isSearchable": { "type": "boolean" }, "order": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/SpecificationType" }, "level": { "$ref": "#/components/schemas/SpecificationLevel" }, "values": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CreateSpecificationValueRequest" } }, "metadata": { "type": [ "null", "object" ] } } }, "CreateSpecificationValueRequest": { "required": [ "value", "name" ], "type": "object", "properties": { "value": { "type": "string" }, "name": { "type": "string" }, "isDefault": { "type": "boolean", "default": false }, "order": { "type": "integer", "format": "int32", "default": 0 } } }, "CreateStoreRequest": { "required": [ "name", "slug", "description", "domain", "logo" ], "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": [ "null", "string" ], "description": "URL-friendly identifier." }, "description": { "type": [ "null", "string" ] }, "domain": { "type": [ "null", "string" ] }, "logo": { "type": [ "null", "string" ] }, "type": { "enum": [ "b2C", "marketplace", "retail", "b2B", "social", "hub", "restaurant" ], "type": "string", "default": "b2C" } } }, "CreateTemplateRequest": { "required": [ "group", "key", "name", "notification", "locale", "subjectTpl", "bodyTpl", "engine" ], "type": "object", "properties": { "group": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" }, "notification": { "$ref": "#/components/schemas/NotificationChannel" }, "locale": { "type": "string" }, "subjectTpl": { "type": "string" }, "bodyTpl": { "type": "string" }, "engine": { "type": [ "null", "string" ] }, "textTpl": { "type": [ "null", "string" ] } } }, "CreateVariantRequest": { "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "sku": { "type": [ "null", "string" ], "description": "Stock keeping unit (SKU)." }, "packageId": { "type": [ "null", "string" ] }, "price": { "type": [ "null", "number" ], "format": "double" }, "compareAtPrice": { "type": [ "null", "number" ], "format": "double" }, "costPrice": { "type": [ "null", "number" ], "format": "double" }, "lowStockThreshold": { "type": [ "null", "integer" ], "format": "int32" }, "allowBackorders": { "type": [ "null", "boolean" ] }, "trackInventory": { "type": [ "null", "boolean" ] }, "weight": { "type": [ "null", "number" ], "format": "double" }, "width": { "type": [ "null", "number" ], "format": "double" }, "height": { "type": [ "null", "number" ], "format": "double" }, "length": { "type": [ "null", "number" ], "format": "double" }, "unitOfMeasure": { "type": [ "null", "string" ] }, "barcode": { "type": [ "null", "string" ], "description": "Barcode of the variant, such as EAN or UPC." }, "countryOfOrigin": { "type": [ "null", "string" ] }, "hsCode": { "type": [ "null", "string" ] }, "isDefault": { "type": [ "null", "boolean" ] }, "isDigital": { "type": [ "null", "boolean" ] }, "images": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/VariantImageModel" } }, "options": { "type": [ "null", "object" ], "additionalProperties": { "type": "string" } }, "modifiers": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ModifierGroupModel" } } } }, "CurrentBillingSubscriptionDto": { "required": [ "currencyCode", "currentPlan", "subscription", "pendingPlanPurchase", "paymentMethod", "automaticCheckoutAvailable", "automaticCheckoutMessage" ], "type": "object", "properties": { "currencyCode": { "type": "string", "description": "ISO 4217 currency code, for example `PEN`." }, "currentPlan": { "$ref": "#/components/schemas/BillingPlanType" }, "subscription": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BillingSubscriptionDto" } ] }, "pendingPlanPurchase": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PlanPurchaseDto" } ] }, "paymentMethod": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BillingPaymentMethodDto" } ] }, "automaticCheckoutAvailable": { "type": "boolean" }, "automaticCheckoutMessage": { "type": "string" } } }, "CursorPaginatedItemsOfAiCreditActivityItemDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AiCreditActivityItemDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfBillingHistoryItemDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BillingHistoryItemDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfCartListItemDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CartListItemDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfCategoryDetailsDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CategoryDetailsDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfCollectionItemDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionItemDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfCollectionProductItemDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionProductItemDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfCustomerDetailsDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerDetailsDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfCustomerGroupDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerGroupDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfFulfillmentOrderListItemDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FulfillmentOrderListItemDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfHolidayDetailsDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/HolidayDetailsDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfInventoryListDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryListDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfInventoryTransactionDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryTransactionDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfLocationDetailsDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LocationDetailsDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfMemberItemDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MemberItemDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfOrderClaimListItemDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderClaimListItemDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfOrderDraftListItemDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderDraftListItemDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfOrderItemListItemDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderItemListItemDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfOrderListItemDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrderListItemDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfPickupPointDetailsDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PickupPointDetailsDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfPriceHistoryDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PriceHistoryDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfProductActivityItemDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductActivityItemDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfProductItemDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductItemDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfProductVariantListItemDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductVariantListItemDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfPromotionItemDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionItemDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfReviewDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ReviewDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfSellerItemDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SellerItemDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfShippingMethodDetailsDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingMethodDetailsDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfShippingRateDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingRateDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfShippingZoneDetailsDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingZoneDetailsDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfSizeGuideSummaryDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SizeGuideSummaryDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfSpecificationDetailsDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SpecificationDetailsDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfTemplateDetailsDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateDetailsDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfVariantSpreadsheetRowDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/VariantSpreadsheetRowDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CursorPaginatedItemsOfWebhookDeliveryDto": { "required": [ "data", "hasNextPage", "nextCursor", "totalCount" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookDeliveryDto" } }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "nextCursor": { "type": [ "null", "string" ], "description": "Cursor to request the next page. `null` on the last page." }, "totalCount": { "type": [ "null", "integer" ], "format": "int64", "description": "Total number of matching items." } } }, "CustomAiCreditPackDto": { "required": [ "minCredits", "maxCredits", "creditStep" ], "type": "object", "properties": { "minCredits": { "type": "integer", "format": "int64" }, "maxCredits": { "type": "integer", "format": "int64" }, "creditStep": { "type": "integer", "format": "int64" } } }, "CustomerAddressDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "addressKey": { "type": "string" }, "department": { "type": [ "null", "string" ] }, "addressNumber": { "type": [ "null", "string" ] }, "province": { "type": [ "null", "string" ] }, "district": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "cellPhone": { "type": [ "null", "string" ] }, "addressLine": { "type": "string" }, "reference": { "type": [ "null", "string" ] }, "countryIsoCode": { "type": "string" }, "postalCode": { "type": [ "null", "string" ] }, "latitude": { "type": [ "null", "number" ], "format": "double" }, "longitude": { "type": [ "null", "number" ], "format": "double" }, "hasCoordinates": { "type": "boolean" }, "isDefault": { "type": "boolean" } } }, "CustomerAddressRequest": { "type": "object", "properties": { "addressKey": { "type": "string" }, "countryIsoCode": { "type": "string" }, "addressLine": { "type": "string" }, "addressNumber": { "type": [ "null", "string" ] }, "department": { "type": [ "null", "string" ] }, "province": { "type": [ "null", "string" ] }, "district": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "cellPhone": { "type": [ "null", "string" ] }, "postalCode": { "type": [ "null", "string" ] }, "reference": { "type": [ "null", "string" ] }, "latitude": { "type": [ "null", "number" ], "format": "double" }, "longitude": { "type": [ "null", "number" ], "format": "double" }, "isDefault": { "type": [ "null", "boolean" ] } } }, "CustomerCreatedDto": { "required": [ "id", "status", "isVerified" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "status": { "$ref": "#/components/schemas/CustomerStatus" }, "isVerified": { "type": "boolean" } } }, "CustomerDetailsDto": { "required": [ "id", "storeId", "email", "firstName", "lastName", "phone", "identificationNumber", "identificationType", "entityName", "dateOfBirth", "gender", "countryIsoCode", "role", "companyName", "consent", "userId", "customerType", "status", "isVerified", "entityIdentificationNumber", "defaultAddressId", "metadata", "totalOrders", "avgOrders", "lastOrderId", "lastOrderDate", "loyaltyPoints", "addresses", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "email": { "type": [ "null", "string" ] }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "identificationNumber": { "type": [ "null", "string" ] }, "identificationType": { "type": [ "null", "string" ] }, "entityName": { "type": [ "null", "string" ] }, "dateOfBirth": { "type": [ "null", "string" ], "format": "date" }, "gender": { "$ref": "#/components/schemas/GenderType" }, "countryIsoCode": { "type": [ "null", "string" ] }, "role": { "type": [ "null", "string" ] }, "companyName": { "type": [ "null", "string" ] }, "consent": { "type": "boolean" }, "userId": { "type": [ "null", "string" ], "format": "uuid" }, "customerType": { "$ref": "#/components/schemas/CustomerType" }, "status": { "$ref": "#/components/schemas/CustomerStatus" }, "isVerified": { "type": "boolean" }, "entityIdentificationNumber": { "type": [ "null", "string" ] }, "defaultAddressId": { "type": [ "null", "string" ] }, "metadata": { "type": [ "null", "string" ] }, "totalOrders": { "type": "integer", "format": "int32" }, "avgOrders": { "type": "number", "format": "double" }, "lastOrderId": { "type": [ "null", "string" ] }, "lastOrderDate": { "type": [ "null", "string" ], "format": "date-time" }, "loyaltyPoints": { "type": "integer", "format": "int32" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerAddressDto" } }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "CustomerExportRequest": { "type": "object", "properties": { "format": { "type": "string" }, "search": { "type": [ "null", "string" ], "description": "Free-text filter. Which fields it covers depends on the resource." }, "isActive": { "type": [ "null", "boolean" ] }, "isVerified": { "type": [ "null", "boolean" ] }, "customerType": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CustomerType" } ] }, "customerTypes": { "type": [ "null", "array" ] }, "status": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CustomerStatus" } ] }, "statuses": { "type": [ "null", "array" ] }, "customerIds": { "type": [ "null", "array" ] }, "createdFrom": { "type": [ "null", "string" ], "format": "date-time" }, "createdTo": { "type": [ "null", "string" ], "format": "date-time" }, "template": { "type": "boolean" } } }, "CustomerGroupDto": { "required": [ "id", "storeId", "name", "description", "isActive", "customerCount", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "isActive": { "type": "boolean" }, "customerCount": { "type": "integer", "format": "int32" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "CustomerGroupMembershipChangeDto": { "required": [ "customerGroupId", "addedCount", "existingCount", "requestedCount" ], "type": "object", "properties": { "customerGroupId": { "type": "string" }, "addedCount": { "type": "integer", "format": "int32" }, "existingCount": { "type": "integer", "format": "int32" }, "requestedCount": { "type": "integer", "format": "int32" } } }, "CustomerGroupMembershipRemovalDto": { "required": [ "customerGroupId", "removedCount", "missingCount", "requestedCount" ], "type": "object", "properties": { "customerGroupId": { "type": "string" }, "removedCount": { "type": "integer", "format": "int32" }, "missingCount": { "type": "integer", "format": "int32" }, "requestedCount": { "type": "integer", "format": "int32" } } }, "CustomerGroupMembersRequest": { "required": [ "customerIds" ], "type": "object", "properties": { "customerIds": { "type": "array" } } }, "CustomerGroupRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "isActive": { "type": "boolean", "default": true } } }, "CustomerIdentityScope": { "enum": [ "store", "tenant", "global" ], "type": "string" }, "CustomerSpreadsheetDto": { "required": [ "id", "totalCount", "expiresAt" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "totalCount": { "type": "integer", "format": "int64", "description": "Total number of matching items." }, "expiresAt": { "type": "string", "format": "date-time" } } }, "CustomerSpreadsheetFilters": { "type": "object", "properties": { "search": { "type": [ "null", "string" ], "description": "Free-text filter. Which fields it covers depends on the resource." }, "isActive": { "type": [ "null", "boolean" ] }, "isVerified": { "type": [ "null", "boolean" ] }, "customerType": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CustomerType" } ] }, "customerTypes": { "type": [ "null", "array" ] }, "status": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CustomerStatus" } ] }, "statuses": { "type": [ "null", "array" ] }, "groupId": { "type": [ "null", "string" ] }, "sortBy": { "type": [ "null", "string" ], "description": "Field to sort by. Accepted values depend on the resource." }, "sortDirection": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SortDirection" } ], "description": "Sort direction: `asc` or `desc`." } } }, "CustomerSpreadsheetRequest": { "type": "object", "properties": { "ids": { "type": [ "null", "array" ] }, "filters": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CustomerSpreadsheetFilters" } ] }, "pageSize": { "type": [ "null", "integer" ], "format": "int32" }, "maxRows": { "type": [ "null", "integer" ], "format": "int32" } } }, "CustomerSpreadsheetSaveRequest": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerSpreadsheetUpdateRequest" } } } }, "CustomerSpreadsheetUpdateRequest": { "type": "object", "properties": { "customerId": { "type": "string" }, "body": { "$ref": "#/components/schemas/UpdateCustomerRequest" } } }, "CustomerStatus": { "enum": [ "active", "pendingVerification", "pendingApproval", "inactive", "blocked" ], "type": "string" }, "CustomerType": { "enum": [ "individual", "business" ], "type": "string" }, "DayOfWeekType": { "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ], "type": "string" }, "DimensionUnit": { "enum": [ "centimeter", "inch" ], "type": "string" }, "DnsRecordDto": { "required": [ "type", "name", "content" ], "type": "object", "properties": { "type": { "type": "string" }, "name": { "type": "string" }, "content": { "type": "string" } } }, "FulfillmentOptionsDto": { "required": [ "offersShipping", "offersPickup", "offersDigitalDelivery", "offersInstallation", "hasAnyOption" ], "type": "object", "properties": { "offersShipping": { "type": "boolean" }, "offersPickup": { "type": "boolean" }, "offersDigitalDelivery": { "type": "boolean" }, "offersInstallation": { "type": "boolean" }, "hasAnyOption": { "type": "boolean" } } }, "FulfillmentOrderDetailsDto": { "required": [ "id", "orderId", "orderNumber", "locationId", "locationName", "status", "shippingConnectionId", "packageId", "shipmentId", "trackingNumber", "trackingLink", "labelUrl", "carrierName", "items", "shipments", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "orderId": { "type": "string" }, "orderNumber": { "type": "string" }, "locationId": { "type": [ "null", "string" ] }, "locationName": { "type": [ "null", "string" ] }, "status": { "$ref": "#/components/schemas/FulfillmentOrderStatus" }, "shippingConnectionId": { "type": [ "null", "string" ] }, "packageId": { "type": [ "null", "string" ] }, "shipmentId": { "type": [ "null", "string" ] }, "trackingNumber": { "type": [ "null", "string" ] }, "trackingLink": { "type": [ "null", "string" ] }, "labelUrl": { "type": [ "null", "string" ] }, "carrierName": { "type": [ "null", "string" ] }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FulfillmentOrderItemDto" } }, "shipments": { "type": "array", "items": { "$ref": "#/components/schemas/FulfillmentOrderShipmentDto" } }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "FulfillmentOrderItemDto": { "required": [ "orderItemId", "productId", "variantId", "title", "sku", "quantity", "shippedQuantity", "remainingQuantity" ], "type": "object", "properties": { "orderItemId": { "type": "string" }, "productId": { "type": [ "null", "string" ] }, "variantId": { "type": [ "null", "string" ] }, "title": { "type": "string" }, "sku": { "type": [ "null", "string" ], "description": "Stock keeping unit (SKU)." }, "quantity": { "type": "number", "format": "double" }, "shippedQuantity": { "type": "number", "format": "double" }, "remainingQuantity": { "type": "number", "format": "double" } } }, "FulfillmentOrderListItemDto": { "required": [ "id", "orderId", "orderNumber", "locationId", "locationName", "status", "itemCount", "totalQuantity", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "orderId": { "type": "string" }, "orderNumber": { "type": "string" }, "locationId": { "type": [ "null", "string" ] }, "locationName": { "type": [ "null", "string" ] }, "status": { "$ref": "#/components/schemas/FulfillmentOrderStatus" }, "itemCount": { "type": "integer", "format": "int32" }, "totalQuantity": { "type": "number", "format": "double" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "FulfillmentOrderShipmentDto": { "required": [ "id", "packageId", "shipmentId", "trackingNumber", "trackingLink", "labelUrl", "carrierName", "items", "createdOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "packageId": { "type": [ "null", "string" ] }, "shipmentId": { "type": [ "null", "string" ] }, "trackingNumber": { "type": [ "null", "string" ] }, "trackingLink": { "type": [ "null", "string" ] }, "labelUrl": { "type": [ "null", "string" ] }, "carrierName": { "type": [ "null", "string" ] }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/FulfillmentShipmentItemDto" } }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." } } }, "FulfillmentOrderState": { "enum": [ "pendingAssignment", "pending", "inProgress", "readyToPickUp", "shipped", "delivered", "cancelled" ], "type": "string" }, "FulfillmentOrderStatus": { "enum": [ "pendingAssignment", "pending", "inProgress", "readyToPickUp", "shipped", "delivered", "cancelled" ], "type": "string" }, "FulfillmentOrderSummaryModel": { "required": [ "id", "storeId", "orderId", "shippingConnectionId", "status", "shipmentId", "trackingNumber", "trackingLink", "labelUrl", "carrierName" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "orderId": { "type": "string" }, "shippingConnectionId": { "type": [ "null", "string" ] }, "status": { "$ref": "#/components/schemas/FulfillmentOrderState" }, "shipmentId": { "type": [ "null", "string" ] }, "trackingNumber": { "type": [ "null", "string" ] }, "trackingLink": { "type": [ "null", "string" ] }, "labelUrl": { "type": [ "null", "string" ] }, "carrierName": { "type": [ "null", "string" ] } } }, "FulfillmentSettingsDto": { "required": [ "storeId", "routingMode", "splitFulfillmentEnabled", "packingSlipSenderName", "packingSlipSenderPhone", "packingSlipSenderEmail", "packingSlipNotes" ], "type": "object", "properties": { "storeId": { "type": "string" }, "routingMode": { "$ref": "#/components/schemas/RoutingMode" }, "splitFulfillmentEnabled": { "type": "boolean" }, "packingSlipSenderName": { "type": [ "null", "string" ] }, "packingSlipSenderPhone": { "type": [ "null", "string" ] }, "packingSlipSenderEmail": { "type": [ "null", "string" ] }, "packingSlipNotes": { "type": [ "null", "string" ] } } }, "FulfillmentSettingsRequest": { "type": "object", "properties": { "routingMode": { "$ref": "#/components/schemas/RoutingMode" }, "splitFulfillmentEnabled": { "type": "boolean" }, "packingSlipSenderName": { "type": [ "null", "string" ] }, "packingSlipSenderPhone": { "type": [ "null", "string" ] }, "packingSlipSenderEmail": { "type": [ "null", "string" ] }, "packingSlipNotes": { "type": [ "null", "string" ] } } }, "FulfillmentShipmentItemDto": { "required": [ "orderItemId", "sku", "quantity", "weight" ], "type": "object", "properties": { "orderItemId": { "type": "string" }, "sku": { "type": [ "null", "string" ], "description": "Stock keeping unit (SKU)." }, "quantity": { "type": "number", "format": "double" }, "weight": { "type": "number", "format": "double" } } }, "FulfillmentShipmentLineModel": { "required": [ "orderItemId", "quantity" ], "type": "object", "properties": { "orderItemId": { "type": "string" }, "quantity": { "type": "number", "format": "double" } } }, "FulfillmentShipmentModel": { "required": [ "id", "fulfillmentOrderId", "orderId", "orderNumber", "shipmentId", "trackingNumber", "trackingLink", "labelUrl", "carrierName" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "fulfillmentOrderId": { "type": "string" }, "orderId": { "type": "string" }, "orderNumber": { "type": "string" }, "shipmentId": { "type": [ "null", "string" ] }, "trackingNumber": { "type": [ "null", "string" ] }, "trackingLink": { "type": [ "null", "string" ] }, "labelUrl": { "type": [ "null", "string" ] }, "carrierName": { "type": [ "null", "string" ] } } }, "GenderType": { "enum": [ "male", "female", "other" ], "type": "string" }, "GeoAreaModel": { "required": [ "id", "countryCode", "type", "code", "name", "parentId", "source" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "countryCode": { "type": "string", "description": "ISO 3166-1 alpha-2 country code, for example `PE`." }, "type": { "$ref": "#/components/schemas/AreaLevel" }, "code": { "type": "string" }, "name": { "type": "string" }, "parentId": { "type": [ "null", "string" ] }, "source": { "type": "string" } } }, "GeoCountryModel": { "required": [ "code", "name" ], "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } }, "HolidayDetailsDto": { "required": [ "id", "storeId", "name", "from", "to", "description" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "name": { "type": "string" }, "from": { "type": "string", "format": "date" }, "to": { "type": "string", "format": "date" }, "description": { "type": [ "null", "string" ] } } }, "HolidayRequest": { "required": [ "name", "fromDate", "toDate" ], "type": "object", "properties": { "name": { "type": "string" }, "fromDate": { "type": "string", "format": "date" }, "toDate": { "type": "string", "format": "date" }, "description": { "type": [ "null", "string" ] } } }, "HttpValidationProblemDetails": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "integer" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "code": { "type": "string", "description": "Machine-readable error code returned by Ecomiq." } } }, "ImportProductsRequest": { "required": [ "clientRunId", "assetId", "checksum" ], "type": "object", "properties": { "clientRunId": { "type": "string" }, "assetId": { "type": "string" }, "checksum": { "type": "string" }, "syncInventory": { "type": [ "null", "boolean" ] }, "recordInventoryAudit": { "type": [ "null", "boolean" ] } } }, "InitialInventoryRequest": { "type": "object", "properties": { "locationId": { "type": "string" }, "onHand": { "type": "integer", "format": "int32" } } }, "InventoryAdjustmentRequest": { "type": "object", "properties": { "variantId": { "type": "string" }, "locationId": { "type": "string" }, "target": { "$ref": "#/components/schemas/InventoryQuantityTarget" }, "mode": { "$ref": "#/components/schemas/InventoryQuantityMode" }, "quantity": { "type": "integer", "format": "int32" }, "reason": { "$ref": "#/components/schemas/TransactionReason" }, "note": { "type": [ "null", "string" ] }, "expectedVersion": { "type": "integer", "format": "int64" } } }, "InventoryAvailabilityModel": { "required": [ "locationId", "variantId", "available" ], "type": "object", "properties": { "locationId": { "type": "string" }, "variantId": { "type": "string" }, "available": { "type": "integer", "format": "int32" } } }, "InventoryAvailabilityQueryDto": { "required": [ "storeId", "locationIds", "variantIds" ], "type": "object", "properties": { "storeId": { "type": "string" }, "locationIds": { "type": "array" }, "variantIds": { "type": "array" } } }, "InventoryCountDto": { "required": [ "total", "precision", "limit" ], "type": "object", "properties": { "total": { "type": "integer", "format": "int32", "description": "Number of inventory items that match the filters. When `precision` is `atLeast`, this is a lower bound." }, "precision": { "$ref": "#/components/schemas/InventoryCountPrecision", "description": "Whether `total` is exact or a lower bound." }, "limit": { "type": [ "null", "integer" ], "format": "int32", "description": "Maximum number of matching inventory items evaluated before the count becomes a lower bound." } } }, "InventoryCountPrecision": { "enum": [ "exact", "atLeast" ], "type": "string" }, "InventoryDto": { "required": [ "id", "locationId", "onHand", "committed", "available", "incoming", "unavailable", "version", "createdOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "locationId": { "type": "string" }, "onHand": { "type": "integer", "format": "int32" }, "committed": { "type": "integer", "format": "int32" }, "available": { "type": "integer", "format": "int32" }, "incoming": { "type": "integer", "format": "int32" }, "unavailable": { "type": "integer", "format": "int32" }, "version": { "type": "integer", "format": "int64" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "InventoryExportRequest": { "type": "object", "properties": { "format": { "type": "string" }, "search": { "type": [ "null", "string" ], "description": "Free-text filter. Which fields it covers depends on the resource." }, "locationIds": { "type": [ "null", "array" ] }, "brandIds": { "type": [ "null", "array" ] }, "categoryIds": { "type": [ "null", "array" ] }, "productStatus": { "type": [ "null", "array" ], "items": { "type": "string" } }, "minOnHand": { "type": [ "null", "integer" ], "format": "int32" }, "maxOnHand": { "type": [ "null", "integer" ], "format": "int32" }, "minAvailable": { "type": [ "null", "integer" ], "format": "int32" }, "maxAvailable": { "type": [ "null", "integer" ], "format": "int32" }, "minCommitted": { "type": [ "null", "integer" ], "format": "int32" }, "maxCommitted": { "type": [ "null", "integer" ], "format": "int32" }, "isLowStock": { "type": [ "null", "boolean" ] }, "isInStock": { "type": [ "null", "boolean" ] }, "template": { "type": "boolean" } } }, "InventoryLevelModel": { "required": [ "id", "locationId", "variantId", "onHand", "committed", "available", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "locationId": { "type": "string" }, "variantId": { "type": "string" }, "onHand": { "type": "integer", "format": "int32" }, "committed": { "type": "integer", "format": "int32" }, "available": { "type": "integer", "format": "int32" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." }, "incoming": { "type": "integer", "format": "int32", "default": 0 }, "unavailable": { "type": "integer", "format": "int32", "default": 0 }, "version": { "type": "integer", "format": "int64", "default": "1" } } }, "InventoryLevelsQueryDto": { "required": [ "storeId", "variantIds" ], "type": "object", "properties": { "storeId": { "type": "string" }, "variantIds": { "type": "array" }, "locationIds": { "type": [ "null", "array" ] } } }, "InventoryListDto": { "required": [ "inventoryId", "variantId", "variantSku", "variantName", "productId", "productName", "productSlug", "productImage", "locationId", "onHand", "committed", "available", "incoming", "unavailable", "version", "lowStockThreshold", "price", "trackInventory", "allowBackorders", "isLowStock", "variantStatus", "isInStock", "productStatus", "createdOn" ], "type": "object", "properties": { "inventoryId": { "type": "string" }, "variantId": { "type": "string" }, "variantSku": { "type": "string" }, "variantBarcode": { "type": [ "null", "string" ] }, "variantName": { "type": "string" }, "productId": { "type": "string" }, "productName": { "type": "string" }, "productSlug": { "type": "string" }, "productImage": { "type": "string" }, "brandId": { "type": [ "null", "string" ] }, "brandName": { "type": [ "null", "string" ] }, "categoryId": { "type": [ "null", "string" ] }, "categoryName": { "type": [ "null", "string" ] }, "locationId": { "type": "string" }, "locationName": { "type": [ "null", "string" ] }, "onHand": { "type": "integer", "format": "int32" }, "committed": { "type": "integer", "format": "int32" }, "available": { "type": "integer", "format": "int32" }, "incoming": { "type": "integer", "format": "int32" }, "unavailable": { "type": "integer", "format": "int32" }, "version": { "type": "integer", "format": "int64" }, "lowStockThreshold": { "type": "integer", "format": "int32" }, "price": { "type": "number", "format": "double" }, "compareAtPrice": { "type": [ "null", "number" ], "format": "double" }, "costPrice": { "type": [ "null", "number" ], "format": "double" }, "trackInventory": { "type": "boolean" }, "allowBackorders": { "type": "boolean" }, "isLowStock": { "type": "boolean" }, "variantStatus": { "type": "string" }, "isInStock": { "type": "boolean" }, "productStatus": { "type": "string" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "InventoryOperationDto": { "required": [ "id", "status", "resource", "format", "createdOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "status": { "$ref": "#/components/schemas/OperationStatus" }, "resource": { "type": "string" }, "format": { "type": "string" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." } } }, "InventoryQuantityMode": { "enum": [ "set", "adjust" ], "type": "string" }, "InventoryQuantityTarget": { "enum": [ "onHand", "available" ], "type": "string" }, "InventoryStockBatchItemRequest": { "type": "object", "properties": { "variantId": { "type": [ "null", "string" ] }, "locationId": { "type": "string" }, "mode": { "$ref": "#/components/schemas/InventoryQuantityMode" }, "quantity": { "type": "integer", "format": "int32" }, "expectedVersion": { "type": "integer", "format": "int64" } } }, "InventoryStockBatchRequest": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryStockBatchItemRequest" } }, "reason": { "$ref": "#/components/schemas/TransactionReason" }, "note": { "type": [ "null", "string" ] } } }, "InventoryStockLineModel": { "required": [ "productId", "variantId", "productName", "variantName", "sku", "quantity" ], "type": "object", "properties": { "productId": { "type": "string" }, "variantId": { "type": "string" }, "productName": { "type": "string" }, "variantName": { "type": "string" }, "sku": { "type": [ "null", "string" ], "description": "Stock keeping unit (SKU)." }, "quantity": { "type": "integer", "format": "int32" } } }, "InventoryTotalsModel": { "required": [ "variantId", "onHand", "committed", "available" ], "type": "object", "properties": { "variantId": { "type": "string" }, "onHand": { "type": "integer", "format": "int32" }, "committed": { "type": "integer", "format": "int32" }, "available": { "type": "integer", "format": "int32" }, "incoming": { "type": "integer", "format": "int32", "default": 0 }, "unavailable": { "type": "integer", "format": "int32", "default": 0 } } }, "InventoryTotalsQueryDto": { "required": [ "storeId", "variantIds" ], "type": "object", "properties": { "storeId": { "type": "string" }, "variantIds": { "type": "array" }, "locationIds": { "type": [ "null", "array" ] } } }, "InventoryTransactionDto": { "required": [ "id", "productId", "productName", "variantId", "variantName", "sku", "locationId", "locationName", "type", "reason", "quantity", "quantityChange", "previousQuantity", "newQuantity", "timestamp" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "productId": { "type": "string" }, "productName": { "type": "string" }, "variantId": { "type": "string" }, "variantName": { "type": "string" }, "sku": { "type": "string", "description": "Stock keeping unit (SKU)." }, "locationId": { "type": "string" }, "locationName": { "type": "string" }, "type": { "type": "string" }, "reason": { "type": "string" }, "quantity": { "type": "string" }, "quantityChange": { "type": "integer", "format": "int32" }, "previousQuantity": { "type": "integer", "format": "int32" }, "newQuantity": { "type": "integer", "format": "int32" }, "note": { "type": [ "null", "string" ] }, "referenceId": { "type": [ "null", "string" ] }, "userId": { "type": [ "null", "string" ], "format": "uuid" }, "userEmail": { "type": [ "null", "string" ] }, "userName": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } } }, "InvitationItemDto": { "required": [ "id", "email", "roleName", "isExpired", "status", "createdOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": [ "null", "string" ] }, "storeName": { "type": [ "null", "string" ] }, "storeLogo": { "type": [ "null", "string" ] }, "email": { "type": "string" }, "roleName": { "type": "string" }, "invitedByName": { "type": [ "null", "string" ] }, "invitedByEmail": { "type": [ "null", "string" ] }, "isExpired": { "type": "boolean" }, "status": { "$ref": "#/components/schemas/InvitationStatus" }, "acceptedAt": { "type": [ "null", "string" ], "format": "date-time" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "token": { "type": [ "null", "string" ] } } }, "InvitationStatus": { "enum": [ "pending", "accepted", "rejected" ], "type": "string" }, "InviteSellerMemberRequest": { "required": [ "email", "roleId" ], "type": "object", "properties": { "email": { "type": "string" }, "roleId": { "type": "string" }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] } } }, "LegalInformationDto": { "required": [ "isVerified", "isComplete" ], "type": "object", "properties": { "isVerified": { "type": "boolean" }, "taxId": { "type": [ "null", "string" ] }, "businessLicense": { "type": [ "null", "string" ] }, "legalName": { "type": [ "null", "string" ] }, "legalAddress": { "type": [ "null", "string" ] }, "contactPerson": { "type": [ "null", "string" ] }, "contactEmail": { "type": [ "null", "string" ] }, "isComplete": { "type": "boolean" } } }, "ListingReadinessIssueDto": { "required": [ "code", "message" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, "LiveShippingQuoteRequest": { "type": "object", "properties": { "shippingMethodId": { "type": "string" }, "countryIsoCode": { "type": [ "null", "string" ] }, "destination": { "$ref": "#/components/schemas/ShipmentAddress" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentProduct" } }, "orderAmount": { "type": "number", "format": "double" }, "currency": { "type": [ "null", "string" ] } } }, "LocalDeliveryZoneDto": { "required": [ "name", "postalCodes" ], "type": "object", "properties": { "name": { "type": "string" }, "postalCodes": { "type": "array", "items": { "type": "string" } }, "radiusKm": { "type": [ "null", "number" ], "format": "double" }, "fee": { "type": [ "null", "number" ], "format": "double" }, "freeFromAmount": { "type": [ "null", "number" ], "format": "double" }, "minHours": { "type": [ "null", "integer" ], "format": "int32" }, "maxHours": { "type": [ "null", "integer" ], "format": "int32" } } }, "LocalDeliveryZoneModel": { "required": [ "name", "postalCodes", "radiusKm", "fee", "freeFromAmount", "minHours", "maxHours" ], "type": "object", "properties": { "name": { "type": "string" }, "postalCodes": { "type": "array", "items": { "type": "string" } }, "radiusKm": { "type": [ "null", "number" ], "format": "double" }, "fee": { "type": [ "null", "number" ], "format": "double" }, "freeFromAmount": { "type": [ "null", "number" ], "format": "double" }, "minHours": { "type": [ "null", "integer" ], "format": "int32" }, "maxHours": { "type": [ "null", "integer" ], "format": "int32" } } }, "LocalDeliveryZoneRequest": { "required": [ "name", "postalCodes" ], "type": "object", "properties": { "name": { "type": "string" }, "postalCodes": { "type": "array", "items": { "type": "string" } }, "radiusKm": { "type": [ "null", "number" ], "format": "double" }, "fee": { "type": [ "null", "number" ], "format": "double" }, "freeFromAmount": { "type": [ "null", "number" ], "format": "double" }, "minHours": { "type": [ "null", "integer" ], "format": "int32" }, "maxHours": { "type": [ "null", "integer" ], "format": "int32" } } }, "LocationDetailsDto": { "required": [ "id", "storeId", "name", "code", "type", "isActive", "isDefault", "useForFulfillment", "supportsShipping", "supportsLocalDelivery", "supportsPickup", "isPhysicalStore", "supportsPos", "priority", "localDeliveryPostalCodes", "localDeliveryZones", "schedules", "status", "createdOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "sellerId": { "type": [ "null", "string" ] }, "name": { "type": "string" }, "code": { "type": "string" }, "type": { "$ref": "#/components/schemas/LocationType" }, "address": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "state": { "type": [ "null", "string" ] }, "country": { "type": [ "null", "string" ] }, "postalCode": { "type": [ "null", "string" ] }, "latitude": { "type": [ "null", "number" ], "format": "double" }, "longitude": { "type": [ "null", "number" ], "format": "double" }, "phone": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "isActive": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "useForFulfillment": { "type": "boolean" }, "supportsShipping": { "type": "boolean" }, "supportsLocalDelivery": { "type": "boolean" }, "supportsPickup": { "type": "boolean" }, "isPhysicalStore": { "type": "boolean" }, "supportsPos": { "type": "boolean" }, "priority": { "type": "integer", "format": "int32" }, "pickupInstructions": { "type": [ "null", "string" ] }, "pickupLeadTimeInMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "pickupSlotInMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "pickupDailyCapacity": { "type": [ "null", "integer" ], "format": "int32" }, "localDeliveryInstructions": { "type": [ "null", "string" ] }, "localDeliveryLeadTimeInMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "localDeliverySlotInMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "localDeliveryDailyCapacity": { "type": [ "null", "integer" ], "format": "int32" }, "localDeliveryFee": { "type": [ "null", "number" ], "format": "double" }, "localDeliveryFreeFromAmount": { "type": [ "null", "number" ], "format": "double" }, "localDeliveryMinHours": { "type": [ "null", "integer" ], "format": "int32" }, "localDeliveryMaxHours": { "type": [ "null", "integer" ], "format": "int32" }, "localDeliveryPostalCodes": { "type": "array", "items": { "type": "string" } }, "localDeliveryZones": { "type": "array", "items": { "$ref": "#/components/schemas/LocalDeliveryZoneDto" } }, "schedules": { "type": "array", "items": { "$ref": "#/components/schemas/LocationScheduleDto" } }, "status": { "$ref": "#/components/schemas/LocationStatus" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "LocationModel": { "required": [ "id", "name", "code", "address", "city", "state", "country", "postalCode", "latitude", "longitude", "phone", "email", "isDefault", "isActive", "isPhysicalStore", "supportsPos", "supportsShipping", "supportsPickup", "supportsLocalDelivery", "priority", "pickupInstructions", "pickupLeadTimeInMinutes", "pickupSlotInMinutes", "pickupDailyCapacity", "localDeliveryInstructions", "localDeliveryLeadTimeInMinutes", "localDeliverySlotInMinutes", "localDeliveryDailyCapacity", "localDeliveryFee", "localDeliveryFreeFromAmount", "localDeliveryMinHours", "localDeliveryMaxHours", "localDeliveryPostalCodes", "localDeliveryZones", "pickupSchedule", "deliverySchedule" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "name": { "type": "string" }, "code": { "type": "string" }, "address": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "state": { "type": [ "null", "string" ] }, "country": { "type": [ "null", "string" ] }, "postalCode": { "type": [ "null", "string" ] }, "latitude": { "type": [ "null", "number" ], "format": "double" }, "longitude": { "type": [ "null", "number" ], "format": "double" }, "phone": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "isDefault": { "type": "boolean" }, "isActive": { "type": "boolean" }, "isPhysicalStore": { "type": "boolean" }, "supportsPos": { "type": "boolean" }, "supportsShipping": { "type": "boolean" }, "supportsPickup": { "type": "boolean" }, "supportsLocalDelivery": { "type": "boolean" }, "priority": { "type": "integer", "format": "int32" }, "pickupInstructions": { "type": [ "null", "string" ] }, "pickupLeadTimeInMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "pickupSlotInMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "pickupDailyCapacity": { "type": [ "null", "integer" ], "format": "int32" }, "localDeliveryInstructions": { "type": [ "null", "string" ] }, "localDeliveryLeadTimeInMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "localDeliverySlotInMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "localDeliveryDailyCapacity": { "type": [ "null", "integer" ], "format": "int32" }, "localDeliveryFee": { "type": [ "null", "number" ], "format": "double" }, "localDeliveryFreeFromAmount": { "type": [ "null", "number" ], "format": "double" }, "localDeliveryMinHours": { "type": [ "null", "integer" ], "format": "int32" }, "localDeliveryMaxHours": { "type": [ "null", "integer" ], "format": "int32" }, "localDeliveryPostalCodes": { "type": "array", "items": { "type": "string" } }, "localDeliveryZones": { "type": "array", "items": { "$ref": "#/components/schemas/LocalDeliveryZoneModel" } }, "pickupSchedule": { "type": "array", "items": { "$ref": "#/components/schemas/LocationScheduleModel" } }, "deliverySchedule": { "type": "array", "items": { "$ref": "#/components/schemas/LocationScheduleModel" } } } }, "LocationScheduleDto": { "required": [ "id", "openTime", "closeTime", "name", "dayOfWeek", "enabled", "isOpen", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "openTime": { "type": "string", "format": "time" }, "closeTime": { "type": "string", "format": "time" }, "name": { "type": "string" }, "dayOfWeek": { "$ref": "#/components/schemas/DayOfWeekType" }, "enabled": { "type": "boolean" }, "isOpen": { "type": "boolean" }, "type": { "$ref": "#/components/schemas/LocationScheduleType" } } }, "LocationScheduleModel": { "required": [ "dayOfWeek", "openTime", "closeTime", "isOpen" ], "type": "object", "properties": { "dayOfWeek": { "$ref": "#/components/schemas/DayOfWeekType" }, "openTime": { "type": "string", "format": "time" }, "closeTime": { "type": "string", "format": "time" }, "isOpen": { "type": "boolean" } } }, "LocationScheduleRequest": { "required": [ "openTime", "closeTime", "name", "dayOfWeek" ], "type": "object", "properties": { "openTime": { "type": "string" }, "closeTime": { "type": "string" }, "name": { "type": "string" }, "dayOfWeek": { "$ref": "#/components/schemas/DayOfWeekType" }, "isOpen": { "type": "boolean", "default": true }, "type": { "enum": [ "delivery", "pickUp", "logistic" ], "type": "string", "default": "pickUp" }, "id": { "type": [ "null", "string" ], "description": "Unique identifier of the resource." } } }, "LocationScheduleType": { "enum": [ "delivery", "pickUp", "logistic" ], "type": "string" }, "LocationStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "LocationType": { "enum": [ "warehouse", "store", "seller" ], "type": "string" }, "MemberContextDto": { "required": [ "id", "role", "usesCustomPermissions", "lastLoginOn", "status" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": [ "null", "string" ] }, "sellerId": { "type": [ "null", "string" ] }, "role": { "$ref": "#/components/schemas/MemberRoleDto" }, "preferences": { "type": [ "null", "object" ] }, "usesCustomPermissions": { "type": "boolean" }, "languageCode": { "type": [ "null", "string" ], "description": "ISO 639-1 language code, for example `es`." }, "timezone": { "type": [ "null", "string" ] }, "currencyCode": { "type": [ "null", "string" ], "description": "ISO 4217 currency code, for example `PEN`." }, "lastLoginOn": { "type": "string", "format": "date-time" }, "status": { "$ref": "#/components/schemas/MemberStatus" } } }, "MemberItemDto": { "required": [ "id", "email", "firstName", "isOwner", "status", "createdOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": [ "null", "string" ] }, "avatarUrl": { "type": [ "null", "string" ] }, "roleName": { "type": [ "null", "string" ] }, "isOwner": { "type": "boolean" }, "status": { "$ref": "#/components/schemas/MemberStatus" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "lastLoginOn": { "type": [ "null", "string" ], "format": "date-time" } } }, "MemberRoleDto": { "required": [ "id", "code", "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "code": { "type": "string" }, "name": { "type": "string" } } }, "MemberStatus": { "enum": [ "active", "inactive", "suspended" ], "type": "string" }, "ModerationDecisionRequest": { "required": [ "productIds", "action", "reason" ], "type": "object", "properties": { "productIds": { "type": "array" }, "action": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ProductModerationAction" } ] }, "reason": { "type": [ "null", "string" ] } } }, "ModerationDecisionResultDto": { "required": [ "approved", "rejected" ], "type": "object", "properties": { "approved": { "type": "integer", "format": "int32" }, "rejected": { "type": "integer", "format": "int32" } } }, "ModerationSellerSummaryDto": { "required": [ "sellerId", "sellerName", "pending" ], "type": "object", "properties": { "sellerId": { "type": "string" }, "sellerName": { "type": [ "null", "string" ] }, "pending": { "type": "integer", "format": "int32" } } }, "ModerationSummaryDto": { "required": [ "pending", "sellers" ], "type": "object", "properties": { "pending": { "type": "integer", "format": "int32" }, "sellers": { "type": "array", "items": { "$ref": "#/components/schemas/ModerationSellerSummaryDto" } } } }, "ModifierGroupDto": { "required": [ "id", "name", "isRequired", "selectionType", "minSelections", "order", "status", "options" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "isRequired": { "type": "boolean" }, "selectionType": { "$ref": "#/components/schemas/ModifierSelectionType" }, "minSelections": { "type": "integer", "format": "int32" }, "maxSelections": { "type": [ "null", "integer" ], "format": "int32" }, "order": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ModifierGroupStatus" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/ModifierOptionDto" } } } }, "ModifierGroupModel": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "isRequired": { "type": "boolean", "default": false }, "selectionType": { "enum": [ "single", "multiple" ], "type": "string", "default": "single" }, "minSelections": { "type": "integer", "format": "int32", "default": 0 }, "maxSelections": { "type": [ "null", "integer" ], "format": "int32" }, "order": { "type": "integer", "format": "int32", "default": 0 }, "status": { "enum": [ "active", "inactive" ], "type": "string", "default": "active" }, "options": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ModifierOptionModel" } } } }, "ModifierGroupStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "ModifierOptionDto": { "required": [ "id", "name", "priceDelta", "isDefault", "order", "status" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "name": { "type": "string" }, "priceDelta": { "type": "number", "format": "double" }, "isDefault": { "type": "boolean" }, "imageUrl": { "type": [ "null", "string" ] }, "order": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ModifierGroupStatus" } } }, "ModifierOptionModel": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "priceDelta": { "type": "number", "format": "double", "default": 0 }, "isDefault": { "type": "boolean", "default": false }, "imageUrl": { "type": [ "null", "string" ] }, "order": { "type": "integer", "format": "int32", "default": 0 }, "status": { "enum": [ "active", "inactive" ], "type": "string", "default": "active" } } }, "ModifierSelectionType": { "enum": [ "single", "multiple" ], "type": "string" }, "NotificationChannel": { "enum": [ "email", "sms", "push", "whatsApp", "inApp", "webhook" ], "type": "string" }, "OperationStatus": { "enum": [ "pending", "running", "completed", "failed", "cancelled" ], "type": "string" }, "OptionDefinitionModel": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "key": { "type": [ "null", "string" ] }, "values": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "OrderAttribution": { "type": "object", "properties": { "campaignId": { "type": [ "null", "string" ] }, "utmSource": { "type": [ "null", "string" ] }, "utmMedium": { "type": [ "null", "string" ] }, "utmCampaign": { "type": [ "null", "string" ] }, "referralCode": { "type": [ "null", "string" ] } } }, "OrderBumpDto": { "required": [ "id", "storeId", "name", "description", "status", "productId", "variantId", "offerPrice", "minimumCartSubtotal", "priority", "maxPerCart", "startsAt", "endsAt", "badgeLabel", "callToAction", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "status": { "$ref": "#/components/schemas/OrderBumpStatus" }, "productId": { "type": "string" }, "variantId": { "type": "string" }, "offerPrice": { "type": [ "null", "number" ], "format": "double" }, "minimumCartSubtotal": { "type": [ "null", "number" ], "format": "double" }, "priority": { "type": "integer", "format": "int32" }, "maxPerCart": { "type": "integer", "format": "int32" }, "startsAt": { "type": [ "null", "string" ], "format": "date-time" }, "endsAt": { "type": [ "null", "string" ], "format": "date-time" }, "badgeLabel": { "type": [ "null", "string" ] }, "callToAction": { "type": [ "null", "string" ] }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "OrderBumpStatus": { "enum": [ "draft", "active", "paused" ], "type": "string" }, "OrderBumpUpsertRequest": { "required": [ "name", "description", "status", "productId", "variantId", "offerPrice", "minimumCartSubtotal", "priority", "maxPerCart", "startsAt", "endsAt", "badgeLabel", "callToAction" ], "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "status": { "$ref": "#/components/schemas/OrderBumpStatus" }, "productId": { "type": "string" }, "variantId": { "type": "string" }, "offerPrice": { "type": [ "null", "number" ], "format": "double" }, "minimumCartSubtotal": { "type": [ "null", "number" ], "format": "double" }, "priority": { "type": "integer", "format": "int32" }, "maxPerCart": { "type": "integer", "format": "int32" }, "startsAt": { "type": [ "null", "string" ], "format": "date-time" }, "endsAt": { "type": [ "null", "string" ], "format": "date-time" }, "badgeLabel": { "type": [ "null", "string" ] }, "callToAction": { "type": [ "null", "string" ] } } }, "OrderCancelRequest": { "required": [ "cancelReason", "cancelReasonType" ], "type": "object", "properties": { "cancelReason": { "type": [ "null", "string" ] }, "cancelReasonType": { "type": [ "null", "string" ] } } }, "OrderClaimDetailsDto": { "required": [ "id", "storeId", "orderId", "orderNumber", "customerId", "claimNumber", "type", "status", "subject", "description", "contactEmail", "contactPhone", "resolution", "resolvedAt", "trackings", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "orderId": { "type": "string" }, "orderNumber": { "type": "string" }, "customerId": { "type": [ "null", "string" ] }, "claimNumber": { "type": "string" }, "type": { "$ref": "#/components/schemas/OrderClaimType" }, "status": { "$ref": "#/components/schemas/OrderClaimStatus" }, "subject": { "type": "string" }, "description": { "type": "string" }, "contactEmail": { "type": [ "null", "string" ] }, "contactPhone": { "type": [ "null", "string" ] }, "resolution": { "type": [ "null", "string" ] }, "resolvedAt": { "type": [ "null", "string" ], "format": "date-time" }, "trackings": { "type": "array", "items": { "$ref": "#/components/schemas/OrderClaimTrackingDto" } }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "OrderClaimListItemDto": { "required": [ "id", "orderId", "orderNumber", "customerId", "claimNumber", "type", "status", "subject", "contactEmail", "contactPhone", "resolvedAt", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "orderId": { "type": "string" }, "orderNumber": { "type": "string" }, "customerId": { "type": [ "null", "string" ] }, "claimNumber": { "type": "string" }, "type": { "$ref": "#/components/schemas/OrderClaimType" }, "status": { "$ref": "#/components/schemas/OrderClaimStatus" }, "subject": { "type": "string" }, "contactEmail": { "type": [ "null", "string" ] }, "contactPhone": { "type": [ "null", "string" ] }, "resolvedAt": { "type": [ "null", "string" ], "format": "date-time" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "OrderClaimNoteRequest": { "required": [ "note" ], "type": "object", "properties": { "note": { "type": "string" } } }, "OrderClaimStatus": { "enum": [ "open", "inReview", "resolved", "rejected", "closed", "cancelled" ], "type": "string" }, "OrderClaimTrackingDto": { "required": [ "id", "type", "title", "content", "userId", "email", "ip", "createdOn", "createdBy" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "type": { "$ref": "#/components/schemas/OrderClaimTrackingType" }, "title": { "type": "string" }, "content": { "type": "string" }, "userId": { "type": [ "null", "string" ], "format": "uuid" }, "email": { "type": [ "null", "string" ] }, "ip": { "type": [ "null", "string" ] }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "createdBy": { "type": [ "null", "string" ], "format": "uuid" } } }, "OrderClaimTrackingType": { "enum": [ "created", "statusChanged", "note" ], "type": "string" }, "OrderClaimType": { "enum": [ "claim", "complaint", "return", "refund", "other" ], "type": "string" }, "OrderCommentRequest": { "required": [ "comment" ], "type": "object", "properties": { "comment": { "type": [ "null", "string" ] } } }, "OrderCustomStatusRequest": { "required": [ "status", "comment" ], "type": "object", "properties": { "status": { "type": "string" }, "comment": { "type": [ "null", "string" ] } } }, "OrderDetailsDto": { "required": [ "id", "storeId", "cartId", "customerId", "orderNumber", "orderShortId", "couponCode", "source", "sourceIdentifier", "orderGroup", "notes", "phone", "email", "firstName", "lastName", "identificationType", "identificationNumber", "entityTaxId", "entityName", "promotion", "shippingPromotion", "totalSkus", "shippingConnectionId", "orderDate", "preOrderDate", "confirmedAt", "inProgressAt", "paymentAt", "shippingAt", "closedAt", "cancelledAt", "completedAt", "conciliationAt", "invoicedAt", "inTransitAt", "pickupAt", "returnedAt", "invalidAt", "status", "state", "fulfillmentStatus", "returnStatus", "shippingType", "invoiceType", "sellerId", "tags", "integrationTags", "createdNotified", "confirmedNotified", "invoicedNotified", "readyToPickUpNotified", "inTransitNotified", "deliveredNotified", "cancelledNotified", "cancelReason", "cancelReasonType", "currencyCode", "subTotal", "discount", "shipping", "extraShippingCost", "tax", "warranty", "total", "userAssigned", "attachments", "invoiceNumber", "invoiceLink", "isSplitSellerItem", "hasRefund", "hasTrackingNumber", "billingAddress", "shippingAddress", "attribution", "instructions", "items", "shippingMethods", "payments", "trackings", "packageItems", "transactions", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "cartId": { "type": "string" }, "customerId": { "type": [ "null", "string" ] }, "orderNumber": { "type": "string" }, "orderShortId": { "type": [ "null", "integer" ], "format": "int32" }, "couponCode": { "type": [ "null", "string" ] }, "source": { "type": [ "null", "string" ] }, "sourceIdentifier": { "type": [ "null", "string" ] }, "orderGroup": { "type": [ "null", "string" ] }, "notes": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] }, "identificationType": { "type": [ "null", "string" ] }, "identificationNumber": { "type": [ "null", "string" ] }, "entityTaxId": { "type": [ "null", "string" ] }, "entityName": { "type": [ "null", "string" ] }, "promotion": { "type": [ "null", "string" ] }, "shippingPromotion": { "type": [ "null", "string" ] }, "totalSkus": { "type": "integer", "format": "int32" }, "shippingConnectionId": { "type": [ "null", "string" ] }, "orderDate": { "type": "string", "format": "date-time" }, "preOrderDate": { "type": [ "null", "string" ], "format": "date-time" }, "confirmedAt": { "type": [ "null", "string" ], "format": "date-time" }, "inProgressAt": { "type": [ "null", "string" ], "format": "date-time" }, "paymentAt": { "type": [ "null", "string" ], "format": "date-time" }, "shippingAt": { "type": [ "null", "string" ], "format": "date-time" }, "closedAt": { "type": [ "null", "string" ], "format": "date-time" }, "cancelledAt": { "type": [ "null", "string" ], "format": "date-time" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time" }, "conciliationAt": { "type": [ "null", "string" ], "format": "date-time" }, "invoicedAt": { "type": [ "null", "string" ], "format": "date-time" }, "inTransitAt": { "type": [ "null", "string" ], "format": "date-time" }, "pickupAt": { "type": [ "null", "string" ], "format": "date-time" }, "returnedAt": { "type": [ "null", "string" ], "format": "date-time" }, "invalidAt": { "type": [ "null", "string" ], "format": "date-time" }, "status": { "$ref": "#/components/schemas/OrderStatus" }, "state": { "$ref": "#/components/schemas/OrderState" }, "fulfillmentStatus": { "$ref": "#/components/schemas/OrderFulfillmentStatus" }, "returnStatus": { "$ref": "#/components/schemas/OrderReturnStatus" }, "shippingType": { "type": [ "null", "string" ] }, "invoiceType": { "$ref": "#/components/schemas/OrderInvoiceType" }, "sellerId": { "type": [ "null", "string" ] }, "tags": { "type": [ "null", "string" ] }, "integrationTags": { "type": [ "null", "string" ] }, "createdNotified": { "type": "boolean" }, "confirmedNotified": { "type": "boolean" }, "invoicedNotified": { "type": "boolean" }, "readyToPickUpNotified": { "type": "boolean" }, "inTransitNotified": { "type": "boolean" }, "deliveredNotified": { "type": "boolean" }, "cancelledNotified": { "type": "boolean" }, "cancelReason": { "type": [ "null", "string" ] }, "cancelReasonType": { "type": [ "null", "string" ] }, "currencyCode": { "type": "string", "description": "ISO 4217 currency code, for example `PEN`." }, "subTotal": { "type": "number", "format": "double" }, "discount": { "type": "number", "format": "double" }, "shipping": { "type": "number", "format": "double" }, "extraShippingCost": { "type": "number", "format": "double" }, "tax": { "type": "number", "format": "double" }, "warranty": { "type": "number", "format": "double" }, "total": { "type": "number", "format": "double" }, "userAssigned": { "type": [ "null", "string" ] }, "attachments": { "type": [ "null", "string" ] }, "invoiceNumber": { "type": [ "null", "string" ] }, "invoiceLink": { "type": [ "null", "string" ] }, "isSplitSellerItem": { "type": "boolean" }, "hasRefund": { "type": "boolean" }, "hasTrackingNumber": { "type": "boolean" }, "billingAddress": { "$ref": "#/components/schemas/Address" }, "shippingAddress": { "$ref": "#/components/schemas/Address" }, "attribution": { "$ref": "#/components/schemas/OrderAttribution" }, "instructions": { "$ref": "#/components/schemas/OrderInstructions" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/OrderItemDetailsDto" } }, "shippingMethods": { "type": "array", "items": { "$ref": "#/components/schemas/OrderShippingMethodDto" } }, "payments": { "type": "array", "items": { "$ref": "#/components/schemas/OrderPaymentDto" } }, "trackings": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTrackingDto" } }, "packageItems": { "type": "array", "items": { "$ref": "#/components/schemas/OrderPackageItemDto" } }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/OrderTransactionDto" } }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "OrderDraftAddressRequest": { "required": [ "name", "address1", "city", "countryCode", "company", "address2", "province", "postalCode", "district", "phone", "latitude", "longitude", "metadata" ], "type": "object", "properties": { "name": { "type": "string" }, "address1": { "type": "string" }, "city": { "type": "string" }, "countryCode": { "type": "string", "description": "ISO 3166-1 alpha-2 country code, for example `PE`." }, "company": { "type": [ "null", "string" ] }, "address2": { "type": [ "null", "string" ] }, "province": { "type": [ "null", "string" ] }, "postalCode": { "type": [ "null", "string" ] }, "district": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "latitude": { "type": [ "null", "number" ], "format": "double" }, "longitude": { "type": [ "null", "number" ], "format": "double" }, "metadata": { "type": [ "null", "object" ] } } }, "OrderDraftConversionDto": { "required": [ "orderId", "orderGroup", "orderIds", "order" ], "type": "object", "properties": { "orderId": { "type": "string" }, "orderGroup": { "type": "string" }, "orderIds": { "type": "array" }, "order": { "$ref": "#/components/schemas/OrderDetailsDto" } } }, "OrderDraftDetailsDto": { "required": [ "id", "storeId", "customerId", "cartId", "draftNumber", "currencyCode", "source", "notes", "email", "phone", "firstName", "lastName", "identificationType", "identificationNumber", "entityTaxId", "entityName", "status", "draftDate", "sentAt", "viewedAt", "acceptedAt", "rejectedAt", "expiredAt", "cancelledAt", "convertedAt", "shareToken", "shareExpiresAt", "allowAnonymousShareAccess", "sharedAt", "billingAddress", "shippingAddress", "metadata", "subTotal", "discount", "shipping", "tax", "warranty", "total", "paymentMethod", "paymentCode", "items", "shippingMethods", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "customerId": { "type": [ "null", "string" ] }, "cartId": { "type": [ "null", "string" ] }, "draftNumber": { "type": "string" }, "currencyCode": { "type": "string", "description": "ISO 4217 currency code, for example `PEN`." }, "source": { "type": [ "null", "string" ] }, "notes": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] }, "identificationType": { "type": [ "null", "string" ] }, "identificationNumber": { "type": [ "null", "string" ] }, "entityTaxId": { "type": [ "null", "string" ] }, "entityName": { "type": [ "null", "string" ] }, "status": { "$ref": "#/components/schemas/OrderDraftStatus" }, "draftDate": { "type": "string", "format": "date-time" }, "sentAt": { "type": [ "null", "string" ], "format": "date-time" }, "viewedAt": { "type": [ "null", "string" ], "format": "date-time" }, "acceptedAt": { "type": [ "null", "string" ], "format": "date-time" }, "rejectedAt": { "type": [ "null", "string" ], "format": "date-time" }, "expiredAt": { "type": [ "null", "string" ], "format": "date-time" }, "cancelledAt": { "type": [ "null", "string" ], "format": "date-time" }, "convertedAt": { "type": [ "null", "string" ], "format": "date-time" }, "shareToken": { "type": [ "null", "string" ] }, "shareExpiresAt": { "type": [ "null", "string" ], "format": "date-time" }, "allowAnonymousShareAccess": { "type": "boolean" }, "sharedAt": { "type": [ "null", "string" ], "format": "date-time" }, "billingAddress": { "$ref": "#/components/schemas/Address" }, "shippingAddress": { "$ref": "#/components/schemas/Address" }, "metadata": { "type": "object" }, "subTotal": { "type": "number", "format": "double" }, "discount": { "type": "number", "format": "double" }, "shipping": { "type": "number", "format": "double" }, "tax": { "type": "number", "format": "double" }, "warranty": { "type": "number", "format": "double" }, "total": { "type": "number", "format": "double" }, "paymentMethod": { "type": "string" }, "paymentCode": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/OrderDraftItemDto" } }, "shippingMethods": { "type": "array", "items": { "$ref": "#/components/schemas/OrderDraftShippingMethodDto" } }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "OrderDraftItemDto": { "required": [ "id", "productId", "sellerId", "shippingProfileId", "variantId", "title", "subtitle", "thumbnail", "quantity", "unitPrice", "subTotal", "discount", "shipping", "tax", "warranty", "total", "requiresShipping", "isTaxInclusive", "metadata" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "productId": { "type": [ "null", "string" ] }, "sellerId": { "type": [ "null", "string" ] }, "shippingProfileId": { "type": [ "null", "string" ] }, "variantId": { "type": [ "null", "string" ] }, "title": { "type": "string" }, "subtitle": { "type": [ "null", "string" ] }, "thumbnail": { "type": [ "null", "string" ] }, "quantity": { "type": "integer", "format": "int32" }, "unitPrice": { "type": "number", "format": "double" }, "subTotal": { "type": "number", "format": "double" }, "discount": { "type": "number", "format": "double" }, "shipping": { "type": "number", "format": "double" }, "tax": { "type": "number", "format": "double" }, "warranty": { "type": "number", "format": "double" }, "total": { "type": "number", "format": "double" }, "requiresShipping": { "type": "boolean" }, "isTaxInclusive": { "type": "boolean" }, "metadata": { "type": "object" } } }, "OrderDraftListItemDto": { "required": [ "id", "storeId", "customerId", "cartId", "draftNumber", "currencyCode", "source", "email", "phone", "firstName", "lastName", "entityName", "status", "draftDate", "sentAt", "acceptedAt", "expiredAt", "cancelledAt", "convertedAt", "shareToken", "shareExpiresAt", "allowAnonymousShareAccess", "sharedAt", "total", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "customerId": { "type": [ "null", "string" ] }, "cartId": { "type": [ "null", "string" ] }, "draftNumber": { "type": "string" }, "currencyCode": { "type": "string", "description": "ISO 4217 currency code, for example `PEN`." }, "source": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] }, "entityName": { "type": [ "null", "string" ] }, "status": { "$ref": "#/components/schemas/OrderDraftStatus" }, "draftDate": { "type": "string", "format": "date-time" }, "sentAt": { "type": [ "null", "string" ], "format": "date-time" }, "acceptedAt": { "type": [ "null", "string" ], "format": "date-time" }, "expiredAt": { "type": [ "null", "string" ], "format": "date-time" }, "cancelledAt": { "type": [ "null", "string" ], "format": "date-time" }, "convertedAt": { "type": [ "null", "string" ], "format": "date-time" }, "shareToken": { "type": [ "null", "string" ] }, "shareExpiresAt": { "type": [ "null", "string" ], "format": "date-time" }, "allowAnonymousShareAccess": { "type": "boolean" }, "sharedAt": { "type": [ "null", "string" ], "format": "date-time" }, "total": { "type": "number", "format": "double" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "OrderDraftShareDto": { "required": [ "shareToken", "shareExpiresAt", "allowAnonymousShareAccess", "sharePath" ], "type": "object", "properties": { "shareToken": { "type": "string" }, "shareExpiresAt": { "type": [ "null", "string" ], "format": "date-time" }, "allowAnonymousShareAccess": { "type": "boolean" }, "sharePath": { "type": "string" } } }, "OrderDraftShippingMethodDto": { "required": [ "id", "name", "description", "subtotal", "discountTotal", "taxTotal", "total", "isTaxInclusive", "sellerId", "shippingProfileId", "shippingMethodId", "connectionId", "providerName", "trackingCode", "estimatedDays", "zoneCode", "locationId", "pickupPointId", "scheduledDate", "scheduledTime", "data" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "subtotal": { "type": "number", "format": "double" }, "discountTotal": { "type": "number", "format": "double" }, "taxTotal": { "type": "number", "format": "double" }, "total": { "type": "number", "format": "double" }, "isTaxInclusive": { "type": "boolean" }, "sellerId": { "type": [ "null", "string" ] }, "shippingProfileId": { "type": [ "null", "string" ] }, "shippingMethodId": { "type": [ "null", "string" ] }, "connectionId": { "type": [ "null", "string" ] }, "providerName": { "type": [ "null", "string" ] }, "trackingCode": { "type": [ "null", "string" ] }, "estimatedDays": { "type": [ "null", "integer" ], "format": "int32" }, "zoneCode": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ] }, "pickupPointId": { "type": [ "null", "string" ] }, "scheduledDate": { "type": [ "null", "string" ], "format": "date" }, "scheduledTime": { "type": [ "null", "string" ], "format": "time" }, "data": { "type": "object" } } }, "OrderDraftStatus": { "enum": [ "draft", "sent", "viewed", "accepted", "rejected", "expired", "converted", "cancelled" ], "type": "string" }, "OrderDraftStatusRequest": { "required": [ "status" ], "type": "object", "properties": { "status": { "$ref": "#/components/schemas/OrderDraftStatus" } } }, "OrderExportRequest": { "type": "object", "properties": { "format": { "type": "string" }, "search": { "type": [ "null", "string" ], "description": "Free-text filter. Which fields it covers depends on the resource." }, "status": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrderStatus" } ] }, "state": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrderState" } ] }, "fulfillmentStatus": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrderFulfillmentStatus" } ] }, "returnStatus": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrderReturnStatus" } ] }, "locationId": { "type": [ "null", "string" ] }, "customerId": { "type": [ "null", "string" ] }, "conciliated": { "type": [ "null", "boolean" ] }, "dateFrom": { "type": [ "null", "string" ], "format": "date-time" }, "dateTo": { "type": [ "null", "string" ], "format": "date-time" }, "orderIds": { "type": [ "null", "array" ] }, "orderNumbers": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "OrderFulfillmentStatus": { "enum": [ "unfulfilled", "hold", "scheduled", "picking", "ready", "shipped", "delivered", "partial", "canceled" ], "type": "string" }, "OrderGroupDetailsDto": { "required": [ "orderId", "orderNumber", "orderGroup", "orderIds", "status", "total", "currencyCode", "createdOn", "updatedOn", "orders" ], "type": "object", "properties": { "orderId": { "type": "string" }, "orderNumber": { "type": "string" }, "orderGroup": { "type": "string" }, "orderIds": { "type": "array" }, "status": { "type": "string" }, "total": { "type": "number", "format": "double" }, "currencyCode": { "type": "string", "description": "ISO 4217 currency code, for example `PEN`." }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." }, "orders": { "type": "array", "items": { "$ref": "#/components/schemas/OrderDetailsDto" } } } }, "OrderInstructions": { "type": "object", "properties": { "giftMessage": { "type": [ "null", "string" ] }, "specialInstructions": { "type": [ "null", "string" ] } } }, "OrderInvoiceRequest": { "required": [ "invoiceNumber", "invoiceLink", "comment" ], "type": "object", "properties": { "invoiceNumber": { "type": [ "null", "string" ] }, "invoiceLink": { "type": [ "null", "string" ] }, "comment": { "type": [ "null", "string" ] } } }, "OrderInvoiceType": { "enum": [ "ticket", "invoice" ], "type": "string" }, "OrderItemCommissionSource": { "enum": [ "seller", "category", "brand" ], "type": [ "null", "string" ] }, "OrderItemDetailsDto": { "required": [ "id", "externalItemId", "productId", "categoryId", "brandId", "sellerId", "shippingProfileId", "variantId", "skuId", "sku", "locationId", "title", "subtitle", "thumbnail", "productTitle", "productDescription", "productType", "productTypeId", "productCollection", "productHandle", "variantSku", "variantBarcode", "variantTitle", "variantOptionValues", "brand", "category", "height", "length", "width", "weight", "qty", "qtyRemaining", "qtyToDispatch", "qtyDispatched", "qtyDelivered", "qtyRefunded", "qtyReturned", "unitPrice", "subTotal", "discount", "shipping", "tax", "warranty", "total", "sellerCommissionId", "commissionSource", "productCommissionPercent", "freightCommissionPercent", "fixedFee", "commissionBaseAmount", "productCommissionAmount", "freightCommissionBaseAmount", "freightCommissionAmount", "commissionAmount", "requiresShipping", "isDiscountable", "isGiftcard", "isTaxInclusive", "isCustomPrice", "shippingConnectionId", "shippingProviderName", "shippingCostId", "shippingCostName", "invoiceNumber", "invoiceLink", "trackingNumber", "trackingLink", "orderItemStatus", "inProgressAt", "paymentAt", "shippingAt", "closedAt", "cancelledAt", "completedAt", "conciliationAt", "invoicedAt", "inTransitAt", "pickupAt", "returnedAt", "deliveredAt", "modifiers", "metadata", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "externalItemId": { "type": [ "null", "string" ] }, "productId": { "type": [ "null", "string" ] }, "categoryId": { "type": [ "null", "string" ] }, "brandId": { "type": [ "null", "string" ] }, "sellerId": { "type": [ "null", "string" ] }, "shippingProfileId": { "type": [ "null", "string" ] }, "variantId": { "type": [ "null", "string" ] }, "skuId": { "type": [ "null", "string" ] }, "sku": { "type": [ "null", "string" ], "description": "Stock keeping unit (SKU)." }, "locationId": { "type": [ "null", "string" ] }, "title": { "type": "string" }, "subtitle": { "type": [ "null", "string" ] }, "thumbnail": { "type": [ "null", "string" ] }, "productTitle": { "type": [ "null", "string" ] }, "productDescription": { "type": [ "null", "string" ] }, "productType": { "type": [ "null", "string" ] }, "productTypeId": { "type": [ "null", "string" ] }, "productCollection": { "type": [ "null", "string" ] }, "productHandle": { "type": [ "null", "string" ] }, "variantSku": { "type": [ "null", "string" ] }, "variantBarcode": { "type": [ "null", "string" ] }, "variantTitle": { "type": [ "null", "string" ] }, "variantOptionValues": { "type": "object" }, "brand": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "height": { "type": "number", "format": "double" }, "length": { "type": "number", "format": "double" }, "width": { "type": "number", "format": "double" }, "weight": { "type": "number", "format": "double" }, "qty": { "type": "number", "format": "double" }, "qtyRemaining": { "type": "number", "format": "double" }, "qtyToDispatch": { "type": "number", "format": "double" }, "qtyDispatched": { "type": "number", "format": "double" }, "qtyDelivered": { "type": "number", "format": "double" }, "qtyRefunded": { "type": "number", "format": "double" }, "qtyReturned": { "type": "number", "format": "double" }, "unitPrice": { "type": "number", "format": "double" }, "subTotal": { "type": "number", "format": "double" }, "discount": { "type": "number", "format": "double" }, "shipping": { "type": "number", "format": "double" }, "tax": { "type": "number", "format": "double" }, "warranty": { "type": "number", "format": "double" }, "total": { "type": "number", "format": "double" }, "sellerCommissionId": { "type": [ "null", "string" ] }, "commissionSource": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrderItemCommissionSource" } ] }, "productCommissionPercent": { "type": [ "null", "number" ], "format": "double" }, "freightCommissionPercent": { "type": [ "null", "number" ], "format": "double" }, "fixedFee": { "type": [ "null", "number" ], "format": "double" }, "commissionBaseAmount": { "type": "number", "format": "double" }, "productCommissionAmount": { "type": "number", "format": "double" }, "freightCommissionBaseAmount": { "type": "number", "format": "double" }, "freightCommissionAmount": { "type": "number", "format": "double" }, "commissionAmount": { "type": "number", "format": "double" }, "requiresShipping": { "type": "boolean" }, "isDiscountable": { "type": "boolean" }, "isGiftcard": { "type": "boolean" }, "isTaxInclusive": { "type": "boolean" }, "isCustomPrice": { "type": "boolean" }, "shippingConnectionId": { "type": [ "null", "string" ] }, "shippingProviderName": { "type": [ "null", "string" ] }, "shippingCostId": { "type": [ "null", "string" ] }, "shippingCostName": { "type": [ "null", "string" ] }, "invoiceNumber": { "type": [ "null", "string" ] }, "invoiceLink": { "type": [ "null", "string" ] }, "trackingNumber": { "type": [ "null", "string" ] }, "trackingLink": { "type": [ "null", "string" ] }, "orderItemStatus": { "$ref": "#/components/schemas/OrderStatus" }, "inProgressAt": { "type": [ "null", "string" ], "format": "date-time" }, "paymentAt": { "type": [ "null", "string" ], "format": "date-time" }, "shippingAt": { "type": [ "null", "string" ], "format": "date-time" }, "closedAt": { "type": [ "null", "string" ], "format": "date-time" }, "cancelledAt": { "type": [ "null", "string" ], "format": "date-time" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time" }, "conciliationAt": { "type": [ "null", "string" ], "format": "date-time" }, "invoicedAt": { "type": [ "null", "string" ], "format": "date-time" }, "inTransitAt": { "type": [ "null", "string" ], "format": "date-time" }, "pickupAt": { "type": [ "null", "string" ], "format": "date-time" }, "returnedAt": { "type": [ "null", "string" ], "format": "date-time" }, "deliveredAt": { "type": [ "null", "string" ], "format": "date-time" }, "modifiers": { "type": "array", "items": { "$ref": "#/components/schemas/OrderItemModifierDto" } }, "metadata": { "type": "object" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "OrderItemListItemDto": { "required": [ "id", "orderId", "storeId", "customerId", "orderNumber", "orderShortId", "orderGroup", "source", "email", "phone", "firstName", "lastName", "entityName", "orderStatus", "state", "fulfillmentStatus", "returnStatus", "orderDate", "currencyCode", "productId", "variantId", "skuId", "sku", "title", "subtitle", "thumbnail", "variantTitle", "brand", "category", "quantity", "qtyToDispatch", "qtyDispatched", "qtyDelivered", "qtyReturned", "total", "invoiceNumber", "invoiceLink", "trackingNumber", "trackingLink", "itemStatus", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "orderId": { "type": "string" }, "storeId": { "type": "string" }, "customerId": { "type": [ "null", "string" ] }, "orderNumber": { "type": "string" }, "orderShortId": { "type": "integer", "format": "int32" }, "orderGroup": { "type": [ "null", "string" ] }, "source": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] }, "entityName": { "type": [ "null", "string" ] }, "orderStatus": { "$ref": "#/components/schemas/OrderStatus" }, "state": { "$ref": "#/components/schemas/OrderState" }, "fulfillmentStatus": { "$ref": "#/components/schemas/OrderFulfillmentStatus" }, "returnStatus": { "$ref": "#/components/schemas/OrderReturnStatus" }, "orderDate": { "type": "string", "format": "date-time" }, "currencyCode": { "type": "string", "description": "ISO 4217 currency code, for example `PEN`." }, "productId": { "type": [ "null", "string" ] }, "variantId": { "type": [ "null", "string" ] }, "skuId": { "type": [ "null", "string" ] }, "sku": { "type": [ "null", "string" ], "description": "Stock keeping unit (SKU)." }, "title": { "type": "string" }, "subtitle": { "type": [ "null", "string" ] }, "thumbnail": { "type": [ "null", "string" ] }, "variantTitle": { "type": [ "null", "string" ] }, "brand": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] }, "quantity": { "type": "number", "format": "double" }, "qtyToDispatch": { "type": "number", "format": "double" }, "qtyDispatched": { "type": "number", "format": "double" }, "qtyDelivered": { "type": "number", "format": "double" }, "qtyReturned": { "type": "number", "format": "double" }, "total": { "type": "number", "format": "double" }, "invoiceNumber": { "type": [ "null", "string" ] }, "invoiceLink": { "type": [ "null", "string" ] }, "trackingNumber": { "type": [ "null", "string" ] }, "trackingLink": { "type": [ "null", "string" ] }, "itemStatus": { "$ref": "#/components/schemas/OrderStatus" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "OrderItemModifierDto": { "required": [ "id", "modifierGroupId", "modifierGroupName", "modifierOptionId", "modifierOptionName", "priceDelta" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "modifierGroupId": { "type": "string" }, "modifierGroupName": { "type": "string" }, "modifierOptionId": { "type": "string" }, "modifierOptionName": { "type": "string" }, "priceDelta": { "type": "number", "format": "double" } } }, "OrderItemReturnRequest": { "required": [ "quantity", "trackingNumber", "trackingLink", "comment", "evidenceUrls" ], "type": "object", "properties": { "quantity": { "type": [ "null", "number" ], "format": "double" }, "trackingNumber": { "type": [ "null", "string" ] }, "trackingLink": { "type": [ "null", "string" ] }, "comment": { "type": [ "null", "string" ] }, "evidenceUrls": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "OrderItemSpreadsheetSaveRequest": { "type": "object", "properties": { "rows": { "type": "array", "items": { "$ref": "#/components/schemas/OrderItemSpreadsheetSaveRowRequest" } } } }, "OrderItemSpreadsheetSaveRowRequest": { "type": "object", "properties": { "orderId": { "type": "string" }, "itemId": { "type": "string" }, "targetStatus": { "type": [ "null", "string" ] }, "invoiceChanged": { "type": "boolean" }, "trackingChanged": { "type": "boolean" }, "invoice": { "$ref": "#/components/schemas/OrderInvoiceRequest" }, "tracking": { "$ref": "#/components/schemas/OrderTrackingRequest" } } }, "OrderItemTrackingRequest": { "required": [ "quantity", "trackingNumber", "trackingLink" ], "type": "object", "properties": { "quantity": { "type": [ "null", "number" ], "format": "double" }, "trackingNumber": { "type": [ "null", "string" ] }, "trackingLink": { "type": [ "null", "string" ] }, "carrierName": { "type": [ "null", "string" ] } } }, "OrderListItemDto": { "required": [ "id", "storeId", "cartId", "customerId", "orderNumber", "orderShortId", "orderGroup", "source", "email", "phone", "firstName", "lastName", "entityName", "userAssigned", "status", "state", "fulfillmentStatus", "returnStatus", "orderDate", "paymentAt", "completedAt", "cancelledAt", "conciliationAt", "currencyCode", "totalSkus", "total", "hasRefund", "hasTrackingNumber", "invoiceNumber", "invoiceLink", "trackingNumber", "trackingLink", "previewItemTitle", "previewItemThumbnail", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "cartId": { "type": "string" }, "customerId": { "type": [ "null", "string" ] }, "orderNumber": { "type": "string" }, "orderShortId": { "type": "integer", "format": "int32" }, "orderGroup": { "type": [ "null", "string" ] }, "source": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] }, "entityName": { "type": [ "null", "string" ] }, "userAssigned": { "type": [ "null", "string" ] }, "status": { "$ref": "#/components/schemas/OrderStatus" }, "state": { "$ref": "#/components/schemas/OrderState" }, "fulfillmentStatus": { "$ref": "#/components/schemas/OrderFulfillmentStatus" }, "returnStatus": { "$ref": "#/components/schemas/OrderReturnStatus" }, "orderDate": { "type": "string", "format": "date-time" }, "paymentAt": { "type": [ "null", "string" ], "format": "date-time" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time" }, "cancelledAt": { "type": [ "null", "string" ], "format": "date-time" }, "conciliationAt": { "type": [ "null", "string" ], "format": "date-time" }, "currencyCode": { "type": "string", "description": "ISO 4217 currency code, for example `PEN`." }, "totalSkus": { "type": "integer", "format": "int32" }, "total": { "type": "number", "format": "double" }, "hasRefund": { "type": "boolean" }, "hasTrackingNumber": { "type": "boolean" }, "invoiceNumber": { "type": [ "null", "string" ] }, "invoiceLink": { "type": [ "null", "string" ] }, "trackingNumber": { "type": [ "null", "string" ] }, "trackingLink": { "type": [ "null", "string" ] }, "previewItemTitle": { "type": [ "null", "string" ] }, "previewItemThumbnail": { "type": [ "null", "string" ] }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "OrderNotesRequest": { "required": [ "notes", "userAssigned" ], "type": "object", "properties": { "notes": { "type": [ "null", "string" ] }, "userAssigned": { "type": [ "null", "string" ] } } }, "OrderPackageItemDto": { "required": [ "id", "carrierId", "carrierName", "trackingNumber", "trackingLink", "skuId", "packages", "weight", "qty", "serviceType", "serviceCost", "from", "to", "partialTracking", "invoiceNumber", "packageType", "packageStatus", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "carrierId": { "type": [ "null", "string" ] }, "carrierName": { "type": [ "null", "string" ] }, "trackingNumber": { "type": [ "null", "string" ] }, "trackingLink": { "type": [ "null", "string" ] }, "skuId": { "type": "string" }, "packages": { "type": "number", "format": "double" }, "weight": { "type": "number", "format": "double" }, "qty": { "type": "number", "format": "double" }, "serviceType": { "type": [ "null", "string" ] }, "serviceCost": { "type": "number", "format": "double" }, "from": { "type": [ "null", "string" ] }, "to": { "type": [ "null", "string" ] }, "partialTracking": { "type": "boolean" }, "invoiceNumber": { "type": [ "null", "string" ] }, "packageType": { "$ref": "#/components/schemas/OrderPackageType" }, "packageStatus": { "$ref": "#/components/schemas/OrderPackageStatus" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "OrderPackageState": { "enum": [ "inTransit", "delivered" ], "type": "string" }, "OrderPackageStatus": { "enum": [ "readyToPickUp", "inTransit", "delivered", "returned" ], "type": "string" }, "OrderPackageType": { "enum": [ "delivery", "return" ], "type": "string" }, "OrderPaymentDto": { "required": [ "id", "paymentMethod", "paymentCode", "amount", "cardNumber", "cardType", "installments", "authorizationCode", "transactionReference", "providerId", "paymentTransactionId", "paymentStatus", "receiptUrl", "metadata" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "paymentMethod": { "type": "string" }, "paymentCode": { "type": "string" }, "amount": { "type": "number", "format": "double" }, "cardNumber": { "type": [ "null", "string" ] }, "cardType": { "type": [ "null", "string" ] }, "installments": { "type": [ "null", "integer" ], "format": "int32" }, "authorizationCode": { "type": [ "null", "string" ] }, "transactionReference": { "type": [ "null", "string" ] }, "providerId": { "type": [ "null", "string" ] }, "paymentTransactionId": { "type": [ "null", "string" ] }, "paymentStatus": { "type": [ "null", "string" ] }, "receiptUrl": { "type": [ "null", "string" ] }, "metadata": { "type": "object" } } }, "OrderPaymentResultModel": { "required": [ "transactionId", "status", "isCaptured", "paymentMethodCode", "code", "cardType", "amount", "reference", "providerId", "publicConfiguration", "clientSecret", "checkoutUrl", "checkoutHtml", "qrCode", "receiptUrl", "expiresAt" ], "type": "object", "properties": { "transactionId": { "type": "string" }, "status": { "$ref": "#/components/schemas/OrderPaymentStatus" }, "isCaptured": { "type": "boolean" }, "paymentMethodCode": { "type": "string" }, "code": { "type": "string" }, "cardType": { "type": [ "null", "string" ] }, "amount": { "type": "number", "format": "double" }, "reference": { "type": "string" }, "providerId": { "type": [ "null", "string" ] }, "publicConfiguration": { "type": "object", "additionalProperties": { "type": "string" } }, "clientSecret": { "type": [ "null", "string" ] }, "checkoutUrl": { "type": [ "null", "string" ] }, "checkoutHtml": { "type": [ "null", "string" ] }, "qrCode": { "type": [ "null", "string" ] }, "receiptUrl": { "type": [ "null", "string" ] }, "expiresAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "OrderPaymentStatus": { "enum": [ "pending", "authorized", "captured", "failed", "cancelled", "refunded" ], "type": "string" }, "OrderReadyToPickUpRequest": { "required": [ "trackingNumber", "trackingLink", "carrierName", "comment" ], "type": "object", "properties": { "trackingNumber": { "type": "string" }, "trackingLink": { "type": [ "null", "string" ] }, "carrierName": { "type": [ "null", "string" ] }, "comment": { "type": [ "null", "string" ] } } }, "OrderRequestContext": { "type": "object", "properties": { "createdFrom": { "type": [ "null", "string" ] }, "platform": { "type": [ "null", "string" ] }, "deviceId": { "type": [ "null", "string" ] }, "sessionId": { "type": [ "null", "string" ] }, "userAgent": { "type": [ "null", "string" ] }, "ipAddress": { "type": [ "null", "string" ] } } }, "OrderReturnRequest": { "required": [ "trackingNumber", "trackingLink", "comment", "evidenceUrls" ], "type": "object", "properties": { "trackingNumber": { "type": [ "null", "string" ] }, "trackingLink": { "type": [ "null", "string" ] }, "comment": { "type": [ "null", "string" ] }, "evidenceUrls": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "OrderReturnStatus": { "enum": [ "none", "requested", "inProgress", "inspected", "returned", "rejected" ], "type": "string" }, "OrderReturnStatusRequest": { "required": [ "status", "comment" ], "type": "object", "properties": { "status": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrderReturnStatus" } ] }, "comment": { "type": [ "null", "string" ] } } }, "OrderScheduleCountDto": { "required": [ "locationId", "pickupPointId", "scheduledDate", "count" ], "type": "object", "properties": { "locationId": { "type": [ "null", "string" ] }, "pickupPointId": { "type": [ "null", "string" ] }, "scheduledDate": { "type": "string", "format": "date" }, "count": { "type": "integer", "format": "int32" } } }, "OrderScheduleCountRequest": { "required": [ "storeId", "scheduledDate", "locationId", "pickupPointId" ], "type": "object", "properties": { "storeId": { "type": "string" }, "scheduledDate": { "type": "string", "format": "date" }, "locationId": { "type": [ "null", "string" ] }, "pickupPointId": { "type": [ "null", "string" ] } } }, "OrderShipmentItemModel": { "required": [ "skuId", "qty", "weight" ], "type": "object", "properties": { "skuId": { "type": "string" }, "qty": { "type": "number", "format": "double" }, "weight": { "type": "number", "format": "double" } } }, "OrderShipmentTrackingDto": { "required": [ "success", "delivered", "events", "message" ], "type": "object", "properties": { "success": { "type": "boolean" }, "delivered": { "type": "boolean" }, "events": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/OrderShipmentTrackingEventDto" } }, "message": { "type": [ "null", "string" ] } } }, "OrderShipmentTrackingEventDto": { "required": [ "group", "name", "description", "date", "images" ], "type": "object", "properties": { "group": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "date": { "type": [ "null", "string" ] }, "images": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "OrderShippingMethodDto": { "required": [ "id", "name", "description", "subtotal", "discountTotal", "taxTotal", "total", "isTaxInclusive", "sellerId", "shippingProfileId", "shippingMethodId", "connectionId", "providerName", "trackingCode", "estimatedDays", "zoneCode", "locationId", "pickupPointId", "scheduledDate", "scheduledTime", "data" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "subtotal": { "type": "number", "format": "double" }, "discountTotal": { "type": "number", "format": "double" }, "taxTotal": { "type": "number", "format": "double" }, "total": { "type": "number", "format": "double" }, "isTaxInclusive": { "type": "boolean" }, "sellerId": { "type": [ "null", "string" ] }, "shippingProfileId": { "type": [ "null", "string" ] }, "shippingMethodId": { "type": [ "null", "string" ] }, "connectionId": { "type": [ "null", "string" ] }, "providerName": { "type": [ "null", "string" ] }, "trackingCode": { "type": [ "null", "string" ] }, "estimatedDays": { "type": [ "null", "integer" ], "format": "int32" }, "zoneCode": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ] }, "pickupPointId": { "type": [ "null", "string" ] }, "scheduledDate": { "type": [ "null", "string" ], "format": "date" }, "scheduledTime": { "type": [ "null", "string" ], "format": "time" }, "data": { "type": "object" } } }, "OrderSpreadsheetDto": { "required": [ "id", "totalCount", "expiresAt" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "totalCount": { "type": "integer", "format": "int64", "description": "Total number of matching items." }, "expiresAt": { "type": "string", "format": "date-time" } } }, "OrderSpreadsheetFilters": { "type": "object", "properties": { "search": { "type": [ "null", "string" ], "description": "Free-text filter. Which fields it covers depends on the resource." }, "status": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrderStatus" } ] }, "statuses": { "type": [ "null", "array" ] }, "state": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrderState" } ] }, "states": { "type": [ "null", "array" ] }, "fulfillmentStatus": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrderFulfillmentStatus" } ] }, "fulfillmentStatuses": { "type": [ "null", "array" ] }, "returnStatus": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrderReturnStatus" } ] }, "returnStatuses": { "type": [ "null", "array" ] }, "itemStatus": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrderStatus" } ] }, "itemStatuses": { "type": [ "null", "array" ] }, "locationId": { "type": [ "null", "string" ] }, "customerId": { "type": [ "null", "string" ] } } }, "OrderSpreadsheetRequest": { "type": "object", "properties": { "ids": { "type": [ "null", "array" ] }, "filters": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrderSpreadsheetFilters" } ] }, "pageSize": { "type": [ "null", "integer" ], "format": "int32" }, "maxRows": { "type": [ "null", "integer" ], "format": "int32" } } }, "OrderState": { "enum": [ "open", "closed", "canceled", "invalid" ], "type": "string" }, "OrderStatus": { "enum": [ "new", "confirmed", "inProgress", "invoiced", "readyToPickUp", "inTransit", "delivered", "partialDelivered", "closed", "cancelled", "invalid", "pendingToConfirm", "pendingToDeliveredToClient", "returned", "partialReturned", "partialCancelled", "none" ], "type": "string" }, "OrderTrackingDto": { "required": [ "id", "orderItemId", "title", "content", "type", "userId", "email", "ip", "createdOn", "createdBy" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "orderItemId": { "type": [ "null", "string" ] }, "title": { "type": "string" }, "content": { "type": "string" }, "type": { "$ref": "#/components/schemas/OrderTrackingType" }, "userId": { "type": [ "null", "string" ], "format": "uuid" }, "email": { "type": [ "null", "string" ] }, "ip": { "type": [ "null", "string" ] }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "createdBy": { "type": [ "null", "string" ], "format": "uuid" } } }, "OrderTrackingRequest": { "required": [ "trackingNumber", "trackingLink" ], "type": "object", "properties": { "trackingNumber": { "type": [ "null", "string" ] }, "trackingLink": { "type": [ "null", "string" ] }, "carrierName": { "type": [ "null", "string" ] } } }, "OrderTrackingType": { "enum": [ "note", "confirmed", "inTransit", "readyToPickUp", "cancelled", "delivered", "email", "sms", "orderInvalid", "new", "readyToShip", "closed", "inProgress", "pendingToDeliveredToClient", "return", "invoiced", "attachment", "customStatus" ], "type": "string" }, "OrderTransactionDto": { "required": [ "id", "type", "amount", "paymentMethod", "referenceId", "referenceType", "transactionReference", "transactionReferenceDocumentLink", "content", "createdOn", "createdBy" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "type": { "$ref": "#/components/schemas/OrderTransactionType" }, "amount": { "type": "number", "format": "double" }, "paymentMethod": { "type": "string" }, "referenceId": { "type": [ "null", "string" ] }, "referenceType": { "type": [ "null", "string" ] }, "transactionReference": { "type": [ "null", "string" ] }, "transactionReferenceDocumentLink": { "type": [ "null", "string" ] }, "content": { "type": [ "null", "string" ] }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "createdBy": { "type": [ "null", "string" ], "format": "uuid" } } }, "OrderTransactionType": { "enum": [ "in", "out" ], "type": "string" }, "OrganizationDetailsDto": { "required": [ "id", "name", "slug", "email", "stores", "status", "createdOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "name": { "type": "string" }, "slug": { "type": "string", "description": "URL-friendly identifier." }, "email": { "type": "string" }, "phone": { "type": [ "null", "string" ] }, "countryCode": { "type": [ "null", "string" ], "description": "ISO 3166-1 alpha-2 country code, for example `PE`." }, "currencyCode": { "type": [ "null", "string" ], "description": "ISO 4217 currency code, for example `PEN`." }, "logo": { "type": [ "null", "string" ] }, "languageCode": { "type": [ "null", "string" ], "description": "ISO 639-1 language code, for example `es`." }, "timeZone": { "type": [ "null", "string" ], "description": "IANA time zone name, for example `America/Lima`." }, "stores": { "type": "array", "items": { "$ref": "#/components/schemas/StoreDetailsDto" } }, "status": { "$ref": "#/components/schemas/OrganizationStatus" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "OrganizationStatus": { "enum": [ "active", "inactive", "suspended" ], "type": "string" }, "PackageDetailsDto": { "required": [ "id", "storeId", "name", "type", "length", "width", "height", "dimensionUnit", "emptyWeight", "weightUnit", "isDefault", "isActive", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/PackageType" }, "length": { "type": "number", "format": "double" }, "width": { "type": "number", "format": "double" }, "height": { "type": "number", "format": "double" }, "dimensionUnit": { "$ref": "#/components/schemas/DimensionUnit" }, "emptyWeight": { "type": "number", "format": "double" }, "weightUnit": { "$ref": "#/components/schemas/WeightUnit" }, "isDefault": { "type": "boolean" }, "isActive": { "type": "boolean" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "PackageRequest": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/PackageType" }, "length": { "type": "number", "format": "double" }, "width": { "type": "number", "format": "double" }, "height": { "type": "number", "format": "double" }, "dimensionUnit": { "$ref": "#/components/schemas/DimensionUnit" }, "emptyWeight": { "type": "number", "format": "double" }, "weightUnit": { "$ref": "#/components/schemas/WeightUnit" }, "isDefault": { "type": "boolean" }, "isActive": { "type": "boolean" } } }, "PackageType": { "enum": [ "box", "envelope", "softPackage" ], "type": "string" }, "PaginatedItemsOfBrandDetailsDto": { "required": [ "pageIndex", "pageSize", "count", "data" ], "type": "object", "properties": { "pageIndex": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "hasPreviousPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/BrandDetailsDto" } } } }, "PaginatedItemsOfTemplateItemDto": { "required": [ "pageIndex", "pageSize", "count", "data" ], "type": "object", "properties": { "pageIndex": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int64" }, "totalPages": { "type": "integer", "format": "int32" }, "hasPreviousPage": { "type": "boolean" }, "hasNextPage": { "type": "boolean", "description": "Whether at least one more page remains." }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateItemDto" } } } }, "PaymentCaptureMode": { "enum": [ "automaticAtCheckout", "manual" ], "type": "string" }, "PaymentLineItemModel": { "required": [ "name", "quantity", "unitAmount" ], "type": "object", "properties": { "name": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "unitAmount": { "type": "number", "format": "double" }, "code": { "type": [ "null", "string" ] }, "discountAmount": { "type": "number", "format": "double", "default": 0 }, "taxAmount": { "type": "number", "format": "double", "default": 0 }, "description": { "type": [ "null", "string" ] } } }, "PaymentMethodKind": { "enum": [ "offline", "card", "wallet", "other" ], "type": "string" }, "PaymentMethodModel": { "required": [ "id", "code", "name", "description", "kind", "isActive", "isDefault", "sortOrder", "connectionId", "providerMethodCode", "phoneNumber", "accountHolder", "qrImageUrl" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "kind": { "$ref": "#/components/schemas/PaymentMethodKind" }, "isActive": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "connectionId": { "type": [ "null", "string" ] }, "providerMethodCode": { "type": [ "null", "string" ] }, "phoneNumber": { "type": [ "null", "string" ] }, "accountHolder": { "type": [ "null", "string" ] }, "qrImageUrl": { "type": [ "null", "string" ] } } }, "PaymentMethodRequest": { "required": [ "code", "isActive", "sortOrder", "connectionId", "providerMethodCode" ], "type": "object", "properties": { "code": { "type": "string" }, "isActive": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "connectionId": { "type": [ "null", "string" ] }, "providerMethodCode": { "type": [ "null", "string" ] }, "phoneNumber": { "type": [ "null", "string" ] }, "accountHolder": { "type": [ "null", "string" ] }, "qrImageUrl": { "type": [ "null", "string" ] } } }, "PaymentMethodsRequest": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodRequest" } } } }, "PaymentSettingsModel": { "type": "object", "properties": { "storeId": { "type": "string" }, "captureMode": { "$ref": "#/components/schemas/PaymentCaptureMode" }, "manualPaymentsEnabled": { "type": "boolean" }, "defaultConnectionId": { "type": [ "null", "string" ] } } }, "PaymentSettingsRequest": { "type": "object", "properties": { "captureMode": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PaymentCaptureMode" } ] }, "defaultConnectionId": { "type": [ "null", "string" ] }, "manualPaymentsEnabled": { "type": [ "null", "boolean" ] } } }, "PaymentStatus": { "enum": [ "pending", "authorized", "captured", "failed", "cancelled", "refunded" ], "type": "string" }, "PickupLocationDto": { "required": [ "id", "name", "address", "city", "state", "country", "postalCode", "phone", "email", "isDefault", "isPhysicalStore", "pickupInstructions", "pickupLeadTimeInMinutes", "pickupSlotInMinutes", "pickupDailyCapacity", "schedule" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "name": { "type": "string" }, "address": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "state": { "type": [ "null", "string" ] }, "country": { "type": [ "null", "string" ] }, "postalCode": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "isDefault": { "type": "boolean" }, "isPhysicalStore": { "type": "boolean" }, "pickupInstructions": { "type": [ "null", "string" ] }, "pickupLeadTimeInMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "pickupSlotInMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "pickupDailyCapacity": { "type": [ "null", "integer" ], "format": "int32" }, "schedule": { "type": "array", "items": { "$ref": "#/components/schemas/PickupOptionScheduleDto" } } } }, "PickupOptionScheduleDto": { "required": [ "day", "openTime", "closeTime", "isOpen" ], "type": "object", "properties": { "day": { "$ref": "#/components/schemas/DayOfWeekType" }, "openTime": { "type": "string", "format": "time" }, "closeTime": { "type": "string", "format": "time" }, "isOpen": { "type": "boolean" } } }, "PickupOptionsDto": { "required": [ "locations", "pickupPoints" ], "type": "object", "properties": { "locations": { "type": "array", "items": { "$ref": "#/components/schemas/PickupLocationDto" } }, "pickupPoints": { "type": "array", "items": { "$ref": "#/components/schemas/PickupPointOptionDto" } } } }, "PickupPointDetailsDto": { "required": [ "id", "storeId", "locationId", "connectionId", "sellerId", "isExternal", "externalId", "name", "description", "state", "city", "neighborhood", "postalCode", "address", "addressNumber", "reference", "observations", "latitude", "longitude", "deliveryTimeInMinutes", "leadTimeInMinutes", "isSellerPickupPoint", "contactName", "contactPhone", "contactEmail", "schedule", "hasCoordinates", "status", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "locationId": { "type": [ "null", "string" ] }, "connectionId": { "type": [ "null", "string" ] }, "sellerId": { "type": [ "null", "string" ] }, "isExternal": { "type": "boolean" }, "externalId": { "type": [ "null", "string" ] }, "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "state": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "neighborhood": { "type": [ "null", "string" ] }, "postalCode": { "type": [ "null", "string" ] }, "address": { "type": "string" }, "addressNumber": { "type": [ "null", "string" ] }, "reference": { "type": [ "null", "string" ] }, "observations": { "type": [ "null", "string" ] }, "latitude": { "type": [ "null", "number" ], "format": "double" }, "longitude": { "type": [ "null", "number" ], "format": "double" }, "deliveryTimeInMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "leadTimeInMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "isSellerPickupPoint": { "type": "boolean" }, "contactName": { "type": [ "null", "string" ] }, "contactPhone": { "type": [ "null", "string" ] }, "contactEmail": { "type": [ "null", "string" ] }, "schedule": { "type": "array", "items": { "$ref": "#/components/schemas/PickupScheduleDto" } }, "hasCoordinates": { "type": "boolean" }, "status": { "$ref": "#/components/schemas/PickupPointStatus" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "PickupPointOptionDto": { "required": [ "id", "locationId", "connectionId", "isExternal", "externalId", "name", "address", "city", "state", "postalCode", "contactPhone", "observations", "leadTimeInMinutes", "schedule" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "locationId": { "type": [ "null", "string" ] }, "connectionId": { "type": [ "null", "string" ] }, "isExternal": { "type": "boolean" }, "externalId": { "type": [ "null", "string" ] }, "name": { "type": "string" }, "address": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "state": { "type": [ "null", "string" ] }, "postalCode": { "type": [ "null", "string" ] }, "contactPhone": { "type": [ "null", "string" ] }, "observations": { "type": [ "null", "string" ] }, "leadTimeInMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "schedule": { "type": "array", "items": { "$ref": "#/components/schemas/PickupOptionScheduleDto" } } } }, "PickupPointScheduleRequest": { "required": [ "day", "openTime", "closeTime" ], "type": "object", "properties": { "day": { "$ref": "#/components/schemas/DayOfWeekType" }, "openTime": { "type": "string", "format": "time" }, "closeTime": { "type": "string", "format": "time" } } }, "PickupPointStatus": { "enum": [ "inactive", "active" ], "type": "string" }, "PickupScheduleDto": { "required": [ "day", "openTime", "closeTime", "duration" ], "type": "object", "properties": { "day": { "$ref": "#/components/schemas/DayOfWeekType" }, "openTime": { "type": "string", "format": "time" }, "closeTime": { "type": "string", "format": "time" }, "duration": { "pattern": "^-?(\\d+\\.)?\\d{2}:\\d{2}:\\d{2}(\\.\\d{1,7})?$", "type": "string" } } }, "PlanPurchaseDto": { "required": [ "id", "currentPlan", "requestedPlan", "currentPrice", "requestedPrice", "amountDue", "creditAmount", "currentBillingInterval", "billingInterval", "currencyCode", "status", "requiresManualApproval", "paymentCheckoutRequired", "createdOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "currentPlan": { "$ref": "#/components/schemas/BillingPlanType" }, "requestedPlan": { "$ref": "#/components/schemas/BillingPlanType" }, "currentPrice": { "type": "number", "format": "double" }, "requestedPrice": { "type": "number", "format": "double" }, "amountDue": { "type": "number", "format": "double" }, "creditAmount": { "type": "number", "format": "double" }, "currentBillingInterval": { "type": "string" }, "billingInterval": { "type": "string" }, "currencyCode": { "type": "string", "description": "ISO 4217 currency code, for example `PEN`." }, "status": { "$ref": "#/components/schemas/PlanPurchaseStatus" }, "requiresManualApproval": { "type": "boolean" }, "paymentCheckoutRequired": { "type": "boolean" }, "paymentProvider": { "type": [ "null", "string" ] }, "paymentCheckoutId": { "type": [ "null", "string" ] }, "paymentCheckoutUrl": { "type": [ "null", "string" ] }, "checkout": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BillingCheckoutDto" } ] }, "effectiveOn": { "type": [ "null", "string" ], "format": "date-time" }, "appliedOn": { "type": [ "null", "string" ], "format": "date-time" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "PlanPurchaseStatus": { "enum": [ "pending", "approved", "rejected", "cancelled", "scheduled" ], "type": "string" }, "PlanUsageDto": { "required": [ "code", "used", "limit" ], "type": "object", "properties": { "code": { "type": "string", "description": "Code of the plan limit being measured." }, "used": { "type": "integer", "format": "int32", "description": "Current usage for this plan limit." }, "limit": { "type": "integer", "format": "int32", "description": "Maximum usage allowed by the current plan." } } }, "PreviewRequest": { "type": "object", "properties": { "dynamicOperator": { "$ref": "#/components/schemas/ConditionOperator" }, "rules": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CollectionRuleModel" } }, "includeCollectionIds": { "type": [ "null", "array" ] }, "excludeCollectionIds": { "type": [ "null", "array" ] }, "includeProductIds": { "type": [ "null", "array" ] }, "excludeProductIds": { "type": [ "null", "array" ] } } }, "PriceBreakDto": { "required": [ "minQuantity", "unitPrice" ], "type": "object", "properties": { "minQuantity": { "type": "integer", "format": "int32" }, "unitPrice": { "type": "number", "format": "double" } } }, "PriceBreakInput": { "type": "object", "properties": { "minQuantity": { "type": "integer", "format": "int32" }, "unitPrice": { "type": "number", "format": "double" } } }, "PriceChangeReason": { "enum": [ "initial", "manualUpdate", "bulkEdit", "promotionStart", "promotionEnd", "costAdjustment", "import" ], "type": "string" }, "PriceHistoryDto": { "required": [ "id", "productId", "productName", "variantName", "sku", "variantId", "newPrice", "reason", "timestamp" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "productId": { "type": "string" }, "productName": { "type": "string" }, "variantName": { "type": "string" }, "sku": { "type": "string", "description": "Stock keeping unit (SKU)." }, "variantId": { "type": "string" }, "previousPrice": { "type": [ "null", "number" ], "format": "double" }, "previousCompareAtPrice": { "type": [ "null", "number" ], "format": "double" }, "newPrice": { "type": "number", "format": "double" }, "newCompareAtPrice": { "type": [ "null", "number" ], "format": "double" }, "costPrice": { "type": [ "null", "number" ], "format": "double" }, "reason": { "type": "string" }, "userId": { "type": [ "null", "string" ], "format": "uuid" }, "userEmail": { "type": [ "null", "string" ] }, "userName": { "type": [ "null", "string" ] }, "timestamp": { "type": "string", "format": "date-time" } } }, "PriceListDiscountType": { "enum": [ "fixedPrice", "percentageDiscount", "amountDiscount" ], "type": "string" }, "PriceListDto": { "required": [ "id", "name", "currency", "isActive", "priority", "scope", "customerId", "productId", "productIds", "categoryIds", "tags", "excludedProductIds", "validFrom", "validTo", "items", "rules" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "name": { "type": "string" }, "currency": { "type": "string" }, "isActive": { "type": "boolean" }, "priority": { "type": "integer", "format": "int32" }, "scope": { "type": "string" }, "customerId": { "type": [ "null", "string" ] }, "productId": { "type": [ "null", "string" ] }, "productIds": { "type": "array" }, "categoryIds": { "type": "array" }, "tags": { "type": "array", "items": { "type": "string" } }, "excludedProductIds": { "type": "array" }, "validFrom": { "type": [ "null", "string" ], "format": "date-time" }, "validTo": { "type": [ "null", "string" ], "format": "date-time" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PriceListItemDto" } }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/PriceListRuleDto" } } } }, "PriceListItemDto": { "required": [ "id", "variantId", "unitPrice", "compareAtPrice", "breaks" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "variantId": { "type": "string" }, "unitPrice": { "type": "number", "format": "double" }, "compareAtPrice": { "type": [ "null", "number" ], "format": "double" }, "breaks": { "type": "array", "items": { "$ref": "#/components/schemas/PriceBreakDto" } } } }, "PriceListItemInput": { "type": "object", "properties": { "variantId": { "type": "string" }, "unitPrice": { "type": "number", "format": "double" }, "compareAtPrice": { "type": [ "null", "number" ], "format": "double" }, "breaks": { "type": "array", "items": { "$ref": "#/components/schemas/PriceBreakInput" } } } }, "PriceListRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "currency": { "type": "string" }, "isActive": { "type": "boolean" }, "priority": { "type": "integer", "format": "int32" }, "scope": { "$ref": "#/components/schemas/PriceListScope" }, "customerId": { "type": [ "null", "string" ] }, "productId": { "type": [ "null", "string" ] }, "productIds": { "type": "array" }, "categoryIds": { "type": "array" }, "tags": { "type": "array", "items": { "type": "string" } }, "excludedProductIds": { "type": "array" }, "validFrom": { "type": [ "null", "string" ], "format": "date-time" }, "validTo": { "type": [ "null", "string" ], "format": "date-time" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/PriceListItemInput" } }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/PriceListRuleInput" } } } }, "PriceListRuleDto": { "required": [ "minQuantity", "maxQuantity", "discountType", "value" ], "type": "object", "properties": { "minQuantity": { "type": "integer", "format": "int32" }, "maxQuantity": { "type": [ "null", "integer" ], "format": "int32" }, "discountType": { "type": "string" }, "value": { "type": "number", "format": "double" } } }, "PriceListRuleInput": { "type": "object", "properties": { "minQuantity": { "type": "integer", "format": "int32" }, "maxQuantity": { "type": [ "null", "integer" ], "format": "int32" }, "discountType": { "$ref": "#/components/schemas/PriceListDiscountType" }, "value": { "type": "number", "format": "double" } } }, "PriceListScope": { "enum": [ "product", "allProducts", "categories", "tags" ], "type": "string" }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "integer" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "code": { "type": "string", "description": "Machine-readable error code returned by Ecomiq." } } }, "ProductActivityChangeDto": { "required": [ "field" ], "type": "object", "properties": { "field": { "type": "string" }, "before": { "type": [ "null", "string" ] }, "after": { "type": [ "null", "string" ] } } }, "ProductActivityItemDto": { "required": [ "id", "source", "action", "timestamp", "changes" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "source": { "$ref": "#/components/schemas/ProductActivitySource" }, "action": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "userId": { "type": [ "null", "string" ], "format": "uuid" }, "userEmail": { "type": [ "null", "string" ] }, "userName": { "type": [ "null", "string" ] }, "entityName": { "type": [ "null", "string" ] }, "productId": { "type": [ "null", "string" ] }, "variantId": { "type": [ "null", "string" ] }, "variantName": { "type": [ "null", "string" ] }, "sku": { "type": [ "null", "string" ], "description": "Stock keeping unit (SKU)." }, "locationId": { "type": [ "null", "string" ] }, "locationName": { "type": [ "null", "string" ] }, "reason": { "type": [ "null", "string" ] }, "referenceId": { "type": [ "null", "string" ] }, "changes": { "type": "array", "items": { "$ref": "#/components/schemas/ProductActivityChangeDto" } } } }, "ProductActivitySource": { "enum": [ "product", "price", "inventory" ], "type": "string" }, "ProductBundleItemDto": { "required": [ "productId", "variantId", "productName", "variantName", "unitPrice", "quantity", "available" ], "type": "object", "properties": { "productId": { "type": "string" }, "variantId": { "type": "string" }, "productName": { "type": "string" }, "variantName": { "type": "string" }, "imageUrl": { "type": [ "null", "string" ] }, "sku": { "type": [ "null", "string" ], "description": "Stock keeping unit (SKU)." }, "unitPrice": { "type": "number", "format": "double" }, "quantity": { "type": "integer", "format": "int32" }, "available": { "type": "integer", "format": "int32" } } }, "ProductBundleItemRequest": { "required": [ "variantId", "quantity" ], "type": "object", "properties": { "variantId": { "type": "string" }, "quantity": { "type": "integer", "format": "int32" } } }, "ProductCollectionDto": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "name": { "type": "string" } } }, "ProductCommissionDto": { "required": [ "source", "productCommissionPercentage", "baseAmount", "productCommissionAmount", "fixedFeeAmount", "estimatedCommissionAmount", "estimatedSellerReceivesAmount" ], "type": "object", "properties": { "source": { "$ref": "#/components/schemas/SellerCommissionSource" }, "sellerCommissionId": { "type": [ "null", "string" ] }, "productCommissionPercentage": { "type": "number", "format": "double" }, "freightCommissionPercent": { "type": [ "null", "number" ], "format": "double" }, "fixedFee": { "type": [ "null", "number" ], "format": "double" }, "baseAmount": { "type": "number", "format": "double" }, "productCommissionAmount": { "type": "number", "format": "double" }, "fixedFeeAmount": { "type": "number", "format": "double" }, "estimatedCommissionAmount": { "type": "number", "format": "double" }, "estimatedSellerReceivesAmount": { "type": "number", "format": "double" } } }, "ProductConditionType": { "enum": [ "new", "used", "refurbished" ], "type": [ "null", "string" ] }, "ProductCountDto": { "required": [ "total", "precision", "limit" ], "type": "object", "properties": { "total": { "type": "integer", "format": "int32", "description": "Number of products that match the filters. When `precision` is `atLeast`, this is a lower bound." }, "precision": { "$ref": "#/components/schemas/ProductCountPrecision", "description": "Whether `total` is exact or a lower bound." }, "limit": { "type": [ "null", "integer" ], "format": "int32", "description": "Maximum number of matching products evaluated before the count becomes a lower bound." } } }, "ProductCountPrecision": { "enum": [ "exact", "atLeast" ], "type": "string" }, "ProductCreateRequest": { "type": "object", "properties": { "name": { "type": "string" }, "sku": { "type": [ "null", "string" ], "description": "Stock keeping unit (SKU)." }, "description": { "type": [ "null", "string" ] }, "slug": { "type": [ "null", "string" ], "description": "URL-friendly identifier." }, "brandId": { "type": [ "null", "string" ] }, "packageId": { "type": [ "null", "string" ] }, "shippingProfileId": { "type": [ "null", "string" ] }, "images": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ProductImageModel" } }, "type": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ProductType" } ] }, "condition": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ProductConditionType" } ] }, "status": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ProductStatus" } ] }, "price": { "type": [ "null", "number" ], "format": "double" }, "compareAtPrice": { "type": [ "null", "number" ], "format": "double" }, "costPrice": { "type": [ "null", "number" ], "format": "double" }, "weight": { "type": [ "null", "number" ], "format": "double" }, "categoryId": { "type": [ "null", "string" ] }, "tags": { "type": [ "null", "array" ], "items": { "type": "string" } }, "summary": { "type": [ "null", "string" ] }, "vendor": { "type": [ "null", "string" ] }, "metaTitle": { "type": [ "null", "string" ] }, "metaDescription": { "type": [ "null", "string" ] }, "keywords": { "type": [ "null", "array" ], "items": { "type": "string" } }, "minOrderQuantity": { "type": "integer", "format": "int32" }, "maxOrderQuantity": { "type": [ "null", "integer" ], "format": "int32" }, "isDigital": { "type": "boolean" }, "trackInventory": { "type": [ "null", "boolean" ] }, "lowStockThreshold": { "type": [ "null", "integer" ], "format": "int32" }, "allowBackorders": { "type": [ "null", "boolean" ] }, "specifications": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SpecificationModel" } }, "variants": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/VariantInputModel" } }, "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ProductBundleItemRequest" } }, "options": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/OptionDefinitionModel" } }, "modifiers": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ModifierGroupModel" } }, "targetChannelIds": { "type": [ "null", "array" ] } } }, "ProductDeleteBatchRequest": { "type": "object", "properties": { "productIds": { "type": "array" }, "expectedCount": { "type": [ "null", "integer" ], "format": "int32" }, "search": { "type": [ "null", "string" ], "description": "Free-text filter. Which fields it covers depends on the resource." }, "statusFilter": { "type": [ "null", "array" ] }, "categoryIds": { "type": [ "null", "array" ] }, "brandIds": { "type": [ "null", "array" ] }, "sellerIds": { "type": [ "null", "array" ] }, "types": { "type": [ "null", "array" ] }, "isFeatured": { "type": [ "null", "boolean" ] }, "ean": { "type": [ "null", "string" ] }, "minPrice": { "type": [ "null", "number" ], "format": "double" }, "maxPrice": { "type": [ "null", "number" ], "format": "double" }, "minOnHand": { "type": [ "null", "integer" ], "format": "int32" }, "maxOnHand": { "type": [ "null", "integer" ], "format": "int32" }, "minAvailable": { "type": [ "null", "integer" ], "format": "int32" }, "tags": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "ProductDetailsDto": { "required": [ "id", "storeId", "name", "description", "slug", "type", "condition", "variants", "price", "totalOnHand", "available", "committed", "totalVariants", "activeVariants", "specifications", "images", "status", "isFeatured", "minOrderQuantity", "isDigital", "hasVariants", "hasOptions", "hasModifiers", "hasActivity", "hasPriceLists", "hasReviews", "hasSizeGuide", "modifierGroups", "views", "salesCount", "reviewsCount", "createdOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "sellerId": { "type": [ "null", "string" ] }, "sellerApprovalPolicy": { "type": [ "null", "string" ] }, "name": { "type": "string" }, "description": { "type": "string" }, "slug": { "type": "string", "description": "URL-friendly identifier." }, "summary": { "type": [ "null", "string" ] }, "type": { "$ref": "#/components/schemas/ProductType" }, "condition": { "$ref": "#/components/schemas/ProductConditionType" }, "discountPercentage": { "type": [ "null", "number" ], "format": "double" }, "currency": { "type": [ "null", "string" ] }, "taxRate": { "type": [ "null", "number" ], "format": "double" }, "taxIncluded": { "type": [ "null", "boolean" ] }, "brand": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/BrandItemDto" } ] }, "variants": { "type": "array", "items": { "$ref": "#/components/schemas/ProductVariantDto" } }, "price": { "type": "number", "format": "double" }, "compareAtPrice": { "type": [ "null", "number" ], "format": "double" }, "costPrice": { "type": [ "null", "number" ], "format": "double" }, "totalOnHand": { "type": "integer", "format": "int32" }, "available": { "type": "integer", "format": "int32" }, "committed": { "type": "integer", "format": "int32" }, "totalVariants": { "type": "integer", "format": "int32" }, "activeVariants": { "type": "integer", "format": "int32" }, "vendor": { "type": [ "null", "string" ] }, "tags": { "type": [ "null", "array" ], "items": { "type": "string" } }, "specifications": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSpecificationDto" } }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/ProductImage" } }, "category": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CategoryItemDto" } ] }, "bundleItems": { "type": "array", "items": { "$ref": "#/components/schemas/ProductBundleItemDto" } }, "packageId": { "type": [ "null", "string" ] }, "shippingProfileId": { "type": [ "null", "string" ] }, "status": { "$ref": "#/components/schemas/ProductStatus" }, "moderationReason": { "type": [ "null", "string" ] }, "metaTitle": { "type": [ "null", "string" ] }, "metaDescription": { "type": [ "null", "string" ] }, "metaKeywords": { "type": [ "null", "array" ], "items": { "type": "string" } }, "featuredUntil": { "type": [ "null", "string" ], "format": "date-time" }, "isFeatured": { "type": "boolean" }, "minOrderQuantity": { "type": "integer", "format": "int32" }, "maxOrderQuantity": { "type": [ "null", "integer" ], "format": "int32" }, "isDigital": { "type": "boolean" }, "hasVariants": { "type": "boolean" }, "hasOptions": { "type": "boolean" }, "hasModifiers": { "type": "boolean" }, "hasActivity": { "type": "boolean" }, "hasPriceLists": { "type": "boolean" }, "hasReviews": { "type": "boolean" }, "hasSizeGuide": { "type": "boolean" }, "modifierGroups": { "type": "array", "items": { "$ref": "#/components/schemas/ModifierGroupDto" } }, "sizeGuide": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SizeGuideItemDto" } ] }, "views": { "type": "integer", "format": "int32" }, "salesCount": { "type": "integer", "format": "int32" }, "reviewsCount": { "type": "integer", "format": "int32" }, "collections": { "type": "array", "items": { "$ref": "#/components/schemas/ProductCollectionDto" } }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." }, "lastActivityOn": { "type": [ "null", "string" ], "format": "date-time" } } }, "ProductImage": { "required": [ "id", "url" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "url": { "type": "string" }, "name": { "type": [ "null", "string" ] }, "width": { "type": [ "null", "integer" ], "format": "int32" }, "height": { "type": [ "null", "integer" ], "format": "int32" }, "isPrimary": { "type": "boolean" }, "order": { "type": "integer", "format": "int32" } } }, "ProductImageModel": { "required": [ "id", "url" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "url": { "type": "string" }, "name": { "type": [ "null", "string" ] }, "width": { "type": [ "null", "integer" ], "format": "int32" }, "height": { "type": [ "null", "integer" ], "format": "int32" }, "isPrimary": { "type": "boolean" }, "order": { "type": "integer", "format": "int32" } } }, "ProductImportAssetResponse": { "required": [ "assetId", "fileName", "contentType", "size", "sha256" ], "type": "object", "properties": { "assetId": { "type": "string" }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "size": { "type": "integer", "format": "int64" }, "sha256": { "type": "string" } } }, "ProductImportSchemaDto": { "required": [ "version", "headers", "requiredHeaders", "headerAliases", "dynamicHeaderPrefixes", "ignoredHeaders" ], "type": "object", "properties": { "version": { "type": "string", "description": "Version of the product import file schema." }, "headers": { "type": "array", "items": { "type": "string" }, "description": "Headers accepted in a product import file." }, "requiredHeaders": { "type": "array", "items": { "type": "string" }, "description": "Headers that every product import file must include." }, "headerAliases": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "description": "Alternative input headers accepted for each canonical header." }, "dynamicHeaderPrefixes": { "type": "array", "items": { "type": "string" }, "description": "Prefixes accepted for dynamic product fields." }, "ignoredHeaders": { "type": "array", "items": { "type": "string" }, "description": "Headers accepted but ignored during product import." } } }, "ProductItemDto": { "required": [ "id", "storeId", "sellerId", "type", "name", "description", "slug", "brand", "price", "totalOnHand", "available", "committed", "totalVariants", "activeVariants", "tags", "specifications", "images", "category", "status", "isFeatured", "minOrderQuantity", "isDigital", "hasVariants", "hasActivity", "hasPriceLists", "hasReviews", "hasSizeGuide", "variants", "views", "salesCount", "reviewsCount", "createdOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "sku": { "type": [ "null", "string" ], "description": "Stock keeping unit (SKU)." }, "storeId": { "type": "string" }, "sellerId": { "type": [ "null", "string" ] }, "type": { "$ref": "#/components/schemas/ProductType" }, "name": { "type": "string" }, "description": { "type": "string" }, "slug": { "type": "string", "description": "URL-friendly identifier." }, "currency": { "type": [ "null", "string" ] }, "taxRate": { "type": [ "null", "number" ], "format": "double" }, "taxIncluded": { "type": [ "null", "boolean" ] }, "brand": { "type": "string" }, "price": { "type": "number", "format": "double" }, "compareAtPrice": { "type": [ "null", "number" ], "format": "double" }, "costPrice": { "type": [ "null", "number" ], "format": "double" }, "totalOnHand": { "type": "integer", "format": "int32" }, "available": { "type": "integer", "format": "int32" }, "committed": { "type": "integer", "format": "int32" }, "totalVariants": { "type": "integer", "format": "int32" }, "activeVariants": { "type": "integer", "format": "int32" }, "vendor": { "type": [ "null", "string" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "specifications": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSpecificationDto" } }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/ProductImage" } }, "category": { "type": "string" }, "packageId": { "type": [ "null", "string" ] }, "shippingProfileId": { "type": [ "null", "string" ] }, "status": { "$ref": "#/components/schemas/ProductStatus" }, "metaTitle": { "type": [ "null", "string" ] }, "metaDescription": { "type": [ "null", "string" ] }, "metaKeywords": { "type": [ "null", "array" ], "items": { "type": "string" } }, "featuredUntil": { "type": [ "null", "string" ], "format": "date-time" }, "isFeatured": { "type": "boolean" }, "minOrderQuantity": { "type": "integer", "format": "int32" }, "maxOrderQuantity": { "type": [ "null", "integer" ], "format": "int32" }, "isDigital": { "type": "boolean" }, "hasVariants": { "type": "boolean" }, "hasActivity": { "type": "boolean" }, "hasPriceLists": { "type": "boolean" }, "hasReviews": { "type": "boolean" }, "hasSizeGuide": { "type": "boolean" }, "variants": { "type": "array", "items": { "$ref": "#/components/schemas/ProductItemVariantDto" } }, "views": { "type": "integer", "format": "int32" }, "salesCount": { "type": "integer", "format": "int32" }, "reviewsCount": { "type": "integer", "format": "int32" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." }, "lastActivityOn": { "type": [ "null", "string" ], "format": "date-time" } } }, "ProductItemVariantDto": { "required": [ "id", "sku", "name", "status", "price", "trackInventory", "allowBackorders", "lowStockThreshold", "onHand", "committed", "available", "images", "options", "inventories" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "sku": { "type": "string", "description": "Stock keeping unit (SKU)." }, "name": { "type": "string" }, "barcode": { "type": [ "null", "string" ], "description": "Barcode of the variant, such as EAN or UPC." }, "status": { "$ref": "#/components/schemas/VariantStatus" }, "price": { "type": "number", "format": "double" }, "compareAtPrice": { "type": [ "null", "number" ], "format": "double" }, "costPrice": { "type": [ "null", "number" ], "format": "double" }, "trackInventory": { "type": "boolean" }, "allowBackorders": { "type": "boolean" }, "lowStockThreshold": { "type": "integer", "format": "int32" }, "onHand": { "type": "integer", "format": "int32" }, "committed": { "type": "integer", "format": "int32" }, "available": { "type": "integer", "format": "int32" }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/VariantImageDto" } }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/VariantOptionDto" } }, "inventories": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryDto" } } } }, "ProductModerationAction": { "enum": [ "approve", "reject" ], "type": [ "null", "string" ] }, "ProductPriceBatchItem": { "type": "object", "properties": { "productId": { "type": [ "null", "string" ] }, "variantId": { "type": [ "null", "string" ] }, "sku": { "type": [ "null", "string" ], "description": "Stock keeping unit (SKU)." }, "price": { "type": [ "null", "number" ], "format": "double" }, "compareAtPrice": { "type": [ "null", "number" ], "format": "double" }, "clearCompareAtPrice": { "type": "boolean" } } }, "ProductPriceBatchRequest": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProductPriceBatchItem" } }, "reason": { "$ref": "#/components/schemas/PriceChangeReason" } } }, "ProductPublicationDto": { "required": [ "channelId", "channelName", "providerId", "channelType", "listingType", "listingId", "listingStatus", "externalId", "externalUrl", "lastSyncAt", "price", "compareAtPrice", "lastSyncError", "lastSyncErrorCode", "readinessStatus", "readinessIssues" ], "type": "object", "properties": { "channelId": { "type": "string" }, "channelName": { "type": "string" }, "providerId": { "type": "string" }, "channelType": { "type": "string" }, "listingType": { "type": "string" }, "listingId": { "type": "string" }, "listingStatus": { "type": "string" }, "externalId": { "type": [ "null", "string" ] }, "externalUrl": { "type": [ "null", "string" ] }, "lastSyncAt": { "type": [ "null", "string" ], "format": "date-time" }, "price": { "type": "number", "format": "double" }, "compareAtPrice": { "type": [ "null", "number" ], "format": "double" }, "lastSyncError": { "type": [ "null", "string" ] }, "lastSyncErrorCode": { "type": [ "null", "string" ] }, "readinessStatus": { "type": "string" }, "readinessIssues": { "type": "array", "items": { "$ref": "#/components/schemas/ListingReadinessIssueDto" } } } }, "ProductPublicationsDto": { "required": [ "productId", "publications" ], "type": "object", "properties": { "productId": { "type": "string" }, "publications": { "type": "array", "items": { "$ref": "#/components/schemas/ProductPublicationDto" } } } }, "ProductRecommendationDto": { "required": [ "productId", "name", "slug", "imageUrl", "currency", "price", "category", "brand" ], "type": "object", "properties": { "productId": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string", "description": "URL-friendly identifier." }, "imageUrl": { "type": [ "null", "string" ] }, "currency": { "type": "string" }, "price": { "type": "number", "format": "double" }, "category": { "type": [ "null", "string" ] }, "brand": { "type": [ "null", "string" ] } } }, "ProductSizeGuideRequest": { "type": "object", "properties": { "sizeGuideId": { "type": [ "null", "string" ] } } }, "ProductSpecificationDto": { "required": [ "name", "key", "value" ], "type": "object", "properties": { "name": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } } }, "ProductSpreadsheetDto": { "required": [ "id", "totalCount", "expiresAt" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "totalCount": { "type": "integer", "format": "int64", "description": "Total number of matching items." }, "expiresAt": { "type": "string", "format": "date-time" } } }, "ProductSpreadsheetFilters": { "type": "object", "properties": { "search": { "type": [ "null", "string" ], "description": "Free-text filter. Which fields it covers depends on the resource." }, "status": { "type": [ "null", "array" ] }, "excludeStatus": { "type": [ "null", "array" ] }, "includeArchived": { "type": [ "null", "boolean" ] }, "categoryIds": { "type": [ "null", "array" ] }, "excludeCategoryIds": { "type": [ "null", "array" ] }, "brandIds": { "type": [ "null", "array" ] }, "excludeBrandIds": { "type": [ "null", "array" ] }, "storeIds": { "type": [ "null", "array" ] }, "sellerIds": { "type": [ "null", "array" ] }, "excludeSellerIds": { "type": [ "null", "array" ] }, "skuIds": { "type": [ "null", "array" ] }, "skus": { "type": [ "null", "array" ], "items": { "type": "string" } }, "types": { "type": [ "null", "array" ] }, "excludeTypes": { "type": [ "null", "array" ] }, "isFeatured": { "type": [ "null", "boolean" ] }, "ean": { "type": [ "null", "string" ] }, "minPrice": { "type": [ "null", "number" ], "format": "double" }, "maxPrice": { "type": [ "null", "number" ], "format": "double" }, "minOnHand": { "type": [ "null", "integer" ], "format": "int32" }, "maxOnHand": { "type": [ "null", "integer" ], "format": "int32" }, "minAvailable": { "type": [ "null", "integer" ], "format": "int32" }, "tags": { "type": [ "null", "array" ], "items": { "type": "string" } }, "excludeTags": { "type": [ "null", "array" ], "items": { "type": "string" } }, "sortBy": { "type": [ "null", "string" ], "description": "Field to sort by. Accepted values depend on the resource." }, "sortDirection": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SortDirection" } ], "description": "Sort direction: `asc` or `desc`." } } }, "ProductSpreadsheetProductPatchRequest": { "type": "object", "properties": { "productId": { "type": "string" }, "body": { "$ref": "#/components/schemas/ProductUpdateRequest" } } }, "ProductSpreadsheetRequest": { "type": "object", "properties": { "ids": { "type": [ "null", "array" ] }, "productIds": { "type": [ "null", "array" ] }, "filters": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ProductSpreadsheetFilters" } ] }, "pageSize": { "type": [ "null", "integer" ], "format": "int32" }, "maxRows": { "type": [ "null", "integer" ], "format": "int32" } } }, "ProductSpreadsheetSaveRequest": { "type": "object", "properties": { "productPatches": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSpreadsheetProductPatchRequest" } }, "statusGroups": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSpreadsheetStatusGroupRequest" } }, "priceItems": { "type": "array", "items": { "$ref": "#/components/schemas/ProductPriceBatchItem" } }, "inventoryItems": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSpreadsheetStockItemRequest" } }, "variantCreates": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSpreadsheetVariantCreateRequest" } }, "variantUpdates": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSpreadsheetVariantUpdateRequest" } }, "variantDeletes": { "type": "array", "items": { "$ref": "#/components/schemas/ProductSpreadsheetVariantDeleteRequest" } }, "productDeletes": { "type": "array" } } }, "ProductSpreadsheetStatusGroupRequest": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/ProductStatus" }, "productIds": { "type": "array" } } }, "ProductSpreadsheetStockItemRequest": { "type": "object", "properties": { "variantId": { "type": "string" }, "locationId": { "type": "string" }, "onHand": { "type": "integer", "format": "int32" }, "expectedVersion": { "type": "integer", "format": "int64" } } }, "ProductSpreadsheetVariantCreateRequest": { "type": "object", "properties": { "productId": { "type": "string" }, "body": { "$ref": "#/components/schemas/CreateVariantRequest" }, "initialInventory": { "type": "array", "items": { "$ref": "#/components/schemas/InitialInventoryRequest" } }, "active": { "type": "boolean" } } }, "ProductSpreadsheetVariantDeleteRequest": { "type": "object", "properties": { "productId": { "type": "string" }, "variantId": { "type": "string" } } }, "ProductSpreadsheetVariantUpdateRequest": { "type": "object", "properties": { "productId": { "type": "string" }, "variantId": { "type": "string" }, "expectedVersion": { "type": "integer", "format": "int64" }, "body": { "$ref": "#/components/schemas/UpdateVariantRequest" } } }, "ProductStatus": { "enum": [ "draft", "active", "inactive", "outOfStock", "discontinued", "archived" ], "type": "string" }, "ProductStatusBatchRequest": { "type": "object", "properties": { "productIds": { "type": "array" }, "status": { "$ref": "#/components/schemas/ProductStatus" } } }, "ProductStatusFilterBatchRequest": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/ProductStatus" }, "search": { "type": [ "null", "string" ], "description": "Free-text filter. Which fields it covers depends on the resource." }, "statusFilter": { "type": [ "null", "array" ] }, "categoryIds": { "type": [ "null", "array" ] }, "brandIds": { "type": [ "null", "array" ] }, "sellerIds": { "type": [ "null", "array" ] }, "types": { "type": [ "null", "array" ] }, "isFeatured": { "type": [ "null", "boolean" ] }, "ean": { "type": [ "null", "string" ] }, "minPrice": { "type": [ "null", "number" ], "format": "double" }, "maxPrice": { "type": [ "null", "number" ], "format": "double" }, "minOnHand": { "type": [ "null", "integer" ], "format": "int32" }, "maxOnHand": { "type": [ "null", "integer" ], "format": "int32" }, "minAvailable": { "type": [ "null", "integer" ], "format": "int32" }, "tags": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "ProductSuggestItemDto": { "required": [ "productId", "variantId", "name", "slug", "sku", "ean", "variantName", "unitPrice", "imageUrl" ], "type": "object", "properties": { "productId": { "type": "string" }, "variantId": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string", "description": "URL-friendly identifier." }, "sku": { "type": "string", "description": "Stock keeping unit (SKU)." }, "ean": { "type": [ "null", "string" ] }, "variantName": { "type": [ "null", "string" ] }, "unitPrice": { "type": "number", "format": "double" }, "imageUrl": { "type": "string" } } }, "ProductType": { "enum": [ "product", "service", "bundle" ], "type": [ "null", "string" ] }, "ProductUpdateRequest": { "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "sku": { "type": [ "null", "string" ], "description": "Stock keeping unit (SKU)." }, "slug": { "type": [ "null", "string" ], "description": "URL-friendly identifier." }, "description": { "type": [ "null", "string" ] }, "summary": { "type": [ "null", "string" ] }, "brandId": { "type": [ "null", "string" ] }, "clearBrand": { "type": [ "null", "boolean" ] }, "categoryId": { "type": [ "null", "string" ] }, "clearCategory": { "type": [ "null", "boolean" ] }, "packageId": { "type": [ "null", "string" ] }, "shippingProfileId": { "type": [ "null", "string" ] }, "clearShippingProfile": { "type": [ "null", "boolean" ] }, "tags": { "type": [ "null", "array" ], "items": { "type": "string" } }, "vendor": { "type": [ "null", "string" ] }, "metaTitle": { "type": [ "null", "string" ] }, "metaDescription": { "type": [ "null", "string" ] }, "keywords": { "type": [ "null", "array" ], "items": { "type": "string" } }, "minOrderQuantity": { "type": [ "null", "integer" ], "format": "int32" }, "maxOrderQuantity": { "type": [ "null", "integer" ], "format": "int32" }, "isDigital": { "type": [ "null", "boolean" ] }, "type": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ProductType" } ] }, "status": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ProductStatus" } ] }, "isFeatured": { "type": [ "null", "boolean" ] }, "price": { "type": [ "null", "number" ], "format": "double" }, "compareAtPrice": { "type": [ "null", "number" ], "format": "double" }, "images": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ProductImageModel" } }, "specifications": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SpecificationModel" } }, "variants": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/VariantInputModel" } }, "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ProductBundleItemRequest" } }, "options": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/OptionDefinitionModel" } }, "modifiers": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ModifierGroupModel" } } } }, "ProductVariantDto": { "required": [ "id", "name", "sku", "order", "isDefault", "price", "isDigital", "trackInventory", "allowBackorders", "lowStockThreshold", "onHand", "committed", "available", "options", "images", "inventories", "status" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "name": { "type": "string" }, "sku": { "type": "string", "description": "Stock keeping unit (SKU)." }, "barcode": { "type": [ "null", "string" ], "description": "Barcode of the variant, such as EAN or UPC." }, "countryOfOrigin": { "type": [ "null", "string" ] }, "hsCode": { "type": [ "null", "string" ] }, "order": { "type": "integer", "format": "int32" }, "isDefault": { "type": "boolean" }, "price": { "type": "number", "format": "double" }, "compareAtPrice": { "type": [ "null", "number" ], "format": "double" }, "costPrice": { "type": [ "null", "number" ], "format": "double" }, "isDigital": { "type": "boolean" }, "trackInventory": { "type": "boolean" }, "allowBackorders": { "type": "boolean" }, "lowStockThreshold": { "type": "integer", "format": "int32" }, "onHand": { "type": "integer", "format": "int32" }, "committed": { "type": "integer", "format": "int32" }, "available": { "type": "integer", "format": "int32" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/VariantOptionDto" } }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/VariantImageDto" } }, "inventories": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryDto" } }, "status": { "$ref": "#/components/schemas/VariantStatus" } } }, "ProductVariantListItemDto": { "required": [ "id", "name", "sku", "status", "order" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "name": { "type": "string" }, "sku": { "type": "string", "description": "Stock keeping unit (SKU)." }, "status": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "imageUrl": { "type": [ "null", "string" ] } } }, "PromotionAllocation": { "enum": [ "once", "each" ], "type": "string" }, "PromotionCodeCustomerDto": { "type": "object", "properties": { "customerId": { "type": "string" }, "email": { "type": [ "null", "string" ] }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] } } }, "PromotionCodeDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "code": { "type": "string" }, "usageLimit": { "type": [ "null", "integer" ], "format": "int32" }, "usageCount": { "type": "integer", "format": "int32" }, "assignedCustomers": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionCodeCustomerDto" } }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "PromotionDetailsDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "sellerId": { "type": [ "null", "string" ] }, "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "status": { "$ref": "#/components/schemas/PromotionStatus" }, "type": { "$ref": "#/components/schemas/PromotionType" }, "target": { "$ref": "#/components/schemas/PromotionTarget" }, "amount": { "type": "number", "format": "double" }, "allocation": { "$ref": "#/components/schemas/PromotionAllocation" }, "maxQuantity": { "type": [ "null", "integer" ], "format": "int32" }, "applyAfterTaxes": { "type": "boolean" }, "isAutomatic": { "type": "boolean" }, "validFrom": { "type": [ "null", "string" ], "format": "date-time" }, "validTo": { "type": [ "null", "string" ], "format": "date-time" }, "usageLimit": { "type": [ "null", "integer" ], "format": "int32" }, "usageCount": { "type": "integer", "format": "int32" }, "customerUsageLimit": { "type": [ "null", "integer" ], "format": "int32" }, "combineWithOtherDiscounts": { "type": "boolean" }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionRuleDto" } }, "codes": { "type": "array", "items": { "$ref": "#/components/schemas/PromotionCodeDto" } }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "PromotionItemDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "sellerId": { "type": [ "null", "string" ] }, "name": { "type": "string" }, "status": { "$ref": "#/components/schemas/PromotionStatus" }, "type": { "$ref": "#/components/schemas/PromotionType" }, "target": { "$ref": "#/components/schemas/PromotionTarget" }, "amount": { "type": "number", "format": "double" }, "allocation": { "$ref": "#/components/schemas/PromotionAllocation" }, "maxQuantity": { "type": [ "null", "integer" ], "format": "int32" }, "applyAfterTaxes": { "type": "boolean" }, "isAutomatic": { "type": "boolean" }, "validFrom": { "type": [ "null", "string" ], "format": "date-time" }, "validTo": { "type": [ "null", "string" ], "format": "date-time" }, "usageLimit": { "type": [ "null", "integer" ], "format": "int32" }, "usageCount": { "type": "integer", "format": "int32" }, "codeCount": { "type": "integer", "format": "int32" }, "ruleCount": { "type": "integer", "format": "int32" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "PromotionOperationDto": { "required": [ "id", "status", "resource", "format", "createdOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "status": { "$ref": "#/components/schemas/OperationStatus" }, "resource": { "type": "string" }, "format": { "type": "string" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." } } }, "PromotionRuleDto": { "type": "object", "properties": { "field": { "$ref": "#/components/schemas/PromotionRuleField" }, "operator": { "$ref": "#/components/schemas/RuleOperator" }, "path": { "type": [ "null", "string" ] }, "value": { "type": "string" } } }, "PromotionRuleField": { "enum": [ "cartSubtotal", "cartTotalQuantity", "productId", "categoryId", "brandId" ], "type": "string" }, "PromotionRuleInput": { "required": [ "value" ], "type": "object", "properties": { "field": { "$ref": "#/components/schemas/PromotionRuleField" }, "operator": { "$ref": "#/components/schemas/RuleOperator" }, "path": { "type": [ "null", "string" ] }, "value": { "type": "string" } } }, "PromotionStatus": { "enum": [ "draft", "active", "scheduled", "inactive" ], "type": "string" }, "PromotionTarget": { "enum": [ "order", "item", "shipping" ], "type": "string" }, "PromotionType": { "enum": [ "percentage", "fixedAmount", "freeShipping", "buyXGetY" ], "type": "string" }, "PromotionUpsertRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "status": { "$ref": "#/components/schemas/PromotionStatus" }, "type": { "$ref": "#/components/schemas/PromotionType" }, "target": { "$ref": "#/components/schemas/PromotionTarget" }, "amount": { "type": "number", "format": "double" }, "allocation": { "$ref": "#/components/schemas/PromotionAllocation" }, "maxQuantity": { "type": [ "null", "integer" ], "format": "int32" }, "applyAfterTaxes": { "type": "boolean" }, "sellerId": { "type": [ "null", "string" ] }, "isAutomatic": { "type": "boolean" }, "validFrom": { "type": [ "null", "string" ], "format": "date-time" }, "validTo": { "type": [ "null", "string" ], "format": "date-time" }, "usageLimit": { "type": [ "null", "integer" ], "format": "int32" }, "customerUsageLimit": { "type": [ "null", "integer" ], "format": "int32" }, "combineWithOtherDiscounts": { "type": "boolean" }, "rules": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/PromotionRuleInput" } }, "codes": { "type": [ "null", "array" ], "items": { "type": "string" } }, "codeUsageLimit": { "type": [ "null", "integer" ], "format": "int32" } } }, "PublicationIssueDto": { "required": [ "code", "message", "count" ], "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "count": { "type": "integer", "format": "int32" } } }, "PublicationReadinessDto": { "required": [ "channelId", "total", "ready", "blocked", "unknown", "missingCategoryMappings", "missingRequiredAttributes", "missingBrands", "issues" ], "type": "object", "properties": { "channelId": { "type": "string" }, "total": { "type": "integer", "format": "int32", "description": "Number of channel listings evaluated for publication readiness." }, "ready": { "type": "integer", "format": "int32" }, "blocked": { "type": "integer", "format": "int32" }, "unknown": { "type": "integer", "format": "int32" }, "missingCategoryMappings": { "type": "integer", "format": "int32" }, "missingRequiredAttributes": { "type": "integer", "format": "int32" }, "missingBrands": { "type": "integer", "format": "int32" }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/PublicationIssueDto" } } } }, "PublishReadyResultDto": { "required": [ "queued" ], "type": "object", "properties": { "queued": { "type": "integer", "format": "int32" } } }, "QueryEnumOfAreaLevel": { "enum": [ "level1", "level2", "level3" ], "type": "string" }, "QueryEnumOfCartStatus": { "enum": [ "inProgress", "pending", "completed", "abandoned", "cancelled", "expired", "failed" ], "type": "string" }, "QueryEnumOfCatalogGender": { "enum": [ "unisex", "men", "women", "kids", "baby" ], "type": "string" }, "QueryEnumOfCollectionStatus": { "enum": [ "draft", "active" ], "type": "string" }, "QueryEnumOfCollectionType": { "enum": [ "static", "dynamic" ], "type": "string" }, "QueryEnumOfCustomerStatus": { "enum": [ "active", "pendingVerification", "pendingApproval", "inactive", "blocked" ], "type": "string" }, "QueryEnumOfCustomerType": { "enum": [ "individual", "business" ], "type": "string" }, "QueryEnumOfFulfillmentOrderStatus": { "enum": [ "pendingAssignment", "pending", "inProgress", "readyToPickUp", "shipped", "delivered", "cancelled" ], "type": "string" }, "QueryEnumOfInvitationStatus": { "enum": [ "pending", "accepted", "rejected" ], "type": "string" }, "QueryEnumOfListingStatus": { "enum": [ "draft", "publishing", "active", "failed", "unpublished", "suspended", "syncError" ], "type": "string" }, "QueryEnumOfListingType": { "enum": [ "salesChannel", "source" ], "type": "string" }, "QueryEnumOfMemberStatus": { "enum": [ "active", "inactive", "suspended" ], "type": "string" }, "QueryEnumOfNotificationChannel": { "enum": [ "email", "sms", "push", "whatsApp", "inApp", "webhook" ], "type": "string" }, "QueryEnumOfOrderClaimStatus": { "enum": [ "open", "inReview", "resolved", "rejected", "closed", "cancelled" ], "type": "string" }, "QueryEnumOfOrderClaimType": { "enum": [ "claim", "complaint", "return", "refund", "other" ], "type": "string" }, "QueryEnumOfOrderDraftStatus": { "enum": [ "draft", "sent", "viewed", "accepted", "rejected", "expired", "converted", "cancelled" ], "type": "string" }, "QueryEnumOfOrderFulfillmentStatus": { "enum": [ "unfulfilled", "hold", "scheduled", "picking", "ready", "shipped", "delivered", "partial", "canceled" ], "type": "string" }, "QueryEnumOfOrderReturnStatus": { "enum": [ "none", "requested", "inProgress", "inspected", "returned", "rejected" ], "type": "string" }, "QueryEnumOfOrderState": { "enum": [ "open", "closed", "canceled", "invalid" ], "type": "string" }, "QueryEnumOfOrderStatus": { "enum": [ "new", "confirmed", "inProgress", "invoiced", "readyToPickUp", "inTransit", "delivered", "partialDelivered", "closed", "cancelled", "invalid", "pendingToConfirm", "pendingToDeliveredToClient", "returned", "partialReturned", "partialCancelled", "none" ], "type": "string" }, "QueryEnumOfPriceChangeReason": { "enum": [ "initial", "manualUpdate", "bulkEdit", "promotionStart", "promotionEnd", "costAdjustment", "import" ], "type": "string" }, "QueryEnumOfProductActivitySource": { "enum": [ "product", "price", "inventory" ], "type": "string" }, "QueryEnumOfProductListProjection": { "enum": [ "summary", "full", "spreadsheet" ], "type": "string" }, "QueryEnumOfProductStatus": { "enum": [ "draft", "active", "inactive", "outOfStock", "discontinued", "archived" ], "type": "string" }, "QueryEnumOfProductType": { "enum": [ "product", "service", "bundle" ], "type": "string" }, "QueryEnumOfPromotionStatus": { "enum": [ "draft", "active", "scheduled", "inactive" ], "type": "string" }, "QueryEnumOfPromotionTarget": { "enum": [ "order", "item", "shipping" ], "type": "string" }, "QueryEnumOfPromotionType": { "enum": [ "percentage", "fixedAmount", "freeShipping", "buyXGetY" ], "type": "string" }, "QueryEnumOfSellerStatus": { "enum": [ "active", "inactive", "deleted" ], "type": "string" }, "QueryEnumOfShippingMethodType": { "enum": [ "regular", "express", "sameDay", "pickup", "localDelivery" ], "type": "string" }, "QueryEnumOfShippingRateType": { "enum": [ "flat", "priceRange", "postalCode", "tableCost", "freeShipping", "weightBased" ], "type": "string" }, "QueryEnumOfSizeGuideMeasurementType": { "enum": [ "body", "garment", "foot", "accessory" ], "type": "string" }, "QueryEnumOfSortDirection": { "enum": [ "asc", "desc" ], "type": "string" }, "QueryEnumOfSpecificationLevel": { "enum": [ "product", "variant", "store", "seller", "all" ], "type": "string" }, "QueryEnumOfSpecificationType": { "enum": [ "input", "textArea", "select", "checkbox", "colorPicker", "datePicker", "timePicker", "dateTimePicker", "file" ], "type": "string" }, "QueryEnumOfTemplateScope": { "enum": [ "system", "store" ], "type": "string" }, "QueryEnumOfTransactionReason": { "enum": [ "inventoryCount", "damage", "expire", "misplacement", "theft", "other", "usedForStore", "promotion", "sale", "return", "restock", "systemCorrection", "initialImport", "transfer" ], "type": "string" }, "QueryEnumOfWebhookDeliveryStatus": { "enum": [ "success", "failed" ], "type": "string" }, "QueuedOperationResponse": { "required": [ "id", "status", "resource", "format", "createdOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "status": { "$ref": "#/components/schemas/OperationStatus" }, "resource": { "type": "string" }, "format": { "type": "string" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." } } }, "RefundPaymentRequest": { "required": [ "paymentTransactionId", "amount" ], "type": "object", "properties": { "paymentTransactionId": { "type": "string" }, "amount": { "type": [ "null", "number" ], "format": "double" } } }, "ReindexStoreProductsDto": { "required": [ "queued" ], "type": "object", "properties": { "queued": { "type": "integer", "format": "int32" } } }, "ReleaseInventoryDto": { "required": [ "storeId", "locationId", "lines" ], "type": "object", "properties": { "storeId": { "type": "string" }, "locationId": { "type": "string" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryStockLineModel" } } } }, "ReserveInventoryDto": { "required": [ "storeId", "locationId", "lines" ], "type": "object", "properties": { "storeId": { "type": "string" }, "locationId": { "type": "string" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryStockLineModel" } } } }, "Result": { "type": "object" }, "ResultOflong": { "type": "object", "properties": { "data": { "type": "integer", "format": "int64" }, "value": { "type": "integer", "format": "int64" } } }, "ReviewDto": { "required": [ "id", "productId", "productName", "customerId", "orderId", "isVerifiedPurchase", "rating", "title", "content", "reviewerName", "reviewerEmail", "status", "approvedAt", "approvedBy", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "productId": { "type": "string" }, "productName": { "type": "string" }, "customerId": { "type": [ "null", "string" ] }, "orderId": { "type": [ "null", "string" ] }, "isVerifiedPurchase": { "type": "boolean" }, "rating": { "type": "integer", "format": "int32" }, "title": { "type": [ "null", "string" ] }, "content": { "type": "string" }, "reviewerName": { "type": [ "null", "string" ] }, "reviewerEmail": { "type": [ "null", "string" ] }, "status": { "$ref": "#/components/schemas/ReviewStatus" }, "approvedAt": { "type": [ "null", "string" ], "format": "date-time" }, "approvedBy": { "type": [ "null", "string" ], "format": "uuid" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "ReviewRequest": { "required": [ "rating", "content", "title", "reviewerName", "reviewerEmail", "customerId", "orderId", "status" ], "type": "object", "properties": { "rating": { "type": "integer", "format": "int32" }, "content": { "type": "string" }, "title": { "type": [ "null", "string" ] }, "reviewerName": { "type": [ "null", "string" ] }, "reviewerEmail": { "type": [ "null", "string" ] }, "customerId": { "type": [ "null", "string" ] }, "orderId": { "type": [ "null", "string" ] }, "status": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ReviewStatus" } ] } } }, "ReviewStatus": { "enum": [ "pending", "approved", "rejected" ], "type": "string" }, "ReviewStatusRequest": { "required": [ "status" ], "type": "object", "properties": { "status": { "$ref": "#/components/schemas/ReviewStatus" } } }, "RoleItemDto": { "required": [ "id", "code", "name", "description", "scope", "isSystem", "isDefault", "membersCount", "status", "createdOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "scope": { "$ref": "#/components/schemas/RoleScope" }, "isSystem": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "membersCount": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/RoleStatus" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "RoleScope": { "enum": [ "store", "marketplace", "seller" ], "type": "string" }, "RoleStatus": { "enum": [ "active", "inactive" ], "type": "string" }, "RoutingLocationAssignmentDto": { "required": [ "locationId", "name", "isDefault", "items" ], "type": "object", "properties": { "locationId": { "type": "string" }, "name": { "type": "string" }, "isDefault": { "type": "boolean" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RoutingLocationItemDto" } } } }, "RoutingLocationItemDto": { "required": [ "variantId", "quantity" ], "type": "object", "properties": { "variantId": { "type": "string" }, "quantity": { "type": "integer", "format": "int32" } } }, "RoutingMode": { "enum": [ "defaultLocation", "highestStock", "priority" ], "type": "string" }, "RoutingPreviewDto": { "required": [ "routingMode", "splitFulfillmentEnabled", "canFulfill", "assignments", "unassignedItems" ], "type": "object", "properties": { "routingMode": { "$ref": "#/components/schemas/RoutingMode" }, "splitFulfillmentEnabled": { "type": "boolean" }, "canFulfill": { "type": "boolean" }, "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/RoutingLocationAssignmentDto" } }, "unassignedItems": { "type": "array", "items": { "$ref": "#/components/schemas/RoutingUnassignedItemDto" } } } }, "RoutingPreviewItemRequest": { "required": [ "variantId", "quantity" ], "type": "object", "properties": { "variantId": { "type": "string" }, "quantity": { "type": "integer", "format": "int32" } } }, "RoutingPreviewRequest": { "type": "object", "properties": { "allowSplitFulfillment": { "type": [ "null", "boolean" ] }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/RoutingPreviewItemRequest" } } } }, "RoutingUnassignedItemDto": { "required": [ "variantId", "quantity" ], "type": "object", "properties": { "variantId": { "type": "string" }, "quantity": { "type": "integer", "format": "int32" } } }, "RuleOperator": { "enum": [ "eq", "neq", "gt", "lt", "in", "notIn", "contains" ], "type": "string" }, "SellerCatalogSettingsDto": { "required": [ "publicationEnabled", "productApprovalPolicy", "promotionsEnabled" ], "type": "object", "properties": { "publicationEnabled": { "type": "boolean" }, "productApprovalPolicy": { "$ref": "#/components/schemas/SellerProductApprovalPolicy" }, "promotionsEnabled": { "type": "boolean" } } }, "SellerCommissionDto": { "required": [ "id", "target", "includeChildrenCategories", "productCommissionPercent", "isActive", "createdOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "target": { "$ref": "#/components/schemas/SellerCommissionTarget" }, "categoryId": { "type": [ "null", "string" ] }, "brandId": { "type": [ "null", "string" ] }, "includeChildrenCategories": { "type": "boolean" }, "productCommissionPercent": { "type": "number", "format": "double" }, "freightCommissionPercent": { "type": [ "null", "number" ], "format": "double" }, "fixedFee": { "type": [ "null", "number" ], "format": "double" }, "isActive": { "type": "boolean" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "SellerCommissionRequest": { "required": [ "target", "categoryId", "brandId", "includeChildrenCategories", "productCommissionPercent", "freightCommissionPercent", "fixedFee", "isActive" ], "type": "object", "properties": { "target": { "$ref": "#/components/schemas/SellerCommissionTarget" }, "categoryId": { "type": [ "null", "string" ] }, "brandId": { "type": [ "null", "string" ] }, "includeChildrenCategories": { "type": "boolean" }, "productCommissionPercent": { "type": "number", "format": "double" }, "freightCommissionPercent": { "type": [ "null", "number" ], "format": "double" }, "fixedFee": { "type": [ "null", "number" ], "format": "double" }, "isActive": { "type": "boolean" } } }, "SellerCommissionSource": { "enum": [ "seller", "category", "brand" ], "type": "string" }, "SellerCommissionTarget": { "enum": [ "category", "brand" ], "type": "string" }, "SellerDetailsDto": { "required": [ "id", "sellerId", "storeId", "name", "slug", "countryCode", "currencyCode", "commissionPercent", "isInternal", "catalogSettings", "shippingSettings", "legalInfo", "billingInfo", "profile", "fulfillment", "rating", "status", "createdOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "sellerId": { "type": "string" }, "storeId": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string", "description": "URL-friendly identifier." }, "countryCode": { "type": "string", "description": "ISO 3166-1 alpha-2 country code, for example `PE`." }, "currencyCode": { "type": "string", "description": "ISO 4217 currency code, for example `PEN`." }, "description": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "emailNotification": { "type": [ "null", "string" ] }, "deliveryPolicy": { "type": [ "null", "string" ] }, "privacyAndSecurityPolicy": { "type": [ "null", "string" ] }, "commissionPercent": { "type": "number", "format": "double" }, "exchangeRate": { "type": [ "null", "number" ], "format": "double" }, "isInternal": { "type": "boolean" }, "catalogSettings": { "$ref": "#/components/schemas/SellerCatalogSettingsDto" }, "shippingSettings": { "$ref": "#/components/schemas/SellerShippingSettingsDto" }, "legalInfo": { "$ref": "#/components/schemas/LegalInformationDto" }, "billingInfo": { "$ref": "#/components/schemas/BillingInformationDto" }, "profile": { "$ref": "#/components/schemas/SellerProfileDto" }, "fulfillment": { "$ref": "#/components/schemas/FulfillmentOptionsDto" }, "rating": { "$ref": "#/components/schemas/SellerRatingDto" }, "status": { "$ref": "#/components/schemas/SellerStatus" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "SellerFulfillmentMode": { "enum": [ "marketplaceFulfilled", "sellerFulfilled", "mixed" ], "type": "string" }, "SellerItemDto": { "required": [ "id", "name", "slug", "countryCode", "isVerified", "averageRating", "totalReviews", "isInternal", "membersCount", "status", "createdOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "name": { "type": "string" }, "slug": { "type": "string", "description": "URL-friendly identifier." }, "logoUrl": { "type": [ "null", "string" ] }, "countryCode": { "type": "string", "description": "ISO 3166-1 alpha-2 country code, for example `PE`." }, "isVerified": { "type": "boolean" }, "averageRating": { "type": "number", "format": "double" }, "totalReviews": { "type": "integer", "format": "int32" }, "isInternal": { "type": "boolean" }, "membersCount": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/SellerStatus" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." } } }, "SellerProductApprovalPolicy": { "enum": [ "manualReview", "autoApprove" ], "type": "string" }, "SellerProfileDto": { "required": [ "hasMedia", "hasSocialLinks" ], "type": "object", "properties": { "logo": { "type": [ "null", "string" ] }, "banner": { "type": [ "null", "string" ] }, "avatar": { "type": [ "null", "string" ] }, "backgroundImage": { "type": [ "null", "string" ] }, "website": { "type": [ "null", "string" ] }, "facebook": { "type": [ "null", "string" ] }, "instagram": { "type": [ "null", "string" ] }, "twitter": { "type": [ "null", "string" ] }, "linkedIn": { "type": [ "null", "string" ] }, "youTube": { "type": [ "null", "string" ] }, "tikTok": { "type": [ "null", "string" ] }, "hasMedia": { "type": "boolean" }, "hasSocialLinks": { "type": "boolean" } } }, "SellerRateManagementMode": { "enum": [ "marketplaceRates", "sellerRates", "hybrid" ], "type": "string" }, "SellerRatingDto": { "required": [ "averageRating", "totalReviews", "fiveStars", "fourStars", "threeStars", "twoStars", "oneStar", "hasReviews" ], "type": "object", "properties": { "averageRating": { "type": "number", "format": "double" }, "totalReviews": { "type": "integer", "format": "int32" }, "fiveStars": { "type": "integer", "format": "int32" }, "fourStars": { "type": "integer", "format": "int32" }, "threeStars": { "type": "integer", "format": "int32" }, "twoStars": { "type": "integer", "format": "int32" }, "oneStar": { "type": "integer", "format": "int32" }, "hasReviews": { "type": "boolean" } } }, "SellerScopeDto": { "required": [ "id", "type", "includeChildrenCategories", "createdOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "type": { "$ref": "#/components/schemas/SellerScopeType" }, "categoryId": { "type": [ "null", "string" ] }, "brandId": { "type": [ "null", "string" ] }, "includeChildrenCategories": { "type": "boolean" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "SellerScopeRequest": { "required": [ "type", "categoryId", "brandId", "includeChildrenCategories" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/SellerScopeType" }, "categoryId": { "type": [ "null", "string" ] }, "brandId": { "type": [ "null", "string" ] }, "includeChildrenCategories": { "type": "boolean" } } }, "SellerScopeType": { "enum": [ "category", "brand" ], "type": "string" }, "SellerShippingSettingsDto": { "required": [ "shippingEnabled", "shippingProfilesEnabled", "fulfillmentMode", "rateManagementMode", "allowedShippingMethods" ], "type": "object", "properties": { "shippingEnabled": { "type": "boolean" }, "shippingProfilesEnabled": { "type": "boolean" }, "fulfillmentMode": { "$ref": "#/components/schemas/SellerFulfillmentMode" }, "rateManagementMode": { "$ref": "#/components/schemas/SellerRateManagementMode" }, "allowedShippingMethods": { "type": "array", "items": { "type": "string" } }, "maxTransitDays": { "type": [ "null", "integer" ], "format": "int32" }, "minShippingRate": { "type": [ "null", "number" ], "format": "double" }, "maxShippingRate": { "type": [ "null", "number" ], "format": "double" } } }, "SellerStatus": { "enum": [ "active", "inactive", "deleted" ], "type": "string" }, "SetCollectionProductsRequest": { "type": "object", "properties": { "productIds": { "type": "array" } } }, "SetOrderDraftShippingMethodRequest": { "type": "object", "properties": { "sellerId": { "type": [ "null", "string" ] }, "shippingProfileId": { "type": [ "null", "string" ] }, "shippingMethodId": { "type": [ "null", "string" ] }, "rateId": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ] }, "pickupPointId": { "type": [ "null", "string" ] }, "scheduledDate": { "type": [ "null", "string" ], "format": "date" }, "scheduledTime": { "type": [ "null", "string" ], "format": "time" }, "serviceCode": { "type": [ "null", "string" ] } } }, "SetOrderPackageStatusRequest": { "required": [ "trackingNumber", "state" ], "type": "object", "properties": { "trackingNumber": { "type": "string" }, "state": { "$ref": "#/components/schemas/OrderPackageState" } } }, "ShipFulfillmentOrderRequest": { "type": "object", "properties": { "shipmentId": { "type": [ "null", "string" ] }, "trackingNumber": { "type": [ "null", "string" ] }, "trackingLink": { "type": [ "null", "string" ] }, "labelUrl": { "type": [ "null", "string" ] }, "carrierName": { "type": [ "null", "string" ] }, "packageId": { "type": [ "null", "string" ] }, "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/FulfillmentShipmentLineModel" } } } }, "ShipmentAddress": { "type": "object", "properties": { "addressLine": { "type": [ "null", "string" ] }, "number": { "type": [ "null", "string" ] }, "postalCode": { "type": [ "null", "string" ] }, "department": { "type": [ "null", "string" ] }, "province": { "type": [ "null", "string" ] }, "district": { "type": [ "null", "string" ] }, "reference": { "type": [ "null", "string" ] }, "latitude": { "type": "number", "format": "double", "default": 0 }, "longitude": { "type": "number", "format": "double", "default": 0 } } }, "ShipmentProduct": { "type": "object", "properties": { "sku": { "type": [ "null", "string" ], "description": "Stock keeping unit (SKU)." }, "name": { "type": [ "null", "string" ] }, "brand": { "type": [ "null", "string" ] }, "weight": { "type": "number", "format": "double", "default": 0 }, "price": { "type": "number", "format": "double", "default": 0 }, "qty": { "type": "integer", "format": "int32", "default": 1 }, "height": { "type": "number", "format": "double", "default": 0 }, "width": { "type": "number", "format": "double", "default": 0 }, "length": { "type": "number", "format": "double", "default": 0 } } }, "ShipmentTrackingDto": { "required": [ "success", "delivered", "events", "message" ], "type": "object", "properties": { "success": { "type": "boolean" }, "delivered": { "type": "boolean" }, "events": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ShipmentTrackingEventDto" } }, "message": { "type": [ "null", "string" ] } } }, "ShipmentTrackingEventDto": { "required": [ "group", "name", "description", "date", "images" ], "type": "object", "properties": { "group": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "date": { "type": [ "null", "string" ] }, "images": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "ShippingCoverageDto": { "required": [ "locations", "zones" ], "type": "object", "properties": { "locations": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingCoverageLocationDto" } }, "zones": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingCoverageZoneDto" } } } }, "ShippingCoverageLocalDeliveryZoneDto": { "required": [ "name", "postalCodes", "radiusKm", "fee", "freeFromAmount", "minHours", "maxHours" ], "type": "object", "properties": { "name": { "type": "string" }, "postalCodes": { "type": "array", "items": { "type": "string" } }, "radiusKm": { "type": [ "null", "number" ], "format": "double" }, "fee": { "type": [ "null", "number" ], "format": "double" }, "freeFromAmount": { "type": [ "null", "number" ], "format": "double" }, "minHours": { "type": [ "null", "integer" ], "format": "int32" }, "maxHours": { "type": [ "null", "integer" ], "format": "int32" } } }, "ShippingCoverageLocationDto": { "required": [ "id", "name", "code", "address", "city", "state", "country", "postalCode", "isActive", "isDefault", "supportsShipping", "supportsLocalDelivery", "supportsPickup", "localDeliveryPostalCodes", "localDeliveryZones", "profiles", "pickupPoints" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "name": { "type": "string" }, "code": { "type": "string" }, "address": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "state": { "type": [ "null", "string" ] }, "country": { "type": [ "null", "string" ] }, "postalCode": { "type": [ "null", "string" ] }, "isActive": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "supportsShipping": { "type": "boolean" }, "supportsLocalDelivery": { "type": "boolean" }, "supportsPickup": { "type": "boolean" }, "localDeliveryPostalCodes": { "type": "array", "items": { "type": "string" } }, "localDeliveryZones": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingCoverageLocalDeliveryZoneDto" } }, "profiles": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingCoverageProfileDto" } }, "pickupPoints": { "type": "array", "items": { "$ref": "#/components/schemas/ShippingCoveragePickupPointDto" } } } }, "ShippingCoveragePickupPointDto": { "required": [ "id", "name", "city", "state", "postalCode", "address", "isExternal", "status" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "name": { "type": "string" }, "city": { "type": [ "null", "string" ] }, "state": { "type": [ "null", "string" ] }, "postalCode": { "type": [ "null", "string" ] }, "address": { "type": [ "null", "string" ] }, "isExternal": { "type": "boolean" }, "status": { "$ref": "#/components/schemas/PickupPointStatus" } } }, "ShippingCoverageProfileDto": { "required": [ "id", "name", "isDefault", "isActive" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "name": { "type": "string" }, "isDefault": { "type": "boolean" }, "isActive": { "type": "boolean" } } }, "ShippingCoverageZoneDto": { "required": [ "id", "code", "name", "description", "countryCodes", "provinceCodes", "cityNames", "districtNames", "postalCodes", "isActive" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "countryCodes": { "type": "array", "items": { "type": "string" } }, "provinceCodes": { "type": "array", "items": { "type": "string" } }, "cityNames": { "type": "array", "items": { "type": "string" } }, "districtNames": { "type": "array", "items": { "type": "string" } }, "postalCodes": { "type": "array", "items": { "type": "string" } }, "isActive": { "type": "boolean" } } }, "ShippingCustomizationDetailsDto": { "required": [ "id", "storeId", "shippingMethodId", "name", "priority", "isActive", "hideInCheckout", "displayName", "sortOrder", "sellerId", "shippingProfileId", "minOrderAmount", "maxOrderAmount", "minWeight", "maxWeight", "availableDays", "startTime", "endTime", "postalCodes", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "shippingMethodId": { "type": "string" }, "name": { "type": "string" }, "priority": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "hideInCheckout": { "type": "boolean" }, "displayName": { "type": [ "null", "string" ] }, "sortOrder": { "type": [ "null", "integer" ], "format": "int32" }, "sellerId": { "type": [ "null", "string" ] }, "shippingProfileId": { "type": [ "null", "string" ] }, "minOrderAmount": { "type": [ "null", "number" ], "format": "double" }, "maxOrderAmount": { "type": [ "null", "number" ], "format": "double" }, "minWeight": { "type": [ "null", "number" ], "format": "double" }, "maxWeight": { "type": [ "null", "number" ], "format": "double" }, "availableDays": { "type": "array" }, "startTime": { "type": [ "null", "string" ], "format": "time" }, "endTime": { "type": [ "null", "string" ], "format": "time" }, "postalCodes": { "type": "array", "items": { "type": "string" } }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "ShippingCustomizationRequest": { "type": "object", "properties": { "shippingMethodId": { "type": "string" }, "name": { "type": "string" }, "priority": { "type": "integer", "format": "int32" }, "isActive": { "type": "boolean" }, "hideInCheckout": { "type": "boolean" }, "displayName": { "type": [ "null", "string" ] }, "sortOrder": { "type": [ "null", "integer" ], "format": "int32" }, "sellerId": { "type": [ "null", "string" ] }, "shippingProfileId": { "type": [ "null", "string" ] }, "minOrderAmount": { "type": [ "null", "number" ], "format": "double" }, "maxOrderAmount": { "type": [ "null", "number" ], "format": "double" }, "minWeight": { "type": [ "null", "number" ], "format": "double" }, "maxWeight": { "type": [ "null", "number" ], "format": "double" }, "availableDays": { "type": "array" }, "startTime": { "type": [ "null", "string" ], "format": "time" }, "endTime": { "type": [ "null", "string" ], "format": "time" }, "postalCodes": { "type": "array", "items": { "type": "string" } } } }, "ShippingEstimateItemModel": { "required": [ "sku", "name", "brand", "weight", "price", "quantity", "height", "width", "length" ], "type": "object", "properties": { "sku": { "type": [ "null", "string" ], "description": "Stock keeping unit (SKU)." }, "name": { "type": "string" }, "brand": { "type": [ "null", "string" ] }, "weight": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" }, "quantity": { "type": "integer", "format": "int32" }, "height": { "type": "number", "format": "double" }, "width": { "type": "number", "format": "double" }, "length": { "type": "number", "format": "double" } } }, "ShippingEstimateModel": { "required": [ "storeId", "orderAmount", "postalCode", "totalWeight", "sellerId", "shippingProfileId" ], "type": "object", "properties": { "storeId": { "type": "string" }, "orderAmount": { "type": "number", "format": "double" }, "postalCode": { "type": [ "null", "string" ] }, "totalWeight": { "type": "number", "format": "double" }, "sellerId": { "type": [ "null", "string" ] }, "shippingProfileId": { "type": [ "null", "string" ] }, "destination": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/Address" } ] }, "items": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ShippingEstimateItemModel" } }, "scheduledDate": { "type": [ "null", "string" ], "format": "date" }, "scheduledTime": { "type": [ "null", "string" ], "format": "time" } } }, "ShippingEstimateOptionModel": { "type": "object", "properties": { "shippingMethodId": { "type": "string" }, "name": { "type": "string" }, "displayName": { "type": "string" }, "type": { "$ref": "#/components/schemas/ShippingMethodType" }, "price": { "type": "number", "format": "double" }, "currency": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32" }, "rateId": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "deliveryLocationId": { "type": [ "null", "string" ] }, "deliveryLocationName": { "type": [ "null", "string" ] }, "deliveryLeadTimeInMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "deliveryMinHours": { "type": [ "null", "integer" ], "format": "int32" }, "deliveryMaxHours": { "type": [ "null", "integer" ], "format": "int32" }, "deliveryInstructions": { "type": [ "null", "string" ] }, "deliveryPostalCodes": { "type": "array", "items": { "type": "string" } }, "deliveryZoneName": { "type": [ "null", "string" ] }, "deliveryZonePostalCodes": { "type": "array", "items": { "type": "string" } }, "deliveryZoneRadiusKm": { "type": [ "null", "number" ], "format": "double" }, "estimatedDeliveryDays": { "type": [ "null", "integer" ], "format": "int32" }, "estimatedDeliveryHours": { "type": [ "null", "integer" ], "format": "int32" }, "estimatedDeliveryFromDate": { "type": [ "null", "string" ], "format": "date" }, "estimatedDeliveryToDate": { "type": [ "null", "string" ], "format": "date" }, "isLiveQuote": { "type": "boolean" }, "serviceCode": { "type": [ "null", "string" ] }, "serviceName": { "type": [ "null", "string" ] }, "metadata": { "type": "object" } } }, "ShippingMethodDetailsDto": { "required": [ "id", "storeId", "sellerId", "name", "displayName", "type", "isActive", "visibleInCheckout", "sortOrder", "shippingProfileId", "minOrderAmount", "maxOrderAmount", "minWeight", "maxWeight", "allowSplitFulfillment", "availableDays", "basePrice", "currency", "estimatedDeliveryDays", "estimatedDeliveryHours", "allowShowCalendar", "metadata", "connectionId", "pickupPointIds", "rates", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "sellerId": { "type": [ "null", "string" ] }, "name": { "type": "string" }, "displayName": { "type": "string" }, "type": { "$ref": "#/components/schemas/ShippingMethodType" }, "isActive": { "type": "boolean" }, "visibleInCheckout": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "shippingProfileId": { "type": [ "null", "string" ] }, "minOrderAmount": { "type": [ "null", "number" ], "format": "double" }, "maxOrderAmount": { "type": [ "null", "number" ], "format": "double" }, "minWeight": { "type": [ "null", "number" ], "format": "double" }, "maxWeight": { "type": [ "null", "number" ], "format": "double" }, "allowSplitFulfillment": { "type": "boolean" }, "availableDays": { "type": "array" }, "basePrice": { "type": "number", "format": "double" }, "currency": { "type": "string" }, "estimatedDeliveryDays": { "type": [ "null", "integer" ], "format": "int32" }, "estimatedDeliveryHours": { "type": [ "null", "integer" ], "format": "int32" }, "allowShowCalendar": { "type": "boolean" }, "metadata": { "type": "object" }, "connectionId": { "type": [ "null", "string" ] }, "pickupPointIds": { "type": "array" }, "rates": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ShippingRateDto" } }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "ShippingMethodRequest": { "type": "object", "properties": { "name": { "type": "string" }, "displayName": { "type": [ "null", "string" ] }, "type": { "$ref": "#/components/schemas/ShippingMethodType" }, "basePrice": { "type": "number", "format": "double" }, "currency": { "type": "string" }, "estimatedDeliveryDays": { "type": [ "null", "integer" ], "format": "int32" }, "estimatedDeliveryHours": { "type": [ "null", "integer" ], "format": "int32" }, "allowShowCalendar": { "type": "boolean" }, "visibleInCheckout": { "type": "boolean" }, "sortOrder": { "type": "integer", "format": "int32" }, "shippingProfileId": { "type": [ "null", "string" ] }, "minOrderAmount": { "type": [ "null", "number" ], "format": "double" }, "maxOrderAmount": { "type": [ "null", "number" ], "format": "double" }, "minWeight": { "type": [ "null", "number" ], "format": "double" }, "maxWeight": { "type": [ "null", "number" ], "format": "double" }, "allowSplitFulfillment": { "type": "boolean" }, "availableDays": { "type": "array" }, "metadata": { "type": "object" }, "connectionId": { "type": [ "null", "string" ] }, "pickupPointIds": { "type": "array" } } }, "ShippingMethodSlotsInputModel": { "required": [ "storeId", "shippingMethodId", "locationId", "pickupPointId", "postalCode", "latitude", "longitude", "date" ], "type": "object", "properties": { "storeId": { "type": "string" }, "shippingMethodId": { "type": "string" }, "locationId": { "type": [ "null", "string" ] }, "pickupPointId": { "type": [ "null", "string" ] }, "postalCode": { "type": [ "null", "string" ] }, "latitude": { "type": [ "null", "number" ], "format": "double" }, "longitude": { "type": [ "null", "number" ], "format": "double" }, "date": { "type": "string", "format": "date" } } }, "ShippingMethodSlotsModel": { "required": [ "shippingMethodId", "type", "locationId", "pickupPointId", "date", "capacity", "scheduledCount", "slots" ], "type": "object", "properties": { "shippingMethodId": { "type": "string" }, "type": { "$ref": "#/components/schemas/ShippingMethodType" }, "locationId": { "type": [ "null", "string" ] }, "pickupPointId": { "type": [ "null", "string" ] }, "date": { "type": "string", "format": "date" }, "capacity": { "type": [ "null", "integer" ], "format": "int32" }, "scheduledCount": { "type": "integer", "format": "int32" }, "slots": { "type": "array", "items": { "type": "string", "format": "time" } } } }, "ShippingMethodType": { "enum": [ "regular", "express", "sameDay", "pickup", "localDelivery" ], "type": "string" }, "ShippingProfileModel": { "required": [ "id", "storeId", "sellerId", "name", "description", "locationIds", "isDefault", "isActive", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "sellerId": { "type": [ "null", "string" ] }, "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "locationIds": { "type": "array" }, "isDefault": { "type": "boolean" }, "isActive": { "type": "boolean" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "ShippingProfileRequest": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "locationIds": { "type": "array" }, "isDefault": { "type": "boolean" } } }, "ShippingQuoteOption": { "required": [ "name", "price" ], "type": "object", "properties": { "name": { "type": "string" }, "price": { "type": "number", "format": "double" }, "currency": { "type": [ "null", "string" ] }, "estimatedDays": { "type": [ "null", "integer" ], "format": "int32" }, "serviceCode": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] } } }, "ShippingQuoteResult": { "required": [ "success" ], "type": "object", "properties": { "success": { "type": "boolean" }, "options": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ShippingQuoteOption" } }, "code": { "type": [ "null", "string" ] }, "message": { "type": [ "null", "string" ] } } }, "ShippingRateDto": { "required": [ "id", "storeId", "sellerId", "shippingMethodId", "type", "price", "currency", "minOrderPrice", "maxOrderPrice", "postalCodes", "isActive", "description", "discountPercentage", "zoneCode", "minWeight", "maxWeight", "minValue", "maxValue", "basePrice", "pricePerKg", "pricePerUnit", "taxIncluded", "surcharge", "deliveryLocationId", "deliveryLocationName", "deliveryLeadTimeInMinutes", "deliveryMinHours", "deliveryMaxHours", "metadata", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "sellerId": { "type": [ "null", "string" ] }, "shippingMethodId": { "type": "string" }, "type": { "$ref": "#/components/schemas/ShippingRateType" }, "price": { "type": [ "null", "number" ], "format": "double" }, "currency": { "type": "string" }, "minOrderPrice": { "type": [ "null", "number" ], "format": "double" }, "maxOrderPrice": { "type": [ "null", "number" ], "format": "double" }, "postalCodes": { "type": "array", "items": { "type": "string" } }, "isActive": { "type": "boolean" }, "description": { "type": [ "null", "string" ] }, "discountPercentage": { "type": [ "null", "number" ], "format": "double" }, "zoneCode": { "type": [ "null", "string" ] }, "minWeight": { "type": "number", "format": "double" }, "maxWeight": { "type": [ "null", "number" ], "format": "double" }, "minValue": { "type": "number", "format": "double" }, "maxValue": { "type": [ "null", "number" ], "format": "double" }, "basePrice": { "type": "number", "format": "double" }, "pricePerKg": { "type": "number", "format": "double" }, "pricePerUnit": { "type": "number", "format": "double" }, "taxIncluded": { "type": [ "null", "boolean" ] }, "surcharge": { "type": [ "null", "number" ], "format": "double" }, "deliveryLocationId": { "type": [ "null", "string" ] }, "deliveryLocationName": { "type": [ "null", "string" ] }, "deliveryLeadTimeInMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "deliveryMinHours": { "type": [ "null", "integer" ], "format": "int32" }, "deliveryMaxHours": { "type": [ "null", "integer" ], "format": "int32" }, "metadata": { "type": "object" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "ShippingRateImportDto": { "required": [ "processedRows", "createdCount", "updatedCount" ], "type": "object", "properties": { "processedRows": { "type": "integer", "format": "int32" }, "createdCount": { "type": "integer", "format": "int32" }, "updatedCount": { "type": "integer", "format": "int32" } } }, "ShippingRateImportRequest": { "type": "object", "properties": { "assetId": { "type": [ "null", "string" ] }, "rows": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ShippingRateImportRow" } } } }, "ShippingRateImportRow": { "type": "object", "properties": { "shippingRateId": { "type": [ "null", "string" ] }, "shippingMethodId": { "type": [ "null", "string" ] }, "shippingMethod": { "type": [ "null", "string" ] }, "shippingMethodName": { "type": [ "null", "string" ] }, "type": { "type": [ "null", "string" ] }, "shippingZone": { "type": [ "null", "string" ] }, "zoneCode": { "type": [ "null", "string" ] }, "price": { "type": [ "null", "string" ] }, "currency": { "type": [ "null", "string" ] }, "minOrderPrice": { "type": [ "null", "string" ] }, "maxOrderPrice": { "type": [ "null", "string" ] }, "postalCodes": { "type": [ "null", "string" ] }, "isActive": { "type": [ "null", "string" ] }, "checkoutLabel": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "discountPercentage": { "type": [ "null", "string" ] }, "minWeight": { "type": [ "null", "string" ] }, "maxWeight": { "type": [ "null", "string" ] }, "minValue": { "type": [ "null", "string" ] }, "maxValue": { "type": [ "null", "string" ] }, "basePrice": { "type": [ "null", "string" ] }, "pricePerKg": { "type": [ "null", "string" ] }, "pricePerUnit": { "type": [ "null", "string" ] }, "taxIncluded": { "type": [ "null", "string" ] }, "surcharge": { "type": [ "null", "string" ] }, "metadataJson": { "type": [ "null", "string" ] } } }, "ShippingRateRequest": { "type": "object", "properties": { "shippingMethodId": { "type": "string" }, "type": { "$ref": "#/components/schemas/ShippingRateType" }, "zoneCode": { "type": [ "null", "string" ] }, "price": { "type": [ "null", "number" ], "format": "double" }, "currency": { "type": "string" }, "minOrderPrice": { "type": [ "null", "number" ], "format": "double" }, "maxOrderPrice": { "type": [ "null", "number" ], "format": "double" }, "postalCodes": { "type": "array", "items": { "type": "string" } }, "isActive": { "type": "boolean" }, "description": { "type": [ "null", "string" ] }, "discountPercentage": { "type": [ "null", "number" ], "format": "double" }, "minWeight": { "type": "number", "format": "double" }, "maxWeight": { "type": [ "null", "number" ], "format": "double" }, "minValue": { "type": "number", "format": "double" }, "maxValue": { "type": [ "null", "number" ], "format": "double" }, "basePrice": { "type": "number", "format": "double" }, "pricePerKg": { "type": "number", "format": "double" }, "pricePerUnit": { "type": "number", "format": "double" }, "taxIncluded": { "type": [ "null", "boolean" ] }, "surcharge": { "type": [ "null", "number" ], "format": "double" }, "metadata": { "type": "object" } } }, "ShippingRateType": { "enum": [ "flat", "priceRange", "postalCode", "tableCost", "freeShipping", "weightBased" ], "type": "string" }, "ShippingSettingsDto": { "required": [ "storeId", "defaultLocationId", "estimatedDeliveryEnabled", "estimatedDeliveryFulfillmentDays", "pickupEnabled", "localDeliveryEnabled", "useLiveRates" ], "type": "object", "properties": { "storeId": { "type": "string" }, "defaultLocationId": { "type": [ "null", "string" ] }, "estimatedDeliveryEnabled": { "type": "boolean" }, "estimatedDeliveryFulfillmentDays": { "type": "integer", "format": "int32" }, "pickupEnabled": { "type": "boolean" }, "localDeliveryEnabled": { "type": "boolean" }, "useLiveRates": { "type": "boolean" } } }, "ShippingSettingsRequest": { "type": "object", "properties": { "defaultLocationId": { "type": [ "null", "string" ] }, "estimatedDeliveryEnabled": { "type": "boolean" }, "estimatedDeliveryFulfillmentDays": { "type": "integer", "format": "int32" }, "pickupEnabled": { "type": "boolean" }, "localDeliveryEnabled": { "type": "boolean" }, "useLiveRates": { "type": "boolean" } } }, "ShippingZoneDetailsDto": { "required": [ "id", "storeId", "code", "name", "description", "countryCodes", "provinceCodes", "cityNames", "districtNames", "postalCodes", "isActive", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "countryCodes": { "type": "array", "items": { "type": "string" } }, "provinceCodes": { "type": "array", "items": { "type": "string" } }, "cityNames": { "type": "array", "items": { "type": "string" } }, "districtNames": { "type": "array", "items": { "type": "string" } }, "postalCodes": { "type": "array", "items": { "type": "string" } }, "isActive": { "type": "boolean" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "ShippingZoneRequest": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "countryCodes": { "type": "array", "items": { "type": "string" } }, "provinceCodes": { "type": "array", "items": { "type": "string" } }, "cityNames": { "type": "array", "items": { "type": "string" } }, "districtNames": { "type": "array", "items": { "type": "string" } }, "postalCodes": { "type": "array", "items": { "type": "string" } } } }, "SizeGuideAssignmentDto": { "required": [ "id", "sizeGuideId", "includeChildrenCategories", "priority", "createdOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "sizeGuideId": { "type": "string" }, "productId": { "type": [ "null", "string" ] }, "productName": { "type": [ "null", "string" ] }, "categoryId": { "type": [ "null", "string" ] }, "categoryName": { "type": [ "null", "string" ] }, "includeChildrenCategories": { "type": "boolean" }, "priority": { "type": "integer", "format": "int32" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." } } }, "SizeGuideAssignmentInput": { "type": "object", "properties": { "productId": { "type": [ "null", "string" ] }, "categoryId": { "type": [ "null", "string" ] }, "includeChildrenCategories": { "type": "boolean" }, "priority": { "type": "integer", "format": "int32" } } }, "SizeGuideDetailsDto": { "required": [ "id", "storeId", "name", "slug", "gender", "measurementType", "unit", "status", "priority", "rows", "assignments", "createdOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "sellerId": { "type": [ "null", "string" ] }, "name": { "type": "string" }, "slug": { "type": "string", "description": "URL-friendly identifier." }, "description": { "type": [ "null", "string" ] }, "imageUrl": { "type": [ "null", "string" ] }, "gender": { "$ref": "#/components/schemas/CatalogGender" }, "measurementType": { "$ref": "#/components/schemas/SizeGuideMeasurementType" }, "unit": { "$ref": "#/components/schemas/SizeGuideUnit" }, "status": { "$ref": "#/components/schemas/SizeGuideStatus" }, "priority": { "type": "integer", "format": "int32" }, "notes": { "type": [ "null", "string" ] }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/SizeGuideRowItemDto" } }, "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/SizeGuideAssignmentDto" } }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "SizeGuideExportRequest": { "type": "object", "properties": { "format": { "type": "string" }, "search": { "type": [ "null", "string" ], "description": "Free-text filter. Which fields it covers depends on the resource." }, "sizeGuideIds": { "type": [ "null", "array" ] }, "gender": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CatalogGender" } ] }, "measurementType": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SizeGuideMeasurementType" } ] }, "status": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SizeGuideStatus" } ] }, "sellerIds": { "type": [ "null", "array" ] }, "template": { "type": "boolean" } } }, "SizeGuideItemDto": { "required": [ "id", "name", "slug", "gender", "measurementType", "unit", "rows" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "name": { "type": "string" }, "slug": { "type": "string", "description": "URL-friendly identifier." }, "description": { "type": [ "null", "string" ] }, "imageUrl": { "type": [ "null", "string" ] }, "gender": { "$ref": "#/components/schemas/CatalogGender" }, "measurementType": { "$ref": "#/components/schemas/SizeGuideMeasurementType" }, "unit": { "$ref": "#/components/schemas/SizeGuideUnit" }, "notes": { "type": [ "null", "string" ] }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/SizeGuideRowItemDto" } } } }, "SizeGuideMeasurementItemDto": { "required": [ "key", "name" ], "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "min": { "type": [ "null", "number" ], "format": "double" }, "max": { "type": [ "null", "number" ], "format": "double" }, "value": { "type": [ "null", "number" ], "format": "double" }, "description": { "type": [ "null", "string" ] } } }, "SizeGuideMeasurementType": { "enum": [ "body", "garment", "foot", "accessory" ], "type": "string" }, "SizeGuideRequest": { "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": [ "null", "string" ], "description": "URL-friendly identifier." }, "description": { "type": [ "null", "string" ] }, "imageUrl": { "type": [ "null", "string" ] }, "gender": { "$ref": "#/components/schemas/CatalogGender" }, "measurementType": { "$ref": "#/components/schemas/SizeGuideMeasurementType" }, "unit": { "$ref": "#/components/schemas/SizeGuideUnit" }, "status": { "$ref": "#/components/schemas/SizeGuideStatus" }, "priority": { "type": "integer", "format": "int32" }, "notes": { "type": [ "null", "string" ] }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/SizeGuideRowItemDto" } } } }, "SizeGuideRowItemDto": { "required": [ "label", "order", "measurements" ], "type": "object", "properties": { "label": { "type": "string" }, "sizeKey": { "type": [ "null", "string" ] }, "order": { "type": "integer", "format": "int32" }, "measurements": { "type": "array", "items": { "$ref": "#/components/schemas/SizeGuideMeasurementItemDto" } } } }, "SizeGuideStatus": { "enum": [ "draft", "active", "inactive" ], "type": "string" }, "SizeGuideSummaryDto": { "required": [ "id", "storeId", "name", "slug", "gender", "measurementType", "unit", "status", "priority", "rowsCount", "assignmentsCount", "createdOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "sellerId": { "type": [ "null", "string" ] }, "name": { "type": "string" }, "slug": { "type": "string", "description": "URL-friendly identifier." }, "imageUrl": { "type": [ "null", "string" ] }, "gender": { "$ref": "#/components/schemas/CatalogGender" }, "measurementType": { "$ref": "#/components/schemas/SizeGuideMeasurementType" }, "unit": { "$ref": "#/components/schemas/SizeGuideUnit" }, "status": { "$ref": "#/components/schemas/SizeGuideStatus" }, "priority": { "type": "integer", "format": "int32" }, "rowsCount": { "type": "integer", "format": "int32" }, "assignmentsCount": { "type": "integer", "format": "int32" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "SizeGuideUnit": { "enum": [ "cm", "in" ], "type": "string" }, "SortDirection": { "enum": [ "asc", "desc" ], "type": [ "null", "string" ] }, "SpecificationDetailsDto": { "required": [ "id", "storeId", "name", "key", "aliases", "isMultiple", "isRequired", "isFilterable", "isSearchable", "order", "status", "type", "level", "values", "metadata", "createdOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "name": { "type": "string" }, "key": { "type": "string" }, "aliases": { "type": "array", "items": { "type": "string" } }, "description": { "type": [ "null", "string" ] }, "isMultiple": { "type": "boolean" }, "isRequired": { "type": "boolean" }, "isFilterable": { "type": "boolean" }, "isSearchable": { "type": "boolean" }, "order": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/SpecificationStatus" }, "type": { "$ref": "#/components/schemas/SpecificationType" }, "level": { "$ref": "#/components/schemas/SpecificationLevel" }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/SpecificationValueDto" } }, "metadata": { "type": "object" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "SpecificationItemDto": { "required": [ "id", "storeId", "name", "key", "aliases", "order", "status", "type", "level" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "name": { "type": "string" }, "key": { "type": "string" }, "aliases": { "type": "array", "items": { "type": "string" } }, "order": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/SpecificationStatus" }, "type": { "$ref": "#/components/schemas/SpecificationType" }, "level": { "$ref": "#/components/schemas/SpecificationLevel" } } }, "SpecificationLevel": { "enum": [ "product", "variant", "store", "seller", "all" ], "type": "string" }, "SpecificationModel": { "required": [ "name", "value" ], "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "key": { "type": [ "null", "string" ] } } }, "SpecificationStatus": { "enum": [ "inactive", "active" ], "type": "string" }, "SpecificationType": { "enum": [ "input", "textArea", "select", "checkbox", "colorPicker", "datePicker", "timePicker", "dateTimePicker", "file" ], "type": "string" }, "SpecificationValueDto": { "required": [ "id", "value", "name", "isDefault", "order" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "value": { "type": "string" }, "name": { "type": "string" }, "isDefault": { "type": "boolean" }, "order": { "type": "integer", "format": "int32" } } }, "StartPaymentRequest": { "required": [ "orderId", "orderGroup", "paymentMethodCode", "amount", "currency", "externalRef", "payerEmail" ], "type": "object", "properties": { "orderId": { "type": "string" }, "orderGroup": { "type": [ "null", "string" ] }, "paymentMethodCode": { "type": "string" }, "amount": { "type": "number", "format": "double" }, "currency": { "type": "string" }, "externalRef": { "type": [ "null", "string" ] }, "payerEmail": { "type": [ "null", "string" ] }, "lineItems": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/PaymentLineItemModel" } }, "receiptUrl": { "type": [ "null", "string" ] }, "token": { "type": [ "null", "string" ] }, "providerPaymentMethodId": { "type": [ "null", "string" ] }, "deviceSessionId": { "type": [ "null", "string" ] } } }, "StartPaymentResultModel": { "required": [ "transactionId", "status", "isCaptured", "paymentMethodCode", "code", "cardType", "amount", "reference", "providerId", "publicConfiguration", "clientSecret", "checkoutUrl", "checkoutHtml", "qrCode", "receiptUrl", "expiresAt" ], "type": "object", "properties": { "transactionId": { "type": "string" }, "status": { "$ref": "#/components/schemas/PaymentStatus" }, "isCaptured": { "type": "boolean" }, "paymentMethodCode": { "type": "string" }, "code": { "type": "string" }, "cardType": { "type": [ "null", "string" ] }, "amount": { "type": "number", "format": "double" }, "reference": { "type": "string" }, "providerId": { "type": [ "null", "string" ] }, "publicConfiguration": { "type": "object", "additionalProperties": { "type": "string" } }, "clientSecret": { "type": [ "null", "string" ] }, "checkoutUrl": { "type": [ "null", "string" ] }, "checkoutHtml": { "type": [ "null", "string" ] }, "qrCode": { "type": [ "null", "string" ] }, "receiptUrl": { "type": [ "null", "string" ] }, "expiresAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "StoreCheckoutCartPageSettings": { "type": "object", "properties": { "showShippingCostCalculation": { "type": "boolean" }, "allowProductLinks": { "type": "boolean" }, "redirectToCartPage": { "type": "boolean" } } }, "StoreCheckoutGeneralSettings": { "type": "object", "properties": { "allowGuestCheckout": { "type": "boolean" }, "identityScope": { "$ref": "#/components/schemas/CustomerIdentityScope" }, "signInMethods": { "type": "array" }, "useSequentialOrderNumbers": { "type": "boolean" }, "automaticallySelectFirstAddress": { "type": "boolean" }, "alwaysRequestCustomerAddress": { "type": "boolean" }, "requestCustomerDateOfBirth": { "type": "boolean" }, "automaticallySelectBestPromotion": { "type": "boolean" } } }, "StoreCheckoutOrderBumpSettings": { "type": "object", "properties": { "mergeOrderBumpOrders": { "type": "boolean" }, "allowOnlyOneAdditionalOffer": { "type": "boolean" }, "maxVisibleOffers": { "type": "integer", "format": "int32" } } }, "StoreCheckoutOrdersAndPaymentsSettings": { "type": "object", "properties": { "allowPurchasesFrom": { "$ref": "#/components/schemas/CheckoutBuyerType" }, "creditCardDailyOrderLimitPerIp": { "type": [ "null", "integer" ], "format": "int32" }, "maximumItemsPerOrder": { "type": [ "null", "integer" ], "format": "int32" }, "deliveryNoteText": { "type": [ "null", "string" ] }, "boletoPaymentNoteText": { "type": [ "null", "string" ] } } }, "StoreCheckoutSettings": { "type": "object", "properties": { "general": { "$ref": "#/components/schemas/StoreCheckoutGeneralSettings" }, "shipping": { "$ref": "#/components/schemas/StoreCheckoutShippingSettings" }, "cartPage": { "$ref": "#/components/schemas/StoreCheckoutCartPageSettings" }, "orderBumps": { "$ref": "#/components/schemas/StoreCheckoutOrderBumpSettings" }, "ordersAndPayments": { "$ref": "#/components/schemas/StoreCheckoutOrdersAndPaymentsSettings" } } }, "StoreCheckoutShippingSettings": { "type": "object", "properties": { "showDeliveryTime": { "type": "boolean" }, "showDeliveryTimeInDays": { "type": "boolean" }, "useBusinessDaysForDeliveryTime": { "type": "boolean" }, "showEstimatedDeliveryDateInThankYouAndEmails": { "type": "boolean" }, "showOriginalShippingPriceWhenFree": { "type": "boolean" } } }, "StoreContextDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "tenantId": { "type": "string" }, "sellerId": { "type": [ "null", "string" ] }, "plan": { "type": "string" }, "storageLimitBytes": { "type": "integer", "format": "int64" }, "monthlyTransferLimitBytes": { "type": "integer", "format": "int64" }, "maxUploadSizeBytes": { "type": "integer", "format": "int64" }, "maxStores": { "type": "integer", "format": "int32" }, "maxMembers": { "type": "integer", "format": "int32" }, "maxProducts": { "type": "integer", "format": "int32" }, "maxCategories": { "type": "integer", "format": "int32" }, "maxBrands": { "type": "integer", "format": "int32" }, "maxAttributes": { "type": "integer", "format": "int32" }, "maxCollections": { "type": "integer", "format": "int32" }, "enableApi": { "type": "boolean" }, "isActive": { "type": "boolean" }, "name": { "type": "string" }, "description": { "type": "string" }, "avatarUrl": { "type": [ "null", "string" ] }, "logo": { "type": [ "null", "string" ] }, "icon": { "type": [ "null", "string" ] }, "slug": { "type": [ "null", "string" ], "description": "URL-friendly identifier." }, "domain": { "type": [ "null", "string" ] }, "domains": { "type": "array", "items": { "type": "string" } }, "timeZone": { "type": "string", "description": "IANA time zone name, for example `America/Lima`." }, "currency": { "type": "string" }, "language": { "type": "string" }, "visibility": { "$ref": "#/components/schemas/StoreVisibility" }, "privateAccessVersion": { "type": "integer", "format": "int32" }, "themeConfig": { "$ref": "#/components/schemas/StoreThemeSettings" }, "featuresEnabled": { "$ref": "#/components/schemas/StoreFeatureFlags" }, "checkoutSettings": { "$ref": "#/components/schemas/StoreCheckoutSettings" } } }, "StoreDetailsDto": { "required": [ "id", "name", "storeType", "status", "provisioningStatus" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "name": { "type": "string" }, "slug": { "type": [ "null", "string" ], "description": "URL-friendly identifier." }, "domain": { "type": [ "null", "string" ] }, "logo": { "type": [ "null", "string" ] }, "icon": { "type": [ "null", "string" ] }, "currentUser": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MemberContextDto" } ] }, "storeType": { "$ref": "#/components/schemas/StoreType" }, "description": { "type": [ "null", "string" ] }, "status": { "$ref": "#/components/schemas/StoreStatus" }, "provisioningStatus": { "$ref": "#/components/schemas/StoreProvisioningStatus" }, "createdOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "StoreDomainDto": { "required": [ "id", "hostname", "status", "isPrimary", "dnsRecords" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "hostname": { "type": "string" }, "status": { "type": "string" }, "isPrimary": { "type": "boolean" }, "dnsRecords": { "type": "array", "items": { "$ref": "#/components/schemas/DnsRecordDto" } } } }, "StoreDomainRequest": { "required": [ "domain" ], "type": "object", "properties": { "domain": { "type": "string" } } }, "StoreFeatureFlags": { "type": "object", "properties": { "flags": { "type": "object", "additionalProperties": { "type": "boolean" } } } }, "StoreItemDto": { "required": [ "id", "name", "organizationId", "storeType", "status", "provisioningStatus" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "name": { "type": "string" }, "slug": { "type": [ "null", "string" ], "description": "URL-friendly identifier." }, "domain": { "type": [ "null", "string" ] }, "logo": { "type": [ "null", "string" ] }, "icon": { "type": [ "null", "string" ] }, "organizationId": { "type": "string" }, "storeType": { "$ref": "#/components/schemas/StoreType" }, "status": { "$ref": "#/components/schemas/StoreStatus" }, "provisioningStatus": { "$ref": "#/components/schemas/StoreProvisioningStatus" }, "createdOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "StoreProvisioningStatus": { "enum": [ "provisioning", "ready", "failed" ], "type": "string" }, "StoreSettingsDto": { "required": [ "id", "name", "description", "slug", "domain", "logo", "favicon", "icon", "visibility", "timeZone", "currency", "language", "themeConfig", "featuresEnabled", "checkoutSettings" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "name": { "type": "string" }, "description": { "type": "string" }, "slug": { "type": [ "null", "string" ], "description": "URL-friendly identifier." }, "domain": { "type": [ "null", "string" ] }, "logo": { "type": [ "null", "string" ] }, "favicon": { "type": [ "null", "string" ] }, "icon": { "type": [ "null", "string" ] }, "visibility": { "$ref": "#/components/schemas/StoreVisibility" }, "timeZone": { "type": "string", "description": "IANA time zone name, for example `America/Lima`." }, "currency": { "type": "string" }, "language": { "type": "string" }, "themeConfig": { "$ref": "#/components/schemas/StoreThemeSettings" }, "featuresEnabled": { "$ref": "#/components/schemas/StoreFeatureFlags" }, "checkoutSettings": { "$ref": "#/components/schemas/StoreCheckoutSettings" } } }, "StoreSettingsRequest": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "name": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "slug": { "type": [ "null", "string" ], "description": "URL-friendly identifier." }, "domain": { "type": [ "null", "string" ] }, "logo": { "type": [ "null", "string" ] }, "icon": { "type": [ "null", "string" ] }, "visibility": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StoreVisibility" } ] }, "timeZone": { "type": [ "null", "string" ], "description": "IANA time zone name, for example `America/Lima`." }, "currency": { "type": [ "null", "string" ] }, "language": { "type": [ "null", "string" ] }, "favicon": { "type": [ "null", "string" ] }, "accessKey": { "type": [ "null", "string" ] }, "themeConfig": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StoreThemeSettings" } ] }, "featuresEnabled": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StoreFeatureFlags" } ] }, "checkoutSettings": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StoreCheckoutSettings" } ] } } }, "StoreSlugCheckDto": { "required": [ "exists" ], "type": "object", "properties": { "exists": { "type": "boolean" } } }, "StoreSlugDto": { "required": [ "storeId", "slug", "domain" ], "type": "object", "properties": { "storeId": { "type": "string" }, "slug": { "type": "string", "description": "URL-friendly identifier." }, "domain": { "type": [ "null", "string" ] } } }, "StoreSlugRequest": { "required": [ "slug" ], "type": "object", "properties": { "slug": { "type": "string", "description": "URL-friendly identifier." } } }, "StoreStatus": { "enum": [ "active", "inactive", "suspended" ], "type": "string" }, "StoreThemeSettings": { "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "mode": { "type": [ "null", "string" ] }, "colors": { "type": "object", "additionalProperties": { "type": "string" } }, "fonts": { "type": "object", "additionalProperties": { "type": "string" } }, "assets": { "type": "object", "additionalProperties": { "type": "string" } } } }, "StoreType": { "enum": [ "b2C", "marketplace", "retail", "b2B", "social", "hub", "restaurant" ], "type": "string" }, "StoreVisibility": { "enum": [ "public", "private" ], "type": "string" }, "Success": { "type": "object" }, "TaxCalculationType": { "enum": [ "additive", "replaceBase", "included", "compound" ], "type": "string" }, "TaxOverrideDto": { "required": [ "id", "storeId", "taxRegionId", "name", "target", "rate", "isExempt", "collectionId", "categoryId", "productType", "description", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "taxRegionId": { "type": "string" }, "name": { "type": "string" }, "target": { "$ref": "#/components/schemas/TaxOverrideTarget" }, "rate": { "type": "number", "format": "double" }, "isExempt": { "type": "boolean" }, "collectionId": { "type": [ "null", "string" ] }, "categoryId": { "type": [ "null", "string" ] }, "productType": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "TaxOverrideRequest": { "required": [ "taxRegionId", "name" ], "type": "object", "properties": { "taxRegionId": { "type": "string" }, "name": { "type": "string" }, "target": { "$ref": "#/components/schemas/TaxOverrideTarget" }, "rate": { "type": "number", "format": "double" }, "isExempt": { "type": "boolean" }, "collectionId": { "type": [ "null", "string" ] }, "categoryId": { "type": [ "null", "string" ] }, "productType": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] } } }, "TaxOverrideTarget": { "enum": [ "products", "shipping" ], "type": "string" }, "TaxRegionDto": { "required": [ "id", "storeId", "countryCode", "name", "serviceType", "isActive", "rates", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": "string" }, "countryCode": { "type": "string", "description": "ISO 3166-1 alpha-2 country code, for example `PE`." }, "name": { "type": "string" }, "serviceType": { "$ref": "#/components/schemas/TaxServiceType" }, "isActive": { "type": "boolean" }, "rates": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRegionRateDto" } }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "TaxRegionItemDto": { "required": [ "id", "countryCode", "name", "serviceType", "isActive", "isCollecting", "createdOn", "updatedOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "countryCode": { "type": "string", "description": "ISO 3166-1 alpha-2 country code, for example `PE`." }, "name": { "type": "string" }, "serviceType": { "$ref": "#/components/schemas/TaxServiceType" }, "isActive": { "type": "boolean" }, "isCollecting": { "type": "boolean" }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." }, "updatedOn": { "type": [ "null", "string" ], "format": "date-time", "description": "Timestamp when the resource was last modified, in ISO 8601." } } }, "TaxRegionRateDto": { "required": [ "id", "provinceCode", "provinceName", "rate", "label", "calculationType" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "provinceCode": { "type": [ "null", "string" ] }, "provinceName": { "type": [ "null", "string" ] }, "rate": { "type": "number", "format": "double" }, "label": { "type": [ "null", "string" ] }, "calculationType": { "$ref": "#/components/schemas/TaxCalculationType" } } }, "TaxRegionRateRequest": { "required": [ "provinceCode", "provinceName", "rate", "label", "calculationType" ], "type": "object", "properties": { "provinceCode": { "type": [ "null", "string" ] }, "provinceName": { "type": [ "null", "string" ] }, "rate": { "type": "number", "format": "double" }, "label": { "type": [ "null", "string" ] }, "calculationType": { "$ref": "#/components/schemas/TaxCalculationType" } } }, "TaxRegionRequest": { "required": [ "countryCode", "name" ], "type": "object", "properties": { "countryCode": { "type": "string", "description": "ISO 3166-1 alpha-2 country code, for example `PE`." }, "name": { "type": "string" }, "serviceType": { "$ref": "#/components/schemas/TaxServiceType" }, "isActive": { "type": "boolean" }, "rates": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/TaxRegionRateRequest" } } } }, "TaxServiceType": { "enum": [ "manual", "basic", "external" ], "type": "string" }, "TaxSettingsDto": { "required": [ "storeId", "serviceType", "serviceActive", "pricesIncludeTax", "chargeTaxOnShipping", "chargeVatOnDigitalGoods", "collectDutiesAtCheckout" ], "type": "object", "properties": { "storeId": { "type": "string" }, "serviceType": { "$ref": "#/components/schemas/TaxServiceType" }, "serviceActive": { "type": "boolean" }, "pricesIncludeTax": { "type": "boolean" }, "chargeTaxOnShipping": { "type": "boolean" }, "chargeVatOnDigitalGoods": { "type": "boolean" }, "collectDutiesAtCheckout": { "type": "boolean" } } }, "TaxSettingsRequest": { "type": "object", "properties": { "serviceType": { "$ref": "#/components/schemas/TaxServiceType" }, "serviceActive": { "type": "boolean" }, "pricesIncludeTax": { "type": "boolean" }, "chargeTaxOnShipping": { "type": "boolean" }, "chargeVatOnDigitalGoods": { "type": "boolean" }, "collectDutiesAtCheckout": { "type": "boolean" } } }, "TemplateDetailsDto": { "required": [ "id", "tenantId", "key", "group", "name", "notification", "version", "bodyTpl", "status" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "tenantId": { "type": "string" }, "storeId": { "type": [ "null", "string" ] }, "key": { "type": "string" }, "group": { "type": "string" }, "name": { "type": "string" }, "notification": { "$ref": "#/components/schemas/NotificationChannel" }, "locale": { "type": [ "null", "string" ] }, "version": { "type": "integer", "format": "int32" }, "subjectTpl": { "type": [ "null", "string" ] }, "exampleData": { "type": [ "null", "string" ] }, "bodyTpl": { "type": "string" }, "textTpl": { "type": [ "null", "string" ] }, "status": { "$ref": "#/components/schemas/TemplateStatus" } } }, "TemplateItemDto": { "required": [ "id", "group", "name", "key", "notification", "version", "status" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "storeId": { "type": [ "null", "string" ] }, "group": { "type": "string" }, "name": { "type": "string" }, "key": { "type": "string" }, "notification": { "$ref": "#/components/schemas/NotificationChannel" }, "locale": { "type": [ "null", "string" ] }, "version": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/TemplateStatus" } } }, "TemplateStatus": { "enum": [ "draft", "active", "archived" ], "type": "string" }, "TransactionReason": { "enum": [ "inventoryCount", "damage", "expire", "misplacement", "theft", "other", "usedForStore", "promotion", "sale", "return", "restock", "systemCorrection", "initialImport", "transfer" ], "type": "string" }, "UpdateBillingInformationRequest": { "required": [ "accountHolder", "documentNumber", "bankName", "accountType", "accountNumber", "interbankAccountNumber" ], "type": "object", "properties": { "accountHolder": { "type": [ "null", "string" ] }, "documentNumber": { "type": [ "null", "string" ], "description": "National identity or tax document number." }, "bankName": { "type": [ "null", "string" ] }, "accountType": { "type": [ "null", "string" ] }, "accountNumber": { "type": [ "null", "string" ] }, "interbankAccountNumber": { "type": [ "null", "string" ] } } }, "UpdateCustomerRequest": { "required": [ "firstName", "lastName" ], "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phone": { "type": [ "null", "string" ] }, "identificationNumber": { "type": [ "null", "string" ] }, "identificationType": { "type": [ "null", "string" ] }, "entityName": { "type": [ "null", "string" ] }, "entityIdentificationNumber": { "type": [ "null", "string" ] }, "gender": { "enum": [ "male", "female", "other" ], "type": [ "null", "string" ] }, "role": { "type": [ "null", "string" ] }, "companyName": { "type": [ "null", "string" ] }, "dateOfBirth": { "type": [ "null", "string" ], "format": "date" }, "consent": { "type": [ "null", "boolean" ] }, "countryIsoCode": { "type": [ "null", "string" ] } } }, "UpdateFulfillmentOptionsRequest": { "required": [ "offersShipping", "offersPickup", "offersDigitalDelivery", "offersInstallation" ], "type": "object", "properties": { "offersShipping": { "type": "boolean" }, "offersPickup": { "type": "boolean" }, "offersDigitalDelivery": { "type": "boolean" }, "offersInstallation": { "type": "boolean" } } }, "UpdateLegalInformationRequest": { "required": [ "isVerified", "taxId", "businessLicense", "legalName", "legalAddress", "contactPerson", "contactEmail" ], "type": "object", "properties": { "isVerified": { "type": "boolean" }, "taxId": { "type": [ "null", "string" ] }, "businessLicense": { "type": [ "null", "string" ] }, "legalName": { "type": [ "null", "string" ] }, "legalAddress": { "type": [ "null", "string" ] }, "contactPerson": { "type": [ "null", "string" ] }, "contactEmail": { "type": [ "null", "string" ] } } }, "UpdateListingPriceRequest": { "required": [ "price" ], "type": "object", "properties": { "price": { "type": "number", "format": "double" }, "compareAtPrice": { "type": [ "null", "number" ], "format": "double" } } }, "UpdateLocationRequest": { "type": "object", "properties": { "name": { "type": "string" }, "code": { "type": "string" }, "type": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LocationType" } ] }, "address": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "state": { "type": [ "null", "string" ] }, "country": { "type": [ "null", "string" ] }, "postalCode": { "type": [ "null", "string" ] }, "latitude": { "type": [ "null", "number" ], "format": "double" }, "longitude": { "type": [ "null", "number" ], "format": "double" }, "phone": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "isDefault": { "type": "boolean" }, "useForFulfillment": { "type": "boolean" }, "supportsShipping": { "type": "boolean" }, "supportsLocalDelivery": { "type": "boolean" }, "supportsPickup": { "type": "boolean" }, "isPhysicalStore": { "type": "boolean" }, "supportsPos": { "type": "boolean" }, "priority": { "type": "integer", "format": "int32" }, "pickupInstructions": { "type": [ "null", "string" ] }, "pickupLeadTimeInMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "pickupSlotInMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "pickupDailyCapacity": { "type": [ "null", "integer" ], "format": "int32" }, "localDeliveryInstructions": { "type": [ "null", "string" ] }, "localDeliveryLeadTimeInMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "localDeliverySlotInMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "localDeliveryDailyCapacity": { "type": [ "null", "integer" ], "format": "int32" }, "localDeliveryFee": { "type": [ "null", "number" ], "format": "double" }, "localDeliveryFreeFromAmount": { "type": [ "null", "number" ], "format": "double" }, "localDeliveryMinHours": { "type": [ "null", "integer" ], "format": "int32" }, "localDeliveryMaxHours": { "type": [ "null", "integer" ], "format": "int32" }, "localDeliveryPostalCodes": { "type": "array", "items": { "type": "string" } }, "localDeliveryZones": { "type": "array", "items": { "$ref": "#/components/schemas/LocalDeliveryZoneRequest" } }, "schedules": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/LocationScheduleRequest" } } } }, "UpdateModifierGroupRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "isRequired": { "type": "boolean" }, "selectionType": { "$ref": "#/components/schemas/ModifierSelectionType" }, "minSelections": { "type": "integer", "format": "int32" }, "maxSelections": { "type": [ "null", "integer" ], "format": "int32" }, "order": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/ModifierGroupStatus" }, "options": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/UpdateModifierOptionRequest" } } } }, "UpdateModifierOptionRequest": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ], "description": "Unique identifier of the resource." }, "name": { "type": "string" }, "priceDelta": { "type": "number", "format": "double", "default": 0 }, "isDefault": { "type": "boolean", "default": false }, "imageUrl": { "type": [ "null", "string" ] }, "order": { "type": "integer", "format": "int32", "default": 0 }, "status": { "enum": [ "active", "inactive" ], "type": "string", "default": "active" } } }, "UpdateOrderClaimStatusRequest": { "required": [ "status", "resolution" ], "type": "object", "properties": { "status": { "$ref": "#/components/schemas/OrderClaimStatus" }, "resolution": { "type": [ "null", "string" ] } } }, "UpdateOrderDraftItemRequest": { "type": "object", "properties": { "quantity": { "type": [ "null", "integer" ], "format": "int32" }, "unitPrice": { "type": [ "null", "number" ], "format": "double" }, "discount": { "type": [ "null", "number" ], "format": "double" }, "shipping": { "type": [ "null", "number" ], "format": "double" }, "tax": { "type": [ "null", "number" ], "format": "double" }, "warranty": { "type": [ "null", "number" ], "format": "double" }, "requiresShipping": { "type": [ "null", "boolean" ] }, "isTaxInclusive": { "type": [ "null", "boolean" ] }, "metadata": { "type": [ "null", "object" ] } } }, "UpdateOrderDraftRequest": { "type": "object", "properties": { "customerId": { "type": [ "null", "string" ] }, "cartId": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] }, "identificationType": { "type": [ "null", "string" ] }, "identificationNumber": { "type": [ "null", "string" ] }, "entityTaxId": { "type": [ "null", "string" ] }, "entityName": { "type": [ "null", "string" ] }, "source": { "type": [ "null", "string" ] }, "notes": { "type": [ "null", "string" ] }, "paymentMethod": { "type": [ "null", "string" ] }, "paymentCode": { "type": [ "null", "string" ] }, "shippingAddress": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrderDraftAddressRequest" } ] }, "billingAddress": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrderDraftAddressRequest" } ] }, "metadata": { "type": [ "null", "object" ] } } }, "UpdateOrderShipmentDto": { "required": [ "storeId", "orderId", "trackingNumber", "trackingLink", "carrierName", "from", "to", "serviceType", "serviceCost", "state", "items" ], "type": "object", "properties": { "storeId": { "type": "string" }, "orderId": { "type": "string" }, "trackingNumber": { "type": [ "null", "string" ] }, "trackingLink": { "type": [ "null", "string" ] }, "carrierName": { "type": [ "null", "string" ] }, "from": { "type": [ "null", "string" ] }, "to": { "type": [ "null", "string" ] }, "serviceType": { "type": [ "null", "string" ] }, "serviceCost": { "type": "number", "format": "double" }, "state": { "$ref": "#/components/schemas/OrderPackageState" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/OrderShipmentItemModel" } } } }, "UpdatePickupPointRequest": { "required": [ "name", "address" ], "type": "object", "properties": { "name": { "type": "string" }, "address": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "state": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "neighborhood": { "type": [ "null", "string" ] }, "postalCode": { "type": [ "null", "string" ] }, "addressNumber": { "type": [ "null", "string" ] }, "reference": { "type": [ "null", "string" ] }, "locationId": { "type": [ "null", "string" ] }, "connectionId": { "type": [ "null", "string" ] }, "isExternal": { "type": "boolean" }, "externalId": { "type": [ "null", "string" ] }, "contactPerson": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "instructions": { "type": [ "null", "string" ] }, "deliveryTimeInMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "leadTimeInMinutes": { "type": [ "null", "integer" ], "format": "int32" }, "schedule": { "type": "array", "items": { "$ref": "#/components/schemas/PickupPointScheduleRequest" } } } }, "UpdateSellerCatalogSettingsRequest": { "required": [ "publicationEnabled", "productApprovalPolicy", "promotionsEnabled" ], "type": "object", "properties": { "publicationEnabled": { "type": "boolean" }, "productApprovalPolicy": { "$ref": "#/components/schemas/SellerProductApprovalPolicy" }, "promotionsEnabled": { "type": "boolean" } } }, "UpdateSellerCommissionsRequest": { "required": [ "commissions" ], "type": "object", "properties": { "commissions": { "type": "array", "items": { "$ref": "#/components/schemas/SellerCommissionRequest" } } } }, "UpdateSellerProfileRequest": { "required": [ "logo", "banner", "avatar", "backgroundImage", "website", "facebook", "instagram", "twitter", "linkedIn", "youTube", "tikTok" ], "type": "object", "properties": { "logo": { "type": [ "null", "string" ] }, "banner": { "type": [ "null", "string" ] }, "avatar": { "type": [ "null", "string" ] }, "backgroundImage": { "type": [ "null", "string" ] }, "website": { "type": [ "null", "string" ] }, "facebook": { "type": [ "null", "string" ] }, "instagram": { "type": [ "null", "string" ] }, "twitter": { "type": [ "null", "string" ] }, "linkedIn": { "type": [ "null", "string" ] }, "youTube": { "type": [ "null", "string" ] }, "tikTok": { "type": [ "null", "string" ] } } }, "UpdateSellerRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": [ "null", "string" ], "description": "URL-friendly identifier." }, "description": { "type": [ "null", "string" ] }, "phone": { "type": [ "null", "string" ] }, "emailNotification": { "type": [ "null", "string" ] }, "deliveryPolicy": { "type": [ "null", "string" ] }, "privacyAndSecurityPolicy": { "type": [ "null", "string" ] }, "commissionPercent": { "type": [ "null", "number" ], "format": "double" }, "exchangeRate": { "type": [ "null", "number" ], "format": "double" }, "legalInfo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UpdateLegalInformationRequest" } ] }, "billingInfo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UpdateBillingInformationRequest" } ] }, "catalogSettings": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UpdateSellerCatalogSettingsRequest" } ] }, "shippingSettings": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UpdateSellerShippingSettingsRequest" } ] }, "profile": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UpdateSellerProfileRequest" } ] }, "fulfillment": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UpdateFulfillmentOptionsRequest" } ] } } }, "UpdateSellerScopesRequest": { "required": [ "scopes" ], "type": "object", "properties": { "scopes": { "type": "array", "items": { "$ref": "#/components/schemas/SellerScopeRequest" } } } }, "UpdateSellerShippingSettingsRequest": { "required": [ "shippingEnabled", "shippingProfilesEnabled", "fulfillmentMode", "rateManagementMode", "allowedShippingMethods", "maxTransitDays", "minShippingRate", "maxShippingRate" ], "type": "object", "properties": { "shippingEnabled": { "type": "boolean" }, "shippingProfilesEnabled": { "type": "boolean" }, "fulfillmentMode": { "$ref": "#/components/schemas/SellerFulfillmentMode" }, "rateManagementMode": { "$ref": "#/components/schemas/SellerRateManagementMode" }, "allowedShippingMethods": { "type": "array", "items": { "type": "string" } }, "maxTransitDays": { "type": [ "null", "integer" ], "format": "int32" }, "minShippingRate": { "type": [ "null", "number" ], "format": "double" }, "maxShippingRate": { "type": [ "null", "number" ], "format": "double" } } }, "UpdateShippingProfileRequest": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "locationIds": { "type": "array" }, "isDefault": { "type": "boolean" }, "isActive": { "type": "boolean" } } }, "UpdateSpecificationRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "key": { "type": [ "null", "string" ] }, "aliases": { "type": [ "null", "array" ], "items": { "type": "string" } }, "description": { "type": [ "null", "string" ] }, "isMultiple": { "type": "boolean" }, "isRequired": { "type": "boolean" }, "isFilterable": { "type": "boolean" }, "isSearchable": { "type": "boolean" }, "order": { "type": "integer", "format": "int32" }, "status": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SpecificationStatus" } ] }, "type": { "$ref": "#/components/schemas/SpecificationType" }, "level": { "$ref": "#/components/schemas/SpecificationLevel" }, "values": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/UpdateSpecificationValueRequest" } }, "metadata": { "type": [ "null", "object" ] } } }, "UpdateSpecificationValueRequest": { "required": [ "id", "value" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "value": { "type": "string" }, "isDefault": { "type": "boolean", "default": false }, "order": { "type": "integer", "format": "int32", "default": 0 } } }, "UpdateTemplateRequest": { "required": [ "name", "subjectTpl", "bodyTpl", "textTpl" ], "type": "object", "properties": { "name": { "type": "string" }, "subjectTpl": { "type": "string" }, "bodyTpl": { "type": "string" }, "textTpl": { "type": [ "null", "string" ] } } }, "UpdateVariantRequest": { "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "sku": { "type": [ "null", "string" ], "description": "Stock keeping unit (SKU)." }, "packageId": { "type": [ "null", "string" ] }, "price": { "type": [ "null", "number" ], "format": "double" }, "compareAtPrice": { "type": [ "null", "number" ], "format": "double" }, "costPrice": { "type": [ "null", "number" ], "format": "double" }, "lowStockThreshold": { "type": [ "null", "integer" ], "format": "int32" }, "allowBackorders": { "type": [ "null", "boolean" ] }, "trackInventory": { "type": [ "null", "boolean" ] }, "isDigital": { "type": [ "null", "boolean" ] }, "weight": { "type": [ "null", "number" ], "format": "double" }, "width": { "type": [ "null", "number" ], "format": "double" }, "height": { "type": [ "null", "number" ], "format": "double" }, "length": { "type": [ "null", "number" ], "format": "double" }, "unitOfMeasure": { "type": [ "null", "string" ] }, "barcode": { "type": [ "null", "string" ], "description": "Barcode of the variant, such as EAN or UPC." }, "countryOfOrigin": { "type": [ "null", "string" ] }, "hsCode": { "type": [ "null", "string" ] }, "isDefault": { "type": [ "null", "boolean" ] }, "status": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/VariantStatus" } ] }, "images": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/VariantImageModel" } }, "options": { "type": [ "null", "object" ], "additionalProperties": { "type": "string" } }, "modifiers": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ModifierGroupModel" } } } }, "VariantImageDto": { "required": [ "imageId", "order", "isPrimary" ], "type": "object", "properties": { "imageId": { "type": "string" }, "order": { "type": "integer", "format": "int32" }, "isPrimary": { "type": "boolean" } } }, "VariantImageModel": { "required": [ "imageId" ], "type": "object", "properties": { "imageId": { "type": "string" }, "isPrimary": { "type": "boolean" }, "order": { "type": "integer", "format": "int32" } } }, "VariantInputModel": { "type": "object", "properties": { "id": { "type": [ "null", "string" ], "description": "Unique identifier of the resource." }, "name": { "type": [ "null", "string" ] }, "sku": { "type": [ "null", "string" ], "description": "Stock keeping unit (SKU)." }, "packageId": { "type": [ "null", "string" ] }, "price": { "type": [ "null", "number" ], "format": "double" }, "compareAtPrice": { "type": [ "null", "number" ], "format": "double" }, "costPrice": { "type": [ "null", "number" ], "format": "double" }, "lowStockThreshold": { "type": [ "null", "integer" ], "format": "int32" }, "allowBackorders": { "type": [ "null", "boolean" ] }, "trackInventory": { "type": [ "null", "boolean" ] }, "weight": { "type": [ "null", "number" ], "format": "double" }, "width": { "type": [ "null", "number" ], "format": "double" }, "height": { "type": [ "null", "number" ], "format": "double" }, "length": { "type": [ "null", "number" ], "format": "double" }, "unitOfMeasure": { "type": [ "null", "string" ] }, "barcode": { "type": [ "null", "string" ], "description": "Barcode of the variant, such as EAN or UPC." }, "countryOfOrigin": { "type": [ "null", "string" ] }, "hsCode": { "type": [ "null", "string" ] }, "images": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/VariantImageModel" } }, "options": { "type": [ "null", "object" ], "additionalProperties": { "type": "string" } }, "isDigital": { "type": [ "null", "boolean" ] }, "isDefault": { "type": [ "null", "boolean" ] } } }, "VariantOptionDto": { "required": [ "name", "key", "value" ], "type": "object", "properties": { "name": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } } }, "VariantSpreadsheetDto": { "required": [ "id", "totalCount", "expiresAt" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "totalCount": { "type": "integer", "format": "int64", "description": "Total number of matching items." }, "expiresAt": { "type": "string", "format": "date-time" } } }, "VariantSpreadsheetFilters": { "type": "object", "properties": { "source": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/VariantSpreadsheetFilterSource" } ] }, "search": { "type": [ "null", "string" ], "description": "Free-text filter. Which fields it covers depends on the resource." }, "channelId": { "type": [ "null", "string" ] }, "productStatus": { "type": [ "null", "array" ] }, "excludeProductStatus": { "type": [ "null", "array" ] }, "includeArchived": { "type": [ "null", "boolean" ] }, "locationIds": { "type": [ "null", "array" ] }, "categoryIds": { "type": [ "null", "array" ] }, "excludeCategoryIds": { "type": [ "null", "array" ] }, "brandIds": { "type": [ "null", "array" ] }, "excludeBrandIds": { "type": [ "null", "array" ] }, "sellerIds": { "type": [ "null", "array" ] }, "excludeSellerIds": { "type": [ "null", "array" ] }, "skus": { "type": [ "null", "array" ], "items": { "type": "string" } }, "productTypes": { "type": [ "null", "array" ] }, "excludeProductTypes": { "type": [ "null", "array" ] }, "isFeatured": { "type": [ "null", "boolean" ] }, "ean": { "type": [ "null", "string" ] }, "minPrice": { "type": [ "null", "number" ], "format": "double" }, "maxPrice": { "type": [ "null", "number" ], "format": "double" }, "minOnHand": { "type": [ "null", "integer" ], "format": "int32" }, "maxOnHand": { "type": [ "null", "integer" ], "format": "int32" }, "minAvailable": { "type": [ "null", "integer" ], "format": "int32" }, "maxAvailable": { "type": [ "null", "integer" ], "format": "int32" }, "minCommitted": { "type": [ "null", "integer" ], "format": "int32" }, "maxCommitted": { "type": [ "null", "integer" ], "format": "int32" }, "isLowStock": { "type": [ "null", "boolean" ] }, "isInStock": { "type": [ "null", "boolean" ] }, "tags": { "type": [ "null", "array" ], "items": { "type": "string" } }, "excludeTags": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "VariantSpreadsheetFilterSource": { "enum": [ "products", "inventory" ], "type": [ "null", "string" ] }, "VariantSpreadsheetInventoryDto": { "required": [ "locationId", "onHand", "committed", "unavailable", "available", "incoming", "version" ], "type": "object", "properties": { "locationId": { "type": "string" }, "onHand": { "type": "integer", "format": "int32" }, "committed": { "type": "integer", "format": "int32" }, "unavailable": { "type": "integer", "format": "int32" }, "available": { "type": "integer", "format": "int32" }, "incoming": { "type": "integer", "format": "int32" }, "version": { "type": "integer", "format": "int64" } } }, "VariantSpreadsheetInventoryItemRequest": { "required": [ "variantId", "locationId" ], "type": "object", "properties": { "variantId": { "type": "string" }, "locationId": { "type": "string" } } }, "VariantSpreadsheetRequest": { "type": "object", "properties": { "variantIds": { "type": [ "null", "array" ] }, "productIds": { "type": [ "null", "array" ] }, "inventoryItems": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/VariantSpreadsheetInventoryItemRequest" } }, "filters": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/VariantSpreadsheetFilters" } ] }, "locationIds": { "type": [ "null", "array" ] }, "pageSize": { "type": [ "null", "integer" ], "format": "int32" } } }, "VariantSpreadsheetRowDto": { "required": [ "productId", "productName", "productStatus", "productTags", "variantId", "variantName", "version", "values", "inventories" ], "type": "object", "properties": { "productId": { "type": "string" }, "productName": { "type": "string" }, "productStatus": { "type": "string" }, "productTags": { "type": "array", "items": { "type": "string" } }, "variantId": { "type": "string" }, "variantName": { "type": "string" }, "version": { "type": "integer", "format": "int64" }, "imageUrl": { "type": [ "null", "string" ] }, "values": { "$ref": "#/components/schemas/VariantSpreadsheetValuesDto" }, "inventories": { "type": "array", "items": { "$ref": "#/components/schemas/VariantSpreadsheetInventoryDto" } } } }, "VariantSpreadsheetValuesDto": { "required": [ "sku", "price", "trackInventory", "allowBackorders", "lowStockThreshold", "weight", "width", "height", "length", "unitOfMeasure", "options" ], "type": "object", "properties": { "sku": { "type": "string", "description": "Stock keeping unit (SKU)." }, "barcode": { "type": [ "null", "string" ], "description": "Barcode of the variant, such as EAN or UPC." }, "price": { "type": "number", "format": "double" }, "compareAtPrice": { "type": [ "null", "number" ], "format": "double" }, "costPrice": { "type": [ "null", "number" ], "format": "double" }, "trackInventory": { "type": "boolean" }, "allowBackorders": { "type": "boolean" }, "lowStockThreshold": { "type": "integer", "format": "int32" }, "weight": { "type": "number", "format": "double" }, "width": { "type": "number", "format": "double" }, "height": { "type": "number", "format": "double" }, "length": { "type": "number", "format": "double" }, "unitOfMeasure": { "type": "string" }, "countryOfOrigin": { "type": [ "null", "string" ] }, "hsCode": { "type": [ "null", "string" ] }, "options": { "type": "object", "additionalProperties": { "type": "string" } } } }, "VariantStatus": { "enum": [ "outOfStock", "discontinued", "pendingMapping", "withError", "active", "inactive" ], "type": [ "null", "string" ] }, "WebhookAuth": { "required": [ "type", "config" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/WebhookAuthType" }, "config": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WebhookAuthType": { "enum": [ "basic", "bearer", "oAuth2" ], "type": "string" }, "WebhookDeliveryDetailDto": { "required": [ "id", "endpointId", "endpointUrl", "eventType", "status", "httpStatusCode", "attemptNumber", "errorMessage", "occurredOn", "payloadStored", "event" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "endpointId": { "type": "string" }, "endpointUrl": { "type": "string" }, "eventType": { "type": "string" }, "status": { "$ref": "#/components/schemas/WebhookDeliveryStatus" }, "httpStatusCode": { "type": "integer", "format": "int32" }, "attemptNumber": { "type": "integer", "format": "int32" }, "errorMessage": { "type": [ "null", "string" ] }, "occurredOn": { "type": "string", "format": "date-time", "description": "Timestamp when the event happened, in ISO 8601." }, "payloadStored": { "type": "boolean" }, "event": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WebhookEventModel" } ] } } }, "WebhookDeliveryDto": { "required": [ "id", "endpointId", "endpointUrl", "eventType", "status", "httpStatusCode", "attemptNumber", "errorMessage", "occurredOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "endpointId": { "type": "string" }, "endpointUrl": { "type": "string" }, "eventType": { "type": "string" }, "status": { "$ref": "#/components/schemas/WebhookDeliveryStatus" }, "httpStatusCode": { "type": "integer", "format": "int32" }, "attemptNumber": { "type": "integer", "format": "int32" }, "errorMessage": { "type": [ "null", "string" ] }, "occurredOn": { "type": "string", "format": "date-time", "description": "Timestamp when the event happened, in ISO 8601." } } }, "WebhookDeliveryStatus": { "enum": [ "success", "failed" ], "type": "string" }, "WebhookEndpointDto": { "required": [ "id", "name", "url", "eventTypes", "status", "deliveryCount", "failureCount", "lastDeliveryOn", "sellerId", "createdOn" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "name": { "type": [ "null", "string" ] }, "url": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string" } }, "status": { "$ref": "#/components/schemas/WebhookEndpointStatus" }, "deliveryCount": { "type": "integer", "format": "int32" }, "failureCount": { "type": "integer", "format": "int32" }, "lastDeliveryOn": { "type": [ "null", "string" ], "format": "date-time" }, "sellerId": { "type": [ "null", "string" ] }, "createdOn": { "type": "string", "format": "date-time", "description": "Timestamp when the resource was created, in ISO 8601." } } }, "WebhookEndpointRequest": { "required": [ "url", "eventTypes" ], "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "url": { "type": "string" }, "eventTypes": { "type": "array", "items": { "type": "string" } }, "secret": { "type": [ "null", "string" ] }, "auth": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WebhookAuth" } ] }, "headers": { "type": [ "null", "object" ], "additionalProperties": { "type": "string" } } } }, "WebhookEndpointStatus": { "enum": [ "active", "paused", "disabled" ], "type": "string" }, "WebhookEventField": { "required": [ "name", "type", "required", "description" ], "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "required": { "type": "boolean" }, "description": { "type": "string" } } }, "WebhookEventModel": { "required": [ "type", "name", "category", "description", "canSubscribe", "payloadType", "fields" ], "type": "object", "properties": { "type": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string" }, "description": { "type": "string" }, "canSubscribe": { "type": "boolean" }, "payloadType": { "type": "string" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEventField" } } } }, "WeightUnit": { "enum": [ "kilogram", "gram", "pound", "ounce" ], "type": "string" } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "OAuth2 access token issued by Ecomiq Auth." } } }, "tags": [ { "name": "Platform & Identity", "description": "Organizations, stores, members, roles, API keys, apps, and account-level administration.", "x-displayName": "Platform & Identity" }, { "name": "Catalog", "description": "Products, variants, categories, brands, collections, pricing, search, and catalog enrichment.", "x-displayName": "Catalog" }, { "name": "Inventory", "description": "Inventory availability, stock movement, and sellable catalog state.", "x-displayName": "Inventory" }, { "name": "Customers", "description": "Customer records, groups, addresses, customer sessions, and reviews.", "x-displayName": "Customers" }, { "name": "Orders", "description": "Orders, order drafts, order bumps, and the order lifecycle.", "x-displayName": "Orders" }, { "name": "Fulfillment & Shipping", "description": "Fulfillment, shipments, shipping methods, pickup points, delivery zones, geo, and taxes.", "x-displayName": "Fulfillment & Shipping" }, { "name": "Payments & Finance", "description": "Payments, refunds, captures, seller balances, settlements, payouts, and adjustments.", "x-displayName": "Payments & Finance" }, { "name": "Promotions", "description": "Discounts, coupons, promotion codes, and promotional pricing rules.", "x-displayName": "Promotions" }, { "name": "Webhooks", "description": "Webhook endpoints, events, deliveries, and operational replay.", "x-displayName": "Webhooks" } ], "servers": [ { "url": "https://api.ecomiq.pe/api", "description": "Production gateway" } ] }