{ "openapi": "3.0.0", "components": { "examples": {}, "headers": {}, "parameters": {}, "requestBodies": {}, "responses": {}, "schemas": { "Marketplace": { "enum": [ "AMAZON", "SHOPIFY", "UNKNOWN" ], "type": "string" }, "Brand": { "properties": { "supported": { "type": "boolean", "description": "If `false`, then products from this brand cannot be purchased through the\nSell Anything API." }, "marketplace": { "$ref": "#/components/schemas/Marketplace", "description": "Indicates what ecommerce platform the brand uses." }, "id": { "type": "string", "description": "A unique identifier for the brand." } }, "required": [ "supported", "marketplace", "id" ], "type": "object" }, "AuthenticationError": { "properties": { "name": { "type": "string" }, "message": { "type": "string" }, "stack": { "type": "string" } }, "required": [ "name", "message" ], "type": "object", "additionalProperties": false }, "NotFoundError": { "properties": { "name": { "type": "string" }, "message": { "type": "string" }, "stack": { "type": "string" } }, "required": [ "name", "message" ], "type": "object", "additionalProperties": false }, "FieldErrors": { "properties": {}, "type": "object", "additionalProperties": { "properties": { "value": {}, "message": { "type": "string" } }, "required": [ "message" ], "type": "object" } }, "ValidateError": { "properties": { "name": { "type": "string" }, "message": { "type": "string" }, "stack": { "type": "string" }, "status": { "type": "number", "format": "double" }, "fields": { "$ref": "#/components/schemas/FieldErrors" } }, "required": [ "name", "message", "status", "fields" ], "type": "object", "additionalProperties": false }, "RuntimeError": { "properties": { "name": { "type": "string" }, "message": { "type": "string" }, "stack": { "type": "string" } }, "required": [ "name", "message" ], "type": "object", "additionalProperties": false }, "Domain": { "type": "string", "example": "shop.aloyoga.com", "format": "hostname", "description": "Represents a valid domain name string.", "pattern": "^(?=.{1,253}$)(?!\\-)([a-zA-Z0-9\\-]{1,63}(?`" } } }, "info": { "title": "checkout-intent-api", "version": "1.0.5", "license": { "name": "ISC" }, "contact": { "name": "Rye Dev Team ", "email": "dev@rye.com" } }, "paths": { "/health": { "get": { "operationId": "GetHealth", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "status": { "type": "string" } }, "required": [ "message", "status" ], "type": "object" } } } } }, "description": "Simple check to confirm the API is running and accessible.", "summary": "Health", "security": [], "parameters": [] } }, "/api/v1/brands/domain/{domain}": { "get": { "operationId": "GetBrandByDomain", "responses": { "200": { "description": "Brand information including marketplace classification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Brand" } } } }, "401": { "description": "Authentication Failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationError" }, "examples": { "Example 1": {} } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" }, "examples": { "Example 1": {} } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateError" }, "examples": { "Example 1": {} } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeError" }, "examples": { "Example 1": {} } } } } }, "description": "Retrieve brand information by domain name\n\nLook up a brand by its domain name (e.g. \"aloyoga.com\").\nReturns brand information including the marketplace type if the lookup succeeds.", "summary": "Brand by Domain", "security": [ { "basicAuth": [] } ], "parameters": [ { "description": "The domain name to look up (e.g. \"aloyoga.com\")", "in": "path", "name": "domain", "required": true, "schema": { "$ref": "#/components/schemas/Domain" } } ] } }, "/api/v1/checkout-intents/{id}": { "get": { "operationId": "GetCheckoutIntent", "responses": { "200": { "description": "Checkout intent information", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutIntent" } } } }, "401": { "description": "Authentication Failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationError" }, "examples": { "Example 1": {} } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" }, "examples": { "Example 1": {} } } } } }, "description": "Retrieve a checkout intent by id\n\nReturns checkout intent information if the lookup succeeds.", "summary": "Checkout Intent by ID", "security": [ { "basicAuth": [] } ], "parameters": [ { "description": "The id of the checkout intent to look up", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ] } }, "/api/v1/checkout-intents": { "post": { "operationId": "CreateCheckoutIntent", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutIntent" } } } }, "401": { "description": "Authentication Failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationError" }, "examples": { "Example 1": {} } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidateError" }, "examples": { "Example 1": {} } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeError" }, "examples": { "Example 1": {} } } } } }, "description": "Create a checkout intent with the given request body.", "summary": "Checkout Intent", "security": [ { "basicAuth": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutIntentPostParams" } } } } } }, "/api/v1/checkout-intents/{id}/confirm": { "post": { "operationId": "ConfirmCheckoutIntent", "responses": { "200": { "description": "The confirmed checkout intent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutIntent" } } } }, "401": { "description": "Authentication Failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationError" }, "examples": { "Example 1": {} } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" }, "examples": { "Example 1": {} } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeError" }, "examples": { "Example 1": {} } } } } }, "description": "Confirm a checkout intent with provided payment information\n\nConfirm means we have buyer's name, address and payment info, so we can\nmove forward to place the order.", "summary": "Confirm Checkout Intent", "security": [ { "basicAuth": [] } ], "parameters": [ { "description": "The id of the checkout intent to confirm", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The request body containing the payment information", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutIntentConfirmParams", "description": "The request body containing the payment information" } } } } } }, "/api/v1/checkout-intents/{id}/payment": { "post": { "operationId": "AddPaymentDetailsToCheckoutIntent", "responses": { "200": { "description": "Payment response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutIntent" } } } }, "401": { "description": "Authentication Failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthenticationError" }, "examples": { "Example 1": {} } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" }, "examples": { "Example 1": {} } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RuntimeError" }, "examples": { "Example 1": {} } } } } }, "description": "Add payment details to a checkout intent", "summary": "POST add payment method to checkout intent", "security": [ { "basicAuth": [] } ], "parameters": [ { "description": "The id of the checkout intent to add payment details to", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The request body containing the payment details", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckoutIntentPaymentParams", "description": "The request body containing the payment details" } } } } } } }, "servers": [ { "url": "https://staging.api.rye.com/" } ] }