{ "openapi": "3.1.2", "info": { "title": "Ecomiq UCP API", "version": "1.0.0", "description": "Universal Commerce Protocol endpoints for AI-agent commerce flows." }, "paths": { "/.well-known/agents/chatgpt": { "get": { "tags": [ "Agent Commerce" ], "operationId": "GetChatGptAgentProfile", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UcpProfileDto" }, "example": { "ucp": { "version": "example", "services": { "key": [ { "version": "example", "spec": "example", "transport": "example", "endpoint": "example", "schema": "example" } ] }, "payment_handlers": { "key": [ { "id": "7204558912004325301", "version": "example", "spec": "example", "schema": "example", "available_instruments": [ { "type": "example", "constraints": {} } ], "config": {} } ] }, "capabilities": { "key": [ { "version": "example", "spec": "example", "schema": "example", "config": {}, "extends": {} } ] } }, "keys": [ { "kid": "7204558912004325301", "kty": "example", "crv": "example", "x": "example", "y": "example", "use": "example", "alg": "example" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpValidationProblemDetails" }, { "$ref": "#/components/schemas/ProblemDetails" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [], "x-ecomiq-anonymous": true, "x-ecomiq-context": "Agent Commerce", "x-ecomiq-resource": "Profiles", "summary": "Get chat gpt agent profile", "description": "Get chat gpt agent profile. A successful request returns HTTP 200 with the documented response body.", "x-ecomiq-generated-description": true, "parameters": [], "x-ecomiq-surface": "ucp", "x-ecomiq-audience": "public", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/.well-known/ucp": { "get": { "tags": [ "Agent Commerce" ], "operationId": "GetUcpProfile", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UcpProfileDto" }, "example": { "ucp": { "version": "example", "services": { "key": [ { "version": "example", "spec": "example", "transport": "example", "endpoint": "example", "schema": "example" } ] }, "payment_handlers": { "key": [ { "id": "7204558912004325301", "version": "example", "spec": "example", "schema": "example", "available_instruments": [ { "type": "example", "constraints": {} } ], "config": {} } ] }, "capabilities": { "key": [ { "version": "example", "spec": "example", "schema": "example", "config": {}, "extends": {} } ] } }, "keys": [ { "kid": "7204558912004325301", "kty": "example", "crv": "example", "x": "example", "y": "example", "use": "example", "alg": "example" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpValidationProblemDetails" }, { "$ref": "#/components/schemas/ProblemDetails" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [], "x-ecomiq-anonymous": true, "x-ecomiq-context": "Agent Commerce", "x-ecomiq-resource": "Profiles", "summary": "Get UCP profile", "description": "Get UCP profile. A successful request returns HTTP 200 with the documented response body.", "x-ecomiq-generated-description": true, "parameters": [], "x-ecomiq-surface": "ucp", "x-ecomiq-audience": "public", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/ucp/carts": { "post": { "tags": [ "Agent Commerce" ], "operationId": "UcpCreateCart", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string", "example": "Bearer " }, "example": "Bearer ", "description": "OAuth 2.0 bearer token.", "x-ecomiq-sample-only": true }, { "name": "x-Store-Domain", "in": "header", "description": "Store slug or configured domain that selects the UCP store context.", "required": true, "schema": { "maxLength": 253, "minLength": 1, "type": "string", "example": "my-store" }, "example": "my-store" }, { "name": "UCP-Agent", "in": "header", "description": "Agent profile binding in the form profile=\"https://agent.example/.well-known/ucp\".", "required": true, "schema": { "minLength": 1, "type": "string", "example": "profile=\"https://agent.example/.well-known/ucp\"" }, "example": "profile=\"https://agent.example/.well-known/ucp\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional idempotency key for retry-safe UCP requests.", "schema": { "maxLength": 300, "minLength": 1, "type": "string", "example": "checkout-2026-0001" }, "example": "checkout-2026-0001" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UcpCartRequest" }, "example": { "line_items": [ { "item": { "id": "7204558912004325301", "title": "Example title", "price": 1, "quantity_unit": { "unit": "example", "display_text": "example", "scale": 1, "increment": 1 }, "unit_price": { "amount": 1, "currency": "PEN", "measure": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 }, "reference": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 } }, "image_url": "https://example.com/resource" }, "quantity": 1, "id": "7204558912004325301", "totals": [ { "type": "example", "amount": 1, "display_text": "example", "lines": [ { "display_text": "example", "amount": 1 } ] } ], "parent_id": "7204558912004325301" } ], "context": { "currency": "PEN", "address_country": "example", "address_region": "example", "postal_code": "example_code", "intent": "example", "language": "es", "eligibility": [ "example" ] }, "signals": { "dev.ucp.buyer_ip": "example", "dev.ucp.user_agent": "example" }, "attribution": {}, "buyer": { "first_name": "Example resource", "last_name": "Example resource", "email": "andrea@example.com", "phone_number": "+51987654321" } } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UcpCartDto" }, "example": { "ucp": { "version": "example", "status": "example", "capabilities": { "key": [ { "version": "example" } ] }, "payment_handlers": { "key": [ { "id": "7204558912004325301", "version": "example", "spec": "example", "schema": "example", "available_instruments": [ { "type": "example", "constraints": {} } ], "config": {} } ] } }, "id": "7204558912004325301", "currency": "PEN", "line_items": [ { "item": { "id": "7204558912004325301", "title": "Example title", "price": 1, "quantity_unit": { "unit": "example", "display_text": "example", "scale": 1, "increment": 1 }, "unit_price": { "amount": 1, "currency": "PEN", "measure": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 }, "reference": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 } }, "image_url": "https://example.com/resource" }, "quantity": 1, "id": "7204558912004325301", "totals": [ { "type": "example", "amount": 1, "display_text": "example", "lines": [ { "display_text": "example", "amount": 1 } ] } ], "parent_id": "7204558912004325301" } ], "context": { "currency": "PEN", "address_country": "example", "address_region": "example", "postal_code": "example_code", "intent": "example", "language": "es", "eligibility": [ "example" ] }, "buyer": { "first_name": "Example resource", "last_name": "Example resource", "email": "andrea@example.com", "phone_number": "+51987654321" }, "totals": [ { "type": "example", "amount": 1, "display_text": "example", "lines": [ { "display_text": "example", "amount": 1 } ] } ], "messages": [ { "type": "example", "content": "example", "code": "example_code", "path": "example", "content_type": "example", "severity": "example" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpValidationProblemDetails" }, { "$ref": "#/components/schemas/ProblemDetails" } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/UcpErrorResponseDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UcpErrorResponseDto" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] }, { "ucpApiKey": [] } ], "x-ecomiq-anonymous": false, "x-ecomiq-context": "Agent Commerce", "x-ecomiq-resource": "Carts", "summary": "UCP create cart", "description": "UCP create cart. A successful request returns HTTP 201 with the documented response body.", "x-ecomiq-generated-description": true, "x-ecomiq-surface": "ucp", "x-ecomiq-audience": "public", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/ucp/carts/{id}": { "get": { "tags": [ "Agent Commerce" ], "operationId": "UcpGetCart", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string", "example": "Bearer " }, "example": "Bearer ", "description": "OAuth 2.0 bearer token.", "x-ecomiq-sample-only": true }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "7204558912004325301" }, "description": "Unique identifier of the resource.", "example": "7204558912004325301" }, { "name": "x-Store-Domain", "in": "header", "description": "Store slug or configured domain that selects the UCP store context.", "required": true, "schema": { "maxLength": 253, "minLength": 1, "type": "string", "example": "my-store" }, "example": "my-store" }, { "name": "UCP-Agent", "in": "header", "description": "Agent profile binding in the form profile=\"https://agent.example/.well-known/ucp\".", "required": true, "schema": { "minLength": 1, "type": "string", "example": "profile=\"https://agent.example/.well-known/ucp\"" }, "example": "profile=\"https://agent.example/.well-known/ucp\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional idempotency key for retry-safe UCP requests.", "schema": { "maxLength": 300, "minLength": 1, "type": "string", "example": "checkout-2026-0001" }, "example": "checkout-2026-0001" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UcpCartDto" }, "example": { "ucp": { "version": "example", "status": "example", "capabilities": { "key": [ { "version": "example" } ] }, "payment_handlers": { "key": [ { "id": "7204558912004325301", "version": "example", "spec": "example", "schema": "example", "available_instruments": [ { "type": "example", "constraints": {} } ], "config": {} } ] } }, "id": "7204558912004325301", "currency": "PEN", "line_items": [ { "item": { "id": "7204558912004325301", "title": "Example title", "price": 1, "quantity_unit": { "unit": "example", "display_text": "example", "scale": 1, "increment": 1 }, "unit_price": { "amount": 1, "currency": "PEN", "measure": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 }, "reference": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 } }, "image_url": "https://example.com/resource" }, "quantity": 1, "id": "7204558912004325301", "totals": [ { "type": "example", "amount": 1, "display_text": "example", "lines": [ { "display_text": "example", "amount": 1 } ] } ], "parent_id": "7204558912004325301" } ], "context": { "currency": "PEN", "address_country": "example", "address_region": "example", "postal_code": "example_code", "intent": "example", "language": "es", "eligibility": [ "example" ] }, "buyer": { "first_name": "Example resource", "last_name": "Example resource", "email": "andrea@example.com", "phone_number": "+51987654321" }, "totals": [ { "type": "example", "amount": 1, "display_text": "example", "lines": [ { "display_text": "example", "amount": 1 } ] } ], "messages": [ { "type": "example", "content": "example", "code": "example_code", "path": "example", "content_type": "example", "severity": "example" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpValidationProblemDetails" }, { "$ref": "#/components/schemas/ProblemDetails" } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/UcpErrorResponseDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UcpErrorResponseDto" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] }, { "ucpApiKey": [] } ], "x-ecomiq-anonymous": false, "x-ecomiq-context": "Agent Commerce", "x-ecomiq-resource": "Carts", "summary": "UCP get cart", "description": "UCP get cart. A successful request returns HTTP 200 with the documented response body.", "x-ecomiq-generated-description": true, "x-ecomiq-surface": "ucp", "x-ecomiq-audience": "public", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Agent Commerce" ], "operationId": "UcpUpdateCart", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string", "example": "Bearer " }, "example": "Bearer ", "description": "OAuth 2.0 bearer token.", "x-ecomiq-sample-only": true }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "7204558912004325301" }, "description": "Unique identifier of the resource.", "example": "7204558912004325301" }, { "name": "x-Store-Domain", "in": "header", "description": "Store slug or configured domain that selects the UCP store context.", "required": true, "schema": { "maxLength": 253, "minLength": 1, "type": "string", "example": "my-store" }, "example": "my-store" }, { "name": "UCP-Agent", "in": "header", "description": "Agent profile binding in the form profile=\"https://agent.example/.well-known/ucp\".", "required": true, "schema": { "minLength": 1, "type": "string", "example": "profile=\"https://agent.example/.well-known/ucp\"" }, "example": "profile=\"https://agent.example/.well-known/ucp\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional idempotency key for retry-safe UCP requests.", "schema": { "maxLength": 300, "minLength": 1, "type": "string", "example": "checkout-2026-0001" }, "example": "checkout-2026-0001" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UcpCartRequest" }, "example": { "line_items": [ { "item": { "id": "7204558912004325301", "title": "Example title", "price": 1, "quantity_unit": { "unit": "example", "display_text": "example", "scale": 1, "increment": 1 }, "unit_price": { "amount": 1, "currency": "PEN", "measure": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 }, "reference": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 } }, "image_url": "https://example.com/resource" }, "quantity": 1, "id": "7204558912004325301", "totals": [ { "type": "example", "amount": 1, "display_text": "example", "lines": [ { "display_text": "example", "amount": 1 } ] } ], "parent_id": "7204558912004325301" } ], "context": { "currency": "PEN", "address_country": "example", "address_region": "example", "postal_code": "example_code", "intent": "example", "language": "es", "eligibility": [ "example" ] }, "signals": { "dev.ucp.buyer_ip": "example", "dev.ucp.user_agent": "example" }, "attribution": {}, "buyer": { "first_name": "Example resource", "last_name": "Example resource", "email": "andrea@example.com", "phone_number": "+51987654321" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UcpCartDto" }, "example": { "ucp": { "version": "example", "status": "example", "capabilities": { "key": [ { "version": "example" } ] }, "payment_handlers": { "key": [ { "id": "7204558912004325301", "version": "example", "spec": "example", "schema": "example", "available_instruments": [ { "type": "example", "constraints": {} } ], "config": {} } ] } }, "id": "7204558912004325301", "currency": "PEN", "line_items": [ { "item": { "id": "7204558912004325301", "title": "Example title", "price": 1, "quantity_unit": { "unit": "example", "display_text": "example", "scale": 1, "increment": 1 }, "unit_price": { "amount": 1, "currency": "PEN", "measure": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 }, "reference": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 } }, "image_url": "https://example.com/resource" }, "quantity": 1, "id": "7204558912004325301", "totals": [ { "type": "example", "amount": 1, "display_text": "example", "lines": [ { "display_text": "example", "amount": 1 } ] } ], "parent_id": "7204558912004325301" } ], "context": { "currency": "PEN", "address_country": "example", "address_region": "example", "postal_code": "example_code", "intent": "example", "language": "es", "eligibility": [ "example" ] }, "buyer": { "first_name": "Example resource", "last_name": "Example resource", "email": "andrea@example.com", "phone_number": "+51987654321" }, "totals": [ { "type": "example", "amount": 1, "display_text": "example", "lines": [ { "display_text": "example", "amount": 1 } ] } ], "messages": [ { "type": "example", "content": "example", "code": "example_code", "path": "example", "content_type": "example", "severity": "example" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpValidationProblemDetails" }, { "$ref": "#/components/schemas/ProblemDetails" } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/UcpErrorResponseDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UcpErrorResponseDto" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] }, { "ucpApiKey": [] } ], "x-ecomiq-anonymous": false, "x-ecomiq-context": "Agent Commerce", "x-ecomiq-resource": "Carts", "summary": "UCP update cart", "description": "UCP update cart. A successful request returns HTTP 200 with the documented response body.", "x-ecomiq-generated-description": true, "x-ecomiq-surface": "ucp", "x-ecomiq-audience": "public", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/ucp/carts/{id}/cancel": { "post": { "tags": [ "Agent Commerce" ], "operationId": "UcpCancelCart", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string", "example": "Bearer " }, "example": "Bearer ", "description": "OAuth 2.0 bearer token.", "x-ecomiq-sample-only": true }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "7204558912004325301" }, "description": "Unique identifier of the resource.", "example": "7204558912004325301" }, { "name": "x-Store-Domain", "in": "header", "description": "Store slug or configured domain that selects the UCP store context.", "required": true, "schema": { "maxLength": 253, "minLength": 1, "type": "string", "example": "my-store" }, "example": "my-store" }, { "name": "UCP-Agent", "in": "header", "description": "Agent profile binding in the form profile=\"https://agent.example/.well-known/ucp\".", "required": true, "schema": { "minLength": 1, "type": "string", "example": "profile=\"https://agent.example/.well-known/ucp\"" }, "example": "profile=\"https://agent.example/.well-known/ucp\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional idempotency key for retry-safe UCP requests.", "schema": { "maxLength": 300, "minLength": 1, "type": "string", "example": "checkout-2026-0001" }, "example": "checkout-2026-0001" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UcpCartDto" }, "example": { "ucp": { "version": "example", "status": "example", "capabilities": { "key": [ { "version": "example" } ] }, "payment_handlers": { "key": [ { "id": "7204558912004325301", "version": "example", "spec": "example", "schema": "example", "available_instruments": [ { "type": "example", "constraints": {} } ], "config": {} } ] } }, "id": "7204558912004325301", "currency": "PEN", "line_items": [ { "item": { "id": "7204558912004325301", "title": "Example title", "price": 1, "quantity_unit": { "unit": "example", "display_text": "example", "scale": 1, "increment": 1 }, "unit_price": { "amount": 1, "currency": "PEN", "measure": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 }, "reference": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 } }, "image_url": "https://example.com/resource" }, "quantity": 1, "id": "7204558912004325301", "totals": [ { "type": "example", "amount": 1, "display_text": "example", "lines": [ { "display_text": "example", "amount": 1 } ] } ], "parent_id": "7204558912004325301" } ], "context": { "currency": "PEN", "address_country": "example", "address_region": "example", "postal_code": "example_code", "intent": "example", "language": "es", "eligibility": [ "example" ] }, "buyer": { "first_name": "Example resource", "last_name": "Example resource", "email": "andrea@example.com", "phone_number": "+51987654321" }, "totals": [ { "type": "example", "amount": 1, "display_text": "example", "lines": [ { "display_text": "example", "amount": 1 } ] } ], "messages": [ { "type": "example", "content": "example", "code": "example_code", "path": "example", "content_type": "example", "severity": "example" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpValidationProblemDetails" }, { "$ref": "#/components/schemas/ProblemDetails" } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/UcpErrorResponseDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UcpErrorResponseDto" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] }, { "ucpApiKey": [] } ], "x-ecomiq-anonymous": false, "x-ecomiq-context": "Agent Commerce", "x-ecomiq-resource": "Carts", "summary": "UCP cancel cart", "description": "UCP cancel cart. A successful request returns HTTP 200 with the documented response body.", "x-ecomiq-generated-description": true, "x-ecomiq-surface": "ucp", "x-ecomiq-audience": "public", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/ucp/catalog/lookup": { "post": { "tags": [ "Agent Commerce" ], "operationId": "UcpLookupCatalog", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string", "example": "Bearer " }, "example": "Bearer ", "description": "OAuth 2.0 bearer token.", "x-ecomiq-sample-only": true }, { "name": "x-Store-Domain", "in": "header", "description": "Store slug or configured domain that selects the UCP store context.", "required": true, "schema": { "maxLength": 253, "minLength": 1, "type": "string", "example": "my-store" }, "example": "my-store" }, { "name": "UCP-Agent", "in": "header", "description": "Agent profile binding in the form profile=\"https://agent.example/.well-known/ucp\".", "required": true, "schema": { "minLength": 1, "type": "string", "example": "profile=\"https://agent.example/.well-known/ucp\"" }, "example": "profile=\"https://agent.example/.well-known/ucp\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional idempotency key for retry-safe UCP requests.", "schema": { "maxLength": 300, "minLength": 1, "type": "string", "example": "checkout-2026-0001" }, "example": "checkout-2026-0001" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UcpCatalogLookupRequest" }, "example": { "ids": [ "example" ], "filters": { "categories": [ "example" ], "price": { "min": 1, "max": 1 } }, "context": { "currency": "PEN", "address_country": "example", "address_region": "example", "postal_code": "example_code", "intent": "example", "language": "es", "eligibility": [ "example" ] }, "signals": { "dev.ucp.buyer_ip": "example", "dev.ucp.user_agent": "example" }, "attribution": {} } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UcpCatalogLookupResponse" }, "example": { "ucp": { "version": "example", "status": "example", "capabilities": { "key": [ { "version": "example" } ] }, "payment_handlers": { "key": [ { "id": "7204558912004325301", "version": "example", "spec": "example", "schema": "example", "available_instruments": [ { "type": "example", "constraints": {} } ], "config": {} } ] } }, "products": [ { "id": "7204558912004325301", "title": "Example title", "description": { "plain": "example", "html": "example", "markdown": "example" }, "price_range": { "min": { "amount": 1, "currency": "PEN" }, "max": { "amount": 1, "currency": "PEN" } }, "handle": "example", "url": "https://example.com/resource", "categories": [ { "value": "example", "taxonomy": "example" } ], "list_price_range": { "min": { "amount": 1, "currency": "PEN" }, "max": { "amount": 1, "currency": "PEN" } } } ], "messages": [ { "type": "example", "content": "example", "code": "example_code", "path": "example", "content_type": "example", "severity": "example" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpValidationProblemDetails" }, { "$ref": "#/components/schemas/ProblemDetails" } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/UcpErrorResponseDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] }, { "ucpApiKey": [] } ], "x-ecomiq-anonymous": false, "x-ecomiq-context": "Agent Commerce", "x-ecomiq-resource": "Catalog", "summary": "UCP lookup catalog", "description": "UCP lookup catalog. A successful request returns HTTP 200 with the documented response body.", "x-ecomiq-generated-description": true, "x-ecomiq-surface": "ucp", "x-ecomiq-audience": "public", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/ucp/catalog/product": { "post": { "tags": [ "Agent Commerce" ], "operationId": "UcpGetCatalogProduct", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string", "example": "Bearer " }, "example": "Bearer ", "description": "OAuth 2.0 bearer token.", "x-ecomiq-sample-only": true }, { "name": "x-Store-Domain", "in": "header", "description": "Store slug or configured domain that selects the UCP store context.", "required": true, "schema": { "maxLength": 253, "minLength": 1, "type": "string", "example": "my-store" }, "example": "my-store" }, { "name": "UCP-Agent", "in": "header", "description": "Agent profile binding in the form profile=\"https://agent.example/.well-known/ucp\".", "required": true, "schema": { "minLength": 1, "type": "string", "example": "profile=\"https://agent.example/.well-known/ucp\"" }, "example": "profile=\"https://agent.example/.well-known/ucp\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional idempotency key for retry-safe UCP requests.", "schema": { "maxLength": 300, "minLength": 1, "type": "string", "example": "checkout-2026-0001" }, "example": "checkout-2026-0001" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UcpCatalogProductRequest" }, "example": { "id": "7204558912004325301", "selected": [ { "name": "Example resource", "label": "example", "id": "7204558912004325301" } ], "preferences": [ "example" ], "filters": { "categories": [ "example" ], "price": { "min": 1, "max": 1 } }, "context": { "currency": "PEN", "address_country": "example", "address_region": "example", "postal_code": "example_code", "intent": "example", "language": "es", "eligibility": [ "example" ] }, "signals": { "dev.ucp.buyer_ip": "example", "dev.ucp.user_agent": "example" }, "attribution": {} } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UcpCatalogProductResponse" }, "example": { "ucp": { "version": "example", "status": "example", "capabilities": { "key": [ { "version": "example" } ] }, "payment_handlers": { "key": [ { "id": "7204558912004325301", "version": "example", "spec": "example", "schema": "example", "available_instruments": [ { "type": "example", "constraints": {} } ], "config": {} } ] } }, "product": { "id": "7204558912004325301", "title": "Example title", "description": { "plain": "example", "html": "example", "markdown": "example" }, "price_range": { "min": { "amount": 1, "currency": "PEN" }, "max": { "amount": 1, "currency": "PEN" } }, "handle": "example", "url": "https://example.com/resource", "categories": [ { "value": "example", "taxonomy": "example" } ], "list_price_range": { "min": { "amount": 1, "currency": "PEN" }, "max": { "amount": 1, "currency": "PEN" } } }, "messages": [ { "type": "example", "content": "example", "code": "example_code", "path": "example", "content_type": "example", "severity": "example" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpValidationProblemDetails" }, { "$ref": "#/components/schemas/ProblemDetails" } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/UcpErrorResponseDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UcpErrorResponseDto" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] }, { "ucpApiKey": [] } ], "x-ecomiq-anonymous": false, "x-ecomiq-context": "Agent Commerce", "x-ecomiq-resource": "Catalog", "summary": "UCP get catalog product", "description": "UCP get catalog product. A successful request returns HTTP 200 with the documented response body.", "x-ecomiq-generated-description": true, "x-ecomiq-surface": "ucp", "x-ecomiq-audience": "public", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/ucp/catalog/search": { "post": { "tags": [ "Agent Commerce" ], "operationId": "UcpSearchCatalog", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string", "example": "Bearer " }, "example": "Bearer ", "description": "OAuth 2.0 bearer token.", "x-ecomiq-sample-only": true }, { "name": "x-Store-Domain", "in": "header", "description": "Store slug or configured domain that selects the UCP store context.", "required": true, "schema": { "maxLength": 253, "minLength": 1, "type": "string", "example": "my-store" }, "example": "my-store" }, { "name": "UCP-Agent", "in": "header", "description": "Agent profile binding in the form profile=\"https://agent.example/.well-known/ucp\".", "required": true, "schema": { "minLength": 1, "type": "string", "example": "profile=\"https://agent.example/.well-known/ucp\"" }, "example": "profile=\"https://agent.example/.well-known/ucp\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional idempotency key for retry-safe UCP requests.", "schema": { "maxLength": 300, "minLength": 1, "type": "string", "example": "checkout-2026-0001" }, "example": "checkout-2026-0001" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UcpCatalogSearchRequest" }, "examples": { "textSearch": { "summary": "Text search", "description": "Searches the catalog with shopper locale and currency context.", "value": { "query": "polo de algodón", "context": { "currency": "PEN", "address_country": "PE", "language": "es" }, "pagination": { "limit": 10 } } }, "filteredSearch": { "summary": "Category and price filters", "description": "Finds products in a category and a price range expressed in minor currency units.", "value": { "filters": { "categories": [ "ropa" ], "price": { "min": 5000, "max": 15000 } }, "context": { "currency": "PEN", "address_country": "PE", "address_region": "Lima", "language": "es" }, "pagination": { "limit": 20 } } }, "nextPage": { "summary": "Next page", "description": "Continues a previous catalog search with its pagination cursor.", "value": { "query": "zapatillas", "context": { "currency": "PEN", "address_country": "PE" }, "pagination": { "cursor": "2", "limit": 10 } } } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UcpCatalogSearchResponse" }, "example": { "ucp": { "version": "example", "status": "example", "capabilities": { "key": [ { "version": "example" } ] }, "payment_handlers": { "key": [ { "id": "7204558912004325301", "version": "example", "spec": "example", "schema": "example", "available_instruments": [ { "type": "example", "constraints": {} } ], "config": {} } ] } }, "products": [ { "id": "7204558912004325301", "title": "Example title", "description": { "plain": "example", "html": "example", "markdown": "example" }, "price_range": { "min": { "amount": 1, "currency": "PEN" }, "max": { "amount": 1, "currency": "PEN" } }, "handle": "example", "url": "https://example.com/resource", "categories": [ { "value": "example", "taxonomy": "example" } ], "list_price_range": { "min": { "amount": 1, "currency": "PEN" }, "max": { "amount": 1, "currency": "PEN" } } } ], "pagination": { "has_next_page": false, "cursor": "example", "total_count": 1 }, "messages": [ { "type": "example", "content": "example", "code": "example_code", "path": "example", "content_type": "example", "severity": "example" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpValidationProblemDetails" }, { "$ref": "#/components/schemas/ProblemDetails" } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/UcpErrorResponseDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] }, { "ucpApiKey": [] } ], "x-ecomiq-anonymous": false, "x-ecomiq-context": "Agent Commerce", "x-ecomiq-resource": "Catalog", "summary": "UCP search catalog", "description": "UCP search catalog. A successful request returns HTTP 200 with the documented response body.", "x-ecomiq-generated-description": true, "x-ecomiq-surface": "ucp", "x-ecomiq-audience": "public", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/ucp/checkout-sessions": { "post": { "tags": [ "Agent Commerce" ], "operationId": "UcpCreateCheckout", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string", "example": "Bearer " }, "example": "Bearer ", "description": "OAuth 2.0 bearer token.", "x-ecomiq-sample-only": true }, { "name": "x-Store-Domain", "in": "header", "description": "Store slug or configured domain that selects the UCP store context.", "required": true, "schema": { "maxLength": 253, "minLength": 1, "type": "string", "example": "my-store" }, "example": "my-store" }, { "name": "UCP-Agent", "in": "header", "description": "Agent profile binding in the form profile=\"https://agent.example/.well-known/ucp\".", "required": true, "schema": { "minLength": 1, "type": "string", "example": "profile=\"https://agent.example/.well-known/ucp\"" }, "example": "profile=\"https://agent.example/.well-known/ucp\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional idempotency key for retry-safe UCP requests.", "schema": { "maxLength": 300, "minLength": 1, "type": "string", "example": "checkout-2026-0001" }, "example": "checkout-2026-0001" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UcpCreateCheckoutRequest" }, "example": { "line_items": [ { "item": { "id": "7204558912004325301", "title": "Example title", "price": 1, "quantity_unit": { "unit": "example", "display_text": "example", "scale": 1, "increment": 1 }, "unit_price": { "amount": 1, "currency": "PEN", "measure": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 }, "reference": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 } }, "image_url": "https://example.com/resource" }, "quantity": 1, "id": "7204558912004325301", "totals": [ { "type": "example", "amount": 1, "display_text": "example", "lines": [ { "display_text": "example", "amount": 1 } ] } ], "parent_id": "7204558912004325301" } ], "cart_id": "7204558912004325301", "buyer": { "first_name": "Example resource", "last_name": "Example resource", "email": "andrea@example.com", "phone_number": "+51987654321" }, "context": { "currency": "PEN", "address_country": "example", "address_region": "example", "postal_code": "example_code", "intent": "example", "language": "es", "eligibility": [ "example" ] }, "signals": { "dev.ucp.buyer_ip": "example", "dev.ucp.user_agent": "example" }, "attribution": {}, "payment": { "instruments": [ { "id": "7204558912004325301", "handler_id": "7204558912004325301", "type": "example", "selected": false, "billing_address": {}, "credential": {}, "display": {} } ] }, "fulfillment": { "methods": [ { "id": "7204558912004325301", "type": "example", "line_item_ids": [ "example" ], "destinations": [ { "id": "7204558912004325301", "type": "example", "name": "Example resource", "address": { "extended_address": "example", "street_address": "example", "address_locality": "example", "address_region": "example", "address_country": "example", "postal_code": "example_code", "first_name": "Example resource", "last_name": "Example resource" }, "extended_address": "example", "street_address": "example", "address_locality": "example", "address_region": "example" } ], "selected_destination_id": "7204558912004325301", "groups": [ { "id": "7204558912004325301", "line_item_ids": [ "example" ], "options": [ { "id": "7204558912004325301", "title": "Example title", "description": { "plain": "example", "html": "example", "markdown": "example" }, "carrier": "example", "earliest_fulfillment_time": "example", "latest_fulfillment_time": "example", "totals": [ { "type": "example", "amount": 1, "display_text": "example", "lines": [ { "display_text": "example", "amount": 1 } ] } ] } ], "selected_option_id": "7204558912004325301" } ] } ], "available_methods": [ { "type": "example", "line_item_ids": [ "example" ], "fulfillable_on": "example", "description": "Example description." } ] } } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UcpCheckoutDto" }, "example": { "ucp": { "version": "example", "status": "example", "capabilities": { "key": [ { "version": "example" } ] }, "payment_handlers": { "key": [ { "id": "7204558912004325301", "version": "example", "spec": "example", "schema": "example", "available_instruments": [ { "type": "example", "constraints": {} } ], "config": {} } ] } }, "id": "7204558912004325301", "status": "example", "currency": "PEN", "cart_id": "7204558912004325301", "line_items": [ { "item": { "id": "7204558912004325301", "title": "Example title", "price": 1, "quantity_unit": { "unit": "example", "display_text": "example", "scale": 1, "increment": 1 }, "unit_price": { "amount": 1, "currency": "PEN", "measure": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 }, "reference": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 } }, "image_url": "https://example.com/resource" }, "quantity": 1, "id": "7204558912004325301", "totals": [ { "type": "example", "amount": 1, "display_text": "example", "lines": [ { "display_text": "example", "amount": 1 } ] } ], "parent_id": "7204558912004325301" } ], "buyer": { "first_name": "Example resource", "last_name": "Example resource", "email": "andrea@example.com", "phone_number": "+51987654321" }, "context": { "currency": "PEN", "address_country": "example", "address_region": "example", "postal_code": "example_code", "intent": "example", "language": "es", "eligibility": [ "example" ] } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpValidationProblemDetails" }, { "$ref": "#/components/schemas/ProblemDetails" } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/UcpErrorResponseDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UcpErrorResponseDto" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] }, { "ucpApiKey": [] } ], "x-ecomiq-anonymous": false, "x-ecomiq-context": "Agent Commerce", "x-ecomiq-resource": "Checkout Sessions", "summary": "UCP create checkout", "description": "UCP create checkout. A successful request returns HTTP 201 with the documented response body.", "x-ecomiq-generated-description": true, "x-ecomiq-surface": "ucp", "x-ecomiq-audience": "public", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/ucp/checkout-sessions/{id}": { "get": { "tags": [ "Agent Commerce" ], "operationId": "UcpGetCheckout", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string", "example": "Bearer " }, "example": "Bearer ", "description": "OAuth 2.0 bearer token.", "x-ecomiq-sample-only": true }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "7204558912004325301" }, "description": "Unique identifier of the resource.", "example": "7204558912004325301" }, { "name": "x-Store-Domain", "in": "header", "description": "Store slug or configured domain that selects the UCP store context.", "required": true, "schema": { "maxLength": 253, "minLength": 1, "type": "string", "example": "my-store" }, "example": "my-store" }, { "name": "UCP-Agent", "in": "header", "description": "Agent profile binding in the form profile=\"https://agent.example/.well-known/ucp\".", "required": true, "schema": { "minLength": 1, "type": "string", "example": "profile=\"https://agent.example/.well-known/ucp\"" }, "example": "profile=\"https://agent.example/.well-known/ucp\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional idempotency key for retry-safe UCP requests.", "schema": { "maxLength": 300, "minLength": 1, "type": "string", "example": "checkout-2026-0001" }, "example": "checkout-2026-0001" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UcpCheckoutDto" }, "example": { "ucp": { "version": "example", "status": "example", "capabilities": { "key": [ { "version": "example" } ] }, "payment_handlers": { "key": [ { "id": "7204558912004325301", "version": "example", "spec": "example", "schema": "example", "available_instruments": [ { "type": "example", "constraints": {} } ], "config": {} } ] } }, "id": "7204558912004325301", "status": "example", "currency": "PEN", "cart_id": "7204558912004325301", "line_items": [ { "item": { "id": "7204558912004325301", "title": "Example title", "price": 1, "quantity_unit": { "unit": "example", "display_text": "example", "scale": 1, "increment": 1 }, "unit_price": { "amount": 1, "currency": "PEN", "measure": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 }, "reference": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 } }, "image_url": "https://example.com/resource" }, "quantity": 1, "id": "7204558912004325301", "totals": [ { "type": "example", "amount": 1, "display_text": "example", "lines": [ { "display_text": "example", "amount": 1 } ] } ], "parent_id": "7204558912004325301" } ], "buyer": { "first_name": "Example resource", "last_name": "Example resource", "email": "andrea@example.com", "phone_number": "+51987654321" }, "context": { "currency": "PEN", "address_country": "example", "address_region": "example", "postal_code": "example_code", "intent": "example", "language": "es", "eligibility": [ "example" ] } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpValidationProblemDetails" }, { "$ref": "#/components/schemas/ProblemDetails" } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/UcpErrorResponseDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UcpErrorResponseDto" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] }, { "ucpApiKey": [] } ], "x-ecomiq-anonymous": false, "x-ecomiq-context": "Agent Commerce", "x-ecomiq-resource": "Checkout Sessions", "summary": "UCP get checkout", "description": "UCP get checkout. A successful request returns HTTP 200 with the documented response body.", "x-ecomiq-generated-description": true, "x-ecomiq-surface": "ucp", "x-ecomiq-audience": "public", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" }, "put": { "tags": [ "Agent Commerce" ], "operationId": "UcpUpdateCheckout", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string", "example": "Bearer " }, "example": "Bearer ", "description": "OAuth 2.0 bearer token.", "x-ecomiq-sample-only": true }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "7204558912004325301" }, "description": "Unique identifier of the resource.", "example": "7204558912004325301" }, { "name": "x-Store-Domain", "in": "header", "description": "Store slug or configured domain that selects the UCP store context.", "required": true, "schema": { "maxLength": 253, "minLength": 1, "type": "string", "example": "my-store" }, "example": "my-store" }, { "name": "UCP-Agent", "in": "header", "description": "Agent profile binding in the form profile=\"https://agent.example/.well-known/ucp\".", "required": true, "schema": { "minLength": 1, "type": "string", "example": "profile=\"https://agent.example/.well-known/ucp\"" }, "example": "profile=\"https://agent.example/.well-known/ucp\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional idempotency key for retry-safe UCP requests.", "schema": { "maxLength": 300, "minLength": 1, "type": "string", "example": "checkout-2026-0001" }, "example": "checkout-2026-0001" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UcpUpdateCheckoutRequest" }, "example": { "line_items": [ { "item": { "id": "7204558912004325301", "title": "Example title", "price": 1, "quantity_unit": { "unit": "example", "display_text": "example", "scale": 1, "increment": 1 }, "unit_price": { "amount": 1, "currency": "PEN", "measure": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 }, "reference": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 } }, "image_url": "https://example.com/resource" }, "quantity": 1, "id": "7204558912004325301", "totals": [ { "type": "example", "amount": 1, "display_text": "example", "lines": [ { "display_text": "example", "amount": 1 } ] } ], "parent_id": "7204558912004325301" } ], "buyer": { "first_name": "Example resource", "last_name": "Example resource", "email": "andrea@example.com", "phone_number": "+51987654321" }, "context": { "currency": "PEN", "address_country": "example", "address_region": "example", "postal_code": "example_code", "intent": "example", "language": "es", "eligibility": [ "example" ] }, "signals": { "dev.ucp.buyer_ip": "example", "dev.ucp.user_agent": "example" }, "attribution": {}, "payment": { "instruments": [ { "id": "7204558912004325301", "handler_id": "7204558912004325301", "type": "example", "selected": false, "billing_address": {}, "credential": {}, "display": {} } ] }, "fulfillment": { "methods": [ { "id": "7204558912004325301", "type": "example", "line_item_ids": [ "example" ], "destinations": [ { "id": "7204558912004325301", "type": "example", "name": "Example resource", "address": { "extended_address": "example", "street_address": "example", "address_locality": "example", "address_region": "example", "address_country": "example", "postal_code": "example_code", "first_name": "Example resource", "last_name": "Example resource" }, "extended_address": "example", "street_address": "example", "address_locality": "example", "address_region": "example" } ], "selected_destination_id": "7204558912004325301", "groups": [ { "id": "7204558912004325301", "line_item_ids": [ "example" ], "options": [ { "id": "7204558912004325301", "title": "Example title", "description": { "plain": "example", "html": "example", "markdown": "example" }, "carrier": "example", "earliest_fulfillment_time": "example", "latest_fulfillment_time": "example", "totals": [ { "type": "example", "amount": 1, "display_text": "example", "lines": [ { "display_text": "example", "amount": 1 } ] } ] } ], "selected_option_id": "7204558912004325301" } ] } ], "available_methods": [ { "type": "example", "line_item_ids": [ "example" ], "fulfillable_on": "example", "description": "Example description." } ] } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UcpCheckoutDto" }, "example": { "ucp": { "version": "example", "status": "example", "capabilities": { "key": [ { "version": "example" } ] }, "payment_handlers": { "key": [ { "id": "7204558912004325301", "version": "example", "spec": "example", "schema": "example", "available_instruments": [ { "type": "example", "constraints": {} } ], "config": {} } ] } }, "id": "7204558912004325301", "status": "example", "currency": "PEN", "cart_id": "7204558912004325301", "line_items": [ { "item": { "id": "7204558912004325301", "title": "Example title", "price": 1, "quantity_unit": { "unit": "example", "display_text": "example", "scale": 1, "increment": 1 }, "unit_price": { "amount": 1, "currency": "PEN", "measure": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 }, "reference": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 } }, "image_url": "https://example.com/resource" }, "quantity": 1, "id": "7204558912004325301", "totals": [ { "type": "example", "amount": 1, "display_text": "example", "lines": [ { "display_text": "example", "amount": 1 } ] } ], "parent_id": "7204558912004325301" } ], "buyer": { "first_name": "Example resource", "last_name": "Example resource", "email": "andrea@example.com", "phone_number": "+51987654321" }, "context": { "currency": "PEN", "address_country": "example", "address_region": "example", "postal_code": "example_code", "intent": "example", "language": "es", "eligibility": [ "example" ] } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpValidationProblemDetails" }, { "$ref": "#/components/schemas/ProblemDetails" } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/UcpErrorResponseDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UcpErrorResponseDto" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] }, { "ucpApiKey": [] } ], "x-ecomiq-anonymous": false, "x-ecomiq-context": "Agent Commerce", "x-ecomiq-resource": "Checkout Sessions", "summary": "UCP update checkout", "description": "UCP update checkout. A successful request returns HTTP 200 with the documented response body.", "x-ecomiq-generated-description": true, "x-ecomiq-surface": "ucp", "x-ecomiq-audience": "public", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/ucp/checkout-sessions/{id}/cancel": { "post": { "tags": [ "Agent Commerce" ], "operationId": "UcpCancelCheckout", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string", "example": "Bearer " }, "example": "Bearer ", "description": "OAuth 2.0 bearer token.", "x-ecomiq-sample-only": true }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "7204558912004325301" }, "description": "Unique identifier of the resource.", "example": "7204558912004325301" }, { "name": "x-Store-Domain", "in": "header", "description": "Store slug or configured domain that selects the UCP store context.", "required": true, "schema": { "maxLength": 253, "minLength": 1, "type": "string", "example": "my-store" }, "example": "my-store" }, { "name": "UCP-Agent", "in": "header", "description": "Agent profile binding in the form profile=\"https://agent.example/.well-known/ucp\".", "required": true, "schema": { "minLength": 1, "type": "string", "example": "profile=\"https://agent.example/.well-known/ucp\"" }, "example": "profile=\"https://agent.example/.well-known/ucp\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional idempotency key for retry-safe UCP requests.", "schema": { "maxLength": 300, "minLength": 1, "type": "string", "example": "checkout-2026-0001" }, "example": "checkout-2026-0001" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UcpCheckoutDto" }, "example": { "ucp": { "version": "example", "status": "example", "capabilities": { "key": [ { "version": "example" } ] }, "payment_handlers": { "key": [ { "id": "7204558912004325301", "version": "example", "spec": "example", "schema": "example", "available_instruments": [ { "type": "example", "constraints": {} } ], "config": {} } ] } }, "id": "7204558912004325301", "status": "example", "currency": "PEN", "cart_id": "7204558912004325301", "line_items": [ { "item": { "id": "7204558912004325301", "title": "Example title", "price": 1, "quantity_unit": { "unit": "example", "display_text": "example", "scale": 1, "increment": 1 }, "unit_price": { "amount": 1, "currency": "PEN", "measure": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 }, "reference": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 } }, "image_url": "https://example.com/resource" }, "quantity": 1, "id": "7204558912004325301", "totals": [ { "type": "example", "amount": 1, "display_text": "example", "lines": [ { "display_text": "example", "amount": 1 } ] } ], "parent_id": "7204558912004325301" } ], "buyer": { "first_name": "Example resource", "last_name": "Example resource", "email": "andrea@example.com", "phone_number": "+51987654321" }, "context": { "currency": "PEN", "address_country": "example", "address_region": "example", "postal_code": "example_code", "intent": "example", "language": "es", "eligibility": [ "example" ] } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpValidationProblemDetails" }, { "$ref": "#/components/schemas/ProblemDetails" } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/UcpErrorResponseDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UcpErrorResponseDto" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] }, { "ucpApiKey": [] } ], "x-ecomiq-anonymous": false, "x-ecomiq-context": "Agent Commerce", "x-ecomiq-resource": "Checkout Sessions", "summary": "UCP cancel checkout", "description": "UCP cancel checkout. A successful request returns HTTP 200 with the documented response body.", "x-ecomiq-generated-description": true, "x-ecomiq-surface": "ucp", "x-ecomiq-audience": "public", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/ucp/checkout-sessions/{id}/complete": { "post": { "tags": [ "Agent Commerce" ], "operationId": "UcpCompleteCheckout", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string", "example": "Bearer " }, "example": "Bearer ", "description": "OAuth 2.0 bearer token.", "x-ecomiq-sample-only": true }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "7204558912004325301" }, "description": "Unique identifier of the resource.", "example": "7204558912004325301" }, { "name": "x-Store-Domain", "in": "header", "description": "Store slug or configured domain that selects the UCP store context.", "required": true, "schema": { "maxLength": 253, "minLength": 1, "type": "string", "example": "my-store" }, "example": "my-store" }, { "name": "UCP-Agent", "in": "header", "description": "Agent profile binding in the form profile=\"https://agent.example/.well-known/ucp\".", "required": true, "schema": { "minLength": 1, "type": "string", "example": "profile=\"https://agent.example/.well-known/ucp\"" }, "example": "profile=\"https://agent.example/.well-known/ucp\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional idempotency key for retry-safe UCP requests.", "schema": { "maxLength": 300, "minLength": 1, "type": "string", "example": "checkout-2026-0001" }, "example": "checkout-2026-0001" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UcpCompleteCheckoutRequest" }, "example": { "payment": { "instruments": [ { "id": "7204558912004325301", "handler_id": "7204558912004325301", "type": "example", "selected": false, "billing_address": {}, "credential": {}, "display": {} } ] }, "signals": { "dev.ucp.buyer_ip": "example", "dev.ucp.user_agent": "example" }, "attribution": {} } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UcpCheckoutDto" }, "example": { "ucp": { "version": "example", "status": "example", "capabilities": { "key": [ { "version": "example" } ] }, "payment_handlers": { "key": [ { "id": "7204558912004325301", "version": "example", "spec": "example", "schema": "example", "available_instruments": [ { "type": "example", "constraints": {} } ], "config": {} } ] } }, "id": "7204558912004325301", "status": "example", "currency": "PEN", "cart_id": "7204558912004325301", "line_items": [ { "item": { "id": "7204558912004325301", "title": "Example title", "price": 1, "quantity_unit": { "unit": "example", "display_text": "example", "scale": 1, "increment": 1 }, "unit_price": { "amount": 1, "currency": "PEN", "measure": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 }, "reference": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 } }, "image_url": "https://example.com/resource" }, "quantity": 1, "id": "7204558912004325301", "totals": [ { "type": "example", "amount": 1, "display_text": "example", "lines": [ { "display_text": "example", "amount": 1 } ] } ], "parent_id": "7204558912004325301" } ], "buyer": { "first_name": "Example resource", "last_name": "Example resource", "email": "andrea@example.com", "phone_number": "+51987654321" }, "context": { "currency": "PEN", "address_country": "example", "address_region": "example", "postal_code": "example_code", "intent": "example", "language": "es", "eligibility": [ "example" ] } } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpValidationProblemDetails" }, { "$ref": "#/components/schemas/ProblemDetails" } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/UcpErrorResponseDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UcpErrorResponseDto" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] }, { "ucpApiKey": [] } ], "x-ecomiq-anonymous": false, "x-ecomiq-context": "Agent Commerce", "x-ecomiq-resource": "Checkout Sessions", "summary": "UCP complete checkout", "description": "UCP complete checkout. A successful request returns HTTP 200 with the documented response body.", "x-ecomiq-generated-description": true, "x-ecomiq-surface": "ucp", "x-ecomiq-audience": "public", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } }, "/ucp/orders/{id}": { "get": { "tags": [ "Agent Commerce" ], "operationId": "UcpGetOrder", "parameters": [ { "name": "Authorization", "in": "header", "required": true, "schema": { "type": "string", "example": "Bearer " }, "example": "Bearer ", "description": "OAuth 2.0 bearer token.", "x-ecomiq-sample-only": true }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "example": "7204558912004325301" }, "description": "Unique identifier of the resource.", "example": "7204558912004325301" }, { "name": "x-Store-Domain", "in": "header", "description": "Store slug or configured domain that selects the UCP store context.", "required": true, "schema": { "maxLength": 253, "minLength": 1, "type": "string", "example": "my-store" }, "example": "my-store" }, { "name": "UCP-Agent", "in": "header", "description": "Agent profile binding in the form profile=\"https://agent.example/.well-known/ucp\".", "required": true, "schema": { "minLength": 1, "type": "string", "example": "profile=\"https://agent.example/.well-known/ucp\"" }, "example": "profile=\"https://agent.example/.well-known/ucp\"" }, { "name": "Idempotency-Key", "in": "header", "description": "Optional idempotency key for retry-safe UCP requests.", "schema": { "maxLength": 300, "minLength": 1, "type": "string", "example": "checkout-2026-0001" }, "example": "checkout-2026-0001" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UcpOrderDto" }, "example": { "ucp": { "version": "example", "status": "example", "capabilities": { "key": [ { "version": "example" } ] }, "payment_handlers": { "key": [ { "id": "7204558912004325301", "version": "example", "spec": "example", "schema": "example", "available_instruments": [ { "type": "example", "constraints": {} } ], "config": {} } ] } }, "id": "7204558912004325301", "checkout_id": "7204558912004325301", "permalink_url": "https://example.com/resource", "fulfillment": { "expectations": [ { "id": "7204558912004325301", "method_type": "example", "destination": { "extended_address": "example", "street_address": "example", "address_locality": "example", "address_region": "example", "address_country": "example", "postal_code": "example_code", "first_name": "Example resource", "last_name": "Example resource" }, "line_items": [ { "id": "7204558912004325301", "quantity": 1 } ], "description": "Example description.", "fulfillable_on": "example" } ], "events": [ { "id": "7204558912004325301", "occurred_at": "2026-08-01T15:30:00Z", "type": "example", "line_items": [ { "id": "7204558912004325301", "quantity": 1 } ], "tracking_number": "example", "tracking_url": "https://example.com/resource", "carrier": "example", "description": "Example description." } ] }, "currency": "PEN", "label": "example", "line_items": [ { "id": "7204558912004325301", "item": { "id": "7204558912004325301", "title": "Example title", "price": 1, "quantity_unit": { "unit": "example", "display_text": "example", "scale": 1, "increment": 1 }, "unit_price": { "amount": 1, "currency": "PEN", "measure": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 }, "reference": { "value": 1, "unit": "example", "display_text": "example", "scale": 1 } }, "image_url": "https://example.com/resource" }, "quantity": { "total": 1, "fulfilled": 1, "original": 1 }, "status": "example", "totals": [ { "type": "example", "amount": 1, "display_text": "example", "lines": [ { "display_text": "example", "amount": 1 } ] } ], "parent_id": "7204558912004325301" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/HttpValidationProblemDetails" }, { "$ref": "#/components/schemas/ProblemDetails" } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/UcpErrorResponseDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UcpErrorResponseDto" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UcpErrorResponseDto" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } }, "security": [ { "bearerAuth": [] }, { "ucpApiKey": [] } ], "x-ecomiq-anonymous": false, "x-ecomiq-context": "Agent Commerce", "x-ecomiq-resource": "Orders", "summary": "UCP get order", "description": "UCP get order. A successful request returns HTTP 200 with the documented response body.", "x-ecomiq-generated-description": true, "x-ecomiq-surface": "ucp", "x-ecomiq-audience": "public", "x-ecomiq-visibility": "public", "x-ecomiq-lifecycle": "stable" } } }, "components": { "schemas": { "HttpValidationProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "code": { "type": "string", "description": "Stable error code, e.g. \"Common.BadRequest\"." } } }, "JsonElement": {}, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true }, "code": { "type": "string", "description": "Stable error code, e.g. \"Common.BadRequest\"." } } }, "UcpAdjustmentDto": { "required": [ "id", "type", "occurred_at", "status" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "type": { "type": "string" }, "occurred_at": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "line_items": { "type": "array", "items": { "$ref": "#/components/schemas/UcpFulfillmentLineItemDto" } }, "totals": { "type": "array", "items": { "$ref": "#/components/schemas/UcpTotalDto" } }, "description": { "type": "string", "nullable": true } } }, "UcpAttributionDto": { "type": "object" }, "UcpAvailabilityDto": { "required": [ "available" ], "type": "object", "properties": { "available": { "type": "boolean" }, "status": { "type": "string", "nullable": true } } }, "UcpAvailablePaymentInstrumentDto": { "required": [ "type" ], "type": "object", "properties": { "type": { "type": "string" }, "constraints": {} } }, "UcpBuyerDto": { "type": "object", "properties": { "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone_number": { "type": "string", "nullable": true } } }, "UcpCapabilityDto": { "required": [ "version", "spec", "schema" ], "type": "object", "properties": { "version": { "type": "string" }, "spec": { "type": "string" }, "schema": { "type": "string" }, "config": {}, "extends": {} } }, "UcpCapabilityRefDto": { "required": [ "version" ], "type": "object", "properties": { "version": { "type": "string" } } }, "UcpCartDto": { "required": [ "ucp", "id", "currency" ], "type": "object", "properties": { "ucp": { "$ref": "#/components/schemas/UcpMetadataDto" }, "id": { "type": "string", "description": "Unique identifier of the resource." }, "line_items": { "type": "array", "items": { "$ref": "#/components/schemas/UcpLineItemDto" } }, "context": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpCatalogContextDto" } ] }, "buyer": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpBuyerDto" } ] }, "currency": { "type": "string" }, "totals": { "type": "array", "items": { "$ref": "#/components/schemas/UcpTotalDto" } }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/UcpMessageDto" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/UcpLinkDto" } }, "continue_url": { "type": "string", "nullable": true }, "expires_at": { "type": "string", "nullable": true } } }, "UcpCartRequest": { "required": [ "line_items" ], "type": "object", "properties": { "line_items": { "type": "array", "items": { "$ref": "#/components/schemas/UcpLineItemDto" } }, "context": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpCatalogContextDto" } ] }, "signals": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpSignalsDto" } ] }, "attribution": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpAttributionDto" } ] }, "buyer": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpBuyerDto" } ] } } }, "UcpCatalogContextDto": { "type": "object", "properties": { "currency": { "type": "string", "nullable": true }, "address_country": { "type": "string", "nullable": true }, "address_region": { "type": "string", "nullable": true }, "postal_code": { "type": "string", "nullable": true }, "intent": { "type": "string", "nullable": true }, "language": { "type": "string", "nullable": true }, "eligibility": { "type": "array", "items": { "type": "string" }, "nullable": true } } }, "UcpCatalogLookupRequest": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "filters": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpCatalogSearchFiltersDto" } ] }, "context": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpCatalogContextDto" } ] }, "signals": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpSignalsDto" } ] }, "attribution": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpAttributionDto" } ] } } }, "UcpCatalogLookupResponse": { "required": [ "ucp" ], "type": "object", "properties": { "ucp": { "$ref": "#/components/schemas/UcpMetadataDto" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/UcpProductDto" } }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/UcpMessageDto" } } } }, "UcpCatalogProductRequest": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "selected": { "type": "array", "items": { "$ref": "#/components/schemas/UcpSelectedOptionDto" } }, "preferences": { "type": "array", "items": { "type": "string" } }, "filters": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpCatalogSearchFiltersDto" } ] }, "context": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpCatalogContextDto" } ] }, "signals": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpSignalsDto" } ] }, "attribution": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpAttributionDto" } ] } } }, "UcpCatalogProductResponse": { "required": [ "ucp", "product" ], "type": "object", "properties": { "ucp": { "$ref": "#/components/schemas/UcpMetadataDto" }, "product": { "$ref": "#/components/schemas/UcpProductDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/UcpMessageDto" } } } }, "UcpCatalogSearchFiltersDto": { "type": "object", "properties": { "categories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "price": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpPriceFilterDto" } ] } } }, "UcpCatalogSearchRequest": { "type": "object", "properties": { "query": { "type": "string", "nullable": true }, "context": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpCatalogContextDto" } ] }, "filters": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpCatalogSearchFiltersDto" } ] }, "pagination": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpPaginationRequestDto" } ] }, "signals": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpSignalsDto" } ] }, "attribution": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpAttributionDto" } ] } } }, "UcpCatalogSearchResponse": { "required": [ "ucp" ], "type": "object", "properties": { "ucp": { "$ref": "#/components/schemas/UcpMetadataDto" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/UcpProductDto" } }, "pagination": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpPaginationResponseDto" } ] }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/UcpMessageDto" } } } }, "UcpCategoryDto": { "required": [ "value" ], "type": "object", "properties": { "value": { "type": "string" }, "taxonomy": { "type": "string", "nullable": true } } }, "UcpCheckoutDto": { "required": [ "ucp", "id", "status", "currency" ], "type": "object", "properties": { "ucp": { "$ref": "#/components/schemas/UcpMetadataDto" }, "id": { "type": "string", "description": "Unique identifier of the resource." }, "cart_id": { "type": "string", "nullable": true }, "line_items": { "type": "array", "items": { "$ref": "#/components/schemas/UcpLineItemDto" } }, "buyer": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpBuyerDto" } ] }, "context": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpCatalogContextDto" } ] }, "status": { "type": "string" }, "currency": { "type": "string" }, "totals": { "type": "array", "items": { "$ref": "#/components/schemas/UcpTotalDto" } }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/UcpMessageDto" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/UcpLinkDto" } }, "expires_at": { "type": "string", "nullable": true }, "continue_url": { "type": "string", "nullable": true }, "payment": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpPaymentDto" } ] }, "fulfillment": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpCheckoutFulfillmentDto" } ] }, "order": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpOrderConfirmationDto" } ] } } }, "UcpCheckoutFulfillmentAvailableMethodDto": { "required": [ "type" ], "type": "object", "properties": { "type": { "type": "string" }, "line_item_ids": { "type": "array", "items": { "type": "string" } }, "fulfillable_on": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } } }, "UcpCheckoutFulfillmentDestinationDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "description": "Unique identifier of the resource." }, "type": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "address": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpPostalAddressDto" } ] }, "extended_address": { "type": "string", "nullable": true }, "street_address": { "type": "string", "nullable": true }, "address_locality": { "type": "string", "nullable": true }, "address_region": { "type": "string", "nullable": true }, "address_country": { "type": "string", "nullable": true }, "postal_code": { "type": "string", "nullable": true }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "phone_number": { "type": "string", "nullable": true } } }, "UcpCheckoutFulfillmentDto": { "type": "object", "properties": { "methods": { "type": "array", "items": { "$ref": "#/components/schemas/UcpCheckoutFulfillmentMethodDto" } }, "available_methods": { "type": "array", "items": { "$ref": "#/components/schemas/UcpCheckoutFulfillmentAvailableMethodDto" } } } }, "UcpCheckoutFulfillmentGroupDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "description": "Unique identifier of the resource." }, "line_item_ids": { "type": "array", "items": { "type": "string" } }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/UcpCheckoutFulfillmentOptionDto" } }, "selected_option_id": { "type": "string", "nullable": true } } }, "UcpCheckoutFulfillmentMethodDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true, "description": "Unique identifier of the resource." }, "type": { "type": "string", "nullable": true }, "line_item_ids": { "type": "array", "items": { "type": "string" } }, "destinations": { "type": "array", "items": { "$ref": "#/components/schemas/UcpCheckoutFulfillmentDestinationDto" } }, "selected_destination_id": { "type": "string", "nullable": true }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/UcpCheckoutFulfillmentGroupDto" } } } }, "UcpCheckoutFulfillmentOptionDto": { "required": [ "id", "title" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "title": { "type": "string" }, "description": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpDescriptionDto" } ] }, "carrier": { "type": "string", "nullable": true }, "earliest_fulfillment_time": { "type": "string", "nullable": true }, "latest_fulfillment_time": { "type": "string", "nullable": true }, "totals": { "type": "array", "items": { "$ref": "#/components/schemas/UcpTotalDto" } } } }, "UcpCompleteCheckoutRequest": { "required": [ "payment" ], "type": "object", "properties": { "payment": { "$ref": "#/components/schemas/UcpPaymentDto" }, "signals": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpSignalsDto" } ] }, "attribution": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpAttributionDto" } ] } } }, "UcpCreateCheckoutRequest": { "required": [ "line_items" ], "type": "object", "properties": { "cart_id": { "type": "string", "nullable": true }, "line_items": { "type": "array", "items": { "$ref": "#/components/schemas/UcpLineItemDto" } }, "buyer": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpBuyerDto" } ] }, "context": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpCatalogContextDto" } ] }, "signals": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpSignalsDto" } ] }, "attribution": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpAttributionDto" } ] }, "payment": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpPaymentDto" } ] }, "fulfillment": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpCheckoutFulfillmentDto" } ] } } }, "UcpDescriptionDto": { "type": "object", "properties": { "plain": { "type": "string", "nullable": true }, "html": { "type": "string", "nullable": true }, "markdown": { "type": "string", "nullable": true } } }, "UcpErrorResponseDto": { "required": [ "ucp" ], "type": "object", "properties": { "ucp": { "$ref": "#/components/schemas/UcpMetadataDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/UcpMessageDto" } } } }, "UcpFulfillmentDto": { "type": "object", "properties": { "expectations": { "type": "array", "items": { "$ref": "#/components/schemas/UcpFulfillmentExpectationDto" } }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/UcpFulfillmentEventDto" } } } }, "UcpFulfillmentEventDto": { "required": [ "id", "occurred_at", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "occurred_at": { "type": "string", "format": "date-time" }, "type": { "type": "string" }, "line_items": { "type": "array", "items": { "$ref": "#/components/schemas/UcpFulfillmentLineItemDto" } }, "tracking_number": { "type": "string", "nullable": true }, "tracking_url": { "type": "string", "nullable": true }, "carrier": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } } }, "UcpFulfillmentExpectationDto": { "required": [ "id", "method_type", "destination" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "line_items": { "type": "array", "items": { "$ref": "#/components/schemas/UcpFulfillmentLineItemDto" } }, "method_type": { "type": "string" }, "destination": { "$ref": "#/components/schemas/UcpPostalAddressDto" }, "description": { "type": "string", "nullable": true }, "fulfillable_on": { "type": "string", "nullable": true } } }, "UcpFulfillmentLineItemDto": { "required": [ "id", "quantity" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "quantity": { "type": "integer", "format": "int64" } } }, "UcpInputCorrelationDto": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "match": { "type": "string", "nullable": true } } }, "UcpItemDto": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "title": { "type": "string", "nullable": true }, "price": { "type": "integer", "format": "int64", "nullable": true }, "quantity_unit": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpQuantityUnitDto" } ] }, "unit_price": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpUnitPriceDto" } ] }, "image_url": { "type": "string", "nullable": true } } }, "UcpJwkPublicKeyDto": { "required": [ "kid", "kty" ], "type": "object", "properties": { "kid": { "type": "string" }, "kty": { "type": "string" }, "crv": { "type": "string", "nullable": true }, "x": { "type": "string", "nullable": true }, "y": { "type": "string", "nullable": true }, "use": { "type": "string", "nullable": true }, "alg": { "type": "string", "nullable": true } } }, "UcpLineItemDto": { "required": [ "item", "quantity" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true, "description": "Unique identifier of the resource." }, "item": { "$ref": "#/components/schemas/UcpItemDto" }, "quantity": { "type": "integer", "format": "int64" }, "totals": { "type": "array", "items": { "$ref": "#/components/schemas/UcpTotalDto" } }, "parent_id": { "type": "string", "nullable": true } } }, "UcpLinkDto": { "required": [ "type", "url" ], "type": "object", "properties": { "type": { "type": "string" }, "url": { "type": "string" }, "title": { "type": "string", "nullable": true } } }, "UcpMeasureDto": { "required": [ "value", "unit", "display_text" ], "type": "object", "properties": { "value": { "type": "integer", "format": "int64" }, "unit": { "type": "string" }, "display_text": { "type": "string" }, "scale": { "type": "integer", "format": "int32", "nullable": true } } }, "UcpMediaDto": { "required": [ "type", "url" ], "type": "object", "properties": { "type": { "type": "string" }, "url": { "type": "string" }, "alt_text": { "type": "string", "nullable": true } } }, "UcpMessageDto": { "required": [ "type", "content" ], "type": "object", "properties": { "type": { "type": "string" }, "code": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true }, "content_type": { "type": "string" }, "content": { "type": "string" }, "severity": { "type": "string", "nullable": true } } }, "UcpMetadataDto": { "required": [ "version", "status" ], "type": "object", "properties": { "version": { "type": "string" }, "status": { "type": "string" }, "capabilities": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/UcpCapabilityRefDto" } } }, "payment_handlers": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/UcpPaymentHandlerDto" } } } } }, "UcpOptionValueDto": { "required": [ "label" ], "type": "object", "properties": { "id": { "type": "string", "nullable": true, "description": "Unique identifier of the resource." }, "label": { "type": "string" }, "available": { "type": "boolean", "nullable": true }, "exists": { "type": "boolean", "nullable": true } } }, "UcpOrderConfirmationDto": { "required": [ "id", "permalink_url" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "label": { "type": "string", "nullable": true }, "permalink_url": { "type": "string" } } }, "UcpOrderDto": { "required": [ "ucp", "id", "checkout_id", "permalink_url", "fulfillment", "currency" ], "type": "object", "properties": { "ucp": { "$ref": "#/components/schemas/UcpMetadataDto" }, "id": { "type": "string", "description": "Unique identifier of the resource." }, "label": { "type": "string", "nullable": true }, "checkout_id": { "type": "string" }, "permalink_url": { "type": "string" }, "line_items": { "type": "array", "items": { "$ref": "#/components/schemas/UcpOrderLineItemDto" } }, "fulfillment": { "$ref": "#/components/schemas/UcpFulfillmentDto" }, "adjustments": { "type": "array", "items": { "$ref": "#/components/schemas/UcpAdjustmentDto" } }, "currency": { "type": "string" }, "totals": { "type": "array", "items": { "$ref": "#/components/schemas/UcpTotalDto" } }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/UcpMessageDto" } }, "attribution": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpAttributionDto" } ] } } }, "UcpOrderLineItemDto": { "required": [ "id", "item", "quantity", "status" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "item": { "$ref": "#/components/schemas/UcpItemDto" }, "quantity": { "$ref": "#/components/schemas/UcpOrderQuantityDto" }, "totals": { "type": "array", "items": { "$ref": "#/components/schemas/UcpTotalDto" } }, "status": { "type": "string" }, "parent_id": { "type": "string", "nullable": true } } }, "UcpOrderQuantityDto": { "required": [ "total", "fulfilled" ], "type": "object", "properties": { "original": { "type": "integer", "format": "int64", "nullable": true }, "total": { "type": "integer", "format": "int64" }, "fulfilled": { "type": "integer", "format": "int64" } } }, "UcpPaginationRequestDto": { "type": "object", "properties": { "cursor": { "type": "string", "nullable": true, "description": "Opaque cursor from the previous response. Omit it on the first page." }, "limit": { "type": "integer", "format": "int32", "nullable": true, "description": "Maximum number of results to return." } } }, "UcpPaginationResponseDto": { "required": [ "has_next_page" ], "type": "object", "properties": { "cursor": { "type": "string", "nullable": true, "description": "Opaque cursor from the previous response. Omit it on the first page." }, "has_next_page": { "type": "boolean" }, "total_count": { "type": "integer", "format": "int64", "nullable": true } } }, "UcpPaymentDto": { "type": "object", "properties": { "instruments": { "type": "array", "items": { "$ref": "#/components/schemas/UcpPaymentInstrumentDto" } } } }, "UcpPaymentHandlerDto": { "required": [ "id", "version", "spec", "schema" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "version": { "type": "string" }, "spec": { "type": "string" }, "schema": { "type": "string" }, "available_instruments": { "type": "array", "items": { "$ref": "#/components/schemas/UcpAvailablePaymentInstrumentDto" } }, "config": {} } }, "UcpPaymentInstrumentDto": { "required": [ "id", "handler_id", "type" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "handler_id": { "type": "string" }, "type": { "type": "string" }, "selected": { "type": "boolean", "nullable": true }, "billing_address": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "credential": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "display": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] } } }, "UcpPostalAddressDto": { "type": "object", "properties": { "extended_address": { "type": "string", "nullable": true }, "street_address": { "type": "string", "nullable": true }, "address_locality": { "type": "string", "nullable": true }, "address_region": { "type": "string", "nullable": true }, "address_country": { "type": "string", "nullable": true }, "postal_code": { "type": "string", "nullable": true }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "phone_number": { "type": "string", "nullable": true } } }, "UcpPriceDto": { "required": [ "amount", "currency" ], "type": "object", "properties": { "amount": { "type": "integer", "format": "int64" }, "currency": { "type": "string" } } }, "UcpPriceFilterDto": { "type": "object", "properties": { "min": { "type": "integer", "format": "int64", "nullable": true }, "max": { "type": "integer", "format": "int64", "nullable": true } } }, "UcpPriceRangeDto": { "required": [ "min", "max" ], "type": "object", "properties": { "min": { "$ref": "#/components/schemas/UcpPriceDto" }, "max": { "$ref": "#/components/schemas/UcpPriceDto" } } }, "UcpProductDto": { "required": [ "id", "title", "description", "price_range" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "handle": { "type": "string", "nullable": true }, "title": { "type": "string" }, "description": { "$ref": "#/components/schemas/UcpDescriptionDto" }, "url": { "type": "string", "nullable": true }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/UcpCategoryDto" } }, "price_range": { "$ref": "#/components/schemas/UcpPriceRangeDto" }, "list_price_range": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpPriceRangeDto" } ] }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/UcpMediaDto" } }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/UcpProductOptionDto" } }, "variants": { "type": "array", "items": { "$ref": "#/components/schemas/UcpVariantDto" } }, "selected": { "type": "array", "items": { "$ref": "#/components/schemas/UcpSelectedOptionDto" }, "nullable": true }, "tags": { "type": "array", "items": { "type": "string" } }, "metadata": {} } }, "UcpProductOptionDto": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/UcpOptionValueDto" } } } }, "UcpProfileDto": { "required": [ "ucp" ], "type": "object", "properties": { "ucp": { "$ref": "#/components/schemas/UcpProfileMetadataDto" }, "keys": { "type": "array", "items": { "$ref": "#/components/schemas/UcpJwkPublicKeyDto" } } } }, "UcpProfileMetadataDto": { "required": [ "version", "services", "payment_handlers" ], "type": "object", "properties": { "version": { "type": "string" }, "services": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/UcpServiceBindingDto" } } }, "capabilities": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/UcpCapabilityDto" } } }, "payment_handlers": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/UcpPaymentHandlerDto" } } } } }, "UcpQuantityUnitDto": { "required": [ "unit", "display_text" ], "type": "object", "properties": { "unit": { "type": "string" }, "display_text": { "type": "string" }, "scale": { "type": "integer", "format": "int32", "nullable": true }, "increment": { "type": "integer", "format": "int64", "nullable": true } } }, "UcpSelectedOptionDto": { "required": [ "name", "label" ], "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string", "nullable": true, "description": "Unique identifier of the resource." }, "label": { "type": "string" } } }, "UcpServiceBindingDto": { "required": [ "version", "spec", "transport" ], "type": "object", "properties": { "version": { "type": "string" }, "spec": { "type": "string" }, "transport": { "type": "string" }, "endpoint": { "type": "string", "nullable": true }, "schema": { "type": "string", "nullable": true } } }, "UcpSignalsDto": { "type": "object", "properties": { "dev.ucp.buyer_ip": { "type": "string", "nullable": true }, "dev.ucp.user_agent": { "type": "string", "nullable": true } } }, "UcpTotalDto": { "required": [ "type", "amount" ], "type": "object", "properties": { "type": { "type": "string" }, "display_text": { "type": "string", "nullable": true }, "amount": { "type": "integer", "format": "int64" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/UcpTotalLineDto" } } } }, "UcpTotalLineDto": { "required": [ "display_text", "amount" ], "type": "object", "properties": { "display_text": { "type": "string" }, "amount": { "type": "integer", "format": "int64" } } }, "UcpUnitPriceDto": { "required": [ "amount", "currency", "measure", "reference" ], "type": "object", "properties": { "amount": { "type": "integer", "format": "int64" }, "currency": { "type": "string" }, "measure": { "$ref": "#/components/schemas/UcpMeasureDto" }, "reference": { "$ref": "#/components/schemas/UcpMeasureDto" } } }, "UcpUpdateCheckoutRequest": { "required": [ "line_items" ], "type": "object", "properties": { "line_items": { "type": "array", "items": { "$ref": "#/components/schemas/UcpLineItemDto" } }, "buyer": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpBuyerDto" } ] }, "context": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpCatalogContextDto" } ] }, "signals": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpSignalsDto" } ] }, "attribution": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpAttributionDto" } ] }, "payment": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpPaymentDto" } ] }, "fulfillment": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpCheckoutFulfillmentDto" } ] } } }, "UcpVariantDto": { "required": [ "id", "title", "description", "price" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier of the resource." }, "sku": { "type": "string", "nullable": true, "description": "Stock keeping unit (SKU)." }, "handle": { "type": "string", "nullable": true }, "title": { "type": "string" }, "description": { "$ref": "#/components/schemas/UcpDescriptionDto" }, "url": { "type": "string", "nullable": true }, "price": { "$ref": "#/components/schemas/UcpPriceDto" }, "list_price": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpPriceDto" } ] }, "availability": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UcpAvailabilityDto" } ] }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/UcpSelectedOptionDto" } }, "media": { "type": "array", "items": { "$ref": "#/components/schemas/UcpMediaDto" } }, "inputs": { "type": "array", "items": { "$ref": "#/components/schemas/UcpInputCorrelationDto" }, "nullable": true }, "metadata": {} } } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "OAuth2 access token issued by Ecomiq Auth." }, "ucpApiKey": { "type": "apiKey", "description": "Ecomiq API key authorized for the requested UCP capability.", "name": "X-API-Key", "in": "header" } } }, "tags": [ { "name": "Agent Commerce", "description": "Universal Commerce Protocol endpoints for agent-driven shopping and checkout.", "x-displayName": "Agent Commerce" } ], "servers": [ { "url": "https://ucp.ecomiq.pe", "description": "Production UCP service" } ] }