Sprawdź opis produktu i wybierz wariant odpowiedni do swoich potrzeb.
", "cover_alt": "Niebieska ilustracja poradnika", "cover_caption": "Ilustracja redakcyjna", "cover_media_id": "e8663afe-3c38-461c-a142-a980085630af", "excerpt": "Praktyczny poradnik zakupowy.", "locale": "pl", "meta_description": "Praktyczne wskazówki dotyczące wyboru produktu.", "meta_keywords": [ "poradnik", "wybór" ], "meta_title": "Jak wybrać produkt", "slug": "jak-wybrac-produkt", "title": "Jak wybrać produkt" }, "schema": { "additionalProperties": false, "properties": { "author_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Author Id" }, "comments_mode": { "enum": [ "inherit", "open", "closed" ], "title": "Comments Mode", "type": "string" }, "content_html": { "maxLength": 50000, "title": "Content Html", "type": "string", "x-shopently-control": "rich_text", "x-shopently-html-profile": "category-v1" }, "cover_alt": { "maxLength": 250, "title": "Cover Alt", "type": "string" }, "cover_caption": { "maxLength": 500, "title": "Cover Caption", "type": "string" }, "cover_media_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Cover Media Id", "x-shopently-control": "media" }, "excerpt": { "maxLength": 1000, "title": "Excerpt", "type": "string" }, "expected_version": { "const": 1, "default": 1, "title": "Expected Version", "type": "integer" }, "locale": { "maxLength": 35, "minLength": 2, "pattern": "^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$", "title": "Locale", "type": "string", "x-shopently-control": "locale" }, "meta_description": { "maxLength": 160, "title": "Meta Description", "type": "string", "x-shopently-character-counter": true, "x-shopently-control": "textarea" }, "meta_keywords": { "items": { "maxLength": 50, "minLength": 1, "type": "string" }, "maxItems": 20, "title": "Meta Keywords", "type": "array", "x-shopently-control": "keywords" }, "meta_title": { "maxLength": 70, "title": "Meta Title", "type": "string", "x-shopently-character-counter": true }, "slug": { "maxLength": 160, "title": "Slug", "type": "string" }, "title": { "maxLength": 200, "title": "Title", "type": "string" } }, "required": [ "locale", "title", "slug", "excerpt", "content_html", "meta_title", "meta_description", "meta_keywords", "cover_media_id", "cover_alt", "cover_caption", "author_id", "comments_mode" ], "title": "CreatePost", "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "html_normalized": false, "id": "2103ba96-2713-420b-b197-8a008730c851", "public_number": 1, "revision_id": "8c4af6da-63f4-42aa-8b37-57c703fa0af7", "status": "draft", "version": 1 }, "meta": { "request_id": "f6a16d96-69fc-401d-9d04-cdc96f86a4c7" } } } }, "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "html_normalized": { "title": "Html Normalized", "type": "boolean" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "public_number": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "type": "null" } ], "title": "Public Number" }, "revision_id": { "format": "uuid", "title": "Revision Id", "type": "string" }, "status": { "enum": [ "draft", "scheduled", "published", "archived" ], "title": "Status", "type": "string" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" } }, "required": [ "id", "version", "status", "revision_id", "html_normalized" ], "title": "DraftSaved", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:post_create" ] } } }, "/api/v1/addons/shopently.blog/posts/{post_id}": { "delete": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/blog-posts/delete/" }, "operationId": "addon_shopently_blog_post_delete", "parameters": [ { "example": "2103ba96-2713-420b-b197-8a008730c851", "in": "path", "name": "post_id", "required": true, "schema": { "format": "uuid", "title": "Post Id", "type": "string" } }, { "example": 6, "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "example": "learn-28da0478bff14319a2452a9887eececb", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": true, "id": "2103ba96-2713-420b-b197-8a008730c851" }, "meta": { "request_id": "56a8c849-a723-469b-97cb-2034c8ccd0a2" } } } }, "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "deleted": { "const": true, "title": "Deleted", "type": "boolean" }, "id": { "format": "uuid", "title": "Id", "type": "string" } }, "required": [ "id", "deleted" ], "title": "Deleted", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:post_delete" ] } }, "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/blog-posts/read/" }, "operationId": "addon_shopently_blog_post_read", "parameters": [ { "example": "2103ba96-2713-420b-b197-8a008730c851", "in": "path", "name": "post_id", "required": true, "schema": { "format": "uuid", "title": "Post Id", "type": "string" } }, { "example": "pl", "in": "query", "name": "locale", "required": true, "schema": { "maxLength": 35, "minLength": 2, "pattern": "^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$", "title": "Locale", "type": "string", "x-shopently-control": "locale" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "author_id": "341494e0-caab-4f47-a8ff-f6795c42a775", "comments_mode": "open", "content_html": "Sprawdź opis produktu i wybierz wariant odpowiedni do swoich potrzeb.
", "cover_alt": "Niebieska ilustracja poradnika", "cover_caption": "Ilustracja redakcyjna", "cover_media_id": "e8663afe-3c38-461c-a142-a980085630af", "draft_revision_id": "8c4af6da-63f4-42aa-8b37-57c703fa0af7", "excerpt": "Praktyczny poradnik zakupowy.", "first_published_at": null, "id": "2103ba96-2713-420b-b197-8a008730c851", "last_published_at": null, "locale": "pl", "meta_description": "Praktyczne wskazówki dotyczące wyboru produktu.", "meta_keywords": [ "poradnik", "wybór" ], "meta_title": "Jak wybrać produkt", "public_number": 1, "publish_at": null, "publish_timezone": null, "published_revision_id": null, "schedule_state": null, "scheduled_revision_id": null, "slug": "jak-wybrac-produkt", "status": "draft", "title": "Jak wybrać produkt", "updated_at": "2026-10-07T23:17:44.320869Z", "version": 1 }, "meta": { "request_id": "c85f6074-44e5-4d74-a117-fb631879fb7d" } } } }, "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "author_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Author Id" }, "comments_mode": { "enum": [ "inherit", "open", "closed" ], "title": "Comments Mode", "type": "string" }, "content_html": { "maxLength": 50000, "title": "Content Html", "type": "string", "x-shopently-control": "rich_text", "x-shopently-html-profile": "category-v1" }, "cover_alt": { "maxLength": 250, "title": "Cover Alt", "type": "string" }, "cover_caption": { "maxLength": 500, "title": "Cover Caption", "type": "string" }, "cover_media_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Cover Media Id", "x-shopently-control": "media" }, "draft_revision_id": { "format": "uuid", "title": "Draft Revision Id", "type": "string" }, "excerpt": { "maxLength": 1000, "title": "Excerpt", "type": "string" }, "first_published_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "First Published At" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "last_published_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Last Published At" }, "locale": { "maxLength": 35, "minLength": 2, "pattern": "^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$", "title": "Locale", "type": "string", "x-shopently-control": "locale" }, "meta_description": { "maxLength": 160, "title": "Meta Description", "type": "string", "x-shopently-character-counter": true, "x-shopently-control": "textarea" }, "meta_keywords": { "items": { "maxLength": 50, "minLength": 1, "type": "string" }, "maxItems": 20, "title": "Meta Keywords", "type": "array", "x-shopently-control": "keywords" }, "meta_title": { "maxLength": 70, "title": "Meta Title", "type": "string", "x-shopently-character-counter": true }, "public_number": { "minimum": 1, "title": "Public Number", "type": "integer" }, "publish_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Publish At" }, "publish_timezone": { "anyOf": [ { "maxLength": 64, "type": "string" }, { "type": "null" } ], "title": "Publish Timezone" }, "published_revision_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Published Revision Id" }, "schedule_state": { "anyOf": [ { "enum": [ "armed", "requires_confirmation" ], "type": "string" }, { "type": "null" } ], "title": "Schedule State" }, "scheduled_revision_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Scheduled Revision Id" }, "slug": { "maxLength": 160, "title": "Slug", "type": "string" }, "status": { "enum": [ "draft", "scheduled", "published", "archived" ], "title": "Status", "type": "string" }, "title": { "maxLength": 200, "title": "Title", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" } }, "required": [ "locale", "title", "slug", "excerpt", "content_html", "meta_title", "meta_description", "meta_keywords", "cover_media_id", "cover_alt", "cover_caption", "author_id", "comments_mode", "id", "public_number", "version", "status", "draft_revision_id", "published_revision_id", "scheduled_revision_id", "publish_at", "publish_timezone", "schedule_state", "first_published_at", "last_published_at", "updated_at" ], "title": "PostDocument", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:post_read" ] } }, "patch": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/blog-posts/update/" }, "operationId": "addon_shopently_blog_post_update", "parameters": [ { "example": "2103ba96-2713-420b-b197-8a008730c851", "in": "path", "name": "post_id", "required": true, "schema": { "format": "uuid", "title": "Post Id", "type": "string" } }, { "example": "learn-6486f38921214552949f30311a1f543f", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "excerpt": "Praktyczny poradnik: porównanie właściwości i wariantów.", "expected_version": 1, "locale": "pl" }, "schema": { "additionalProperties": false, "properties": { "author_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Author Id" }, "comments_mode": { "enum": [ "inherit", "open", "closed" ], "title": "Comments Mode", "type": "string" }, "content_html": { "maxLength": 50000, "title": "Content Html", "type": "string", "x-shopently-control": "rich_text", "x-shopently-html-profile": "category-v1" }, "cover_alt": { "maxLength": 250, "title": "Cover Alt", "type": "string" }, "cover_caption": { "maxLength": 500, "title": "Cover Caption", "type": "string" }, "cover_media_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Cover Media Id", "x-shopently-control": "media" }, "excerpt": { "maxLength": 1000, "title": "Excerpt", "type": "string" }, "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" }, "locale": { "maxLength": 35, "minLength": 2, "pattern": "^[a-zA-Z]{2,3}(?:-[a-zA-Z0-9]{2,8})*$", "title": "Locale", "type": "string", "x-shopently-control": "locale" }, "meta_description": { "maxLength": 160, "title": "Meta Description", "type": "string", "x-shopently-character-counter": true, "x-shopently-control": "textarea" }, "meta_keywords": { "items": { "maxLength": 50, "minLength": 1, "type": "string" }, "maxItems": 20, "title": "Meta Keywords", "type": "array", "x-shopently-control": "keywords" }, "meta_title": { "maxLength": 70, "title": "Meta Title", "type": "string", "x-shopently-character-counter": true }, "slug": { "maxLength": 160, "title": "Slug", "type": "string" }, "title": { "maxLength": 200, "title": "Title", "type": "string" } }, "required": [ "expected_version", "locale" ], "title": "PatchPost", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "html_normalized": false, "id": "2103ba96-2713-420b-b197-8a008730c851", "public_number": null, "revision_id": "5745799d-723b-4341-9f6e-1a63e50f1d40", "status": "draft", "version": 2 }, "meta": { "request_id": "bd4bb9ba-0f29-41c0-858d-3581bb03928f" } } } }, "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "html_normalized": { "title": "Html Normalized", "type": "boolean" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "public_number": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "type": "null" } ], "title": "Public Number" }, "revision_id": { "format": "uuid", "title": "Revision Id", "type": "string" }, "status": { "enum": [ "draft", "scheduled", "published", "archived" ], "title": "Status", "type": "string" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" } }, "required": [ "id", "version", "status", "revision_id", "html_normalized" ], "title": "DraftSaved", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:post_update" ] } } }, "/api/v1/addons/shopently.blog/posts/{post_id}/archive": { "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/blog-posts/archive/" }, "operationId": "addon_shopently_blog_post_archive", "parameters": [ { "example": "2103ba96-2713-420b-b197-8a008730c851", "in": "path", "name": "post_id", "required": true, "schema": { "format": "uuid", "title": "Post Id", "type": "string" } }, { "example": "learn-14c6494b41f142189df2b60be2bae407", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 3 }, "schema": { "additionalProperties": false, "properties": { "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, "required": [ "expected_version" ], "title": "VersionCommand", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "id": "2103ba96-2713-420b-b197-8a008730c851", "status": "archived", "version": 4 }, "meta": { "request_id": "132f5ca3-88c0-4c81-b6b2-cc8c67efc1cc" } } } }, "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "title": "Id", "type": "string" }, "status": { "enum": [ "draft", "scheduled", "published", "archived" ], "title": "Status", "type": "string" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" } }, "required": [ "id", "version", "status" ], "title": "PublicationSaved", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:post_publish" ] } } }, "/api/v1/addons/shopently.blog/posts/{post_id}/publish": { "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/blog-posts/publish/" }, "operationId": "addon_shopently_blog_post_publish", "parameters": [ { "example": "2103ba96-2713-420b-b197-8a008730c851", "in": "path", "name": "post_id", "required": true, "schema": { "format": "uuid", "title": "Post Id", "type": "string" } }, { "example": "learn-d4d47592948e4567a1511a4e797467af", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 2, "revision_id": "5745799d-723b-4341-9f6e-1a63e50f1d40" }, "schema": { "additionalProperties": false, "properties": { "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" }, "revision_id": { "format": "uuid", "title": "Revision Id", "type": "string" } }, "required": [ "expected_version", "revision_id" ], "title": "PublishCommand", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "id": "2103ba96-2713-420b-b197-8a008730c851", "status": "published", "version": 3 }, "meta": { "request_id": "ebb0a3b6-a737-4b64-8ac9-8e2a39e7ab46" } } } }, "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "title": "Id", "type": "string" }, "status": { "enum": [ "draft", "scheduled", "published", "archived" ], "title": "Status", "type": "string" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" } }, "required": [ "id", "version", "status" ], "title": "PublicationSaved", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:post_publish" ] } } }, "/api/v1/addons/shopently.blog/posts/{post_id}/schedule": { "delete": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/blog-posts/cancel-schedule/" }, "operationId": "addon_shopently_blog_post_cancel_schedule", "parameters": [ { "example": "2103ba96-2713-420b-b197-8a008730c851", "in": "path", "name": "post_id", "required": true, "schema": { "format": "uuid", "title": "Post Id", "type": "string" } }, { "example": 5, "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "example": "learn-7cb6adeb92bd45d4902c639cfc87c92a", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "id": "2103ba96-2713-420b-b197-8a008730c851", "status": "archived", "version": 6 }, "meta": { "request_id": "4e68abf3-1d66-4aec-b92a-903c4b2ca6f3" } } } }, "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "title": "Id", "type": "string" }, "status": { "enum": [ "draft", "scheduled", "published", "archived" ], "title": "Status", "type": "string" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" } }, "required": [ "id", "version", "status" ], "title": "PublicationSaved", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:post_publish" ] } }, "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/blog-posts/schedule/" }, "operationId": "addon_shopently_blog_post_schedule", "parameters": [ { "example": "2103ba96-2713-420b-b197-8a008730c851", "in": "path", "name": "post_id", "required": true, "schema": { "format": "uuid", "title": "Post Id", "type": "string" } }, { "example": "learn-4127e3d9922742cc912bda42fdba2422", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 4, "publish_at": "2026-10-08T23:17:45.449196+00:00", "revision_id": "5745799d-723b-4341-9f6e-1a63e50f1d40", "timezone": "UTC" }, "schema": { "additionalProperties": false, "properties": { "expected_version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" }, "publish_at": { "format": "date-time", "title": "Publish At", "type": "string", "x-shopently-control": "date_time", "x-shopently-timezone-field": "timezone" }, "revision_id": { "format": "uuid", "title": "Revision Id", "type": "string" }, "timezone": { "maxLength": 64, "minLength": 1, "title": "Timezone", "type": "string" } }, "required": [ "expected_version", "revision_id", "publish_at", "timezone" ], "title": "ScheduleCommand", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "id": "2103ba96-2713-420b-b197-8a008730c851", "publish_at": "2026-10-08T23:17:45.449196Z", "status": "scheduled", "version": 5 }, "meta": { "request_id": "d5d1037e-0776-4f63-a337-87335e26c5e4" } } } }, "schema": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "title": "Id", "type": "string" }, "publish_at": { "format": "date-time", "title": "Publish At", "type": "string" }, "status": { "enum": [ "draft", "scheduled", "published", "archived" ], "title": "Status", "type": "string" }, "version": { "maximum": 9223372036854775807, "minimum": 1, "title": "Version", "type": "integer" } }, "required": [ "id", "version", "status", "publish_at" ], "title": "ScheduleSaved", "type": "object" }, "meta": { "additionalProperties": false, "properties": { "request_id": { "maxLength": 100, "minLength": 1, "type": "string" } }, "required": [ "request_id" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" } } }, "description": "Successful module operation" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Call", "tags": [ "Addon shopently.blog" ], "x-shopently-access": { "addon_contract_major": 1, "addon_id": "shopently.blog", "api_plan_features": [ "api.enabled", "addons.use" ], "conditional_scopes": [], "required_scopes": [ "addon.shopently.blog:post_publish" ] } } }, "/api/v1/auth/revoke": { "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/authentication/#authentication-step-4" }, "operationId": "revoke_token_api_v1_auth_revoke_post", "requestBody": { "content": { "application/json": { "example": { "access_token": "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" }, "schema": { "$ref": "#/components/schemas/TokenRevokeRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "revoked": true }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_TokenRevokedData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0.0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0.0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "ApiKey": [] } ], "summary": "Revoke Token", "tags": [ "Authentication" ], "x-shopently-access": { "api_plan_features": [ "api.enabled" ], "conditional_scopes": [], "required_scopes": [] } } }, "/api/v1/auth/token": { "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/authentication/#authentication-step-2" }, "operationId": "token_api_v1_auth_token_post", "requestBody": { "content": { "application/json": { "example": { "ttl_seconds": 1800 }, "schema": { "anyOf": [ { "$ref": "#/components/schemas/TokenRequest" }, { "type": "null" } ], "title": "Body" } } } }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "access_token": "EXAMPLE_ACCESS_TOKEN", "expires_at": "2026-01-01T12:15:00Z", "expires_in": 1800, "permissions": [ "orders.order:read" ], "rate_limits": { "auth_per_minute": 1, "read_per_minute": 2, "write_per_minute": 15 }, "token_type": "Bearer", "warnings": [] }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_TokenData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0.0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0.0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "ApiKey": [] } ], "summary": "Token", "tags": [ "Authentication" ], "x-shopently-access": { "api_plan_features": [ "api.enabled" ], "conditional_scopes": [], "required_scopes": [] } } }, "/api/v1/brands": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/brands/list/" }, "operationId": "collection_api_v1_brands_get", "parameters": [ { "example": 20, "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": [ { "created_at": "2026-01-01T12:00:00Z", "id": "example", "name": "Example", "number": "example", "updated_at": "2026-01-01T12:00:00Z", "version": 1 } ], "meta": { "locale": "en", "market_code": "PL", "market_id": "example", "pagination": { "has_more": false, "limit": 20, "next_cursor": null }, "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_list_BrandData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Collection", "tags": [ "Brands" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.brand:read" ] } }, "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/brands/create/" }, "operationId": "create_brand_api_v1_brands_post", "parameters": [ { "example": "example-create_brand_api_v1_brands_post", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "name": "Example" }, "schema": { "$ref": "#/components/schemas/BrandCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Brand", "tags": [ "Brands" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.brand:create" ] } } }, "/api/v1/brands/{identity}": { "delete": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/brands/delete/" }, "operationId": "delete_brand_api_v1_brands__identity__delete", "parameters": [ { "example": "example", "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "example": 1, "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "example": "example-delete_brand_api_v1_brands__identity__delete", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": true, "id": "example", "version": null }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Delete Brand", "tags": [ "Brands" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.brand:delete" ] } }, "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/brands/get/" }, "operationId": "record_api_v1_brands__identity__get", "parameters": [ { "example": "example", "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "created_at": "2026-01-01T12:00:00Z", "id": "example", "name": "Example", "number": "example", "updated_at": "2026-01-01T12:00:00Z", "version": 1 }, "meta": { "locale": "en", "market_code": "PL", "market_id": "example", "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_BrandData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Record", "tags": [ "Brands" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.brand:read" ] } }, "patch": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/brands/update/" }, "operationId": "update_brand_api_v1_brands__identity__patch", "parameters": [ { "example": "example", "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "example": "example-update_brand_api_v1_brands__identity__patch", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 1, "name": "Example" }, "schema": { "$ref": "#/components/schemas/BrandUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Brand", "tags": [ "Brands" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.brand:update" ] } } }, "/api/v1/categories": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/categories/list/" }, "operationId": "category_list_api_v1_categories_get", "parameters": [ { "example": 20, "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "query", "name": "parent_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Parent Id" } }, { "in": "query", "name": "is_visible", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Visible" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": [ { "created_at": "2026-01-01T12:00:00Z", "id": "example", "is_available": true, "is_visible": false, "name": "Example", "number": "example", "parent_id": null, "slug": "example", "updated_at": "2026-01-01T12:00:00Z", "version": 1 } ], "meta": { "locale": "en", "market_code": "PL", "market_id": "example", "pagination": { "has_more": false, "limit": 20, "next_cursor": null }, "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_list_CategorySummaryData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Category List", "tags": [ "Categories" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.category:read" ] } }, "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/categories/create/" }, "operationId": "create_category_api_v1_categories_post", "parameters": [ { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "example": "example-create_category_api_v1_categories_post", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "name": "Example" }, "schema": { "$ref": "#/components/schemas/CategoryCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Category", "tags": [ "Categories" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.category:create" ] } } }, "/api/v1/categories/{category_id}": { "delete": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/categories/delete/" }, "operationId": "delete_category_api_v1_categories__category_id__delete", "parameters": [ { "example": "example", "in": "path", "name": "category_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Category Id", "type": "string" } }, { "example": 1, "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "example": "example-delete_category_api_v1_categories__category_id__delete", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": true, "id": "example", "version": null }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Delete Category", "tags": [ "Categories" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.category:delete" ] } }, "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/categories/get/" }, "operationId": "category_detail_api_v1_categories__category_id__get", "parameters": [ { "example": "example", "in": "path", "name": "category_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Category Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "created_at": "2026-01-01T12:00:00Z", "description": "example", "id": "example", "introduction": "example", "is_available": true, "is_visible": false, "meta_description": "example", "meta_keywords": [ "example" ], "meta_title": "example", "name": "Example", "number": "example", "parent_id": null, "slug": "example", "updated_at": "2026-01-01T12:00:00Z", "version": 1 }, "meta": { "locale": "en", "market_code": "PL", "market_id": "example", "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_CategoryDetailData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Category Detail", "tags": [ "Categories" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.category:read" ] } }, "patch": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/categories/update/" }, "operationId": "update_category_api_v1_categories__category_id__patch", "parameters": [ { "example": "example", "in": "path", "name": "category_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Category Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "example": "example-update_category_api_v1_categories__category_id__patch", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 1, "name": "Example" }, "schema": { "$ref": "#/components/schemas/CategoryUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Category", "tags": [ "Categories" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.category:update" ] } } }, "/api/v1/context": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/context/#principles" }, "operationId": "context_api_v1_context_get", "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "base_market_id": "example", "default_locale": "en", "global_enabled": false, "languages": [ { "code": "en", "direction": "ltr", "is_default": true, "name": "English", "native_name": "English", "status": "draft" } ], "markets": [ { "code": "PL", "currency": { "code": "PLN", "minor_units": 2 }, "id": "example", "is_default": true, "name": "Poland", "price_list": null, "status": "draft" } ], "multilingual_enabled": false }, "meta": { "locale": "en", "market_code": "PL", "market_id": "example", "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_ContextData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0.0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0.0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Context", "tags": [ "Context" ], "x-shopently-access": { "api_plan_features": [ "api.enabled" ], "conditional_scopes": [], "required_scopes": [] } } }, "/api/v1/discounts/coupons": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/discounts/coupons-list/" }, "operationId": "collection_api_v1_discounts_coupons_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": [], "meta": { "locale": "example", "market_code": "example", "market_id": "poland", "pagination": { "has_more": false, "limit": 1, "next_cursor": null }, "request_id": "learn-example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_list_CampaignData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Collection", "tags": [ "Discounts" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "discounts.coupons:read" ] } }, "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/discounts/coupons-create/" }, "operationId": "create_campaign_api_v1_discounts_coupons_post", "parameters": [ { "example": "learn-create_campaign_api_v1_discounts_coupons_post", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "code": "LEARN10", "markets": [ { "currency": "PLN", "market_id": "poland", "minor_units": 2 } ], "name": "Autumn guide offer" }, "schema": { "$ref": "#/components/schemas/CampaignCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example-campaign", "version": null }, "meta": { "locale": "example", "market_code": "example", "market_id": "poland", "pagination": { "has_more": false, "limit": 1, "next_cursor": null }, "request_id": "learn-example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Campaign", "tags": [ "Discounts" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "discounts.coupons:create" ] } } }, "/api/v1/discounts/coupons/{identity}": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/discounts/coupons-get/" }, "operationId": "record_api_v1_discounts_coupons__identity__get", "parameters": [ { "example": "example-campaign", "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "created_at": "2026-10-07T10:00:00Z", "created_by": { "kind": "admin", "label": "Editorial integration", "reference": "learn-api-key" }, "enabled": false, "id": "example-campaign", "kind": "coupon", "markets": [ { "currency": "PLN", "market_id": "poland", "minor_units": 0 } ], "name": "Autumn guide offer", "updated_at": "2026-10-07T10:00:00Z", "used_count": 0, "version": 1 }, "meta": { "locale": "example", "market_code": "example", "market_id": "poland", "pagination": { "has_more": false, "limit": 1, "next_cursor": null }, "request_id": "learn-example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_CampaignData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Record", "tags": [ "Discounts" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "discounts.coupons:read" ] } }, "patch": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/discounts/coupons-update/" }, "operationId": "update_campaign_api_v1_discounts_coupons__identity__patch", "parameters": [ { "example": "example-campaign", "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "example": "learn-update_campaign_api_v1_discounts_coupons__identity__patch", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "code": "LEARN10", "expected_version": 1, "markets": [ { "currency": "PLN", "market_id": "poland", "minor_units": 2 } ], "name": "Autumn guide offer" }, "schema": { "$ref": "#/components/schemas/CampaignUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example-campaign", "version": null }, "meta": { "locale": "example", "market_code": "example", "market_id": "poland", "pagination": { "has_more": false, "limit": 1, "next_cursor": null }, "request_id": "learn-example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Campaign", "tags": [ "Discounts" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "discounts.coupons:update" ] } } }, "/api/v1/discounts/coupons/{identity}/status": { "patch": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/discounts/coupons-status/" }, "operationId": "campaign_status_api_v1_discounts_coupons__identity__status_patch", "parameters": [ { "example": "example-campaign", "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "example": "learn-campaign_status_api_v1_discounts_coupons__identity__status_patch", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "enabled": false, "expected_version": 1 }, "schema": { "$ref": "#/components/schemas/CampaignStatus" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example-campaign", "version": null }, "meta": { "locale": "example", "market_code": "example", "market_id": "poland", "pagination": { "has_more": false, "limit": 1, "next_cursor": null }, "request_id": "learn-example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Campaign Status", "tags": [ "Discounts" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "discounts.coupons:change_status" ] } } }, "/api/v1/discounts/promotions": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/discounts/promotions-list/" }, "operationId": "collection_api_v1_discounts_promotions_get", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": [], "meta": { "locale": "example", "market_code": "example", "market_id": "poland", "pagination": { "has_more": false, "limit": 1, "next_cursor": null }, "request_id": "learn-example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_list_CampaignData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Collection", "tags": [ "Discounts" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "discounts.promotions:read" ] } }, "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/discounts/promotions-create/" }, "operationId": "create_campaign_api_v1_discounts_promotions_post", "parameters": [ { "example": "learn-create_campaign_api_v1_discounts_promotions_post", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "markets": [ { "currency": "PLN", "market_id": "poland", "minor_units": 2 } ], "name": "Autumn guide offer" }, "schema": { "$ref": "#/components/schemas/CampaignCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example-campaign", "version": null }, "meta": { "locale": "example", "market_code": "example", "market_id": "poland", "pagination": { "has_more": false, "limit": 1, "next_cursor": null }, "request_id": "learn-example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Campaign", "tags": [ "Discounts" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "discounts.promotions:create" ] } } }, "/api/v1/discounts/promotions/{identity}": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/discounts/promotions-get/" }, "operationId": "record_api_v1_discounts_promotions__identity__get", "parameters": [ { "example": "example-campaign", "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "created_at": "2026-10-07T10:00:00Z", "created_by": { "kind": "admin", "label": "Editorial integration", "reference": "learn-api-key" }, "enabled": false, "id": "example-campaign", "kind": "coupon", "markets": [ { "currency": "PLN", "market_id": "poland", "minor_units": 0 } ], "name": "Autumn guide offer", "updated_at": "2026-10-07T10:00:00Z", "used_count": 0, "version": 1 }, "meta": { "locale": "example", "market_code": "example", "market_id": "poland", "pagination": { "has_more": false, "limit": 1, "next_cursor": null }, "request_id": "learn-example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_CampaignData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Record", "tags": [ "Discounts" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "discounts.promotions:read" ] } }, "patch": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/discounts/promotions-update/" }, "operationId": "update_campaign_api_v1_discounts_promotions__identity__patch", "parameters": [ { "example": "example-campaign", "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "example": "learn-update_campaign_api_v1_discounts_promotions__identity__patch", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 1, "markets": [ { "currency": "PLN", "market_id": "poland", "minor_units": 2 } ], "name": "Autumn guide offer" }, "schema": { "$ref": "#/components/schemas/CampaignUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example-campaign", "version": null }, "meta": { "locale": "example", "market_code": "example", "market_id": "poland", "pagination": { "has_more": false, "limit": 1, "next_cursor": null }, "request_id": "learn-example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Campaign", "tags": [ "Discounts" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "discounts.promotions:update" ] } } }, "/api/v1/discounts/promotions/{identity}/status": { "patch": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/discounts/promotions-status/" }, "operationId": "campaign_status_api_v1_discounts_promotions__identity__status_patch", "parameters": [ { "example": "example-campaign", "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "example": "learn-campaign_status_api_v1_discounts_promotions__identity__status_patch", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "enabled": false, "expected_version": 1 }, "schema": { "$ref": "#/components/schemas/CampaignStatus" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example-campaign", "version": null }, "meta": { "locale": "example", "market_code": "example", "market_id": "poland", "pagination": { "has_more": false, "limit": 1, "next_cursor": null }, "request_id": "learn-example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Campaign Status", "tags": [ "Discounts" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "discounts.promotions:change_status" ] } } }, "/api/v1/features": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/features/list/" }, "operationId": "collection_api_v1_features_get", "parameters": [ { "example": 20, "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": [ { "created_at": "2026-01-01T12:00:00Z", "id": "example", "name": "Example", "number": "example", "position": 1, "updated_at": "2026-01-01T12:00:00Z", "version": 1 } ], "meta": { "locale": "en", "market_code": "PL", "market_id": "example", "pagination": { "has_more": false, "limit": 20, "next_cursor": null }, "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_list_FeatureData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Collection", "tags": [ "Features" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.feature:read" ] } }, "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/features/create/" }, "operationId": "create_feature_api_v1_features_post", "parameters": [ { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "example": "example-create_feature_api_v1_features_post", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "name": "Example" }, "schema": { "$ref": "#/components/schemas/FeatureCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Feature", "tags": [ "Features" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.feature:create" ] } } }, "/api/v1/features/{identity}": { "delete": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/features/delete/" }, "operationId": "delete_feature_api_v1_features__identity__delete", "parameters": [ { "example": "example", "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "example": 1, "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "example": "example-delete_feature_api_v1_features__identity__delete", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": true, "id": "example", "version": null }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Delete Feature", "tags": [ "Features" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.feature:delete" ] } }, "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/features/get/" }, "operationId": "record_api_v1_features__identity__get", "parameters": [ { "example": "example", "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "created_at": "2026-01-01T12:00:00Z", "id": "example", "name": "Example", "number": "example", "position": 1, "updated_at": "2026-01-01T12:00:00Z", "version": 1 }, "meta": { "locale": "en", "market_code": "PL", "market_id": "example", "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_FeatureData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Record", "tags": [ "Features" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.feature:read" ] } }, "patch": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/features/update/" }, "operationId": "update_feature_api_v1_features__identity__patch", "parameters": [ { "example": "example", "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "example": "example-update_feature_api_v1_features__identity__patch", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 1, "name": "Example" }, "schema": { "$ref": "#/components/schemas/FeatureUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Feature", "tags": [ "Features" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.feature:update" ] } } }, "/api/v1/features/{identity}/values": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/features/list-values/" }, "operationId": "values_api_v1_features__identity__values_get", "parameters": [ { "example": "example", "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "example": 20, "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": [ { "created_at": "2026-01-01T12:00:00Z", "feature_id": "example", "id": "example", "number": "example", "position": 1, "updated_at": "2026-01-01T12:00:00Z", "value": "example", "version": 1 } ], "meta": { "locale": "en", "market_code": "PL", "market_id": "example", "pagination": { "has_more": false, "limit": 20, "next_cursor": null }, "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_list_FeatureValueData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Values", "tags": [ "Features" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.feature:read" ] } }, "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/features/create-value/" }, "operationId": "create_feature_value_api_v1_features__identity__values_post", "parameters": [ { "example": "example", "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "example": "example-create_feature_value_api_v1_features__identity__values_post", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 1, "value": "Example" }, "schema": { "$ref": "#/components/schemas/FeatureValueCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Feature Value", "tags": [ "Features" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.feature:create" ] } } }, "/api/v1/features/{identity}/values/{value_id}": { "delete": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/features/delete-value/" }, "operationId": "delete_feature_value_api_v1_features__identity__values__value_id__delete", "parameters": [ { "example": "example", "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "example": "example", "in": "path", "name": "value_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Value Id", "type": "string" } }, { "example": 1, "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "example": "example-delete_feature_value_api_v1_features__identity__values__value_id__delete", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": true, "id": "example", "version": null }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Delete Feature Value", "tags": [ "Features" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.feature:delete" ] } }, "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/features/get-value/" }, "operationId": "value_record_api_v1_features__identity__values__value_id__get", "parameters": [ { "example": "example", "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "example": "example", "in": "path", "name": "value_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Value Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "created_at": "2026-01-01T12:00:00Z", "feature_id": "example", "id": "example", "number": "example", "position": 1, "updated_at": "2026-01-01T12:00:00Z", "value": "example", "version": 1 }, "meta": { "locale": "en", "market_code": "PL", "market_id": "example", "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_FeatureValueData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Value Record", "tags": [ "Features" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.feature:read" ] } }, "patch": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/features/update-value/" }, "operationId": "update_feature_value_api_v1_features__identity__values__value_id__patch", "parameters": [ { "example": "example", "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "example": "example", "in": "path", "name": "value_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Value Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "example": "example-update_feature_value_api_v1_features__identity__values__value_id__patch", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 1, "value": "Example" }, "schema": { "$ref": "#/components/schemas/FeatureValueUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Feature Value", "tags": [ "Features" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.feature:update" ] } } }, "/api/v1/inventory/deliveries": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/deliveries/list/" }, "operationId": "delivery_list_api_v1_inventory_deliveries_get", "parameters": [ { "example": 20, "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "warehouse_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Warehouse Id" } }, { "in": "query", "name": "target_type", "required": false, "schema": { "anyOf": [ { "enum": [ "product", "variant" ], "type": "string" }, { "type": "null" } ], "title": "Target Type" } }, { "in": "query", "name": "target_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Target Id" } }, { "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "enum": [ "planned", "received" ], "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "in": "query", "name": "record_status", "required": false, "schema": { "anyOf": [ { "enum": [ "active", "deleted" ], "type": "string" }, { "type": "null" } ], "title": "Record Status" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": [ { "created_at": "2026-01-01T12:00:00Z", "deleted_at": null, "delivered_at": "2026-01-01T12:00:00Z", "id": "example", "increases_stock": true, "location_id": "example", "quantity": 1, "received_at": null, "record_status": "active", "status": "planned", "stock_applied_at": null, "target_id": "example", "target_type": "product", "updated_at": "2026-01-01T12:00:00Z", "version": 1, "warehouse_id": "example" } ], "meta": { "pagination": { "has_more": false, "limit": 20, "next_cursor": null }, "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_DeliveryData____2" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Delivery List", "tags": [ "Deliveries" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.stock_delivery:read" ] } }, "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/deliveries/create/" }, "operationId": "create_delivery_api_v1_inventory_deliveries_post", "parameters": [ { "example": "example-create_delivery_api_v1_inventory_deliveries_post", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "delivered_at": "2026-01-01T00:00:00Z", "location_id": "example", "quantity": 1, "status": "planned", "target_id": "example", "target_type": "product", "warehouse_id": "example" }, "schema": { "$ref": "#/components/schemas/DeliveryCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Delivery", "tags": [ "Inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.stock_delivery:create" ] } } }, "/api/v1/inventory/deliveries/{delivery_id}": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/deliveries/get/" }, "operationId": "delivery_detail_api_v1_inventory_deliveries__delivery_id__get", "parameters": [ { "example": "example", "in": "path", "name": "delivery_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Delivery Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "created_at": "2026-01-01T12:00:00Z", "deleted_at": null, "delivered_at": "2026-01-01T12:00:00Z", "id": "example", "increases_stock": true, "location_id": "example", "notes": "example", "quantity": 1, "received_at": null, "record_status": "active", "status": "planned", "stock_applied_at": null, "target_id": "example", "target_type": "product", "updated_at": "2026-01-01T12:00:00Z", "version": 1, "warehouse_id": "example" }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_DeliveryDetailData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Delivery Detail", "tags": [ "Deliveries" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.stock_delivery:read" ] } } }, "/api/v1/inventory/products/{product_id}/digital-imports": { "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/inventory/import-create/" }, "operationId": "create_import_api_v1_inventory_products__product_id__digital_imports_post", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "220d9f39-b8d9-5f28-9c9c-b85f003679fa", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "count": 2, "kind": "code" }, "schema": { "$ref": "#/components/schemas/ImportCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "00000000-0000-4000-8000-000000000001", "version": 1 }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Import", "tags": [ "Digital inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.digital_unit:write" ] } } }, "/api/v1/inventory/products/{product_id}/digital-imports/{import_id}": { "delete": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/inventory/import-cancel/" }, "operationId": "cancel_import_api_v1_inventory_products__product_id__digital_imports__import_id__delete", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000001", "in": "path", "name": "import_id", "required": true, "schema": { "format": "uuid", "title": "Import Id", "type": "string" } }, { "example": 1, "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "example": "786bad73-d0c0-5909-afa0-efb95ae35ad7", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "00000000-0000-4000-8000-000000000001", "version": 2 }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Cancel Import", "tags": [ "Digital inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.digital_unit:delete" ] } }, "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/inventory/import-read/" }, "operationId": "read_import_api_v1_inventory_products__product_id__digital_imports__import_id__get", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000001", "in": "path", "name": "import_id", "required": true, "schema": { "format": "uuid", "title": "Import Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "delivery_id": null, "delivery_status": null, "delivery_version": null, "expected_count": 2, "expires_at": "2026-11-03T13:00:00Z", "id": "00000000-0000-4000-8000-000000000001", "kind": "code", "product_id": "example", "status": "validated", "validated_count": 2, "validation_digest": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", "version": 2 }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_ImportData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Read Import", "tags": [ "Digital inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.digital_unit:read" ] } } }, "/api/v1/inventory/products/{product_id}/digital-imports/{import_id}/commit": { "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/inventory/import-commit/" }, "operationId": "commit_import_api_v1_inventory_products__product_id__digital_imports__import_id__commit_post", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000001", "in": "path", "name": "import_id", "required": true, "schema": { "format": "uuid", "title": "Import Id", "type": "string" } }, { "example": "3481f068-87b2-5453-b3ef-2ab932a153bf", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "delivered_at": "2026-11-03T12:00:00Z", "expected_delivery_version": 0, "expected_sales_limit_version": 0, "expected_version": 2, "location_id": "location-digital", "publish_for_sale": true, "status": "received", "validation_digest": "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb", "warehouse_id": "warehouse-main" }, "schema": { "$ref": "#/components/schemas/ImportCommit" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "00000000-0000-4000-8000-000000000001", "version": 2 }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Commit Import", "tags": [ "Digital inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [ { "body_field": "publish_for_sale", "scopes": [ "inventory.stock:update_sales_limit" ], "when": "true" } ], "required_scopes": [ "inventory.digital_unit:write", "inventory.stock_delivery:create" ] } } }, "/api/v1/inventory/products/{product_id}/digital-imports/{import_id}/receive": { "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/inventory/import-receive/" }, "operationId": "receive_import_api_v1_inventory_products__product_id__digital_imports__import_id__receive_post", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000001", "in": "path", "name": "import_id", "required": true, "schema": { "format": "uuid", "title": "Import Id", "type": "string" } }, { "example": "c5b4d095-b59c-5d18-b8f4-fcbb49a4e0ec", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_delivery_version": 1, "expected_version": 3 }, "schema": { "$ref": "#/components/schemas/ImportReceive" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "00000000-0000-4000-8000-000000000001", "version": 2 }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Receive Import", "tags": [ "Digital inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [ { "body_field": "publish_for_sale", "scopes": [ "inventory.stock:update_sales_limit" ], "when": "true" } ], "required_scopes": [ "inventory.digital_unit:write", "inventory.stock_delivery:create" ] } } }, "/api/v1/inventory/products/{product_id}/digital-imports/{import_id}/validate": { "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/inventory/import-validate/" }, "operationId": "validate_import_api_v1_inventory_products__product_id__digital_imports__import_id__validate_post", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000001", "in": "path", "name": "import_id", "required": true, "schema": { "format": "uuid", "title": "Import Id", "type": "string" } }, { "example": "33138cb2-27a3-5f27-a0fb-3023fb3dec88", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 1, "format": "txt", "source_upload_id": "00000000-0000-4000-8000-000000000002" }, "schema": { "$ref": "#/components/schemas/ImportValidate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "00000000-0000-4000-8000-000000000001", "version": 2 }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Validate Import", "tags": [ "Digital inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.digital_unit:write" ] } } }, "/api/v1/inventory/products/{product_id}/digital-imports/{import_id}/withdrawal": { "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/inventory/import-withdraw/" }, "operationId": "withdraw_import_api_v1_inventory_products__product_id__digital_imports__import_id__withdrawal_post", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000001", "in": "path", "name": "import_id", "required": true, "schema": { "format": "uuid", "title": "Import Id", "type": "string" } }, { "example": "a941dbf7-c57f-5f38-85e2-7d058ce28935", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_delivery_version": 1, "expected_order_version": 1, "expected_version": 3, "reason": "Withdraw a revoked license" }, "schema": { "$ref": "#/components/schemas/ImportWithdrawal" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "00000000-0000-4000-8000-000000000001", "version": 2 }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Withdraw Import", "tags": [ "Digital inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.digital_unit:delete" ] } } }, "/api/v1/inventory/products/{product_id}/digital-pool": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/inventory/pool-read/" }, "operationId": "read_pool_api_v1_inventory_products__product_id__digital_pool_get", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "configured": true, "counts": { "available": 1, "held": 0, "issued": 1, "planned": 0, "retired": 0, "staged": 0 }, "email_mode": "order_link", "enabled": true, "order_version": 2, "product_id": "example", "retention_days": null, "version": 1 }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_PoolData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Read Pool", "tags": [ "Digital inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.digital_unit:read" ] } }, "patch": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/inventory/pool-save/" }, "operationId": "save_pool_api_v1_inventory_products__product_id__digital_pool_patch", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "ee843b03-c1d6-520f-b617-e14f9ca773eb", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "email_mode": "order_link", "enabled": true, "expected_version": 0, "retention_days": null }, "schema": { "$ref": "#/components/schemas/PoolChange" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "00000000-0000-4000-8000-000000000001", "version": 2 }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Save Pool", "tags": [ "Digital inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.digital_pool:manage" ] } } }, "/api/v1/inventory/products/{product_id}/digital-units": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/inventory/units-list/" }, "operationId": "listing_api_v1_inventory_products__product_id__digital_units_get", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "state", "required": false, "schema": { "default": "available", "enum": [ "available", "held", "issued", "retired", "planned" ], "title": "State", "type": "string" } }, { "in": "query", "name": "warehouse_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Warehouse Id" } }, { "in": "query", "name": "kind", "required": false, "schema": { "anyOf": [ { "enum": [ "file", "code" ], "type": "string" }, { "type": "null" } ], "title": "Kind" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "order_version": 2, "total": 1, "units": [ { "content_state": "present", "delivery_id": "delivery-example", "filename": null, "id": "00000000-0000-4000-8000-000000000003", "issued_at": null, "kind": "code", "location_id": "location-digital", "mime_type": null, "payload_id": "00000000-0000-4000-8000-000000000004", "product_id": "example", "size_bytes": null, "sort_order": 1, "state": "available", "version": 1, "warehouse_id": "warehouse-main" } ] }, "meta": { "pagination": { "has_more": false, "limit": 50, "next_cursor": null }, "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_UnitsData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Listing", "tags": [ "Digital inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.digital_unit:read" ] } } }, "/api/v1/inventory/products/{product_id}/digital-units/reorder": { "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/inventory/units-reorder/" }, "operationId": "reorder_api_v1_inventory_products__product_id__digital_units_reorder_post", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "8e721db4-9367-576b-8727-c99c91ff825c", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_order_version": 1, "unit_ids": [ "00000000-0000-4000-8000-000000000008", "00000000-0000-4000-8000-000000000003" ] }, "schema": { "$ref": "#/components/schemas/UnitReorder" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "00000000-0000-4000-8000-000000000001", "version": 2 }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Reorder", "tags": [ "Digital inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.digital_unit:write" ] } } }, "/api/v1/inventory/products/{product_id}/digital-units/{unit_id}/content": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/inventory/unit-content/" }, "operationId": "get_content_api_v1_inventory_products__product_id__digital_units__unit_id__content_get", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000003", "in": "path", "name": "unit_id", "required": true, "schema": { "format": "uuid", "title": "Unit Id", "type": "string" } } ], "responses": { "200": { "content": { "application/epub+zip": { "schema": { "format": "binary", "type": "string" } }, "application/json": { "examples": { "success": { "value": { "data": { "code": "DEMO-ONE", "delivery_id": null, "kind": "code", "payload_id": "00000000-0000-4000-8000-000000000004", "unit_id": "00000000-0000-4000-8000-000000000003" }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_CodeContentData_" } }, "application/pdf": { "schema": { "format": "binary", "type": "string" } }, "application/zip": { "schema": { "format": "binary", "type": "string" } }, "audio/mpeg": { "schema": { "format": "binary", "type": "string" } }, "image/avif": { "schema": { "format": "binary", "type": "string" } }, "image/jpeg": { "schema": { "format": "binary", "type": "string" } }, "image/png": { "schema": { "format": "binary", "type": "string" } }, "image/svg+xml": { "schema": { "format": "binary", "type": "string" } }, "image/webp": { "schema": { "format": "binary", "type": "string" } }, "video/mp4": { "schema": { "format": "binary", "type": "string" } } }, "description": "Authorized file or explicitly revealed code" }, "206": { "content": { "application/epub+zip": { "schema": { "format": "binary", "type": "string" } }, "application/pdf": { "schema": { "format": "binary", "type": "string" } }, "application/zip": { "schema": { "format": "binary", "type": "string" } }, "audio/mpeg": { "schema": { "format": "binary", "type": "string" } }, "image/avif": { "schema": { "format": "binary", "type": "string" } }, "image/jpeg": { "schema": { "format": "binary", "type": "string" } }, "image/png": { "schema": { "format": "binary", "type": "string" } }, "image/svg+xml": { "schema": { "format": "binary", "type": "string" } }, "image/webp": { "schema": { "format": "binary", "type": "string" } }, "video/mp4": { "schema": { "format": "binary", "type": "string" } } }, "description": "Authorized single byte range" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Get Content", "tags": [ "Digital inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.digital_unit:reveal" ] } }, "head": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/inventory/unit-head/" }, "operationId": "head_content_api_v1_inventory_products__product_id__digital_units__unit_id__content_head", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000003", "in": "path", "name": "unit_id", "required": true, "schema": { "format": "uuid", "title": "Unit Id", "type": "string" } } ], "responses": { "200": { "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Head Content", "tags": [ "Digital inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.digital_unit:reveal" ] } } }, "/api/v1/inventory/products/{product_id}/digital-units/{unit_id}/content-deletion": { "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/inventory/unit-delete/" }, "operationId": "withdraw_api_v1_inventory_products__product_id__digital_units__unit_id__content_deletion_post", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000003", "in": "path", "name": "unit_id", "required": true, "schema": { "format": "uuid", "title": "Unit Id", "type": "string" } }, { "example": "2c2219ee-ab71-5090-896d-c2a0f2f33f69", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 1, "reason": "Withdraw a revoked license" }, "schema": { "$ref": "#/components/schemas/UnitDeletion" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "00000000-0000-4000-8000-000000000003", "version": 2 }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Withdraw", "tags": [ "Digital inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.digital_unit:delete" ] } } }, "/api/v1/inventory/products/{product_id}/digital-units/{unit_id}/replacement": { "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/inventory/unit-replace/" }, "operationId": "replace_api_v1_inventory_products__product_id__digital_units__unit_id__replacement_post", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000003", "in": "path", "name": "unit_id", "required": true, "schema": { "format": "uuid", "title": "Unit Id", "type": "string" } }, { "example": "b8d3ed25-9cdc-581d-9008-5d215c7cd1c3", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "code": "SYNTHETIC-REPLACEMENT", "expected_version": 1, "reason": "Replace an invalid activation code" }, "schema": { "$ref": "#/components/schemas/UnitReplacement" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "00000000-0000-4000-8000-000000000003", "version": 2 }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Replace", "tags": [ "Digital inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.digital_unit:write" ] } } }, "/api/v1/inventory/products/{product_id}/digital-uploads": { "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/inventory/upload-create/" }, "operationId": "create_upload_api_v1_inventory_products__product_id__digital_uploads_post", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "7ff87132-4c36-5199-a071-a75ddf81f9f4", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "consumer_id": "00000000-0000-4000-8000-000000000001", "consumer_kind": "digital_import", "filename": "codes.txt", "purpose": "digital_import", "sha256": "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a", "size_bytes": 18 }, "schema": { "$ref": "#/components/schemas/DigitalUploadCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "00000000-0000-4000-8000-000000000002", "version": null }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Upload", "tags": [ "Digital inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.digital_unit:write" ] } } }, "/api/v1/inventory/products/{product_id}/digital-uploads/{upload_id}": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/inventory/upload-read/" }, "operationId": "read_upload_api_v1_inventory_products__product_id__digital_uploads__upload_id__get", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000002", "in": "path", "name": "upload_id", "required": true, "schema": { "format": "uuid", "title": "Upload Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "consumer_id": "00000000-0000-4000-8000-000000000001", "consumer_kind": "digital_import", "expires_at": "2026-11-03T13:00:00Z", "filename": "codes.txt", "id": "00000000-0000-4000-8000-000000000002", "product_id": "example", "purpose": "digital_import", "received_bytes": 18, "sha256": "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a", "size_bytes": 18, "status": "ready" }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_DigitalUploadData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Read Upload", "tags": [ "Digital inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.digital_unit:read" ] } } }, "/api/v1/inventory/products/{product_id}/digital-uploads/{upload_id}/content": { "put": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/inventory/upload-content/" }, "operationId": "receive_upload_api_v1_inventory_products__product_id__digital_uploads__upload_id__content_put", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000002", "in": "path", "name": "upload_id", "required": true, "schema": { "format": "uuid", "title": "Upload Id", "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "additionalProperties": false, "properties": { "file": { "format": "binary", "type": "string" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "consumer_id": "00000000-0000-4000-8000-000000000001", "consumer_kind": "digital_import", "expires_at": "2026-11-03T13:00:00Z", "filename": "codes.txt", "id": "00000000-0000-4000-8000-000000000002", "product_id": "example", "purpose": "digital_import", "received_bytes": 18, "sha256": "636e307039d9ca307836e9a93ea492425545bcccb6cb4ef935ab635560db828a", "size_bytes": 18, "status": "ready" }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_DigitalUploadData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Receive Upload", "tags": [ "Digital inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.digital_unit:write" ] } } }, "/api/v1/inventory/stock": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/inventory/list-stock/" }, "operationId": "stock_list_api_v1_inventory_stock_get", "parameters": [ { "example": 20, "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "warehouse_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Warehouse Id" } }, { "in": "query", "name": "target_type", "required": false, "schema": { "anyOf": [ { "enum": [ "product", "variant" ], "type": "string" }, { "type": "null" } ], "title": "Target Type" } }, { "in": "query", "name": "target_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Target Id" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": [ { "active": true, "available": 5, "id": "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ", "manual_reserved": 2, "on_hand": 10, "reserved": 3, "sellable_limit": 10, "target_id": "example", "target_type": "product", "total_reserved": 5, "updated_at": "2026-01-01T12:00:00Z", "version": 1, "warehouse_id": "example" } ], "meta": { "pagination": { "has_more": false, "limit": 20, "next_cursor": null }, "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_list_StockData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Stock List", "tags": [ "Inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.stock:read" ] } } }, "/api/v1/inventory/stock-adjustments": { "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/inventory/create-adjustment/" }, "operationId": "create_adjustment_api_v1_inventory_stock_adjustments_post", "parameters": [ { "example": "example-create_adjustment_api_v1_inventory_stock_adjustments_post", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 0, "locations": [ { "location_id": "example", "on_hand": 1 } ], "reason": "Example", "target_id": "example", "target_type": "product", "warehouse_id": "example" }, "schema": { "$ref": "#/components/schemas/StockAdjustmentCreate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "201": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Adjustment", "tags": [ "Inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.stock:update" ] } } }, "/api/v1/inventory/stock/{stock_id}": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/inventory/get-stock/" }, "operationId": "stock_detail_api_v1_inventory_stock__stock_id__get", "parameters": [ { "example": "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ", "in": "path", "name": "stock_id", "required": true, "schema": { "maxLength": 256, "minLength": 1, "title": "Stock Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "active": true, "allocations": [ { "location_code": "example", "location_id": "example", "location_name": "example", "on_hand": 10 } ], "available": 5, "id": "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ", "manual_reserved": 2, "on_hand": 10, "reserved": 3, "sellable_limit": 10, "target_id": "example", "target_type": "product", "total_reserved": 5, "updated_at": "2026-01-01T12:00:00Z", "version": 1, "warehouse_id": "example" }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_StockDetailData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Stock Detail", "tags": [ "Inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.stock:read" ] } }, "patch": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/inventory/update-stock/" }, "operationId": "update_stock_api_v1_inventory_stock__stock_id__patch", "parameters": [ { "example": "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ", "in": "path", "name": "stock_id", "required": true, "schema": { "maxLength": 256, "minLength": 1, "title": "Stock Id", "type": "string" } }, { "example": "example-update_stock_api_v1_inventory_stock__stock_id__patch", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 1, "locations": [ { "location_id": "example", "on_hand": 1 } ], "reason": "Example" }, "schema": { "$ref": "#/components/schemas/StockAdjustmentUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Stock", "tags": [ "Inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.stock:update" ] } } }, "/api/v1/inventory/stock/{stock_id}/manual-reservation": { "patch": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/inventory/update-manual-reservation/" }, "operationId": "update_manual_reservation_api_v1_inventory_stock__stock_id__manual_reservation_patch", "parameters": [ { "example": "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ", "in": "path", "name": "stock_id", "required": true, "schema": { "maxLength": 256, "minLength": 1, "title": "Stock Id", "type": "string" } }, { "example": "example-update_manual_reservation_api_v1_inventory_stock__stock_id__manual_reservation_patch", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 1, "manual_reserved": 1 }, "schema": { "$ref": "#/components/schemas/ManualReservationUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Manual Reservation", "tags": [ "Inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.stock:update_manual_reservation" ] } } }, "/api/v1/inventory/stock/{stock_id}/sales-limit": { "patch": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/inventory/update-sales-limit/" }, "operationId": "update_sales_limit_api_v1_inventory_stock__stock_id__sales_limit_patch", "parameters": [ { "example": "stock_v1_WyJleGFtcGxlIiwicHJvZHVjdCIsImV4YW1wbGUiXQ", "in": "path", "name": "stock_id", "required": true, "schema": { "maxLength": 256, "minLength": 1, "title": "Stock Id", "type": "string" } }, { "example": "example-update_sales_limit_api_v1_inventory_stock__stock_id__sales_limit_patch", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 1, "sellable_limit": 1 }, "schema": { "$ref": "#/components/schemas/SalesLimitUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Sales Limit", "tags": [ "Inventory" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.stock:update_sales_limit" ] } } }, "/api/v1/inventory/warehouses": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/warehouses/list/" }, "operationId": "warehouse_list_api_v1_inventory_warehouses_get", "parameters": [ { "example": 20, "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "active", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Active" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": [ { "active": true, "address_line": "example", "city": "example", "code": "example", "country_code": "PL", "created_at": "2026-01-01T12:00:00Z", "customer_visible": false, "id": "example", "name": "Example", "postal_code": "example", "updated_at": "2026-01-01T12:00:00Z", "version": 1 } ], "meta": { "pagination": { "has_more": false, "limit": 20, "next_cursor": null }, "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_list_WarehouseData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Warehouse List", "tags": [ "Warehouses" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.stock:read" ] } } }, "/api/v1/inventory/warehouses/{warehouse_id}": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/warehouses/get/" }, "operationId": "warehouse_detail_api_v1_inventory_warehouses__warehouse_id__get", "parameters": [ { "example": "example", "in": "path", "name": "warehouse_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Warehouse Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "active": true, "address_line": "example", "city": "example", "code": "example", "country_code": "PL", "created_at": "2026-01-01T12:00:00Z", "customer_visible": false, "id": "example", "name": "Example", "postal_code": "example", "updated_at": "2026-01-01T12:00:00Z", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_WarehouseData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Warehouse Detail", "tags": [ "Warehouses" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.stock:read" ] } } }, "/api/v1/inventory/warehouses/{warehouse_id}/locations": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/warehouses/list-locations/" }, "operationId": "locations_api_v1_inventory_warehouses__warehouse_id__locations_get", "parameters": [ { "example": "example", "in": "path", "name": "warehouse_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Warehouse Id", "type": "string" } }, { "example": 20, "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "parent_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Parent Id" } }, { "in": "query", "name": "is_leaf", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Leaf" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": [ { "code": "example", "created_at": "2026-01-01T12:00:00Z", "id": "example", "is_leaf": true, "location_type": "zone", "name": "Example", "parent_id": null, "updated_at": "2026-01-01T12:00:00Z", "version": 1, "warehouse_id": "example" } ], "meta": { "pagination": { "has_more": false, "limit": 20, "next_cursor": null }, "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_list_LocationData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Locations", "tags": [ "Warehouses" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled" ], "conditional_scopes": [], "required_scopes": [ "inventory.stock:read" ] } } }, "/api/v1/order-statuses": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/orders/statuses/" }, "operationId": "order_statuses_api_v1_order_statuses_get", "parameters": [ { "example": 20, "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": [ { "created_at": "2026-01-01T12:00:00Z", "id": "status-0", "is_initial": true, "name": "New", "position": 0 }, { "created_at": "2026-01-01T12:00:00Z", "id": "status-1", "is_initial": false, "name": "Processing", "position": 1 } ], "meta": { "pagination": { "has_more": false, "limit": 20, "next_cursor": null }, "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____1" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Order Statuses", "tags": [ "Orders" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.orders.enabled" ], "conditional_scopes": [], "required_scopes": [ "orders.order:read" ] } } }, "/api/v1/orders": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/orders/list/" }, "operationId": "order_list_api_v1_orders_get", "parameters": [ { "example": 20, "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "number", "required": false, "schema": { "anyOf": [ { "maxLength": 48, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Number" } }, { "in": "query", "name": "status_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Status Id" } }, { "in": "query", "name": "payment_status", "required": false, "schema": { "anyOf": [ { "enum": [ "unpaid", "paid", "failed", "refunded" ], "type": "string" }, { "type": "null" } ], "title": "Payment Status" } }, { "in": "query", "name": "created_from", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created From" } }, { "in": "query", "name": "created_to", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created To" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": [ { "created_at": "2026-10-19T10:00:00Z", "customer": { "email": "customer@example.invalid", "first_name": "Example", "last_name": "Example", "phone": null }, "delivery": { "amount": { "amount": "0.00", "currency": "PLN", "minor_units": 2 }, "dates": { "dispatch_timezone": "Europe/Warsaw", "estimated_delivery_from": "2026-10-20", "estimated_delivery_to": "2026-10-21", "planned_dispatch_on": "2026-10-19" }, "method_code": "shipping-old", "method_name": "Historic carrier", "pickup_point": null, "recipient_mode": "full_address" }, "discount_amount": { "amount": "24.60", "currency": "PLN", "minor_units": 2 }, "id": "order-0000", "lifecycle_state": "placed", "locale": "pl", "market_id": "market-pl", "number": "0001", "payment": { "amount": { "amount": "329.40", "currency": "PLN", "minor_units": 2 }, "environment": "live", "method_code": "payment-old", "method_name": "Historic method", "paid_at": null, "status": "unpaid", "updated_at": "2026-10-19T10:00:00Z", "version": 0 }, "prices_include_tax": true, "shipping_discount_amount": { "amount": "24.60", "currency": "PLN", "minor_units": 2 }, "status": { "id": "status-0", "name": "Status 0", "updated_at": "2026-10-19T10:00:00Z", "version": 1 }, "subtotal": { "amount": "329.40", "currency": "PLN", "minor_units": 2 }, "tax": { "amount": "49.40", "currency": "PLN", "minor_units": 2 }, "tax_country_code": "PL", "total": { "amount": "329.40", "currency": "PLN", "minor_units": 2 } } ], "meta": { "pagination": { "has_more": false, "limit": 20, "next_cursor": null }, "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_list_OrderSummaryData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Order List", "tags": [ "Orders" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.orders.enabled" ], "conditional_scopes": [], "required_scopes": [ "orders.order:read" ] } } }, "/api/v1/orders/{order_id}": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/orders/details/" }, "operationId": "order_detail_api_v1_orders__order_id__get", "parameters": [ { "example": "order-0000", "in": "path", "name": "order_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Order Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "created_at": "2026-10-19T10:00:00Z", "customer": { "email": "customer@example.invalid", "first_name": "Example", "last_name": "Example", "phone": null }, "delivery": { "amount": { "amount": "0.00", "currency": "PLN", "minor_units": 2 }, "dates": { "dispatch_timezone": "Europe/Warsaw", "estimated_delivery_from": "2026-10-20", "estimated_delivery_to": "2026-10-21", "planned_dispatch_on": "2026-10-19" }, "discount_gross": { "amount": "24.60", "currency": "PLN", "minor_units": 2 }, "discount_net": { "amount": "20.00", "currency": "PLN", "minor_units": 2 }, "discount_tax": { "amount": "4.60", "currency": "PLN", "minor_units": 2 }, "discounts": [ { "amount": { "amount": "24.60", "currency": "PLN", "minor_units": 2 }, "campaign_id": "saved-coupon", "code": "SAVE", "kind": "coupon", "name": "Saved coupon", "sequence": 1, "version": 3 } ], "gross": { "amount": "0.00", "currency": "PLN", "minor_units": 2 }, "method_code": "shipping-old", "method_name": "Historic carrier", "net": { "amount": "0.00", "currency": "PLN", "minor_units": 2 }, "original_gross": { "amount": "24.60", "currency": "PLN", "minor_units": 2 }, "original_net": { "amount": "20.00", "currency": "PLN", "minor_units": 2 }, "original_tax": { "amount": "4.60", "currency": "PLN", "minor_units": 2 }, "pickup_point": null, "recipient_mode": "full_address", "tax": { "amount": "0.00", "currency": "PLN", "minor_units": 2 }, "tax_category_id": "standard", "tax_category_name": "VAT 23%", "tax_rate": "0.23" }, "discount_amount": { "amount": "24.60", "currency": "PLN", "minor_units": 2 }, "discounts": [ { "amount": { "amount": "12.30", "currency": "PLN", "minor_units": 2 }, "campaign_id": "saved-coupon", "code": "SAVE", "kind": "coupon", "name": "Saved coupon", "sequence": 1, "shipping_amount": { "amount": "24.60", "currency": "PLN", "minor_units": 2 }, "version": 3 } ], "id": "order-0000", "invoice": null, "invoice_requested": false, "lifecycle_state": "placed", "lines": [ { "discount_amount": { "amount": "24.60", "currency": "PLN", "minor_units": 2 }, "discount_gross": { "amount": "24.60", "currency": "PLN", "minor_units": 2 }, "discount_net": { "amount": "20.00", "currency": "PLN", "minor_units": 2 }, "discount_tax": { "amount": "4.60", "currency": "PLN", "minor_units": 2 }, "discounts": [ { "amount": { "amount": "12.30", "currency": "PLN", "minor_units": 2 }, "campaign_id": "saved-coupon", "code": "SAVE", "kind": "coupon", "name": "Saved coupon", "sequence": 1, "shipping_amount": null, "version": 3 } ], "identifiers": {}, "image": null, "line_id": "saved-line-a", "manual_discount": { "amount": { "amount": "12.30", "currency": "PLN", "minor_units": 2 }, "kind": "fixed", "value": "12.30" }, "name": "Saved A", "original_total": { "amount": "246.00", "currency": "PLN", "minor_units": 2 }, "original_total_gross": { "amount": "246.00", "currency": "PLN", "minor_units": 2 }, "original_total_net": { "amount": "200.00", "currency": "PLN", "minor_units": 2 }, "original_total_tax": { "amount": "46.00", "currency": "PLN", "minor_units": 2 }, "position": 1, "product_id": "product-api", "quantity": 2, "sku": "A", "tax": { "amount": "20.70", "currency": "PLN", "minor_units": 2 }, "tax_category_id": "standard", "tax_category_name": "VAT 23%", "tax_rate": "0.23", "total": { "amount": "221.40", "currency": "PLN", "minor_units": 2 }, "total_gross": { "amount": "221.40", "currency": "PLN", "minor_units": 2 }, "total_net": { "amount": "180.00", "currency": "PLN", "minor_units": 2 }, "total_tax": { "amount": "41.40", "currency": "PLN", "minor_units": 2 }, "unit_gross": { "amount": "123.00", "currency": "PLN", "minor_units": 2 }, "unit_net": { "amount": "100.00", "currency": "PLN", "minor_units": 2 }, "unit_price": { "amount": "123.00", "currency": "PLN", "minor_units": 2 }, "unit_tax": { "amount": "23.00", "currency": "PLN", "minor_units": 2 }, "variant_id": null, "variant_options": [] }, { "discount_amount": { "amount": "0.00", "currency": "PLN", "minor_units": 2 }, "discount_gross": { "amount": "0.00", "currency": "PLN", "minor_units": 2 }, "discount_net": { "amount": "0.00", "currency": "PLN", "minor_units": 2 }, "discount_tax": { "amount": "0.00", "currency": "PLN", "minor_units": 2 }, "discounts": [], "identifiers": {}, "image": null, "line_id": "b548a171-c331-505f-98f8-db3a06070998", "manual_discount": null, "name": "Saved B", "original_total": { "amount": "108.00", "currency": "PLN", "minor_units": 2 }, "original_total_gross": { "amount": "108.00", "currency": "PLN", "minor_units": 2 }, "original_total_net": { "amount": "100.00", "currency": "PLN", "minor_units": 2 }, "original_total_tax": { "amount": "8.00", "currency": "PLN", "minor_units": 2 }, "position": 2, "product_id": "deleted-product", "quantity": 1, "sku": "B", "tax": null, "tax_category_id": "reduced", "tax_category_name": "VAT 8%", "tax_rate": "0.08", "total": { "amount": "108.00", "currency": "PLN", "minor_units": 2 }, "total_gross": { "amount": "108.00", "currency": "PLN", "minor_units": 2 }, "total_net": { "amount": "100.00", "currency": "PLN", "minor_units": 2 }, "total_tax": { "amount": "8.00", "currency": "PLN", "minor_units": 2 }, "unit_gross": { "amount": "108.00", "currency": "PLN", "minor_units": 2 }, "unit_net": { "amount": "100.00", "currency": "PLN", "minor_units": 2 }, "unit_price": { "amount": "108.00", "currency": "PLN", "minor_units": 2 }, "unit_tax": { "amount": "8.00", "currency": "PLN", "minor_units": 2 }, "variant_id": null, "variant_options": [] } ], "locale": "pl", "market_id": "market-pl", "number": "0001", "payment": { "amount": { "amount": "329.40", "currency": "PLN", "minor_units": 2 }, "environment": "live", "method_code": "payment-old", "method_name": "Historic method", "paid_at": null, "status": "unpaid", "updated_at": "2026-10-19T10:00:00Z", "version": 0 }, "pickup_point": null, "prices_include_tax": true, "shipping_address": null, "shipping_discount_amount": { "amount": "24.60", "currency": "PLN", "minor_units": 2 }, "status": { "id": "status-0", "name": "Status 0", "updated_at": "2026-10-19T10:00:00Z", "version": 1 }, "subtotal": { "amount": "329.40", "currency": "PLN", "minor_units": 2 }, "tax": { "amount": "49.40", "currency": "PLN", "minor_units": 2 }, "tax_breakdown": { "groups": [ { "gross": { "amount": "221.40", "currency": "PLN", "minor_units": 2 }, "net": { "amount": "180.00", "currency": "PLN", "minor_units": 2 }, "source": "products", "tax": { "amount": "41.40", "currency": "PLN", "minor_units": 2 }, "tax_rate": "0.23" }, { "gross": { "amount": "108.00", "currency": "PLN", "minor_units": 2 }, "net": { "amount": "100.00", "currency": "PLN", "minor_units": 2 }, "source": "products", "tax": { "amount": "8.00", "currency": "PLN", "minor_units": 2 }, "tax_rate": "0.08" }, { "gross": { "amount": "0.00", "currency": "PLN", "minor_units": 2 }, "net": { "amount": "0.00", "currency": "PLN", "minor_units": 2 }, "source": "shipping", "tax": { "amount": "0.00", "currency": "PLN", "minor_units": 2 }, "tax_rate": "0.23" } ], "unallocated_tax": { "amount": "0.00", "currency": "PLN", "minor_units": 2 } }, "tax_country_code": "PL", "total": { "amount": "329.40", "currency": "PLN", "minor_units": 2 }, "totals": { "before_discounts": { "gross": { "amount": "378.60", "currency": "PLN", "minor_units": 2 }, "net": { "amount": "320.00", "currency": "PLN", "minor_units": 2 }, "tax": { "amount": "58.60", "currency": "PLN", "minor_units": 2 } }, "discounts": { "gross": { "amount": "49.20", "currency": "PLN", "minor_units": 2 }, "net": { "amount": "40.00", "currency": "PLN", "minor_units": 2 }, "tax": { "amount": "9.20", "currency": "PLN", "minor_units": 2 } }, "order": { "gross": { "amount": "329.40", "currency": "PLN", "minor_units": 2 }, "net": { "amount": "280.00", "currency": "PLN", "minor_units": 2 }, "tax": { "amount": "49.40", "currency": "PLN", "minor_units": 2 } }, "product_discounts": { "gross": { "amount": "24.60", "currency": "PLN", "minor_units": 2 }, "net": { "amount": "20.00", "currency": "PLN", "minor_units": 2 }, "tax": { "amount": "4.60", "currency": "PLN", "minor_units": 2 } }, "products": { "gross": { "amount": "329.40", "currency": "PLN", "minor_units": 2 }, "net": { "amount": "280.00", "currency": "PLN", "minor_units": 2 }, "tax": { "amount": "49.40", "currency": "PLN", "minor_units": 2 } }, "products_before_discounts": { "gross": { "amount": "354.00", "currency": "PLN", "minor_units": 2 }, "net": { "amount": "300.00", "currency": "PLN", "minor_units": 2 }, "tax": { "amount": "54.00", "currency": "PLN", "minor_units": 2 } }, "shipping": { "gross": { "amount": "0.00", "currency": "PLN", "minor_units": 2 }, "net": { "amount": "0.00", "currency": "PLN", "minor_units": 2 }, "tax": { "amount": "0.00", "currency": "PLN", "minor_units": 2 } }, "shipping_before_discounts": { "gross": { "amount": "24.60", "currency": "PLN", "minor_units": 2 }, "net": { "amount": "20.00", "currency": "PLN", "minor_units": 2 }, "tax": { "amount": "4.60", "currency": "PLN", "minor_units": 2 } }, "shipping_discounts": { "gross": { "amount": "24.60", "currency": "PLN", "minor_units": 2 }, "net": { "amount": "20.00", "currency": "PLN", "minor_units": 2 }, "tax": { "amount": "4.60", "currency": "PLN", "minor_units": 2 } } } }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_OrderDetailData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Order Detail", "tags": [ "Orders" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.orders.enabled" ], "conditional_scopes": [], "required_scopes": [ "orders.order:read" ] } } }, "/api/v1/orders/{order_id}/digital-deliveries": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/orders/deliveries-list/" }, "operationId": "listing_api_v1_orders__order_id__digital_deliveries_get", "parameters": [ { "example": "order-example", "in": "path", "name": "order_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Order Id", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": [ { "can_download": true, "content_state": "present", "delete_due_at": null, "filename": null, "first_available_at": "2026-11-03T12:00:00Z", "generation": 1, "id": "00000000-0000-4000-8000-000000000005", "kind": "code", "line_id": "line-example", "order_id": "order-example", "payload_id": "00000000-0000-4000-8000-000000000012", "product_id": "example", "reason": "", "size_bytes": null, "state": "available", "unit_id": "00000000-0000-4000-8000-000000000011", "unit_ordinal": 1, "variant_id": null, "version": 2 } ], "meta": { "pagination": { "has_more": false, "limit": 50, "next_cursor": null }, "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_DeliveryData____1" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Listing", "tags": [ "Digital order deliveries" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.orders.enabled" ], "conditional_scopes": [], "required_scopes": [ "orders.digital_delivery:read" ] } } }, "/api/v1/orders/{order_id}/digital-deliveries/{delivery_id}/content": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/orders/delivery-content/" }, "operationId": "get_content_api_v1_orders__order_id__digital_deliveries__delivery_id__content_get", "parameters": [ { "example": "order-example", "in": "path", "name": "order_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Order Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000005", "in": "path", "name": "delivery_id", "required": true, "schema": { "format": "uuid", "title": "Delivery Id", "type": "string" } } ], "responses": { "200": { "content": { "application/epub+zip": { "schema": { "format": "binary", "type": "string" } }, "application/json": { "examples": { "success": { "value": { "data": { "code": "DEMO-TWO", "delivery_id": "00000000-0000-4000-8000-000000000005", "kind": "code", "payload_id": "00000000-0000-4000-8000-000000000012", "unit_id": "00000000-0000-4000-8000-000000000011" }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_CodeContentData_" } }, "application/pdf": { "schema": { "format": "binary", "type": "string" } }, "application/zip": { "schema": { "format": "binary", "type": "string" } }, "audio/mpeg": { "schema": { "format": "binary", "type": "string" } }, "image/avif": { "schema": { "format": "binary", "type": "string" } }, "image/jpeg": { "schema": { "format": "binary", "type": "string" } }, "image/png": { "schema": { "format": "binary", "type": "string" } }, "image/svg+xml": { "schema": { "format": "binary", "type": "string" } }, "image/webp": { "schema": { "format": "binary", "type": "string" } }, "video/mp4": { "schema": { "format": "binary", "type": "string" } } }, "description": "Authorized file or explicitly revealed code" }, "206": { "content": { "application/epub+zip": { "schema": { "format": "binary", "type": "string" } }, "application/pdf": { "schema": { "format": "binary", "type": "string" } }, "application/zip": { "schema": { "format": "binary", "type": "string" } }, "audio/mpeg": { "schema": { "format": "binary", "type": "string" } }, "image/avif": { "schema": { "format": "binary", "type": "string" } }, "image/jpeg": { "schema": { "format": "binary", "type": "string" } }, "image/png": { "schema": { "format": "binary", "type": "string" } }, "image/svg+xml": { "schema": { "format": "binary", "type": "string" } }, "image/webp": { "schema": { "format": "binary", "type": "string" } }, "video/mp4": { "schema": { "format": "binary", "type": "string" } } }, "description": "Authorized single byte range" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Get Content", "tags": [ "Digital order deliveries" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.orders.enabled" ], "conditional_scopes": [], "required_scopes": [ "orders.digital_delivery:reveal" ] } }, "head": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/orders/delivery-head/" }, "operationId": "head_content_api_v1_orders__order_id__digital_deliveries__delivery_id__content_head", "parameters": [ { "example": "order-example", "in": "path", "name": "order_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Order Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000005", "in": "path", "name": "delivery_id", "required": true, "schema": { "format": "uuid", "title": "Delivery Id", "type": "string" } } ], "responses": { "200": { "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Head Content", "tags": [ "Digital order deliveries" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.orders.enabled" ], "conditional_scopes": [], "required_scopes": [ "orders.digital_delivery:reveal" ] } } }, "/api/v1/orders/{order_id}/digital-deliveries/{delivery_id}/content-deletion": { "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/orders/delivery-delete/" }, "operationId": "delete_api_v1_orders__order_id__digital_deliveries__delivery_id__content_deletion_post", "parameters": [ { "example": "order-example", "in": "path", "name": "order_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Order Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000005", "in": "path", "name": "delivery_id", "required": true, "schema": { "format": "uuid", "title": "Delivery Id", "type": "string" } }, { "example": "1f66a8a9-934e-5f0d-9c90-21bd142b8b1e", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 1, "reason": "Withdraw a revoked license" }, "schema": { "$ref": "#/components/schemas/DeliveryContentDeletion" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "00000000-0000-4000-8000-000000000005", "version": 2 }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Delete", "tags": [ "Digital order deliveries" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.orders.enabled" ], "conditional_scopes": [], "required_scopes": [ "orders.digital_delivery:delete" ] } } }, "/api/v1/orders/{order_id}/digital-deliveries/{delivery_id}/replacement": { "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/orders/delivery-replace/" }, "operationId": "replace_api_v1_orders__order_id__digital_deliveries__delivery_id__replacement_post", "parameters": [ { "example": "order-example", "in": "path", "name": "order_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Order Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000005", "in": "path", "name": "delivery_id", "required": true, "schema": { "format": "uuid", "title": "Delivery Id", "type": "string" } }, { "example": "f9c1d800-0171-5cc9-a2b4-d8a83d93db4c", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_unit_version": 1, "expected_version": 1, "reason": "Replace an invalid activation code", "replacement_unit_id": "00000000-0000-4000-8000-000000000008" }, "schema": { "$ref": "#/components/schemas/DeliveryReplacement" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "00000000-0000-4000-8000-000000000005", "version": 2 }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Replace", "tags": [ "Digital order deliveries" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.inventory.enabled", "api.orders.enabled" ], "conditional_scopes": [], "required_scopes": [ "orders.digital_delivery:write", "inventory.digital_unit:write" ] } } }, "/api/v1/orders/{order_id}/file-releases": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/orders/list-releases-order-file/" }, "operationId": "list_releases_api_v1_orders__order_id__file_releases_get", "parameters": [ { "example": "example", "in": "path", "name": "order_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Order Id", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "releases": [ { "access_reason": "paid", "access_state": "active", "current_release": null, "grant_reason": "purchase", "granted_at": "2026-01-01T12:00:00Z", "id": "example", "line_id": "example", "manifest_sha256": "1111111111111111111111111111111111111111111111111111111111111111", "product_id": "example", "published_at": "2026-01-01T12:00:00Z", "purchase_id": "00000000-0000-4000-8000-000000000001", "release_id": "00000000-0000-4000-8000-000000000001", "release_sequence": 1, "update_days": 365, "update_mode": "period", "update_months": null, "updates_until": "2027-01-01T12:00:00Z", "version_label": "1.0" } ], "updates_pending": false }, "meta": { "pagination": { "has_more": false, "limit": 50, "next_cursor": null }, "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_OrderReleaseListData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "List Releases", "tags": [ "Order files" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.orders.enabled" ], "conditional_scopes": [], "required_scopes": [ "orders.order_file:read_digital" ] } } }, "/api/v1/orders/{order_id}/files": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/orders/list-files-order-file/" }, "operationId": "list_files_api_v1_orders__order_id__files_get", "parameters": [ { "example": "example", "in": "path", "name": "order_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Order Id", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "example": "digital", "in": "query", "name": "category", "required": true, "schema": { "$ref": "#/components/schemas/FileCategory" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "files": [ { "can_download": true, "category": "digital", "filename": "manual.pdf", "id": "example", "label": "Manual", "line_id": "example", "mime_type": "application/pdf", "product_id": "example", "purchase_id": "00000000-0000-4000-8000-000000000001", "reason": "paid", "sha256": "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd", "size_bytes": 46, "source_file_id": "00000000-0000-4000-8000-000000000001", "source_version_id": "00000000-0000-4000-8000-000000000001", "source_version_number": 1, "state": "active" } ], "updates_pending": false }, "meta": { "pagination": { "has_more": false, "limit": 50, "next_cursor": null }, "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_OrderFileListData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "List Files", "tags": [ "Order files" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.orders.enabled" ], "conditional_scopes": [], "required_scopes": [], "selected_scopes": [ { "equals": "internal", "query_field": "category", "scopes": [ "orders.order_file:read_internal" ] }, { "equals": "customer_document", "query_field": "category", "scopes": [ "orders.order_file:read_customer_document" ] }, { "equals": "digital", "query_field": "category", "scopes": [ "orders.order_file:read_digital" ] } ] } } }, "/api/v1/orders/{order_id}/files/{order_file_id}/content": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/orders/get-content-order-file/" }, "operationId": "get_content_api_v1_orders__order_id__files__order_file_id__content_get", "parameters": [ { "example": "example", "in": "path", "name": "order_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Order Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000001", "in": "path", "name": "order_file_id", "required": true, "schema": { "format": "uuid", "title": "Order File Id", "type": "string" } }, { "example": "digital", "in": "query", "name": "category", "required": true, "schema": { "$ref": "#/components/schemas/FileCategory" } } ], "responses": { "200": { "content": { "application/epub+zip": { "schema": { "format": "binary", "type": "string" } }, "application/pdf": { "schema": { "format": "binary", "type": "string" } }, "application/zip": { "schema": { "format": "binary", "type": "string" } }, "audio/mpeg": { "schema": { "format": "binary", "type": "string" } }, "image/avif": { "schema": { "format": "binary", "type": "string" } }, "image/jpeg": { "schema": { "format": "binary", "type": "string" } }, "image/png": { "schema": { "format": "binary", "type": "string" } }, "image/svg+xml": { "schema": { "format": "binary", "type": "string" } }, "image/webp": { "schema": { "format": "binary", "type": "string" } }, "video/mp4": { "schema": { "format": "binary", "type": "string" } } }, "description": "Complete authorized file" }, "206": { "content": { "application/epub+zip": { "schema": { "format": "binary", "type": "string" } }, "application/pdf": { "schema": { "format": "binary", "type": "string" } }, "application/zip": { "schema": { "format": "binary", "type": "string" } }, "audio/mpeg": { "schema": { "format": "binary", "type": "string" } }, "image/avif": { "schema": { "format": "binary", "type": "string" } }, "image/jpeg": { "schema": { "format": "binary", "type": "string" } }, "image/png": { "schema": { "format": "binary", "type": "string" } }, "image/svg+xml": { "schema": { "format": "binary", "type": "string" } }, "image/webp": { "schema": { "format": "binary", "type": "string" } }, "video/mp4": { "schema": { "format": "binary", "type": "string" } } }, "description": "Authorized single byte range" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Get Content", "tags": [ "Order files" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.orders.enabled" ], "conditional_scopes": [], "required_scopes": [], "selected_scopes": [ { "equals": "internal", "query_field": "category", "scopes": [ "orders.order_file:read_internal" ] }, { "equals": "customer_document", "query_field": "category", "scopes": [ "orders.order_file:read_customer_document" ] }, { "equals": "digital", "query_field": "category", "scopes": [ "orders.order_file:read_digital" ] } ] } }, "head": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/orders/head-content-order-file/" }, "operationId": "head_content_api_v1_orders__order_id__files__order_file_id__content_head", "parameters": [ { "example": "example", "in": "path", "name": "order_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Order Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000001", "in": "path", "name": "order_file_id", "required": true, "schema": { "format": "uuid", "title": "Order File Id", "type": "string" } }, { "example": "digital", "in": "query", "name": "category", "required": true, "schema": { "$ref": "#/components/schemas/FileCategory" } } ], "responses": { "200": { "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Head Content", "tags": [ "Order files" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.orders.enabled" ], "conditional_scopes": [], "required_scopes": [], "selected_scopes": [ { "equals": "internal", "query_field": "category", "scopes": [ "orders.order_file:read_internal" ] }, { "equals": "customer_document", "query_field": "category", "scopes": [ "orders.order_file:read_customer_document" ] }, { "equals": "digital", "query_field": "category", "scopes": [ "orders.order_file:read_digital" ] } ] } } }, "/api/v1/orders/{order_id}/payment-status": { "patch": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/orders/change-payment-status/" }, "operationId": "adjust_payment_status_api_v1_orders__order_id__payment_status_patch", "parameters": [ { "example": "order-0000", "in": "path", "name": "order_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Order Id", "type": "string" } }, { "example": "example-adjust_payment_status_api_v1_orders__order_id__payment_status_patch", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 0, "reason": "Bank transfer confirmed", "status": "paid" }, "schema": { "$ref": "#/components/schemas/PaymentStatusUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "payment-0000", "version": 2 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Adjust Payment Status", "tags": [ "Orders" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.orders.enabled" ], "conditional_scopes": [], "required_scopes": [ "payments.payment:adjust_status" ] } } }, "/api/v1/orders/{order_id}/status": { "patch": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/orders/change-status/" }, "operationId": "update_order_status_api_v1_orders__order_id__status_patch", "parameters": [ { "example": "order-0000", "in": "path", "name": "order_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Order Id", "type": "string" } }, { "example": "example-update_order_status_api_v1_orders__order_id__status_patch", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 1, "status_id": "status-1" }, "schema": { "$ref": "#/components/schemas/OrderStatusUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "order-0000", "version": 2 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Order Status", "tags": [ "Orders" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.orders.enabled" ], "conditional_scopes": [], "required_scopes": [ "orders.order:change_status" ] } } }, "/api/v1/pages": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/pages/list/" }, "operationId": "pages_api_v1_pages_get", "parameters": [ { "example": 20, "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "query", "name": "published", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Published" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": [ { "created_at": "2026-01-01T12:00:00Z", "id": "example", "is_available": true, "market_scope": "all", "number": "example", "published": false, "slug": "example", "title": "example", "updated_at": "2026-01-01T12:00:00Z", "version": 1 } ], "meta": { "locale": "en", "market_code": "PL", "market_id": "example", "pagination": { "has_more": false, "limit": 20, "next_cursor": null }, "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_list_PageSummaryData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Pages", "tags": [ "Pages" ], "x-shopently-access": { "api_plan_features": [ "api.content.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "content.page:read" ] } }, "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/pages/create/" }, "operationId": "create_page_api_v1_pages_post", "parameters": [ { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "example": "example-create_page_api_v1_pages_post", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "title": "Example" }, "schema": { "$ref": "#/components/schemas/PageCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Page", "tags": [ "Pages" ], "x-shopently-access": { "api_plan_features": [ "api.content.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "content.page:create" ] } } }, "/api/v1/pages/{page_id}": { "delete": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/pages/delete/" }, "operationId": "delete_page_api_v1_pages__page_id__delete", "parameters": [ { "example": "example", "in": "path", "name": "page_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Page Id", "type": "string" } }, { "example": 1, "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 2147483647, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "example": "example-delete_page_api_v1_pages__page_id__delete", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": true, "id": "example", "version": null }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Delete Page", "tags": [ "Pages" ], "x-shopently-access": { "api_plan_features": [ "api.content.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "content.page:delete" ] } }, "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/pages/get/" }, "operationId": "get_page_api_v1_pages__page_id__get", "parameters": [ { "example": "example", "in": "path", "name": "page_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Page Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "body_html": "Example
", "created_at": "2026-01-01T12:00:00Z", "id": "example", "is_available": true, "market_scope": "all", "meta_description": "example", "meta_keywords": [ "example" ], "meta_title": "example", "number": "example", "published": false, "slug": "example", "title": "example", "updated_at": "2026-01-01T12:00:00Z", "version": 1 }, "meta": { "locale": "en", "market_code": "PL", "market_id": "example", "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_PageDetailData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Get Page", "tags": [ "Pages" ], "x-shopently-access": { "api_plan_features": [ "api.content.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "content.page:read" ] } }, "patch": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/pages/update/" }, "operationId": "update_page_api_v1_pages__page_id__patch", "parameters": [ { "example": "example", "in": "path", "name": "page_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Page Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "example": "example-update_page_api_v1_pages__page_id__patch", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 1, "title": "Example" }, "schema": { "$ref": "#/components/schemas/PageUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Page", "tags": [ "Pages" ], "x-shopently-access": { "api_plan_features": [ "api.content.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "content.page:update" ] } } }, "/api/v1/product-file-uploads": { "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/products/create-upload-product-file/" }, "operationId": "create_upload_api_v1_product_file_uploads_post", "parameters": [ { "example": "digital", "in": "query", "name": "category", "required": true, "schema": { "$ref": "#/components/schemas/FileCategory" } }, { "example": "files-example-create_upload_api_v1_product_file_uploads_post", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "filename": "manual.pdf", "product_id": "example", "sha256": "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd", "size_bytes": 46 }, "schema": { "$ref": "#/components/schemas/UploadCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "00000000-0000-4000-8000-000000000001", "version": null }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Upload", "tags": [ "Product file uploads" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [], "selected_scopes": [ { "equals": "internal", "query_field": "category", "scopes": [ "catalog.product_file:write_internal" ] }, { "equals": "customer_document", "query_field": "category", "scopes": [ "catalog.product_file:write_customer_document" ] }, { "equals": "digital", "query_field": "category", "scopes": [ "catalog.product_file:write_digital" ] } ] } } }, "/api/v1/product-file-uploads/{upload_id}": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/products/read-upload-product-file/" }, "operationId": "read_upload_api_v1_product_file_uploads__upload_id__get", "parameters": [ { "example": "00000000-0000-4000-8000-000000000001", "in": "path", "name": "upload_id", "required": true, "schema": { "format": "uuid", "title": "Upload Id", "type": "string" } }, { "example": "digital", "in": "query", "name": "category", "required": true, "schema": { "$ref": "#/components/schemas/FileCategory" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "category": "digital", "expires_at": "2026-01-01T12:00:00Z", "filename": "manual.pdf", "id": "00000000-0000-4000-8000-000000000001", "product_id": "example", "received_bytes": 46, "sha256": "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd", "size_bytes": 46, "status": "ready" }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_UploadData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Read Upload", "tags": [ "Product file uploads" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [], "selected_scopes": [ { "equals": "internal", "query_field": "category", "scopes": [ "catalog.product_file:read_internal" ] }, { "equals": "customer_document", "query_field": "category", "scopes": [ "catalog.product_file:read_customer_document" ] }, { "equals": "digital", "query_field": "category", "scopes": [ "catalog.product_file:read_digital" ] } ] } } }, "/api/v1/product-file-uploads/{upload_id}/content": { "put": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/products/receive-upload-product-file/" }, "operationId": "receive_upload_api_v1_product_file_uploads__upload_id__content_put", "parameters": [ { "example": "00000000-0000-4000-8000-000000000001", "in": "path", "name": "upload_id", "required": true, "schema": { "format": "uuid", "title": "Upload Id", "type": "string" } }, { "example": "digital", "in": "query", "name": "category", "required": true, "schema": { "$ref": "#/components/schemas/FileCategory" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "additionalProperties": false, "properties": { "file": { "format": "binary", "type": "string" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "category": "digital", "expires_at": "2026-01-01T12:00:00Z", "filename": "manual.pdf", "id": "00000000-0000-4000-8000-000000000001", "product_id": "example", "received_bytes": 46, "sha256": "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd", "size_bytes": 46, "status": "ready" }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_UploadData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Receive Upload", "tags": [ "Product file uploads" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [], "selected_scopes": [ { "equals": "internal", "query_field": "category", "scopes": [ "catalog.product_file:write_internal" ] }, { "equals": "customer_document", "query_field": "category", "scopes": [ "catalog.product_file:write_customer_document" ] }, { "equals": "digital", "query_field": "category", "scopes": [ "catalog.product_file:write_digital" ] } ] } } }, "/api/v1/products": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/products/list/" }, "operationId": "product_list_api_v1_products_get", "parameters": [ { "example": 20, "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "query", "name": "sku", "required": false, "schema": { "anyOf": [ { "maxLength": 100, "minLength": 1, "pattern": "^\\S+$", "type": "string" }, { "type": "null" } ], "title": "Sku" } }, { "in": "query", "name": "published", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Published" } }, { "in": "query", "name": "brand_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Brand Id" } }, { "in": "query", "name": "category_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Category Id" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": [ { "availability": { "available_from": null, "available_until": null, "is_available": true }, "brand_id": null, "condition": "new", "created_at": "2026-01-01T12:00:00Z", "id": "example", "name": "Example", "number": "example", "price": { "amount": "0.00", "currency": "PLN", "minor_units": 2, "tax_included": true }, "price_version": 1, "primary_category_id": "example", "primary_media_id": "example", "published": false, "sku": "example", "slug": "example", "tax_category_id": "example", "updated_at": "2026-01-01T12:00:00Z", "variants_enabled": false, "version": 1 } ], "meta": { "locale": "en", "market_code": "PL", "market_id": "example", "pagination": { "has_more": false, "limit": 20, "next_cursor": null }, "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_list_ProductSummaryData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Product List", "tags": [ "Products" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.product:read" ] } }, "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/products/create/" }, "operationId": "create_product_api_v1_products_post", "parameters": [ { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "example": "example-create_product_api_v1_products_post", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "name": "Example", "sku": "example" }, "schema": { "$ref": "#/components/schemas/ProductCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Product", "tags": [ "Products" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [ { "body_field": "variant_value_ids", "scopes": [ "catalog.product_variant:create" ], "when": "nonempty" } ], "required_scopes": [ "catalog.product:create" ] } } }, "/api/v1/products/{product_id}": { "delete": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/products/delete/" }, "operationId": "delete_product_api_v1_products__product_id__delete", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": 1, "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "example": "example-delete_product_api_v1_products__product_id__delete", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": true, "id": "example", "version": null }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Delete Product", "tags": [ "Products" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.product:delete" ] } }, "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/products/get/" }, "operationId": "product_detail_api_v1_products__product_id__get", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "availability": { "available_from": null, "available_until": null, "is_available": true }, "brand_id": null, "condition": "new", "created_at": "2026-01-01T12:00:00Z", "description": "example", "features": [ { "feature_id": "example", "feature_name": "example", "value": "example", "value_id": "example" } ], "id": "example", "identifiers": {}, "media": [ { "alt_text": "example", "id": "example", "is_primary": true, "kind": "image", "mime_type": "image/jpeg", "position": 1, "url": "https://example.invalid/product.jpg" } ], "meta_description": "example", "meta_keywords": [ "example" ], "meta_title": "example", "name": "Example", "number": "example", "price": { "amount": "0.00", "currency": "PLN", "minor_units": 2, "tax_included": true }, "price_version": 1, "primary_category_id": "example", "primary_media_id": "example", "published": false, "sku": "example", "slug": "example", "tax_category_id": "example", "updated_at": "2026-01-01T12:00:00Z", "variants_enabled": false, "version": 1 }, "meta": { "locale": "en", "market_code": "PL", "market_id": "example", "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_ProductDetailData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Product Detail", "tags": [ "Products" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.product:read" ] } }, "patch": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/products/update/" }, "operationId": "update_product_api_v1_products__product_id__patch", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "example": "example-update_product_api_v1_products__product_id__patch", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 1, "sku": "example" }, "schema": { "$ref": "#/components/schemas/ProductUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Product", "tags": [ "Products" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [ { "body_field": "variant_value_ids", "scopes": [ "catalog.product_variant:create", "catalog.product_variant:update", "catalog.product_variant:delete" ], "when": "present" }, { "body_field": "variants_enabled", "scopes": [ "catalog.product_variant:update" ], "when": "present" } ], "required_scopes": [ "catalog.product:update" ] } } }, "/api/v1/products/{product_id}/file-releases": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/products/list-releases-product-file/" }, "operationId": "list_releases_api_v1_products__product_id__file_releases_get", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "current_release_id": "00000000-0000-4000-8000-000000000001", "product_version": 2, "releases": [ { "changelog": "Manual update", "files": [ { "file_id": "00000000-0000-4000-8000-000000000001", "sort_order": 0, "version_id": "00000000-0000-4000-8000-000000000001" } ], "id": "00000000-0000-4000-8000-000000000001", "manifest_sha256": "1111111111111111111111111111111111111111111111111111111111111111", "published_at": null, "release_sequence": null, "state": "active", "version_label": "1.0", "withdrawn_at": null } ], "update_days": 365, "update_mode": "period", "update_months": null }, "meta": { "pagination": { "has_more": false, "limit": 50, "next_cursor": null }, "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_ReleaseListData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "List Releases", "tags": [ "Product file releases" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.product_file:read_digital" ] } }, "post": { "deprecated": true, "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/products/create-draft-product-file/" }, "operationId": "create_draft_api_v1_products__product_id__file_releases_post", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "files-example-create_draft_api_v1_products__product_id__file_releases_post", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 1, "version_ids": [ "00000000-0000-4000-8000-000000000001" ], "version_label": "1.0" }, "schema": { "$ref": "#/components/schemas/ReleaseDraft" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } }, "success": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Draft", "tags": [ "Product file releases" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.product_file:write_digital" ] } } }, "/api/v1/products/{product_id}/file-releases/{release_id}": { "delete": { "deprecated": true, "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/products/delete-draft-product-file/" }, "operationId": "delete_draft_api_v1_products__product_id__file_releases__release_id__delete", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000001", "in": "path", "name": "release_id", "required": true, "schema": { "format": "uuid", "title": "Release Id", "type": "string" } }, { "example": 1, "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "example": "files-example-delete_draft_api_v1_products__product_id__file_releases__release_id__delete", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } }, "success": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Delete Draft", "tags": [ "Product file releases" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.product_file:write_digital" ] } }, "patch": { "deprecated": true, "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/products/update-draft-product-file/" }, "operationId": "update_draft_api_v1_products__product_id__file_releases__release_id__patch", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000001", "in": "path", "name": "release_id", "required": true, "schema": { "format": "uuid", "title": "Release Id", "type": "string" } }, { "example": "files-example-update_draft_api_v1_products__product_id__file_releases__release_id__patch", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 1, "version_ids": [ "00000000-0000-4000-8000-000000000001" ], "version_label": "1.0" }, "schema": { "$ref": "#/components/schemas/ReleaseDraft" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } }, "success": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Draft", "tags": [ "Product file releases" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.product_file:write_digital" ] } } }, "/api/v1/products/{product_id}/file-releases/{release_id}/publish": { "post": { "deprecated": true, "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/products/publish-release-product-file/" }, "operationId": "publish_release_api_v1_products__product_id__file_releases__release_id__publish_post", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000001", "in": "path", "name": "release_id", "required": true, "schema": { "format": "uuid", "title": "Release Id", "type": "string" } }, { "example": "files-example-publish_release_api_v1_products__product_id__file_releases__release_id__publish_post", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 1 }, "schema": { "$ref": "#/components/schemas/ProductVersion" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } }, "success": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Publish Release", "tags": [ "Product file releases" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.product_file:write_digital" ] } } }, "/api/v1/products/{product_id}/file-releases/{release_id}/withdraw": { "post": { "deprecated": true, "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/products/withdraw-release-product-file/" }, "operationId": "withdraw_release_api_v1_products__product_id__file_releases__release_id__withdraw_post", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000001", "in": "path", "name": "release_id", "required": true, "schema": { "format": "uuid", "title": "Release Id", "type": "string" } }, { "example": "files-example-withdraw_release_api_v1_products__product_id__file_releases__release_id__withdraw_post", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 1 }, "schema": { "$ref": "#/components/schemas/ProductVersion" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } }, "success": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Withdraw Release", "tags": [ "Product file releases" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.product_file:write_digital" ] } } }, "/api/v1/products/{product_id}/file-update-policy": { "patch": { "deprecated": true, "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/products/update-policy-product-file/" }, "operationId": "update_policy_api_v1_products__product_id__file_update_policy_patch", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "files-example-update_policy_api_v1_products__product_id__file_update_policy_patch", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "days": 365, "expected_version": 1, "mode": "period", "months": null }, "schema": { "$ref": "#/components/schemas/UpdatePolicy" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } }, "success": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Policy", "tags": [ "Product file releases" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.product_file:write_digital" ] } } }, "/api/v1/products/{product_id}/files": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/products/list-files-product-file/" }, "operationId": "list_files_api_v1_products__product_id__files_get", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "example": "digital", "in": "query", "name": "category", "required": true, "schema": { "$ref": "#/components/schemas/FileCategory" } }, { "in": "query", "name": "current_only", "required": false, "schema": { "default": true, "title": "Current Only", "type": "boolean" } }, { "in": "query", "name": "include_archived", "required": false, "schema": { "default": false, "title": "Include Archived", "type": "boolean" } }, { "in": "query", "name": "file_id", "required": false, "schema": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "File Id" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "files": [ { "category": "digital", "created_at": "2026-01-01T12:00:00Z", "current_version_id": "00000000-0000-4000-8000-000000000001", "file_id": "00000000-0000-4000-8000-000000000001", "filename": "manual.pdf", "id": "00000000-0000-4000-8000-000000000001", "label": "Manual", "mime_type": "application/pdf", "sha256": "5cd2f1cb0e5532b397e7ab1887baf6000c49450fd80ae279eb047c06e4545ecd", "size_bytes": 46, "state": "active", "version_number": 1 } ], "product_version": 2 }, "meta": { "pagination": { "has_more": false, "limit": 50, "next_cursor": null }, "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_ProductFileListData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "List Files", "tags": [ "Product files" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [], "selected_scopes": [ { "equals": "internal", "query_field": "category", "scopes": [ "catalog.product_file:read_internal" ] }, { "equals": "customer_document", "query_field": "category", "scopes": [ "catalog.product_file:read_customer_document" ] }, { "equals": "digital", "query_field": "category", "scopes": [ "catalog.product_file:read_digital" ] } ] } }, "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/products/assign-file-product-file/" }, "operationId": "assign_file_api_v1_products__product_id__files_post", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "digital", "in": "query", "name": "category", "required": true, "schema": { "$ref": "#/components/schemas/FileCategory" } }, { "example": "files-example-assign_file_api_v1_products__product_id__files_post", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "audience": { "mode": "new_purchases" }, "expected_version": 1, "upload_id": "00000000-0000-4000-8000-000000000001" }, "schema": { "$ref": "#/components/schemas/FileAssign" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "00000000-0000-4000-8000-000000000001", "version": 2 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Assign File", "tags": [ "Product files" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [], "selected_scopes": [ { "equals": "internal", "query_field": "category", "scopes": [ "catalog.product_file:write_internal" ] }, { "equals": "customer_document", "query_field": "category", "scopes": [ "catalog.product_file:write_customer_document" ] }, { "equals": "digital", "query_field": "category", "scopes": [ "catalog.product_file:write_digital" ] } ] } } }, "/api/v1/products/{product_id}/files/{file_id}": { "delete": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/products/archive-file-product-file/" }, "operationId": "archive_file_api_v1_products__product_id__files__file_id__delete", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000001", "in": "path", "name": "file_id", "required": true, "schema": { "format": "uuid", "title": "File Id", "type": "string" } }, { "example": "digital", "in": "query", "name": "category", "required": true, "schema": { "$ref": "#/components/schemas/FileCategory" } }, { "example": 1, "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "example": "files-example-archive_file_api_v1_products__product_id__files__file_id__delete", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": true, "id": "00000000-0000-4000-8000-000000000001", "version": 2 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Archive File", "tags": [ "Product files" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [], "selected_scopes": [ { "equals": "internal", "query_field": "category", "scopes": [ "catalog.product_file:write_internal" ] }, { "equals": "customer_document", "query_field": "category", "scopes": [ "catalog.product_file:write_customer_document" ] }, { "equals": "digital", "query_field": "category", "scopes": [ "catalog.product_file:write_digital" ] } ] } } }, "/api/v1/products/{product_id}/files/{file_id}/audience": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/products/audience-read/" }, "operationId": "read_api_v1_products__product_id__files__file_id__audience_get", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000007", "in": "path", "name": "file_id", "required": true, "schema": { "format": "uuid", "title": "File Id", "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "default": 25, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "anchor_at": "2026-11-03T12:00:00Z", "effective_at": "2026-11-03T12:00:00Z", "file_id": "00000000-0000-4000-8000-000000000007", "file_version_id": "00000000-0000-4000-8000-000000000010", "historical_access_preserved": true, "id": "00000000-0000-4000-8000-000000000009", "lookback_days": null, "mode": "all_purchasers", "next_cursor": null, "order_ids": [], "product_version": 3, "revision": 1 }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_AudienceData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Read", "tags": [ "Product files" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.product_file:read_digital" ] } }, "patch": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/products/audience-save/" }, "operationId": "save_api_v1_products__product_id__files__file_id__audience_patch", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000007", "in": "path", "name": "file_id", "required": true, "schema": { "format": "uuid", "title": "File Id", "type": "string" } }, { "example": "4e239a57-b0ef-576e-9aa1-683b3adeeb8c", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "audience": { "mode": "all_purchasers" }, "expected_version": 1 }, "schema": { "$ref": "#/components/schemas/AudienceChange" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "00000000-0000-4000-8000-000000000001", "version": 2 }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Save", "tags": [ "Product files" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.product_file:write_digital" ] } } }, "/api/v1/products/{product_id}/files/{file_id}/versions": { "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/products/add-version-product-file/" }, "operationId": "add_version_api_v1_products__product_id__files__file_id__versions_post", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000001", "in": "path", "name": "file_id", "required": true, "schema": { "format": "uuid", "title": "File Id", "type": "string" } }, { "example": "digital", "in": "query", "name": "category", "required": true, "schema": { "$ref": "#/components/schemas/FileCategory" } }, { "example": "files-example-add_version_api_v1_products__product_id__files__file_id__versions_post", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 1, "upload_id": "00000000-0000-4000-8000-000000000001" }, "schema": { "$ref": "#/components/schemas/FileAssign" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "00000000-0000-4000-8000-000000000001", "version": 2 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Add Version", "tags": [ "Product files" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [], "selected_scopes": [ { "equals": "internal", "query_field": "category", "scopes": [ "catalog.product_file:write_internal" ] }, { "equals": "customer_document", "query_field": "category", "scopes": [ "catalog.product_file:write_customer_document" ] }, { "equals": "digital", "query_field": "category", "scopes": [ "catalog.product_file:write_digital" ] } ] } } }, "/api/v1/products/{product_id}/files/{file_id}/versions/{version_id}/content": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/products/get-content-product-file/" }, "operationId": "get_content_api_v1_products__product_id__files__file_id__versions__version_id__content_get", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000001", "in": "path", "name": "file_id", "required": true, "schema": { "format": "uuid", "title": "File Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000001", "in": "path", "name": "version_id", "required": true, "schema": { "format": "uuid", "title": "Version Id", "type": "string" } }, { "example": "digital", "in": "query", "name": "category", "required": true, "schema": { "$ref": "#/components/schemas/FileCategory" } } ], "responses": { "200": { "content": { "application/epub+zip": { "schema": { "format": "binary", "type": "string" } }, "application/pdf": { "schema": { "format": "binary", "type": "string" } }, "application/zip": { "schema": { "format": "binary", "type": "string" } }, "audio/mpeg": { "schema": { "format": "binary", "type": "string" } }, "image/avif": { "schema": { "format": "binary", "type": "string" } }, "image/jpeg": { "schema": { "format": "binary", "type": "string" } }, "image/png": { "schema": { "format": "binary", "type": "string" } }, "image/svg+xml": { "schema": { "format": "binary", "type": "string" } }, "image/webp": { "schema": { "format": "binary", "type": "string" } }, "video/mp4": { "schema": { "format": "binary", "type": "string" } } }, "description": "Complete authorized file" }, "206": { "content": { "application/epub+zip": { "schema": { "format": "binary", "type": "string" } }, "application/pdf": { "schema": { "format": "binary", "type": "string" } }, "application/zip": { "schema": { "format": "binary", "type": "string" } }, "audio/mpeg": { "schema": { "format": "binary", "type": "string" } }, "image/avif": { "schema": { "format": "binary", "type": "string" } }, "image/jpeg": { "schema": { "format": "binary", "type": "string" } }, "image/png": { "schema": { "format": "binary", "type": "string" } }, "image/svg+xml": { "schema": { "format": "binary", "type": "string" } }, "image/webp": { "schema": { "format": "binary", "type": "string" } }, "video/mp4": { "schema": { "format": "binary", "type": "string" } } }, "description": "Authorized single byte range" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Get Content", "tags": [ "Product files" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [], "selected_scopes": [ { "equals": "internal", "query_field": "category", "scopes": [ "catalog.product_file:read_internal" ] }, { "equals": "customer_document", "query_field": "category", "scopes": [ "catalog.product_file:read_customer_document" ] }, { "equals": "digital", "query_field": "category", "scopes": [ "catalog.product_file:read_digital" ] } ] } }, "head": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/products/head-content-product-file/" }, "operationId": "head_content_api_v1_products__product_id__files__file_id__versions__version_id__content_head", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000001", "in": "path", "name": "file_id", "required": true, "schema": { "format": "uuid", "title": "File Id", "type": "string" } }, { "example": "00000000-0000-4000-8000-000000000001", "in": "path", "name": "version_id", "required": true, "schema": { "format": "uuid", "title": "Version Id", "type": "string" } }, { "example": "digital", "in": "query", "name": "category", "required": true, "schema": { "$ref": "#/components/schemas/FileCategory" } } ], "responses": { "200": { "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Head Content", "tags": [ "Product files" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [], "selected_scopes": [ { "equals": "internal", "query_field": "category", "scopes": [ "catalog.product_file:read_internal" ] }, { "equals": "customer_document", "query_field": "category", "scopes": [ "catalog.product_file:read_customer_document" ] }, { "equals": "digital", "query_field": "category", "scopes": [ "catalog.product_file:read_digital" ] } ] } } }, "/api/v1/products/{product_id}/variants": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/variants/list-product-variants/" }, "operationId": "variants_api_v1_products__product_id__variants_get", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": 20, "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "query", "name": "active", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Active" } }, { "in": "query", "name": "sku", "required": false, "schema": { "anyOf": [ { "maxLength": 100, "minLength": 1, "pattern": "^\\S+$", "type": "string" }, { "type": "null" } ], "title": "Sku" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": [ { "active": true, "created_at": "2026-01-01T12:00:00Z", "id": "example", "is_default": true, "media_ids": [ "example" ], "position": 1, "pricing": { "base_adjustment": { "amount": "0.00", "currency": "PLN", "minor_units": 2 }, "market_price": null, "price": { "amount": "0.00", "currency": "PLN", "minor_units": 2, "tax_included": true }, "product_version": 1, "version": 1 }, "primary_media_id": "example", "product_id": "example", "sku": "example", "updated_at": "2026-01-01T12:00:00Z", "values": [ { "option_id": "example", "option_name": "example", "value": "example", "value_id": "example" } ], "version": 1 } ], "meta": { "locale": "en", "market_code": "PL", "market_id": "example", "pagination": { "has_more": false, "limit": 20, "next_cursor": null }, "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_list_ProductVariantData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Variants", "tags": [ "Product variants" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.product:read" ] } }, "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/variants/create-product-variant/" }, "operationId": "create_variant_api_v1_products__product_id__variants_post", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "example": "example-create_variant_api_v1_products__product_id__variants_post", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 1, "value_ids": [ "example" ] }, "schema": { "$ref": "#/components/schemas/VariantCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Variant", "tags": [ "Product variants" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.product_variant:create" ] } } }, "/api/v1/products/{product_id}/variants/{variant_id}": { "delete": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/variants/delete-product-variant/" }, "operationId": "delete_variant_api_v1_products__product_id__variants__variant_id__delete", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "example", "in": "path", "name": "variant_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Variant Id", "type": "string" } }, { "example": 1, "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "example": 1, "in": "query", "name": "expected_price_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 0, "title": "Expected Price Version", "type": "integer" } }, { "example": "example-delete_variant_api_v1_products__product_id__variants__variant_id__delete", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": true, "id": "example", "version": null }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Delete Variant", "tags": [ "Product variants" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.product_variant:delete" ] } }, "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/variants/get-product-variant/" }, "operationId": "variant_api_v1_products__product_id__variants__variant_id__get", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "example", "in": "path", "name": "variant_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Variant Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "active": true, "created_at": "2026-01-01T12:00:00Z", "id": "example", "is_default": true, "media_ids": [ "example" ], "position": 1, "pricing": { "base_adjustment": { "amount": "0.00", "currency": "PLN", "minor_units": 2 }, "market_price": null, "price": { "amount": "0.00", "currency": "PLN", "minor_units": 2, "tax_included": true }, "product_version": 1, "version": 1 }, "primary_media_id": "example", "product_id": "example", "sku": "example", "updated_at": "2026-01-01T12:00:00Z", "values": [ { "option_id": "example", "option_name": "example", "value": "example", "value_id": "example" } ], "version": 1 }, "meta": { "locale": "en", "market_code": "PL", "market_id": "example", "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_ProductVariantData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Variant", "tags": [ "Product variants" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.product:read" ] } }, "patch": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/variants/update-product-variant/" }, "operationId": "update_variant_api_v1_products__product_id__variants__variant_id__patch", "parameters": [ { "example": "example", "in": "path", "name": "product_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Product Id", "type": "string" } }, { "example": "example", "in": "path", "name": "variant_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Variant Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "example": "example-update_variant_api_v1_products__product_id__variants__variant_id__patch", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 1, "sku": "example" }, "schema": { "$ref": "#/components/schemas/VariantUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Variant", "tags": [ "Product variants" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.product_variant:update" ] } } }, "/api/v1/request-statuses": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/requests/list-statuses/" }, "operationId": "request_statuses_api_v1_request_statuses_get", "parameters": [ { "example": 20, "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "type", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RequestType" }, { "type": "null" } ], "title": "Type" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": [ { "code": "example", "created_at": "2026-01-01T12:00:00Z", "id": "example", "is_initial": false, "locale": "en", "name": "Example", "position": 1, "type": "return" } ], "meta": { "pagination": { "has_more": false, "limit": 20, "next_cursor": null }, "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/shopently_engine__runtime__public_api_http__responses__models__ApiResponse_list_StatusDefinitionData____2" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Request Statuses", "tags": [ "Requests" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.requests.enabled" ], "conditional_scopes": [], "required_scopes": [ "returns.request:read" ] } } }, "/api/v1/requests": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/requests/list/" }, "operationId": "request_list_api_v1_requests_get", "parameters": [ { "example": 20, "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "number", "required": false, "schema": { "anyOf": [ { "maxLength": 48, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Number" } }, { "in": "query", "name": "type", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/RequestType" }, { "type": "null" } ], "title": "Type" } }, { "in": "query", "name": "status_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Status Id" } }, { "in": "query", "name": "order_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Order Id" } }, { "in": "query", "name": "order_number", "required": false, "schema": { "anyOf": [ { "maxLength": 48, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Order Number" } }, { "in": "query", "name": "created_from", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created From" } }, { "in": "query", "name": "created_to", "required": false, "schema": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Created To" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": [ { "created_at": "2026-01-01T12:00:00Z", "customer": { "email": "customer@example.invalid", "name": "Example" }, "id": "example", "number": "example", "order_id": "example", "order_number": "example", "products_value": { "amount": "0.00", "currency": "PLN", "minor_units": 2 }, "refund": { "amount": { "amount": "0.00", "currency": "PLN", "minor_units": 2 }, "completed_at": null, "status": "pending", "updated_at": "2026-01-01T12:00:00Z", "version": 1 }, "resolution_state": "unknown", "status": { "id": "example", "locale": "en", "name": "Example" }, "type": "return", "updated_at": "2026-01-01T12:00:00Z", "version": 1 } ], "meta": { "pagination": { "has_more": false, "limit": 20, "next_cursor": null }, "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_list_RequestSummaryData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Request List", "tags": [ "Requests" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.requests.enabled" ], "conditional_scopes": [], "required_scopes": [ "returns.request:read" ] } } }, "/api/v1/requests/{request_id}": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/requests/get/" }, "operationId": "request_detail_api_v1_requests__request_id__get", "parameters": [ { "example": "example", "in": "path", "name": "request_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Request Id", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "created_at": "2026-01-01T12:00:00Z", "customer": { "email": "customer@example.invalid", "name": "Example" }, "id": "example", "items": [ { "id": "example", "name": "Example", "order_line_id": "example", "product_id": "example", "quantity": 1, "returned_quantity": 1, "sku": "example", "total": { "amount": "0.00", "currency": "PLN", "minor_units": 2 }, "unit_price": { "amount": "0.00", "currency": "PLN", "minor_units": 2 }, "variant_id": "example", "variant_options": [ { "name": "Example", "value": "example" } ] } ], "number": "example", "order_id": "example", "order_number": "example", "products_value": { "amount": "0.00", "currency": "PLN", "minor_units": 2 }, "refund": { "amount": { "amount": "0.00", "currency": "PLN", "minor_units": 2 }, "completed_at": null, "status": "pending", "updated_at": "2026-01-01T12:00:00Z", "version": 1 }, "resolution_state": "unknown", "status": { "id": "example", "locale": "en", "name": "Example" }, "type": "return", "updated_at": "2026-01-01T12:00:00Z", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_RequestDetailData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Request Detail", "tags": [ "Requests" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.requests.enabled" ], "conditional_scopes": [], "required_scopes": [ "returns.request:read" ] } } }, "/api/v1/requests/{request_id}/refund-amount": { "patch": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/requests/update-refund-amount/" }, "operationId": "adjust_request_refund_amount_api_v1_requests__request_id__refund_amount_patch", "parameters": [ { "example": "example", "in": "path", "name": "request_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Request Id", "type": "string" } }, { "example": "example-adjust_request_refund_amount_api_v1_requests__request_id__refund_amount_patch", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "amount": "0.00", "expected_version": 1 }, "schema": { "$ref": "#/components/schemas/RefundAmountUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Adjust Request Refund Amount", "tags": [ "Requests" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.requests.enabled" ], "conditional_scopes": [], "required_scopes": [ "payments.request_refund:adjust_amount" ] } } }, "/api/v1/requests/{request_id}/status": { "patch": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/requests/update-status/" }, "operationId": "change_request_status_api_v1_requests__request_id__status_patch", "parameters": [ { "example": "example", "in": "path", "name": "request_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Request Id", "type": "string" } }, { "example": "example-change_request_status_api_v1_requests__request_id__status_patch", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 1, "status_id": "example" }, "schema": { "$ref": "#/components/schemas/RequestStatusUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Change Request Status", "tags": [ "Requests" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.requests.enabled" ], "conditional_scopes": [], "required_scopes": [ "returns.request:update" ] } } }, "/api/v1/search/overview": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/search/overview/" }, "operationId": "overview_api_v1_search_overview_get", "parameters": [ { "in": "query", "name": "days", "required": false, "schema": { "default": 30, "enum": [ 7, 30, 90 ], "title": "Days", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "click_through_rate": 0, "clicked_searches": 1, "recent": [ { "is_zero_results": false, "locale_code": "en", "occurred_at": "2026-01-01T12:00:00Z", "query_display": "example", "query_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "request_id": "example", "result_count": 1, "source": "results" } ], "searches": 1, "zero_result_rate": 0, "zero_results": 1 }, "meta": { "period": { "as_of": "2026-01-02T00:00:00Z", "days": 1, "started_at": "2026-01-01T00:00:00Z" }, "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/AnalyticsResponse_OverviewData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Overview", "tags": [ "Search analytics" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.search.enabled" ], "conditional_scopes": [], "required_scopes": [ "search.analytics:read" ] } } }, "/api/v1/search/queries": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/search/list-queries/" }, "operationId": "queries_api_v1_search_queries_get", "parameters": [ { "example": 20, "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "days", "required": false, "schema": { "default": 30, "enum": [ 7, 30, 90 ], "title": "Days", "type": "integer" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "pattern": "^[a-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "source", "required": false, "schema": { "anyOf": [ { "enum": [ "results", "autocomplete" ], "type": "string" }, { "type": "null" } ], "title": "Source" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "query", "required": false, "schema": { "default": "", "maxLength": 255, "title": "Query", "type": "string" } }, { "in": "query", "name": "searches_min", "required": false, "schema": { "anyOf": [ { "maximum": 9223372036854775807, "minimum": 0, "type": "integer" }, { "type": "null" } ], "title": "Searches Min" } }, { "in": "query", "name": "searches_max", "required": false, "schema": { "anyOf": [ { "maximum": 9223372036854775807, "minimum": 0, "type": "integer" }, { "type": "null" } ], "title": "Searches Max" } }, { "in": "query", "name": "clicks_min", "required": false, "schema": { "anyOf": [ { "maximum": 9223372036854775807, "minimum": 0, "type": "integer" }, { "type": "null" } ], "title": "Clicks Min" } }, { "in": "query", "name": "clicks_max", "required": false, "schema": { "anyOf": [ { "maximum": 9223372036854775807, "minimum": 0, "type": "integer" }, { "type": "null" } ], "title": "Clicks Max" } }, { "in": "query", "name": "zero_results_min", "required": false, "schema": { "anyOf": [ { "maximum": 9223372036854775807, "minimum": 0, "type": "integer" }, { "type": "null" } ], "title": "Zero Results Min" } }, { "in": "query", "name": "zero_results_max", "required": false, "schema": { "anyOf": [ { "maximum": 9223372036854775807, "minimum": 0, "type": "integer" }, { "type": "null" } ], "title": "Zero Results Max" } }, { "in": "query", "name": "zero_result_scope", "required": false, "schema": { "$ref": "#/components/schemas/ZeroResultScope", "default": "all" } }, { "in": "query", "name": "sort", "required": false, "schema": { "$ref": "#/components/schemas/QueryMetricSort", "default": "last_seen_desc" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": [ { "clicks": 1, "last_seen_at": "2026-01-01T12:00:00Z", "query_display": "example", "query_hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "searches": 1, "zero_results": 1 } ], "meta": { "pagination": { "has_more": false, "limit": 20, "next_cursor": null }, "period": { "as_of": "2026-01-02T00:00:00Z", "days": 1, "started_at": "2026-01-01T00:00:00Z" }, "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/AnalyticsResponse_list_MetricData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Queries", "tags": [ "Search analytics" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.search.enabled" ], "conditional_scopes": [], "required_scopes": [ "search.analytics:read" ] } } }, "/api/v1/search/queries/{query_hash}": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/search/get-query/" }, "operationId": "occurrences_api_v1_search_queries__query_hash__get", "parameters": [ { "example": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "in": "path", "name": "query_hash", "required": true, "schema": { "pattern": "^[a-f0-9]{64}$", "title": "Query Hash", "type": "string" } }, { "example": 20, "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "days", "required": false, "schema": { "default": 30, "enum": [ 7, 30, 90 ], "title": "Days", "type": "integer" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "pattern": "^[a-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$", "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "source", "required": false, "schema": { "anyOf": [ { "enum": [ "results", "autocomplete" ], "type": "string" }, { "type": "null" } ], "title": "Source" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": [ { "category_id": "example", "category_result_count": 1, "currency_code": "PLN", "is_zero_results": false, "locale_code": "en", "market_id": "example", "max_price": "0.00", "min_price": "0.00", "occurred_at": "2026-01-01T12:00:00Z", "page": 1, "product_result_count": 1, "query_display": "example", "request_id": "example", "results": [ { "clicked": false, "entity_id": "example", "entity_type": "product", "image_url": "https://example.invalid/product.jpg", "number": "example", "placement_source": "organic", "position": 1, "sku": "example", "slug": "example", "title": "example" } ], "sort_key": "example", "source": "results" } ], "meta": { "pagination": { "has_more": false, "limit": 20, "next_cursor": null }, "period": { "as_of": "2026-01-02T00:00:00Z", "days": 1, "started_at": "2026-01-01T00:00:00Z" }, "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/AnalyticsResponse_list_OccurrenceData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Occurrences", "tags": [ "Search analytics" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.search.enabled" ], "conditional_scopes": [], "required_scopes": [ "search.analytics:read" ] } } }, "/api/v1/search/rules": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/search/list-rules/" }, "operationId": "rule_list_api_v1_search_rules_get", "parameters": [ { "example": 20, "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "in": "query", "name": "enabled", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Enabled" } }, { "in": "query", "name": "name", "required": false, "schema": { "default": "", "maxLength": 160, "title": "Name", "type": "string" } }, { "in": "query", "name": "phrase", "required": false, "schema": { "default": "", "maxLength": 255, "title": "Phrase", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": [ { "created_at": "2026-01-01T12:00:00Z", "enabled": true, "id": "example", "is_available": true, "market_scope": "all", "name": "Example", "updated_at": "2026-01-01T12:00:00Z", "version": 1 } ], "meta": { "locale": "en", "market_code": "PL", "market_id": "example", "pagination": { "has_more": false, "limit": 20, "next_cursor": null }, "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_list_RuleSummaryData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Rule List", "tags": [ "Search rules" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.search.enabled" ], "conditional_scopes": [], "required_scopes": [ "search.rule:read" ] } }, "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/search/create-rule/" }, "operationId": "create_rule_api_v1_search_rules_post", "parameters": [ { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "example": "example-create_rule_api_v1_search_rules_post", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "name": "Example", "phrases": [ "example" ], "product_ids": [ "example" ] }, "schema": { "$ref": "#/components/schemas/RuleCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Rule", "tags": [ "Search rules" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.search.enabled" ], "conditional_scopes": [], "required_scopes": [ "search.rule:create" ] } } }, "/api/v1/search/rules/{rule_id}": { "delete": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/search/delete-rule/" }, "operationId": "delete_rule_api_v1_search_rules__rule_id__delete", "parameters": [ { "example": "example", "in": "path", "name": "rule_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Rule Id", "type": "string" } }, { "example": 1, "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 2147483647, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "example": "example-delete_rule_api_v1_search_rules__rule_id__delete", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": true, "id": "example", "version": null }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Delete Rule", "tags": [ "Search rules" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.search.enabled" ], "conditional_scopes": [], "required_scopes": [ "search.rule:delete" ] } }, "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/search/get-rule/" }, "operationId": "rule_detail_api_v1_search_rules__rule_id__get", "parameters": [ { "example": "example", "in": "path", "name": "rule_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Rule Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "category_ids": [ "example" ], "created_at": "2026-01-01T12:00:00Z", "enabled": true, "id": "example", "is_available": true, "market_ids": [ "example" ], "market_scope": "all", "name": "Example", "phrase_groups": [ { "locale": "en", "phrases": [ "example" ] } ], "product_ids": [ "example" ], "updated_at": "2026-01-01T12:00:00Z", "version": 1 }, "meta": { "locale": "en", "market_code": "PL", "market_id": "example", "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_RuleDetailData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Rule Detail", "tags": [ "Search rules" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.search.enabled" ], "conditional_scopes": [], "required_scopes": [ "search.rule:read" ] } }, "patch": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/search/update-rule/" }, "operationId": "update_rule_api_v1_search_rules__rule_id__patch", "parameters": [ { "example": "example", "in": "path", "name": "rule_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Rule Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "example": "example-update_rule_api_v1_search_rules__rule_id__patch", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 1, "name": "Example" }, "schema": { "$ref": "#/components/schemas/RuleUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Rule", "tags": [ "Search rules" ], "x-shopently-access": { "api_plan_features": [ "api.enabled", "api.search.enabled" ], "conditional_scopes": [], "required_scopes": [ "search.rule:update" ] } } }, "/api/v1/variant-options": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/variants/list-options/" }, "operationId": "collection_api_v1_variant_options_get", "parameters": [ { "example": 20, "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": [ { "created_at": "2026-01-01T12:00:00Z", "id": "example", "name": "Example", "number": "example", "position": 1, "selection_type": "button", "updated_at": "2026-01-01T12:00:00Z", "value_presentation_type": "text", "version": 1 } ], "meta": { "locale": "en", "market_code": "PL", "market_id": "example", "pagination": { "has_more": false, "limit": 20, "next_cursor": null }, "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_list_VariantOptionData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Collection", "tags": [ "Variant options" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.variant_option:read" ] } }, "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/variants/create-option/" }, "operationId": "create_variant_option_api_v1_variant_options_post", "parameters": [ { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "example": "example-create_variant_option_api_v1_variant_options_post", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "name": "Example" }, "schema": { "$ref": "#/components/schemas/VariantOptionCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Variant Option", "tags": [ "Variant options" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.variant_option:create" ] } } }, "/api/v1/variant-options/{identity}": { "delete": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/variants/delete-option/" }, "operationId": "delete_variant_option_api_v1_variant_options__identity__delete", "parameters": [ { "example": "example", "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "example": 1, "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "example": "example-delete_variant_option_api_v1_variant_options__identity__delete", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": true, "id": "example", "version": null }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Delete Variant Option", "tags": [ "Variant options" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.variant_option:delete" ] } }, "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/variants/get-option/" }, "operationId": "record_api_v1_variant_options__identity__get", "parameters": [ { "example": "example", "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "created_at": "2026-01-01T12:00:00Z", "id": "example", "name": "Example", "number": "example", "position": 1, "selection_type": "button", "updated_at": "2026-01-01T12:00:00Z", "value_presentation_type": "text", "version": 1 }, "meta": { "locale": "en", "market_code": "PL", "market_id": "example", "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_VariantOptionData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Record", "tags": [ "Variant options" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.variant_option:read" ] } }, "patch": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/variants/update-option/" }, "operationId": "update_variant_option_api_v1_variant_options__identity__patch", "parameters": [ { "example": "example", "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "example": "example-update_variant_option_api_v1_variant_options__identity__patch", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 1, "name": "Example" }, "schema": { "$ref": "#/components/schemas/VariantOptionUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Variant Option", "tags": [ "Variant options" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.variant_option:update" ] } } }, "/api/v1/variant-options/{identity}/values": { "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/variants/list-option-values/" }, "operationId": "values_api_v1_variant_options__identity__values_get", "parameters": [ { "example": "example", "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "example": 20, "in": "query", "name": "limit", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "title": "Limit", "type": "integer" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "anyOf": [ { "maxLength": 1024, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": [ { "color_hex": "#008855", "created_at": "2026-01-01T12:00:00Z", "id": "example", "image_media_id": null, "number": "example", "option_id": "example", "position": 1, "sku_code": "example", "updated_at": "2026-01-01T12:00:00Z", "value": "example", "version": 1 } ], "meta": { "locale": "en", "market_code": "PL", "market_id": "example", "pagination": { "has_more": false, "limit": 20, "next_cursor": null }, "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_list_VariantValueData__" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Values", "tags": [ "Variant options" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.variant_option:read" ] } }, "post": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/variants/create-option-value/" }, "operationId": "create_variant_value_api_v1_variant_options__identity__values_post", "parameters": [ { "example": "example", "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "example": "example-create_variant_value_api_v1_variant_options__identity__values_post", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 1, "value": "Example" }, "schema": { "$ref": "#/components/schemas/VariantValueCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Resource created, or the original creation result replayed.", "headers": { "Location": { "description": "Relative URL of the created resource.", "schema": { "type": "string" } } } }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Create Variant Value", "tags": [ "Variant options" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.variant_option:create" ] } } }, "/api/v1/variant-options/{identity}/values/{value_id}": { "delete": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/variants/delete-option-value/" }, "operationId": "delete_variant_value_api_v1_variant_options__identity__values__value_id__delete", "parameters": [ { "example": "example", "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "example": "example", "in": "path", "name": "value_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Value Id", "type": "string" } }, { "example": 1, "in": "query", "name": "expected_version", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": 1, "title": "Expected Version", "type": "integer" } }, { "example": "example-delete_variant_value_api_v1_variant_options__identity__values__value_id__delete", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": true, "id": "example", "version": null }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Delete Variant Value", "tags": [ "Variant options" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.variant_option:delete" ] } }, "get": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/variants/get-option-value/" }, "operationId": "value_record_api_v1_variant_options__identity__values__value_id__get", "parameters": [ { "example": "example", "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "example": "example", "in": "path", "name": "value_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Value Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "color_hex": "#008855", "created_at": "2026-01-01T12:00:00Z", "id": "example", "image_media_id": null, "number": "example", "option_id": "example", "position": 1, "sku_code": "example", "updated_at": "2026-01-01T12:00:00Z", "value": "example", "version": 1 }, "meta": { "locale": "en", "market_code": "PL", "market_id": "example", "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_VariantValueData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Value Record", "tags": [ "Variant options" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.variant_option:read" ] } }, "patch": { "externalDocs": { "description": "Documentation and examples", "url": "https://learn.shopently.com/en/api/docs/variants/update-option-value/" }, "operationId": "update_variant_value_api_v1_variant_options__identity__values__value_id__patch", "parameters": [ { "example": "example", "in": "path", "name": "identity", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Identity", "type": "string" } }, { "example": "example", "in": "path", "name": "value_id", "required": true, "schema": { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "title": "Value Id", "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "anyOf": [ { "maxLength": 20, "minLength": 2, "type": "string" }, { "type": "null" } ], "title": "Locale" } }, { "in": "query", "name": "market_id", "required": false, "schema": { "anyOf": [ { "pattern": "^[a-z0-9][a-z0-9_-]{0,62}$", "type": "string" }, { "type": "null" } ], "title": "Market Id" } }, { "in": "query", "name": "market_code", "required": false, "schema": { "anyOf": [ { "maxLength": 16, "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Market Code" } }, { "example": "example-update_variant_value_api_v1_variant_options__identity__values__value_id__patch", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]{0,127}$", "title": "Idempotency-Key", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "expected_version": 1, "value": "Example" }, "schema": { "$ref": "#/components/schemas/VariantValueUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "examples": { "success": { "value": { "data": { "deleted": false, "id": "example", "version": 1 }, "meta": { "request_id": "example" } } } }, "schema": { "$ref": "#/components/schemas/ApiResponse_MutationData_" } } }, "description": "Successful Response" }, "400": { "content": { "application/json": { "examples": { "request.malformed": { "value": { "error": { "code": "request.malformed", "fields": null, "message": "The request could not be read." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request could not be read.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "examples": { "authentication.invalid_credentials": { "value": { "error": { "code": "authentication.invalid_credentials", "fields": null, "message": "The credentials are invalid." }, "meta": { "request_id": "example-request" } } }, "authentication.required": { "value": { "error": { "code": "authentication.required", "fields": null, "message": "Authentication is required." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Authentication is required.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "WWW-Authenticate": { "schema": { "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "403": { "content": { "application/json": { "examples": { "authorization.client_ip_unverified": { "value": { "error": { "code": "authorization.client_ip_unverified", "fields": null, "message": "The client IP address could not be verified." }, "meta": { "request_id": "example-request" } } }, "authorization.ip_not_allowed": { "value": { "error": { "code": "authorization.ip_not_allowed", "fields": null, "message": "Access from this IP address is not allowed." }, "meta": { "request_id": "example-request" } } }, "authorization.scope_denied": { "value": { "error": { "code": "authorization.scope_denied", "fields": null, "message": "The required permission has not been granted." }, "meta": { "request_id": "example-request" } } }, "entitlements.api_disabled": { "value": { "error": { "code": "entitlements.api_disabled", "fields": null, "message": "API access is disabled for this store." }, "meta": { "request_id": "example-request" } } }, "entitlements.limit_exceeded": { "value": { "error": { "code": "entitlements.limit_exceeded", "fields": null, "message": "The operation exceeds a plan limit." }, "meta": { "request_id": "example-request" } } }, "entitlements.operation_disabled": { "value": { "error": { "code": "entitlements.operation_disabled", "fields": null, "message": "The current plan does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "entitlements.resource_blocked": { "value": { "error": { "code": "entitlements.resource_blocked", "fields": null, "message": "A plan limit blocks access to this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The required permission has not been granted.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "404": { "content": { "application/json": { "examples": { "resource.not_found": { "value": { "error": { "code": "resource.not_found", "fields": null, "message": "The resource was not found." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The resource was not found.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "405": { "content": { "application/json": { "examples": { "request.method_not_allowed": { "value": { "error": { "code": "request.method_not_allowed", "fields": null, "message": "This method is not supported for this resource." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "This method is not supported for this resource.", "headers": { "Allow": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "409": { "content": { "application/json": { "examples": { "idempotency.key_reused": { "value": { "error": { "code": "idempotency.key_reused", "fields": null, "message": "This idempotency key was used with a different request." }, "meta": { "request_id": "example-request" } } }, "resource.already_exists": { "value": { "error": { "code": "resource.already_exists", "fields": null, "message": "A resource with these unique values already exists." }, "meta": { "request_id": "example-request" } } }, "resource.in_use": { "value": { "error": { "code": "resource.in_use", "fields": null, "message": "The resource is still in use." }, "meta": { "request_id": "example-request" } } }, "resource.state_conflict": { "value": { "error": { "code": "resource.state_conflict", "fields": null, "message": "The current resource state does not allow this operation." }, "meta": { "request_id": "example-request" } } }, "resource.version_conflict": { "value": { "error": { "code": "resource.version_conflict", "fields": null, "message": "The resource version has changed." }, "meta": { "request_id": "example-request" } } }, "storage.limit_reached": { "value": { "error": { "code": "storage.limit_reached", "fields": null, "message": "The upload storage limit is reached." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The upload storage limit is reached.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "413": { "content": { "application/json": { "examples": { "request.too_large": { "value": { "error": { "code": "request.too_large", "fields": null, "message": "The request exceeds the size limit." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request exceeds the size limit.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "415": { "content": { "application/json": { "examples": { "request.unsupported_media_type": { "value": { "error": { "code": "request.unsupported_media_type", "fields": null, "message": "The request media type or encoding is not supported." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request media type or encoding is not supported.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "416": { "content": { "application/json": { "examples": { "request.range_not_satisfiable": { "value": { "error": { "code": "request.range_not_satisfiable", "fields": null, "message": "The requested byte range is unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The requested byte range is unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "422": { "content": { "application/json": { "examples": { "request.validation_failed": { "value": { "error": { "code": "request.validation_failed", "fields": null, "message": "Some request parameters are invalid." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Some request parameters are invalid.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "429": { "content": { "application/json": { "examples": { "capacity.queue_full": { "value": { "error": { "code": "capacity.queue_full", "fields": null, "message": "The API is busy. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "capacity.wait_timeout": { "value": { "error": { "code": "capacity.wait_timeout", "fields": null, "message": "The API could not start this request in time. Please retry shortly." }, "meta": { "request_id": "example-request" } } }, "rate_limit.exceeded": { "value": { "error": { "code": "rate_limit.exceeded", "fields": null, "message": "The request rate limit has been exceeded." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The request rate limit has been exceeded.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "500": { "content": { "application/json": { "examples": { "internal.error": { "value": { "error": { "code": "internal.error", "fields": null, "message": "An unexpected error occurred." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "An unexpected error occurred.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "502": { "content": { "application/json": { "examples": { "gateway.bad_response": { "value": { "error": { "code": "gateway.bad_response", "fields": null, "message": "The API gateway could not obtain a valid response." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway could not obtain a valid response.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "503": { "content": { "application/json": { "examples": { "service.unavailable": { "value": { "error": { "code": "service.unavailable", "fields": null, "message": "The API is temporarily unavailable." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API is temporarily unavailable.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "Retry-After": { "schema": { "minimum": 0, "type": "integer" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } }, "504": { "content": { "application/json": { "examples": { "gateway.timeout": { "value": { "error": { "code": "gateway.timeout", "fields": null, "message": "The API gateway timed out." }, "meta": { "request_id": "example-request" } } } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The API gateway timed out.", "headers": { "Cache-Control": { "schema": { "const": "no-store", "type": "string" } }, "X-Correlation-ID": { "description": "Request identifier.", "schema": { "type": "string" } } } } }, "security": [ { "Bearer": [] } ], "summary": "Update Variant Value", "tags": [ "Variant options" ], "x-shopently-access": { "api_plan_features": [ "api.catalog.enabled", "api.enabled" ], "conditional_scopes": [], "required_scopes": [ "catalog.variant_option:update" ] } } } }, "servers": [ { "description": "Use your own Shopently store domain. The default is a technical example domain.", "url": "https://{store_domain}", "variables": { "store_domain": { "default": "shop.onshopently.com", "description": "Your store hostname, without the protocol or a path." } } } ], "x-shopently-errors": { "authentication.invalid_credentials": { "message": "The credentials are invalid.", "status": 401 }, "authentication.required": { "message": "Authentication is required.", "status": 401 }, "authorization.client_ip_unverified": { "message": "The client IP address could not be verified.", "status": 403 }, "authorization.ip_not_allowed": { "message": "Access from this IP address is not allowed.", "status": 403 }, "authorization.scope_denied": { "message": "The required permission has not been granted.", "status": 403 }, "capacity.queue_full": { "message": "The API is busy. Please retry shortly.", "status": 429 }, "capacity.wait_timeout": { "message": "The API could not start this request in time. Please retry shortly.", "status": 429 }, "entitlements.api_disabled": { "message": "API access is disabled for this store.", "status": 403 }, "entitlements.limit_exceeded": { "message": "The operation exceeds a plan limit.", "status": 403 }, "entitlements.operation_disabled": { "message": "The current plan does not allow this operation.", "status": 403 }, "entitlements.resource_blocked": { "message": "A plan limit blocks access to this resource.", "status": 403 }, "gateway.bad_response": { "message": "The API gateway could not obtain a valid response.", "status": 502 }, "gateway.timeout": { "message": "The API gateway timed out.", "status": 504 }, "idempotency.key_reused": { "message": "This idempotency key was used with a different request.", "status": 409 }, "internal.error": { "message": "An unexpected error occurred.", "status": 500 }, "rate_limit.exceeded": { "message": "The request rate limit has been exceeded.", "status": 429 }, "request.malformed": { "message": "The request could not be read.", "status": 400 }, "request.method_not_allowed": { "message": "This method is not supported for this resource.", "status": 405 }, "request.range_not_satisfiable": { "message": "The requested byte range is unavailable.", "status": 416 }, "request.too_large": { "message": "The request exceeds the size limit.", "status": 413 }, "request.unsupported_media_type": { "message": "The request media type or encoding is not supported.", "status": 415 }, "request.validation_failed": { "message": "Some request parameters are invalid.", "status": 422 }, "resource.already_exists": { "message": "A resource with these unique values already exists.", "status": 409 }, "resource.in_use": { "message": "The resource is still in use.", "status": 409 }, "resource.not_found": { "message": "The resource was not found.", "status": 404 }, "resource.state_conflict": { "message": "The current resource state does not allow this operation.", "status": 409 }, "resource.version_conflict": { "message": "The resource version has changed.", "status": 409 }, "service.unavailable": { "message": "The API is temporarily unavailable.", "status": 503 }, "storage.limit_reached": { "message": "The upload storage limit is reached.", "status": 409 } } }