{ "openapi" : "3.0.1", "info" : { "contact" : { "email" : "support@ultracart.com", "name" : "UltraCart Support", "url" : "http://www.ultracart.com/api/" }, "description" : "UltraCart REST API Version 2", "termsOfService" : "https://www.ultracart.com/api/terms.html", "title" : "UltraCart Rest API V2", "version" : "2.0.0" }, "servers" : [ { "url" : "https://secure.ultracart.com/rest/v2" } ], "security" : [ { "ultraCartOauth" : [ "affiliate_read", "affiliate_write", "auto_order_read", "auto_order_write", "channel_partner_read", "channel_partner_write", "chargeback_read", "chargeback_write", "checkout_read", "checkout_write", "configuration_read", "configuration_write", "conversation_read", "conversation_write", "coupon_read", "coupon_write", "customer_read", "customer_write", "fulfillment_read", "fulfillment_write", "gift_certificate_read", "gift_certificate_write", "integration_log_read", "integration_log_write", "order_read", "order_write", "item_read", "item_write", "storefront_read", "storefront_write", "tax_read", "tax_write", "webhook_read", "webhook_write", "ultrabooks_read", "ultrabooks_write", "user_read", "user_write", "workflow_read", "workflow_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "paths" : { "/auto_order/auto_orders" : { "get" : { "description" : "Retrieves auto orders from the account. If no parameters are specified, all auto orders will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.\n", "operationId" : "getAutoOrders", "parameters" : [ { "description" : "Auto order code", "in" : "query", "name" : "auto_order_code", "schema" : { "type" : "string" } }, { "description" : "Original order id", "in" : "query", "name" : "original_order_id", "schema" : { "type" : "string" } }, { "description" : "First name", "in" : "query", "name" : "first_name", "schema" : { "type" : "string" } }, { "description" : "Last name", "in" : "query", "name" : "last_name", "schema" : { "type" : "string" } }, { "description" : "Company", "in" : "query", "name" : "company", "schema" : { "type" : "string" } }, { "description" : "City", "in" : "query", "name" : "city", "schema" : { "type" : "string" } }, { "description" : "State", "in" : "query", "name" : "state", "schema" : { "type" : "string" } }, { "description" : "Postal code", "in" : "query", "name" : "postal_code", "schema" : { "type" : "string" } }, { "description" : "Country code (ISO-3166 two letter)", "in" : "query", "name" : "country_code", "schema" : { "type" : "string" } }, { "description" : "Phone", "in" : "query", "name" : "phone", "schema" : { "type" : "string" } }, { "description" : "Email", "in" : "query", "name" : "email", "schema" : { "type" : "string" } }, { "description" : "Original order date begin", "in" : "query", "name" : "original_order_date_begin", "schema" : { "type" : "string" } }, { "description" : "Original order date end", "in" : "query", "name" : "original_order_date_end", "schema" : { "type" : "string" } }, { "description" : "Next shipment date begin", "in" : "query", "name" : "next_shipment_date_begin", "schema" : { "type" : "string" } }, { "description" : "Next shipment date end", "in" : "query", "name" : "next_shipment_date_end", "schema" : { "type" : "string" } }, { "description" : "Card type", "in" : "query", "name" : "card_type", "schema" : { "type" : "string" } }, { "description" : "Item ID", "in" : "query", "name" : "item_id", "schema" : { "type" : "string" } }, { "description" : "Status", "in" : "query", "name" : "status", "schema" : { "type" : "string" } }, { "description" : "The maximum number of records to return on this one API call. (Max 200)", "in" : "query", "name" : "_limit", "schema" : { "default" : 100, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "Fetch auto orders that have been created/modified since this date/time.", "in" : "query", "name" : "_since", "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "The sort order of the auto orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.", "in" : "query", "name" : "_sort", "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AutoOrdersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "auto_order_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve auto orders", "tags" : [ "auto_order" ] } }, "/auto_order/auto_orders/batch" : { "post" : { "description" : "Retrieves a group of auto orders from the account based on an array of auto order oids. If more than 200 auto order ids are specified, the API call will fail with a bad request error.\n", "operationId" : "getAutoOrdersBatch", "parameters" : [ { "description" : "The object expansion to perform on the result.", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AutoOrderQueryBatch" } } }, "description" : "Auto order batch", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AutoOrdersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve auto order batch", "tags" : [ "auto_order" ], "x-codegen-request-body-name" : "auto_order_batch" }, "put" : { "description" : "Update multiple auto orders on the UltraCart account.\n", "operationId" : "updateAutoOrdersBatch", "parameters" : [ { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } }, { "description" : "Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.", "in" : "query", "name" : "_placeholders", "schema" : { "type" : "boolean" } }, { "description" : "True if the operation should be run async. No result returned", "in" : "query", "name" : "_async", "schema" : { "type" : "boolean" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/AutoOrdersRequest" } } }, "description" : "Auto orders to update (synchronous maximum 20 / asynchronous maximum 100)", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AutoOrdersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "auto_order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update multiple auto orders", "tags" : [ "auto_order" ], "x-codegen-request-body-name" : "auto_orders_request" } }, "/auto_order/auto_orders/code/{auto_order_code}" : { "get" : { "description" : "Retrieves a single auto order using the specified reference (original) order id.\n", "operationId" : "getAutoOrderByCode", "parameters" : [ { "description" : "The auto order oid to retrieve.", "in" : "path", "name" : "auto_order_code", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AutoOrderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "auto_order_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve an auto order by code", "tags" : [ "auto_order" ] } }, "/auto_order/auto_orders/query" : { "post" : { "description" : "Retrieves a group of auto orders from the account based on a query object. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.\n", "operationId" : "getAutoOrdersByQuery", "parameters" : [ { "description" : "The maximum number of records to return on this one API call. (Maximum 200)", "in" : "query", "name" : "_limit", "schema" : { "default" : 100, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "The sort order of the auto orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.", "in" : "query", "name" : "_sort", "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result.", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AutoOrderQuery" } } }, "description" : "Auto order query", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AutoOrdersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve auto orders by query", "tags" : [ "auto_order" ], "x-codegen-request-body-name" : "auto_order_query" } }, "/auto_order/auto_orders/reference_order_id/{reference_order_id}" : { "get" : { "description" : "Retrieves a single auto order using the specified reference (original) order id.\n", "operationId" : "getAutoOrderByReferenceOrderId", "parameters" : [ { "description" : "The auto order oid to retrieve.", "in" : "path", "name" : "reference_order_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AutoOrderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "auto_order_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve an auto order by order id", "tags" : [ "auto_order" ] }, "post" : { "description" : "Establish an auto order by referencing a regular order id. The result will be an auto order without any items. You should add the items and perform an update call. Orders must be less than 60 days old and use a credit card payment.\n", "operationId" : "establishAutoOrderByReferenceOrderId", "parameters" : [ { "description" : "The order id to attach this auto order to", "in" : "path", "name" : "reference_order_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AutoOrderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "auto_order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Establish an auto order by referencing a regular order id", "tags" : [ "auto_order" ] } }, "/auto_order/auto_orders/reference_order_id/{reference_order_id}/items/original/{original_item_id}/cancel" : { "post" : { "description" : "Cancels a single item on an auto order identified by the original order id and the item's original_item_id. The request body may specify mode=end (soft cancel by setting no_order_after_dts to the current time, preserving the row for reporting; this is the default when the body is omitted) or mode=remove (hard delete). Returns the updated auto order based upon expansion.\n", "operationId" : "cancelAutoOrderItemByReferenceOrderId", "parameters" : [ { "description" : "The reference order id (original_order_id) of the auto order.", "in" : "path", "name" : "reference_order_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The original_item_id (SKU) of the item to cancel.", "in" : "path", "name" : "original_item_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/AutoOrderItemCancelRequest" } } }, "description" : "Cancel request. Body is optional; omit for default mode=end.", "required" : false }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AutoOrderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "auto_order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Cancel a single item on an auto order", "tags" : [ "auto_order" ], "x-codegen-request-body-name" : "auto_order_item_cancel_request" } }, "/auto_order/auto_orders/{auto_order_oid}" : { "get" : { "description" : "Retrieves a single auto order using the specified auto order oid.\n", "operationId" : "getAutoOrder", "parameters" : [ { "description" : "The auto order oid to retrieve.", "in" : "path", "name" : "auto_order_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AutoOrderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "auto_order_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve an auto order by oid", "tags" : [ "auto_order" ] }, "put" : { "description" : "Update an auto order on the UltraCart account.\n", "operationId" : "updateAutoOrder", "parameters" : [ { "description" : "The auto order oid to update.", "in" : "path", "name" : "auto_order_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "Validate original order before updating", "in" : "query", "name" : "validate_original_order", "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/AutoOrder" } } }, "description" : "Auto order to update", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AutoOrderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "auto_order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update an auto order", "tags" : [ "auto_order" ], "x-codegen-request-body-name" : "auto_order" } }, "/auto_order/auto_orders/{auto_order_oid}/consolidate" : { "put" : { "description" : "Consolidates mutliple auto orders on the UltraCart account.\n", "operationId" : "consolidateAutoOrders", "parameters" : [ { "description" : "The auto order oid to consolidate into.", "in" : "path", "name" : "auto_order_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/AutoOrderConsolidate" } } }, "description" : "Auto orders to consolidate", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AutoOrderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "auto_order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Consolidates multiple auto orders", "tags" : [ "auto_order" ], "x-codegen-request-body-name" : "auto_order_consolidate" } }, "/auto_order/auto_orders/{auto_order_oid}/emails" : { "get" : { "description" : "Retrieves email delivery records associated with the specified auto order.\n", "operationId" : "getAutoOrderEmails", "parameters" : [ { "description" : "The auto order oid to retrieve email delivery information for.", "in" : "path", "name" : "auto_order_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AutoOrderEmailsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "auto_order_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve email delivery information for this auto order.", "tags" : [ "auto_order" ] } }, "/auto_order/auto_orders/{auto_order_oid}/items/{auto_order_item_oid}/add_ons" : { "put" : { "description" : "Update an auto order item add ons. Returns the auto order based upon expansion\n", "operationId" : "updateAutoOrderItemAddOns", "parameters" : [ { "description" : "The auto order oid to update.", "in" : "path", "name" : "auto_order_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The auto order item oid to update.", "in" : "path", "name" : "auto_order_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/AutoOrderAddonItemsUpdateRequest" } } }, "description" : "Auto order add ons update request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AutoOrderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "auto_order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update an auto order item add ons", "tags" : [ "auto_order" ], "x-codegen-request-body-name" : "auto_order_add_ons_update_request" } }, "/auto_order/auto_orders/{auto_order_oid}/items/{auto_order_item_oid}/properties" : { "put" : { "description" : "Update an auto order item properties. Returns the auto order based upon expansion\n", "operationId" : "updateAutoOrderItemProperties", "parameters" : [ { "description" : "The auto order oid to update.", "in" : "path", "name" : "auto_order_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The auto order item oid to update.", "in" : "path", "name" : "auto_order_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/AutoOrderPropertiesUpdateRequest" } } }, "description" : "Auto order property update request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AutoOrderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "auto_order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update an auto order item properties", "tags" : [ "auto_order" ], "x-codegen-request-body-name" : "auto_order_properties_update_request" } }, "/auto_order/auto_orders/{auto_order_oid}/pause" : { "put" : { "description" : "Completely pause an auto order\n", "operationId" : "pauseAutoOrder", "parameters" : [ { "description" : "The auto order oid to pause.", "in" : "path", "name" : "auto_order_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/AutoOrder" } } }, "description" : "Auto order to pause", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AutoOrderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "auto_order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Pause auto order", "tags" : [ "auto_order" ], "x-codegen-request-body-name" : "auto_order" } }, "/auto_order/auto_orders/{auto_order_oid}/properties" : { "put" : { "description" : "Update an auto order properties. Returns the auto order based upon expansion\n", "operationId" : "updateAutoOrderProperties", "parameters" : [ { "description" : "The auto order oid to update.", "in" : "path", "name" : "auto_order_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/AutoOrderPropertiesUpdateRequest" } } }, "description" : "Auto order property update request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AutoOrderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "auto_order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update an auto order properties", "tags" : [ "auto_order" ], "x-codegen-request-body-name" : "auto_order_properties_update_request" } }, "/oauth/device/authorize" : { "post" : { "description" : "Initiates the device authorization flow by returning a device code and user code. The device displays the user code to the merchant, who visits the verification URI to approve the request. RFC 8628.\n", "operationId" : "oauthDeviceAuthorize", "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "$ref" : "#/components/schemas/oauthDeviceAuthorize_request" } } }, "required" : true }, "responses" : { "200" : { "$ref" : "#/components/responses/" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "summary" : "Initiate a device authorization flow.", "tags" : [ "oauth" ] } }, "/oauth/revoke" : { "post" : { "description" : "Revokes the OAuth application associated with the specified client_id and token.\n", "operationId" : "oauthRevoke", "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "$ref" : "#/components/schemas/oauthRevoke_request" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OauthRevokeSuccessResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "summary" : "Revoke this OAuth application.", "tags" : [ "oauth" ] } }, "/oauth/token" : { "post" : { "description" : "The final leg in the OAuth process which exchanges the specified access token for the access code needed to make API calls.\n", "operationId" : "oauthAccessToken", "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "$ref" : "#/components/schemas/oauthAccessToken_request" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OauthTokenResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "summary" : "Exchange authorization code for access token.", "tags" : [ "oauth" ] } }, "/customer/customers" : { "get" : { "description" : "Retrieves customers from the account. If no parameters are specified, all customers will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.\n", "operationId" : "getCustomers", "parameters" : [ { "description" : "Email", "in" : "query", "name" : "email", "schema" : { "type" : "string" } }, { "description" : "Quickbooks class", "in" : "query", "name" : "qb_class", "schema" : { "type" : "string" } }, { "description" : "Quickbooks code", "in" : "query", "name" : "quickbooks_code", "schema" : { "type" : "string" } }, { "description" : "Last modified date start", "in" : "query", "name" : "last_modified_dts_start", "schema" : { "type" : "string" } }, { "description" : "Last modified date end", "in" : "query", "name" : "last_modified_dts_end", "schema" : { "type" : "string" } }, { "description" : "Signup date start", "in" : "query", "name" : "signup_dts_start", "schema" : { "type" : "string" } }, { "description" : "Signup date end", "in" : "query", "name" : "signup_dts_end", "schema" : { "type" : "string" } }, { "description" : "Billing first name", "in" : "query", "name" : "billing_first_name", "schema" : { "type" : "string" } }, { "description" : "Billing last name", "in" : "query", "name" : "billing_last_name", "schema" : { "type" : "string" } }, { "description" : "Billing company", "in" : "query", "name" : "billing_company", "schema" : { "type" : "string" } }, { "description" : "Billing city", "in" : "query", "name" : "billing_city", "schema" : { "type" : "string" } }, { "description" : "Billing state", "in" : "query", "name" : "billing_state", "schema" : { "type" : "string" } }, { "description" : "Billing postal code", "in" : "query", "name" : "billing_postal_code", "schema" : { "type" : "string" } }, { "description" : "Billing country code", "in" : "query", "name" : "billing_country_code", "schema" : { "type" : "string" } }, { "description" : "Billing day phone", "in" : "query", "name" : "billing_day_phone", "schema" : { "type" : "string" } }, { "description" : "Billing evening phone", "in" : "query", "name" : "billing_evening_phone", "schema" : { "type" : "string" } }, { "description" : "Shipping first name", "in" : "query", "name" : "shipping_first_name", "schema" : { "type" : "string" } }, { "description" : "Shipping last name", "in" : "query", "name" : "shipping_last_name", "schema" : { "type" : "string" } }, { "description" : "Shipping company", "in" : "query", "name" : "shipping_company", "schema" : { "type" : "string" } }, { "description" : "Shipping city", "in" : "query", "name" : "shipping_city", "schema" : { "type" : "string" } }, { "description" : "Shipping state", "in" : "query", "name" : "shipping_state", "schema" : { "type" : "string" } }, { "description" : "Shipping postal code", "in" : "query", "name" : "shipping_postal_code", "schema" : { "type" : "string" } }, { "description" : "Shipping country code", "in" : "query", "name" : "shipping_country_code", "schema" : { "type" : "string" } }, { "description" : "Shipping day phone", "in" : "query", "name" : "shipping_day_phone", "schema" : { "type" : "string" } }, { "description" : "Shipping evening phone", "in" : "query", "name" : "shipping_evening_phone", "schema" : { "type" : "string" } }, { "description" : "Pricing tier oid", "in" : "query", "name" : "pricing_tier_oid", "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "Pricing tier name", "in" : "query", "name" : "pricing_tier_name", "schema" : { "type" : "string" } }, { "description" : "The maximum number of records to return on this one API call. (Max 200)", "in" : "query", "name" : "_limit", "schema" : { "default" : 100, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "Fetch customers that have been created/modified since this date/time.", "in" : "query", "name" : "_since", "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.", "in" : "query", "name" : "_sort", "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "customer_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve customers", "tags" : [ "customer" ] }, "post" : { "description" : "Insert a customer on the UltraCart account.\n", "operationId" : "insertCustomer", "parameters" : [ { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/Customer" } } }, "description" : "Customer to insert", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "customer_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Insert a customer", "tags" : [ "customer" ], "x-codegen-request-body-name" : "customer" } }, "/customer/customers/by_email/{email}" : { "get" : { "description" : "Retrieves a single customer using the specified customer email address.\n", "operationId" : "getCustomerByEmail", "parameters" : [ { "description" : "The email address of the customer to retrieve.", "in" : "path", "name" : "email", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "customer_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve a customer by Email", "tags" : [ "customer" ] } }, "/customer/customers/dataTables" : { "post" : { "description" : "Retrieves customers from the account. If no searches are specified, all customers will be returned.\n", "operationId" : "getCustomersForDataTables", "parameters" : [ { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DataTablesServerSideResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "customer_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve customers for DataTables plugin", "tags" : [ "customer" ] } }, "/customer/customers/email_verify/get_token" : { "post" : { "description" : "Create a token that can be used to verify a customer email address. The implementation of how a customer interacts with this token is left to the merchant.\n", "operationId" : "getEmailVerificationToken", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailVerifyTokenRequest" } } }, "description" : "Token request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailVerifyTokenResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "customer_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Create a token that can be used to verify a customer email address", "tags" : [ "customer" ], "x-codegen-request-body-name" : "token_request" } }, "/customer/customers/email_verify/validate_token" : { "post" : { "description" : "Validate a token that can be used to verify a customer email address. The implementation of how a customer interacts with this token is left to the merchant.\n", "operationId" : "validateEmailVerificationToken", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailVerifyTokenValidateRequest" } } }, "description" : "Token validation request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailVerifyTokenValidateResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "customer_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Validate a token that can be used to verify a customer email address", "tags" : [ "customer" ], "x-codegen-request-body-name" : "validation_request" } }, "/customer/customers/query" : { "post" : { "description" : "Retrieves customers from the account. If no parameters are specified, all customers will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.\n", "operationId" : "getCustomersByQuery", "parameters" : [ { "description" : "The maximum number of records to return on this one API call. (Max 200)", "in" : "query", "name" : "_limit", "schema" : { "default" : 100, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "Fetch customers that have been created/modified since this date/time.", "in" : "query", "name" : "_since", "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.", "in" : "query", "name" : "_sort", "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerQuery" } } }, "description" : "Customer query", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "customer_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve customers by query", "tags" : [ "customer" ], "x-codegen-request-body-name" : "customer_query" } }, "/customer/customers/search" : { "get" : { "description" : "Retrieves customers from the account by matching the search value against most customer fields. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. This search also goes against the cache so updates should not be performed with these result objects. Always re-query the individual customer profile if you are going to make updates.\n", "operationId" : "searchCustomers", "parameters" : [ { "description" : "Search", "in" : "query", "name" : "search_string", "schema" : { "type" : "string" } }, { "description" : "Signup date start", "in" : "query", "name" : "signup_dts_start", "schema" : { "type" : "string" } }, { "description" : "Signup date end", "in" : "query", "name" : "signup_dts_end", "schema" : { "type" : "string" } }, { "description" : "The maximum number of records to return on this one API call. (Max 200)", "in" : "query", "name" : "_limit", "schema" : { "default" : 100, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "Fetch customers that have been created/modified since this date/time.", "in" : "query", "name" : "_since", "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.", "in" : "query", "name" : "_sort", "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "customer_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Search for customers", "tags" : [ "customer" ] } }, "/customer/customers/{customer_profile_oid}" : { "delete" : { "description" : "Delete a customer on the UltraCart account.\n", "operationId" : "deleteCustomer", "parameters" : [ { "description" : "The customer_profile_oid to delete.", "in" : "path", "name" : "customer_profile_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "customer_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete a customer", "tags" : [ "customer" ] }, "get" : { "description" : "Retrieves a single customer using the specified customer profile oid.\n", "operationId" : "getCustomer", "parameters" : [ { "description" : "The customer oid to retrieve.", "in" : "path", "name" : "customer_profile_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "customer_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve a customer", "tags" : [ "customer" ] }, "put" : { "description" : "Update a customer on the UltraCart account.\n", "operationId" : "updateCustomer", "parameters" : [ { "description" : "The customer_profile_oid to update.", "in" : "path", "name" : "customer_profile_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/Customer" } } }, "description" : "Customer to update", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "customer_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update a customer", "tags" : [ "customer" ], "x-codegen-request-body-name" : "customer" } }, "/customer/customers/{customer_profile_oid}/adjust_cashback_balance" : { "post" : { "description" : "Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.\n", "operationId" : "adjustInternalCertificate", "parameters" : [ { "description" : "The customer profile oid", "in" : "path", "name" : "customer_profile_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/AdjustInternalCertificateRequest" } } }, "description" : "adjustInternalCertificateRequest", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AdjustInternalCertificateResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "customer_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.", "tags" : [ "customer" ], "x-codegen-request-body-name" : "adjust_internal_certificate_request" } }, "/customer/customers/{customer_profile_oid}/email_lists" : { "post" : { "description" : "Update email list subscriptions for a customer\n", "operationId" : "updateCustomerEmailLists", "parameters" : [ { "description" : "The customer profile oid", "in" : "path", "name" : "customer_profile_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/CustomerEmailListChanges" } } }, "description" : "List changes", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerEmailListChanges" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "customer_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update email list subscriptions for a customer", "tags" : [ "customer" ], "x-codegen-request-body-name" : "list_changes" } }, "/customer/customers/{customer_profile_oid}/magic_link/{storefront_host_name}" : { "put" : { "description" : "Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.\n", "operationId" : "getMagicLink", "parameters" : [ { "description" : "The customer_profile_oid of the customer.", "in" : "path", "name" : "customer_profile_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The storefront to log into.", "in" : "path", "name" : "storefront_host_name", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerMagicLinkResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "customer_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "getMagicLink", "tags" : [ "customer" ] } }, "/customer/customers/{customer_profile_oid}/merge" : { "put" : { "description" : "Merge customer into this customer.\n", "operationId" : "mergeCustomer", "parameters" : [ { "description" : "The customer_profile_oid to update.", "in" : "path", "name" : "customer_profile_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/CustomerMergeRequest" } } }, "description" : "Customer to merge into this profile.", "required" : true }, "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "customer_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Merge customer into this customer", "tags" : [ "customer" ], "x-codegen-request-body-name" : "customer" } }, "/customer/customers/{customer_profile_oid}/store_credit" : { "get" : { "description" : "Retrieve the customer store credit accumulated through loyalty programs\n", "operationId" : "getCustomerStoreCredit", "parameters" : [ { "description" : "The customer oid to retrieve.", "in" : "path", "name" : "customer_profile_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerStoreCreditResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "customer_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve the customer store credit accumulated through loyalty programs", "tags" : [ "customer" ] }, "post" : { "description" : "Adds store credit to a customer\n", "operationId" : "addCustomerStoreCredit", "parameters" : [ { "description" : "The customer oid to credit.", "in" : "path", "name" : "customer_profile_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/CustomerStoreCreditAddRequest" } } }, "description" : "Store credit to add", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "customer_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Adds store credit to a customer", "tags" : [ "customer" ], "x-codegen-request-body-name" : "store_credit_request" } }, "/customer/customers/{customer_profile_oid}/wishlist" : { "get" : { "description" : "Retrieve wishlist items for customer.\n", "operationId" : "getCustomerWishList", "parameters" : [ { "description" : "The customer oid for this wishlist.", "in" : "path", "name" : "customer_profile_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerWishListItemsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "customer_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve wishlist items for customer", "tags" : [ "customer" ] }, "post" : { "description" : "Insert a customer wishlist item\n", "operationId" : "insertWishListItem", "parameters" : [ { "description" : "The customer oid for this wishlist.", "in" : "path", "name" : "customer_profile_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/CustomerWishListItem" } } }, "description" : "Wishlist item to insert", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerWishListItem" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "customer_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Insert a customer wishlist item", "tags" : [ "customer" ], "x-codegen-request-body-name" : "wishlist_item" } }, "/customer/customers/{customer_profile_oid}/wishlist/{customer_wishlist_item_oid}" : { "delete" : { "description" : "Delete a customer wishlist item\n", "operationId" : "deleteWishListItem", "parameters" : [ { "description" : "The customer oid for this wishlist.", "in" : "path", "name" : "customer_profile_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The wishlist oid for this wishlist item to delete.", "in" : "path", "name" : "customer_wishlist_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "customer_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete a customer wishlist item", "tags" : [ "customer" ] }, "get" : { "description" : "Retrieve wishlist item for customer.\n", "operationId" : "getCustomerWishListItem", "parameters" : [ { "description" : "The customer oid for this wishlist.", "in" : "path", "name" : "customer_profile_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The wishlist oid for this wishlist item.", "in" : "path", "name" : "customer_wishlist_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerWishListItemResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "customer_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve wishlist item for customer", "tags" : [ "customer" ] }, "put" : { "description" : "Update a customer wishlist item\n", "operationId" : "updateWishListItem", "parameters" : [ { "description" : "The customer oid for this wishlist.", "in" : "path", "name" : "customer_profile_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The wishlist oid for this wishlist item.", "in" : "path", "name" : "customer_wishlist_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/CustomerWishListItem" } } }, "description" : "Wishlist item to update", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerWishListItem" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "customer_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update a customer wishlist item", "tags" : [ "customer" ], "x-codegen-request-body-name" : "wishlist_item" } }, "/customer/editor_values" : { "get" : { "description" : "Retrieve values needed for a customer profile editor.\n", "operationId" : "getCustomerEditorValues", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerEditorValues" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "customer_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve values needed for a customer profile editor", "tags" : [ "customer" ] } }, "/customer/email_lists" : { "get" : { "description" : "Retrieve all email lists across all storefronts\n", "operationId" : "getCustomerEmailLists", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailListsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "customer_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve all email lists across all storefronts", "tags" : [ "customer" ] } }, "/customer/search" : { "post" : { "operationId" : "searchCustomerProfileValues", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LookupRequest" } } }, "description" : "LookupRequest", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LookupResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "customer_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Searches for all matching values (using POST)", "tags" : [ "customer" ], "x-codegen-request-body-name" : "lookup_request" } }, "/fulfillment/distribution_centers" : { "get" : { "description" : "Retrieves the distribution centers that this user has access to.\n", "operationId" : "getDistributionCenters", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DistributionCentersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "fulfillment_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve distribution centers", "tags" : [ "fulfillment" ] } }, "/fulfillment/distribution_centers/{distribution_center_code}/acknowledgements" : { "put" : { "description" : "Acknowledge receipt of orders so that they are removed from the fulfillment queue. This method must be called after receiving and order (via webhook) or retrieving (via retrieve orders method).\n", "operationId" : "acknowledgeOrders", "parameters" : [ { "description" : "Distribution center code", "in" : "path", "name" : "distribution_center_code", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "items" : { "type" : "string" }, "type" : "array" } } }, "description" : "Orders to acknowledge receipt of (limit 100)", "required" : true }, "responses" : { "204" : { "content" : { }, "description" : "No Content" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "fulfillment_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Acknowledge receipt of orders.", "tags" : [ "fulfillment" ], "x-codegen-request-body-name" : "orderIds" } }, "/fulfillment/distribution_centers/{distribution_center_code}/inventory" : { "post" : { "description" : "Update the inventory for items associated with this distribution center\n", "operationId" : "updateInventory", "parameters" : [ { "description" : "Distribution center code", "in" : "path", "name" : "distribution_center_code", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/FulfillmentInventory" }, "type" : "array" } } }, "description" : "Inventory updates (limit 500)", "required" : true }, "responses" : { "204" : { "content" : { }, "description" : "No Content" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "fulfillment_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update inventory", "tags" : [ "fulfillment" ], "x-codegen-request-body-name" : "inventories" } }, "/fulfillment/distribution_centers/{distribution_center_code}/orders" : { "get" : { "description" : "Retrieves up to 100 orders that are queued up in this distribution center. You must acknowledge them before additional new orders will be returned. There is NO record chunking. You'll get the same 100 records again and again until you acknowledge orders. The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes.\n", "operationId" : "getDistributionCenterOrders", "parameters" : [ { "description" : "Distribution center code", "in" : "path", "name" : "distribution_center_code", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrdersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "fulfillment_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve orders queued up for this distribution center.", "tags" : [ "fulfillment" ] } }, "/fulfillment/distribution_centers/{distribution_center_code}/orders/{order_id}" : { "get" : { "description" : "The packing slip PDF that is returned is base 64 encoded\n", "operationId" : "generatePackingSlip", "parameters" : [ { "description" : "Distribution center code", "in" : "path", "name" : "distribution_center_code", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Order ID", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderPackingSlipResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "fulfillment_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Generate a packing slip for this order for the given distribution center.", "tags" : [ "fulfillment" ] } }, "/fulfillment/distribution_centers/{distribution_center_code}/shipments" : { "post" : { "description" : "Store the tracking information and mark the order shipped for this distribution center.\n", "operationId" : "shipOrders", "parameters" : [ { "description" : "Distribution center code", "in" : "path", "name" : "distribution_center_code", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/FulfillmentShipment" }, "type" : "array" } } }, "description" : "Orders to mark shipped", "required" : true }, "responses" : { "204" : { "content" : { }, "description" : "No Content" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "fulfillment_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Mark orders as shipped", "tags" : [ "fulfillment" ], "x-codegen-request-body-name" : "shipments" } }, "/coupon/auto_apply" : { "get" : { "description" : "Retrieve auto apply rules and conditions\n", "operationId" : "getAutoApply", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponAutoApplyConditions" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "coupon_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve auto apply rules and conditions", "tags" : [ "coupon" ] }, "post" : { "description" : "Update auto apply rules and conditions\n", "operationId" : "updateAutoApply", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponAutoApplyConditions" } } }, "description" : "Conditions", "required" : true }, "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "coupon_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update auto apply rules and conditions", "tags" : [ "coupon" ], "x-codegen-request-body-name" : "conditions" } }, "/coupon/coupons" : { "get" : { "description" : "Retrieves coupons for this account. If no parameters are specified, all coupons will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.\n", "operationId" : "getCoupons", "parameters" : [ { "description" : "Merchant code", "in" : "query", "name" : "merchant_code", "schema" : { "type" : "string" } }, { "description" : "Description", "in" : "query", "name" : "description", "schema" : { "type" : "string" } }, { "description" : "Coupon type", "in" : "query", "name" : "coupon_type", "schema" : { "type" : "string" } }, { "description" : "Start date begin", "in" : "query", "name" : "start_date_begin", "schema" : { "type" : "string" } }, { "description" : "Start date end", "in" : "query", "name" : "start_date_end", "schema" : { "type" : "string" } }, { "description" : "Expiration date begin", "in" : "query", "name" : "expiration_date_begin", "schema" : { "type" : "string" } }, { "description" : "Expiration date end", "in" : "query", "name" : "expiration_date_end", "schema" : { "type" : "string" } }, { "description" : "Affiliate oid", "in" : "query", "name" : "affiliate_oid", "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "Exclude expired", "in" : "query", "name" : "exclude_expired", "schema" : { "type" : "boolean" } }, { "description" : "The maximum number of records to return on this one API call. (Max 200)", "in" : "query", "name" : "_limit", "schema" : { "default" : 100, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "The sort order of the coupons. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.", "in" : "query", "name" : "_sort", "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "coupon_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve coupons", "tags" : [ "coupon" ] }, "post" : { "description" : "Insert a coupon on the UltraCart account.\n", "operationId" : "insertCoupon", "parameters" : [ { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/Coupon" } } }, "description" : "Coupon to insert", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "coupon_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Insert a coupon", "tags" : [ "coupon" ], "x-codegen-request-body-name" : "coupon" } }, "/coupon/coupons/batch" : { "post" : { "description" : "Insert multiple coupon on the UltraCart account.\n", "operationId" : "insertCoupons", "parameters" : [ { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } }, { "description" : "Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.", "in" : "query", "name" : "_placeholders", "schema" : { "type" : "boolean" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/CouponsRequest" } } }, "description" : "Coupons to insert (maximum 50)", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "coupon_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Insert multiple coupons", "tags" : [ "coupon" ], "x-codegen-request-body-name" : "coupons_request" }, "put" : { "description" : "Update multiple coupon on the UltraCart account.\n", "operationId" : "updateCoupons", "parameters" : [ { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } }, { "description" : "Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.", "in" : "query", "name" : "_placeholders", "schema" : { "type" : "boolean" } }, { "description" : "True if the operation should be run async. No result returned", "in" : "query", "name" : "_async", "schema" : { "type" : "boolean" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/CouponsRequest" } } }, "description" : "Coupons to update (synchronous maximum 50 / asynchronous maximum 100)", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "coupon_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update multiple coupons", "tags" : [ "coupon" ], "x-codegen-request-body-name" : "coupons_request" } }, "/coupon/coupons/by_code" : { "delete" : { "description" : "Delete coupons on the UltraCart account.\n", "operationId" : "deleteCouponsByCode", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponDeletesRequest" } } }, "description" : "Coupon oids to delete", "required" : true }, "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "coupon_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Deletes multiple coupons", "tags" : [ "coupon" ], "x-codegen-request-body-name" : "coupon_delete_request" } }, "/coupon/coupons/by_oid" : { "delete" : { "description" : "Delete coupons on the UltraCart account.\n", "operationId" : "deleteCouponsByOid", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponDeletesRequest" } } }, "description" : "Coupon oids to delete", "required" : true }, "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "coupon_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Deletes multiple coupons", "tags" : [ "coupon" ], "x-codegen-request-body-name" : "coupon_delete_request" } }, "/coupon/coupons/merchant_code/{merchant_code}" : { "get" : { "description" : "Retrieves a single coupon using the specified merchant code.\n", "operationId" : "getCouponByMerchantCode", "parameters" : [ { "description" : "The coupon merchant code to retrieve.", "in" : "path", "name" : "merchant_code", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "coupon_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve a coupon by merchant code", "tags" : [ "coupon" ] } }, "/coupon/coupons/merchant_code/{merchant_code}/exists" : { "get" : { "description" : "Determines if a coupon merchant code already exists.\n", "operationId" : "doesCouponCodeExist", "parameters" : [ { "description" : "The coupon merchant code to examine.", "in" : "path", "name" : "merchant_code", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponExistsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "coupon_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Determines if a coupon merchant code already exists", "tags" : [ "coupon" ] } }, "/coupon/coupons/merchant_code/{merchant_code}/generate_codes" : { "post" : { "description" : "Generate one time codes by merchant code\n", "operationId" : "generateOneTimeCodesByMerchantCode", "parameters" : [ { "description" : "The merchant code to generate one time codes.", "in" : "path", "name" : "merchant_code", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/CouponCodesRequest" } } }, "description" : "Coupon code generation parameters", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponCodesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "coupon_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Generates one time codes by merchant code", "tags" : [ "coupon" ], "x-codegen-request-body-name" : "coupon_codes_request" } }, "/coupon/coupons/query" : { "post" : { "description" : "Retrieves coupons from the account. If no parameters are specified, all coupons will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.\n", "operationId" : "getCouponsByQuery", "parameters" : [ { "description" : "The maximum number of records to return on this one API call. (Max 200)", "in" : "query", "name" : "_limit", "schema" : { "default" : 100, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "The sort order of the coupons. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.", "in" : "query", "name" : "_sort", "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponQuery" } } }, "description" : "Coupon query", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "coupon_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve coupons by query", "tags" : [ "coupon" ], "x-codegen-request-body-name" : "coupon_query" } }, "/coupon/coupons/{coupon_oid}" : { "delete" : { "description" : "Delete a coupon on the UltraCart account.\n", "operationId" : "deleteCoupon", "parameters" : [ { "description" : "The coupon_oid to delete.", "in" : "path", "name" : "coupon_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "coupon_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete a coupon", "tags" : [ "coupon" ] }, "get" : { "description" : "Retrieves a single coupon using the specified coupon profile oid.\n", "operationId" : "getCoupon", "parameters" : [ { "description" : "The coupon oid to retrieve.", "in" : "path", "name" : "coupon_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "coupon_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve a coupon", "tags" : [ "coupon" ] }, "put" : { "description" : "Update a coupon on the UltraCart account.\n", "operationId" : "updateCoupon", "parameters" : [ { "description" : "The coupon_oid to update.", "in" : "path", "name" : "coupon_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/Coupon" } } }, "description" : "Coupon to update", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "coupon_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update a coupon", "tags" : [ "coupon" ], "x-codegen-request-body-name" : "coupon" } }, "/coupon/coupons/{coupon_oid}/generate_codes" : { "post" : { "description" : "Generate one time codes for a coupon\n", "operationId" : "generateCouponCodes", "parameters" : [ { "description" : "The coupon oid to generate codes.", "in" : "path", "name" : "coupon_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/CouponCodesRequest" } } }, "description" : "Coupon code generation parameters", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponCodesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "coupon_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Generates one time codes for a coupon", "tags" : [ "coupon" ], "x-codegen-request-body-name" : "coupon_codes_request" } }, "/coupon/coupons/{coupon_oid}/upload_codes" : { "post" : { "description" : "Upload one-time codes for a coupon\n", "operationId" : "uploadCouponCodes", "parameters" : [ { "description" : "The coupon oid to associate with the provided one-time codes.", "in" : "path", "name" : "coupon_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/UploadCouponCodesRequest" } } }, "description" : "One-time coupon codes", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UploadCouponCodesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "coupon_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Upload one-time codes for a coupon", "tags" : [ "coupon" ], "x-codegen-request-body-name" : "upload_coupon_codes_request" } }, "/coupon/editor_values" : { "get" : { "description" : "Retrieve values needed for a coupon editor\n", "operationId" : "getEditorValues", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponEditorValues" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "coupon_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve values needed for a coupon editor", "tags" : [ "coupon" ] } }, "/coupon/searchItems" : { "get" : { "description" : "Searches for items to display within a coupon editor and assign to coupons\n", "operationId" : "searchItems", "parameters" : [ { "in" : "query", "name" : "s", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "m", "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CouponItemSearchResultsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "coupon_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Searches for items to display within a coupon editor and assign to coupons", "tags" : [ "coupon" ] } }, "/tax/providers" : { "get" : { "description" : "Retrieves tax methods for this account.\n", "operationId" : "getTaxProviders", "parameters" : [ { "description" : "The maximum number of records to return on this one API call. (Max 200)", "in" : "query", "name" : "_limit", "schema" : { "default" : 100, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxProvidersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve tax methods", "tags" : [ "tax" ] } }, "/tax/providers/avalara" : { "get" : { "description" : "Retrieves the Avalara tax provider.\n", "operationId" : "getTaxProviderAvalara", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxProviderAvalara" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve the Avalara tax provider", "tags" : [ "tax" ] }, "post" : { "description" : "Update the Avalara tax provider.\n", "operationId" : "updateTaxProviderAvalara", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxProviderAvalara" } } }, "description" : "TaxProviderAvalara object", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxProviderAvalara" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update the Avalara tax provider", "tags" : [ "tax" ], "x-codegen-request-body-name" : "tax_provider_avalara" } }, "/tax/providers/avalara/companies" : { "post" : { "description" : "Returns Avalara Tax companies configured by the merchant\n", "operationId" : "getTaxProviderAvalaraCompanies", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxProviderAvalara" } } }, "description" : "TaxProviderAvalara object", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxProviderAvalaraCompaniesResult" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Returns Avalara Tax companies configured by the merchant", "tags" : [ "tax" ], "x-codegen-request-body-name" : "tax_provider_avalara" } }, "/tax/providers/avalara/test" : { "get" : { "description" : "Attempts to connect to Avalara and returns back the response.\n", "operationId" : "getTaxProviderAvalaraTest", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxProviderTestResult" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Attempts to connect to Avalara and returns back the response", "tags" : [ "tax" ] } }, "/tax/providers/self" : { "get" : { "description" : "Retrieves the Self tax provider.\n", "operationId" : "getTaxProviderSelf", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxProviderSelf" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve the Self tax provider", "tags" : [ "tax" ] }, "post" : { "description" : "Update the Self tax provider.\n", "operationId" : "updateTaxProviderSelf", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxProviderSelf" } } }, "description" : "TaxProviderSelf object", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxProviderSelf" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update the Self tax provider", "tags" : [ "tax" ], "x-codegen-request-body-name" : "tax_provider_self" } }, "/tax/providers/self/city/{city}" : { "delete" : { "description" : "Deletes a Self tax provider city.\n", "operationId" : "deleteTaxProviderSelfCity", "parameters" : [ { "description" : "The city being deleted.", "in" : "path", "name" : "city", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxCity" } } }, "description" : "tax city to be deleted", "required" : true }, "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Deletes a Self tax provider city", "tags" : [ "tax" ], "x-codegen-request-body-name" : "tax_city" }, "post" : { "description" : "Updates a Self tax provider city.\n", "operationId" : "updateTaxProviderSelfCity", "parameters" : [ { "description" : "The city being updated.", "in" : "path", "name" : "city", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxCity" } } }, "description" : "tax city to be updated", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxCity" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Updates a Self tax provider city", "tags" : [ "tax" ], "x-codegen-request-body-name" : "tax_city" } }, "/tax/providers/self/countries" : { "get" : { "description" : "Retrieves the Self tax provider countries.\n", "operationId" : "getTaxProviderSelfCountries", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxProviderSelfCountriesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve the Self tax provider countries", "tags" : [ "tax" ] } }, "/tax/providers/self/country/{countryCode}" : { "delete" : { "description" : "Deletes a Self tax provider country.\n", "operationId" : "deleteTaxProviderSelfCountry", "parameters" : [ { "description" : "The country code being deleted.", "in" : "path", "name" : "countryCode", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxCountry" } } }, "description" : "tax country to be deleted", "required" : true }, "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Deletes a Self tax provider country", "tags" : [ "tax" ], "x-codegen-request-body-name" : "tax_country" }, "post" : { "description" : "Updates a Self tax provider country.\n", "operationId" : "updateTaxProviderSelfCountry", "parameters" : [ { "description" : "The country code being updated.", "in" : "path", "name" : "countryCode", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxCountry" } } }, "description" : "tax country to be updated", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxCountry" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Updates a Self tax provider country", "tags" : [ "tax" ], "x-codegen-request-body-name" : "tax_country" } }, "/tax/providers/self/county/{county}" : { "delete" : { "description" : "Deletes a Self tax provider county.\n", "operationId" : "deleteTaxProviderSelfCounty", "parameters" : [ { "description" : "The county being deleted.", "in" : "path", "name" : "county", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxCounty" } } }, "description" : "tax county to be deleted", "required" : true }, "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Deletes a Self tax provider county", "tags" : [ "tax" ], "x-codegen-request-body-name" : "tax_county" }, "post" : { "description" : "Updates a Self tax provider county.\n", "operationId" : "updateTaxProviderSelfCounty", "parameters" : [ { "description" : "The county being updated.", "in" : "path", "name" : "county", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxCounty" } } }, "description" : "tax county to be updated", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxCounty" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Updates a Self tax provider county", "tags" : [ "tax" ], "x-codegen-request-body-name" : "tax_county" } }, "/tax/providers/self/postalCode/{postal_code}" : { "delete" : { "description" : "Deletes a Self tax provider postalCode.\n", "operationId" : "deleteTaxProviderSelfPostalCode", "parameters" : [ { "description" : "The postal code being deleted.", "in" : "path", "name" : "postal_code", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxPostalCode" } } }, "description" : "tax postal code to be deleted", "required" : true }, "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Deletes a Self tax provider postalCode", "tags" : [ "tax" ], "x-codegen-request-body-name" : "tax_postal_code" }, "post" : { "description" : "Updates a Self tax provider postalCode.\n", "operationId" : "updateTaxProviderSelfPostalCode", "parameters" : [ { "description" : "The postal code being updated.", "in" : "path", "name" : "postal_code", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxPostalCode" } } }, "description" : "tax postal code to be updated", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxPostalCode" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Updates a Self tax provider postalCode", "tags" : [ "tax" ], "x-codegen-request-body-name" : "tax_postal_code" } }, "/tax/providers/self/regions/{countryCode}" : { "get" : { "description" : "Retrieves the Self tax provider regions for a given country code.\n", "operationId" : "getTaxProviderSelfRegionsByCountryCode", "parameters" : [ { "description" : "The country code regions desired.", "in" : "path", "name" : "countryCode", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxProviderSelfRegionsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve the Self tax provider regions for a given country code", "tags" : [ "tax" ] } }, "/tax/providers/self/state/{stateCode}" : { "delete" : { "description" : "Deletes a Self tax provider state.\n", "operationId" : "deleteTaxProviderSelfState", "parameters" : [ { "description" : "The state code being deleted.", "in" : "path", "name" : "stateCode", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxState" } } }, "description" : "tax state to be deleted", "required" : true }, "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Deletes a Self tax provider state", "tags" : [ "tax" ], "x-codegen-request-body-name" : "tax_state" }, "post" : { "description" : "Updates a Self tax provider state.\n", "operationId" : "updateTaxProviderSelfState", "parameters" : [ { "description" : "The state code being updated.", "in" : "path", "name" : "stateCode", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxState" } } }, "description" : "tax state to be updated", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxState" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Updates a Self tax provider state", "tags" : [ "tax" ], "x-codegen-request-body-name" : "tax_state" } }, "/tax/providers/setActive/{providerName}" : { "post" : { "description" : "Toggle a tax provider to active.\n", "operationId" : "setActiveTaxProvider", "parameters" : [ { "description" : "The tax provider to set active.", "in" : "path", "name" : "providerName", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxProviderActivateResult" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Toggle a tax provider to active", "tags" : [ "tax" ] } }, "/tax/providers/sovos" : { "get" : { "description" : "Retrieves the Sovos tax provider.\n", "operationId" : "getTaxProviderSovos", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxProviderSovos" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve the Sovos tax provider", "tags" : [ "tax" ] }, "post" : { "description" : "Update the Sovos tax provider.\n", "operationId" : "updateTaxProviderSovos", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxProviderSovos" } } }, "description" : "TaxProviderSovos object", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxProviderSovos" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update the Sovos tax provider", "tags" : [ "tax" ], "x-codegen-request-body-name" : "tax_provider_sovos" } }, "/tax/providers/sovos/test" : { "get" : { "description" : "Attempts to connect to Sovos and returns back the response.\n", "operationId" : "getTaxProviderSovosTest", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxProviderTestResult" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Attempts to connect to Sovos and returns back the response", "tags" : [ "tax" ] } }, "/tax/providers/taxjar" : { "get" : { "description" : "Retrieves the TaxJar tax provider.\n", "operationId" : "getTaxProviderTaxJar", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxProviderTaxJar" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve the TaxJar tax provider", "tags" : [ "tax" ] }, "post" : { "description" : "Update the TaxJar tax provider.\n", "operationId" : "updateTaxProviderTaxJar", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxProviderTaxJar" } } }, "description" : "TaxProviderTaxJar object", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxProviderTaxJar" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update the TaxJar tax provider", "tags" : [ "tax" ], "x-codegen-request-body-name" : "tax_provider_taxJar" } }, "/tax/providers/taxjar/test" : { "get" : { "description" : "Attempts to connect to TaxJar and returns back the response.\n", "operationId" : "getTaxProviderTaxJarTest", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxProviderTestResult" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Attempts to connect to TaxJar and returns back the response", "tags" : [ "tax" ] } }, "/tax/providers/ultracart" : { "get" : { "description" : "Retrieves the UltraCart tax provider.\n", "operationId" : "getTaxProviderUltraCart", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxProviderUltraCart" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve the UltraCart tax provider", "tags" : [ "tax" ] }, "post" : { "description" : "Update the UltraCart tax provider.\n", "operationId" : "updateTaxProviderUltraCart", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxProviderUltraCart" } } }, "description" : "TaxProviderUltraCart object", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TaxProviderUltraCart" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "tax_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update the UltraCart tax provider", "tags" : [ "tax" ], "x-codegen-request-body-name" : "tax_provider_ultracart" } }, "/storefront" : { "get" : { "operationId" : "getStoreFronts", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/StoreFrontsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "summary" : "Get storefronts (internal use only for security reasons)", "tags" : [ "storefront" ] } }, "/storefront/code_library" : { "post" : { "operationId" : "addToLibrary", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AddLibraryItemRequest" } } }, "description" : "New library item request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LibraryItemResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Add to library", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "add_library_request" } }, "/storefront/code_library/apply" : { "post" : { "operationId" : "applyToStoreFront", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApplyLibraryItemRequest" } } }, "description" : "New library item", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApplyLibraryItemResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Apply library item to storefront.", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "apply_library_request" } }, "/storefront/code_library/filter_values" : { "get" : { "operationId" : "getLibraryFilterValues", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LibraryFilterValuesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get library values used to populate drop down boxes for filtering.", "tags" : [ "storefront" ] } }, "/storefront/code_library/search" : { "post" : { "description" : "Retrieves a library items based on a query object. If no parameters are specified, the API call will default to the merchant id only. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.\n", "operationId" : "searchLibraryItems", "parameters" : [ { "description" : "The maximum number of records to return on this one API call. (Maximum 10000)", "in" : "query", "name" : "_limit", "schema" : { "default" : 10000, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "The sort order of the library items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.", "in" : "query", "name" : "_sort", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LibraryItemQuery" } } }, "description" : "Item query", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LibraryItemsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "affiliate_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve library items", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "item_query" } }, "/storefront/code_library/search_published" : { "post" : { "description" : "Retrieves a library items based on a query object. If no parameters are specified, the API call will default to the merchant id only. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.\n", "operationId" : "searchPublishedItems", "parameters" : [ { "description" : "The maximum number of records to return on this one API call. (Maximum 10000)", "in" : "query", "name" : "_limit", "schema" : { "default" : 10000, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "The sort order of the library items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.", "in" : "query", "name" : "_sort", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LibraryItemQuery" } } }, "description" : "Item query", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LibraryItemsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "affiliate_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve library items", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "item_query" } }, "/storefront/code_library/search_review" : { "post" : { "description" : "Retrieves a library items based on a query object. If no parameters are specified, the API call will default to the merchant id only. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.\n", "operationId" : "searchReviewItems", "parameters" : [ { "description" : "The maximum number of records to return on this one API call. (Maximum 10000)", "in" : "query", "name" : "_limit", "schema" : { "default" : 10000, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "The sort order of the library items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.", "in" : "query", "name" : "_sort", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LibraryItemQuery" } } }, "description" : "Item query", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LibraryItemsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "affiliate_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve library items needing review or rejected", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "item_query" } }, "/storefront/code_library/search_shared" : { "post" : { "description" : "Retrieves a library items based on a query object. If no parameters are specified, the API call will default to the merchant id only. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.\n", "operationId" : "searchSharedItems", "parameters" : [ { "description" : "The maximum number of records to return on this one API call. (Maximum 10000)", "in" : "query", "name" : "_limit", "schema" : { "default" : 10000, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "The sort order of the library items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.", "in" : "query", "name" : "_sort", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LibraryItemQuery" } } }, "description" : "Item query", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LibraryItemsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "affiliate_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve library items", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "item_query" } }, "/storefront/code_library/{library_item_oid}" : { "delete" : { "operationId" : "deleteLibraryItem", "parameters" : [ { "in" : "path", "name" : "library_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Delete library item", "tags" : [ "storefront" ] }, "get" : { "operationId" : "getLibraryItem", "parameters" : [ { "in" : "path", "name" : "library_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LibraryItemResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get library item.", "tags" : [ "storefront" ] }, "put" : { "operationId" : "updateLibraryItem", "parameters" : [ { "in" : "path", "name" : "library_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LibraryItem" } } }, "description" : "Library item", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LibraryItemResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Update library item. Note that only certain fields may be updated via this method.", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "library_item" } }, "/storefront/code_library/{library_item_oid}/duplicate" : { "post" : { "operationId" : "duplicateLibraryItem", "parameters" : [ { "in" : "path", "name" : "library_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LibraryItemResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Duplicate library item.", "tags" : [ "storefront" ] } }, "/storefront/code_library/{library_item_oid}/publish" : { "post" : { "operationId" : "publishLibraryItem", "parameters" : [ { "in" : "path", "name" : "library_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PublishLibraryItemRequest" } } }, "description" : "Publish library item request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LibraryItemResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Publish library item.", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "publish_library_request" } }, "/storefront/code_library/{library_item_oid}/published_versions" : { "delete" : { "operationId" : "deleteLibraryItemPublishedVersions", "parameters" : [ { "in" : "path", "name" : "library_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Delete all published versions for a library item, including anything in review.", "tags" : [ "storefront" ] }, "get" : { "operationId" : "getLibraryItemPublishedVersions", "parameters" : [ { "in" : "path", "name" : "library_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LibraryItemsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get all published versions for a library item.", "tags" : [ "storefront" ] } }, "/storefront/code_library/{library_item_oid}/purchase" : { "post" : { "operationId" : "purchaseLibraryItem", "parameters" : [ { "in" : "path", "name" : "library_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "query", "name" : "storefront_oid", "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LibraryItemResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Purchase public library item, which creates a copy of the item in your personal code library", "tags" : [ "storefront" ] } }, "/storefront/email/global_settings" : { "get" : { "operationId" : "getEmailGlobalSettings", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailGlobalSettingsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email globalsettings", "tags" : [ "storefront" ] }, "post" : { "operationId" : "updateEmailGlobalSettings", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailGlobalSettings" } } }, "description" : "global settings request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailGlobalSettingsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Update email global settings", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "global_settings" } }, "/storefront/email/sending_domain/{domain}" : { "get" : { "operationId" : "getEmailSendingDomain", "parameters" : [ { "in" : "path", "name" : "domain", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailSendingDomainResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email sending domain", "tags" : [ "storefront" ] } }, "/storefront/email/sending_domains" : { "get" : { "operationId" : "getEmailSendingDomains", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailSendingDomainsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email sending domains", "tags" : [ "storefront" ] }, "post" : { "operationId" : "createEmailSendingDomain2", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailDomain" } } }, "description" : "EmailDomain", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailSendingDomainResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Create email sending domain for various providers", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_domain" } }, "/storefront/email/sending_domains/{domain}" : { "delete" : { "operationId" : "deleteEmailSendingDomain", "parameters" : [ { "in" : "path", "name" : "domain", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "delete email campaign", "tags" : [ "storefront" ] }, "put" : { "operationId" : "updateEmailSendingDomain", "parameters" : [ { "in" : "path", "name" : "domain", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailDomain" } } }, "description" : "EmailDomain", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailSendingDomainResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Update email sending domain", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_domain" } }, "/storefront/email/sending_domains/{domain}/create" : { "post" : { "operationId" : "createEmailSendingDomain", "parameters" : [ { "in" : "path", "name" : "domain", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailSendingDomainResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Create email campaign", "tags" : [ "storefront" ] } }, "/storefront/email/sending_domains/{domain}/status" : { "post" : { "operationId" : "getEmailSendingDomainStatus", "parameters" : [ { "in" : "path", "name" : "domain", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailSendingDomainResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email sending domain status", "tags" : [ "storefront" ] } }, "/storefront/pricing_tiers" : { "get" : { "description" : "Retrieves the pricing tiers\n", "operationId" : "getStoreFrontPricingTiers", "parameters" : [ { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PricingTiersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve pricing tiers", "tags" : [ "storefront" ] } }, "/storefront/ruler/validate" : { "post" : { "operationId" : "validateRuler", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RulerValidationRequest" } } }, "description" : "Ruler Validate Request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RulerValidationResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Validate AWS Event Ruler", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "ruler_validate_request" } }, "/storefront/search" : { "get" : { "operationId" : "search", "parameters" : [ { "in" : "query", "name" : "category", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "matches", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "storefront_oid", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "max_hits", "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "query", "name" : "subcategory", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LookupResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Searches for all matching values", "tags" : [ "storefront" ] }, "post" : { "operationId" : "search2", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LookupRequest" } } }, "description" : "LookupRequest", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LookupResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Searches for all matching values (using POST)", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "lookup_request" } }, "/storefront/thumbnailParameters" : { "post" : { "operationId" : "getThumbnailParameters", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ThumbnailParametersRequest" } } }, "description" : "Thumbnail Parameters", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ThumbnailParametersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get thumbnail parameters", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "thumbnail_parameters" } }, "/storefront/twilio/accounts" : { "get" : { "operationId" : "getTwilioAccounts", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TwiliosResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get all Twilio accounts", "tags" : [ "storefront" ] }, "post" : { "operationId" : "createTwilioAccount", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Twilio" } } }, "description" : "Twilio", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TwilioResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Create Twilio account", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "twilio" } }, "/storefront/twilio/accounts/{esp_twilio_uuid}" : { "delete" : { "operationId" : "deleteTwilioAccount", "parameters" : [ { "in" : "path", "name" : "esp_twilio_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "delete Twilio account", "tags" : [ "storefront" ] }, "get" : { "operationId" : "getTwilioAccount", "parameters" : [ { "in" : "path", "name" : "esp_twilio_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TwilioResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get Twilio account", "tags" : [ "storefront" ] }, "put" : { "operationId" : "updateTwilioAccount", "parameters" : [ { "in" : "path", "name" : "esp_twilio_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Twilio" } } }, "description" : "Twilio", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TwilioResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Update Twilio account", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "twilio" } }, "/storefront/{id}/fs/dir" : { "get" : { "operationId" : "getFsDirectory", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "query", "name" : "path", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "storefront_fs_directory_oid", "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "query", "name" : "storefront_theme_oid", "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FileManagerPageResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get file manager directory", "tags" : [ "storefront" ] }, "post" : { "operationId" : "createFsDirectory", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "query", "name" : "name", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "parent_storefront_fs_directory_oid", "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FileManagerPageResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Create file manager directory", "tags" : [ "storefront" ] } }, "/storefront/{id}/fs/file" : { "delete" : { "operationId" : "deleteFsFile", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "query", "name" : "parent_storefront_fs_directory_oid", "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "query", "name" : "storefront_fs_file_oid", "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FileManagerPageResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Delete file manager directory", "tags" : [ "storefront" ] } }, "/storefront/{id}/fs/upload" : { "post" : { "operationId" : "uploadFsFile", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FileManagerUploadRequest" } } }, "description" : "UploadRequest", "required" : true }, "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "This is the last step in uploading a file after 1) calling getUploadFsFileUrl and 2) uploading a file to the provided url, then finally 3) calling this method and providing the key to trigger the server into reading the S3 bucket and retrieving the file.", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "upload_request" } }, "/storefront/{id}/fs/upload_url/{extension}" : { "get" : { "operationId" : "getUploadFsFileUrl", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "extension", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FileManagerUploadUrlResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Retrieves a S3 url where a file may be uploaded. Once uploaded, use uploadFsFile to trigger the server into reading the S3 bucket and retrieving the file.", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/editor_token" : { "get" : { "description" : "Fetches a temporary authentication token for the editor\n", "operationId" : "getEditorToken", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailEditorTokenResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Gets editor token", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/baseTemplates" : { "get" : { "operationId" : "getEmailBaseTemplates", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailBaseTemplateListResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email communication base templates", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/campaign_folders" : { "get" : { "operationId" : "getEmailCampaignFolders", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCampaignFoldersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email campaign folders", "tags" : [ "storefront" ] }, "post" : { "operationId" : "insertEmailCampaignFolder", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCampaignFolder" } } }, "description" : "Email campaign folder", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCampaignFolderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Insert email campaign folder", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_campaign_folder" } }, "/storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid}" : { "delete" : { "operationId" : "deleteEmailCampaignFolder", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_campaign_folder_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Delete email campaignFolder", "tags" : [ "storefront" ] }, "get" : { "operationId" : "getEmailCampaignFolder", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_campaign_folder_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCampaignFolderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email campaign folder", "tags" : [ "storefront" ] }, "put" : { "operationId" : "updateEmailCampaignFolder", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_campaign_folder_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCampaignFolder" } } }, "description" : "Email campaign folder", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCampaignFolderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Update email campaign folder", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_campaign_folder" } }, "/storefront/{storefront_oid}/email/campaigns" : { "get" : { "operationId" : "getEmailCampaigns", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCampaignsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email campaigns", "tags" : [ "storefront" ] }, "post" : { "operationId" : "insertEmailCampaign", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCampaign" } } }, "description" : "Email campaign", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCampaignResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Insert email campaign", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_campaign" } }, "/storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}" : { "get" : { "operationId" : "getEmailCampaign", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_campaign_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCampaignResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email campaign", "tags" : [ "storefront" ] }, "put" : { "operationId" : "updateEmailCampaign", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_campaign_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCampaign" } } }, "description" : "Email campaign", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCampaignResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Update email campaign", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_campaign" } }, "/storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/clone" : { "post" : { "operationId" : "cloneEmailCampaign", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_campaign_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "target_storefront_oid", "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCampaignResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Clone email campaign", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/screenshots" : { "get" : { "operationId" : "getEmailCampaignScreenshots", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_campaign_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenshotsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email campaign screenshots", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/start" : { "put" : { "operationId" : "startEmailCampaign", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_campaign_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Start email campaign", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/campaignsWithStats/{stat_days}" : { "get" : { "operationId" : "getEmailCampaignsWithStats", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "stat_days", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCampaignsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email campaigns with stats", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/commseqs" : { "get" : { "operationId" : "getEmailCommseqs", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email commseqs", "tags" : [ "storefront" ] }, "post" : { "operationId" : "insertEmailCommseq", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseq" } } }, "description" : "Email commseq", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Insert email commseq", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_commseq" } }, "/storefront/{storefront_oid}/email/commseqs/editorValues" : { "get" : { "operationId" : "getEmailCommseqEditorValues", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailEditorValuesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email merchant specific editor values", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}" : { "get" : { "operationId" : "getEmailCommseq", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email commseq", "tags" : [ "storefront" ] }, "put" : { "operationId" : "updateEmailCommseq", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseq" } } }, "description" : "Email commseq", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Update email commseq", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_commseq" } }, "/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/emailStats" : { "post" : { "operationId" : "getEmailCommseqEmailStats", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailStatSummaryRequest" } } }, "description" : "StatsRequest", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailStatSummaryResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email communication sequence emails stats", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "statsRequest" } }, "/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/postcardStats" : { "post" : { "operationId" : "getEmailCommseqPostcardStats", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailStatPostcardSummaryRequest" } } }, "description" : "StatsRequest", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailStatPostcardSummaryResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email communication sequence postcard stats", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "statsRequest" } }, "/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/rate_limiters" : { "delete" : { "operationId" : "resetEmailCommseqRateLimiters", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Reset email commseq rate limiters (only callable by UltraCart Support)", "tags" : [ "storefront" ] }, "get" : { "operationId" : "getEmailCommseqRateLimiters", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailRateLimitersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email commseq rate limiters", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/smsStats" : { "post" : { "operationId" : "getEmailCommseqSmsStats", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailStatSmsSummaryRequest" } } }, "description" : "StatsRequest", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailStatSmsSummaryResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email communication sequence sms stats", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "statsRequest" } }, "/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat" : { "delete" : { "operationId" : "deleteEmailCommseqStat", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Delete communication sequence stats", "tags" : [ "storefront" ] }, "get" : { "operationId" : "getEmailCommseqStatOverall", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqStatResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get communication sequence stats overall", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stepStats" : { "post" : { "operationId" : "getEmailCommseqStepStats", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailStepStatRequest" } } }, "description" : "StatsRequest", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailStepStatResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email communication sequence step stats", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "statsRequest" } }, "/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/emails/{commseq_email_uuid}/clicks" : { "get" : { "operationId" : "getEmailEmailClicks", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "commseq_step_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "commseq_email_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "days", "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailClicksResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email email clicks", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/emails/{commseq_email_uuid}/orders" : { "get" : { "operationId" : "getEmailEmailOrders", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "commseq_step_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "commseq_email_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "days", "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailOrdersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email email orders", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/logs" : { "get" : { "operationId" : "getEmailDispatchLogs", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "commseq_step_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqStepLogsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email dispatch logs", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/sms/orders" : { "get" : { "operationId" : "getEmailSmsOrders", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "commseq_step_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "days", "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailSmsOrdersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email sms orders", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/test" : { "post" : { "operationId" : "sequenceTest", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqSequenceTestRequest" } } }, "description" : "Commseq test request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqSequenceTestResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Sequence test", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_commseq_sequence_test_request" } }, "/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting" : { "post" : { "operationId" : "getEmailCommseqStepWaiting", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailStepWaitingRequest" } } }, "description" : "WaitingRequest", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailStepWaitingResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email communication sequence customers waiting at each requested step", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "waitingRequest" } }, "/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting/{commseq_step_uuid}" : { "post" : { "operationId" : "releaseEmailCommseqStepWaiting", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "commseq_step_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Release email communication sequence customers waiting at the specified step", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/webhookEditorValues" : { "get" : { "operationId" : "getEmailCommseqWebhookEditorValues", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailWebhookEditorValuesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email webhook editor values", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/countries" : { "get" : { "description" : "Obtain a list of all the countries\n", "operationId" : "getCountries", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CountriesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get countries", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/customers" : { "get" : { "operationId" : "getEmailCustomers", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "query", "name" : "pageNumber", "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "query", "name" : "pageSize", "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "query", "name" : "searchEmailPrefix", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCustomersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email customers", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/customers/{email_customer_uuid}" : { "put" : { "operationId" : "updateEmailCustomer", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_customer_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCustomer" } } }, "description" : "Email customer", "required" : true }, "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Update email customer", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_customer" } }, "/storefront/{storefront_oid}/email/customers/{email_customer_uuid}/editor_url" : { "get" : { "operationId" : "getEmailCustomerEditorUrl", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_customer_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCustomerEditorUrlResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get customers editor URL", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/dashboard_activity" : { "get" : { "operationId" : "getEmailDashboardActivity", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "query", "name" : "last_records", "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailDashboardActivityResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email dashboard activity", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/dashboard_stats" : { "get" : { "operationId" : "getEmailDashboardStats", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "query", "name" : "days", "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailDashboardStatsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get dashboard stats", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/emails" : { "get" : { "operationId" : "getEmailEmails", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqEmailsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email emails", "tags" : [ "storefront" ] }, "post" : { "operationId" : "insertEmailEmail", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqEmail" } } }, "description" : "Email email", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqEmailResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Insert email email", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_commseq_email" } }, "/storefront/{storefront_oid}/email/emails/multiple" : { "post" : { "operationId" : "getEmailEmailsMultiple", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqEmailsRequest" } } }, "description" : "Request of email uuids", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqEmailsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email emails multiple", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_commseq_emails_request" } }, "/storefront/{storefront_oid}/email/emails/{commseq_email_uuid}" : { "delete" : { "operationId" : "deleteEmailEmail", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_email_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Delete email email", "tags" : [ "storefront" ] }, "get" : { "operationId" : "getEmailEmail", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_email_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqEmailResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email email", "tags" : [ "storefront" ] }, "put" : { "operationId" : "updateEmailEmail", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_email_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqEmail" } } }, "description" : "Email commseq email", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqEmailResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Update email email", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_commseq_email" } }, "/storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/orders/{order_id}/editor_url" : { "get" : { "operationId" : "getEmailEmailCustomerEditorUrl", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_email_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCustomerEditorUrlResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email order customer editor url", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/review" : { "post" : { "operationId" : "review", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_email_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqEmailSendTestRequest" } } }, "description" : "Email commseq email review request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqEmailSendTestResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Request a review of an email", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_commseq_email_review_request" } }, "/storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/test" : { "post" : { "operationId" : "sendEmailTest", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_email_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqEmailSendTestRequest" } } }, "description" : "Email commseq email test request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqEmailSendTestResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Send email test", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_commseq_email_test_request" } }, "/storefront/{storefront_oid}/email/flow_folders" : { "get" : { "operationId" : "getEmailFlowFolders", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailFlowFoldersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email flow folders", "tags" : [ "storefront" ] }, "post" : { "operationId" : "insertEmailFlowFolder", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailFlowFolder" } } }, "description" : "Email flow folder", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailFlowFolderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Insert email flow folder", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_flow_folder" } }, "/storefront/{storefront_oid}/email/flow_folders/{email_flow_folder_uuid}" : { "delete" : { "operationId" : "deleteEmailFlowFolder", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_flow_folder_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Delete email flowFolder", "tags" : [ "storefront" ] }, "get" : { "operationId" : "getEmailFlowFolder", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_flow_folder_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailFlowFolderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email flow folder", "tags" : [ "storefront" ] }, "put" : { "operationId" : "updateEmailFlowFolder", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_flow_folder_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailFlowFolder" } } }, "description" : "Email flow folder", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailFlowFolderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Update email flow folder", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_flow_folder" } }, "/storefront/{storefront_oid}/email/flows" : { "get" : { "operationId" : "getEmailFlows", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailFlowsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email flows", "tags" : [ "storefront" ] }, "post" : { "operationId" : "insertEmailFlow", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailFlow" } } }, "description" : "Email flow", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailFlowResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Insert email flow", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_flow" } }, "/storefront/{storefront_oid}/email/flows/{email_flow_uuid}" : { "get" : { "operationId" : "getEmailFlow", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_flow_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailFlowResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email flow", "tags" : [ "storefront" ] }, "put" : { "operationId" : "updateEmailFlow", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_flow_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailFlow" } } }, "description" : "Email flow", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailFlowResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Update email flow", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_flow" } }, "/storefront/{storefront_oid}/email/flows/{email_flow_uuid}/backfill" : { "post" : { "operationId" : "backPopulateEmailFlow", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_flow_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailFlowBackPopulateRequest" } } }, "description" : "The request to back populate", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailFlowBackPopulateResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Back populate email flow", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "back_populate_request" } }, "/storefront/{storefront_oid}/email/flows/{email_flow_uuid}/clone" : { "post" : { "operationId" : "cloneEmailFlow", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_flow_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "target_storefront_oid", "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailFlowResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Clone email flow", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/flows/{email_flow_uuid}/screenshots" : { "get" : { "operationId" : "getEmailFlowScreenshots", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_flow_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenshotsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email flow screenshots", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/geocode" : { "post" : { "operationId" : "geocodeAddress", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GeocodeRequest" } } }, "description" : "geocode request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GeocodeResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Obtain lat/long for an address", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "geocode_request" } }, "/storefront/{storefront_oid}/email/globalUnsubscribe" : { "post" : { "operationId" : "globalUnsubscribe", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailGlobalUnsubscribeRequest" } } }, "description" : "Unsubscribe", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailGlobalUnsubscribeResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Globally unsubscribe a customer", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "unsubscribe" } }, "/storefront/{storefront_oid}/email/histogram/property_names" : { "get" : { "description" : "Obtain a list of property names for a given property type\n", "operationId" : "getHistogramPropertyNames", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "query", "name" : "property_type", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailHistogramPropertyNamesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get histogram property names", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/histogram/property_values" : { "get" : { "description" : "Obtain a list of property values for a given property name and type\n", "operationId" : "getHistogramPropertyValues", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "query", "name" : "property_name", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "property_type", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "limit", "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailHistogramPropertyValuesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get histogram property values", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/list_segment_folders" : { "get" : { "operationId" : "getEmailListSegmentFolders", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailListSegmentFoldersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email campaign folders", "tags" : [ "storefront" ] }, "post" : { "operationId" : "insertEmailListSegmentFolder", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailListSegmentFolder" } } }, "description" : "Email campaign folder", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailListSegmentFolderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Insert email campaign folder", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_list_segment_folder" } }, "/storefront/{storefront_oid}/email/list_segment_folders/{email_list_segment_folder_uuid}" : { "delete" : { "operationId" : "deleteEmailListSegmentFolder", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_list_segment_folder_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Delete email ListSegmentFolder", "tags" : [ "storefront" ] }, "get" : { "operationId" : "getEmailListSegmentFolder", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_list_segment_folder_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailListSegmentFolderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email campaign folder", "tags" : [ "storefront" ] }, "put" : { "operationId" : "updateEmailListSegmentFolder", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_list_segment_folder_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailListSegmentFolder" } } }, "description" : "Email campaign folder", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailListSegmentFolderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Update email campaign folder", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_list_segment_folder" } }, "/storefront/{storefront_oid}/email/lists" : { "get" : { "operationId" : "getEmailLists", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailListsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email lists", "tags" : [ "storefront" ] }, "post" : { "operationId" : "insertEmailList", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailList" } } }, "description" : "Email list", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailListResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Insert email list", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_list" } }, "/storefront/{storefront_oid}/email/lists/{email_list_uuid}" : { "get" : { "operationId" : "getEmailList", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_list_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailListResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email list", "tags" : [ "storefront" ] }, "put" : { "operationId" : "updateEmailList", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_list_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailList" } } }, "description" : "Email list", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailListResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Update email list", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_list" } }, "/storefront/{storefront_oid}/email/lists/{email_list_uuid}/archive" : { "post" : { "operationId" : "archiveEmailList", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_list_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailListArchiveResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Archive email list", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers" : { "get" : { "operationId" : "getEmailListCustomers", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_list_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "pageNumber", "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "query", "name" : "pageSize", "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailListCustomersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email list customers", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers/{email_customer_uuid}" : { "delete" : { "operationId" : "deleteEmailListCustomer", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_list_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "email_customer_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Delete email list customer", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/lists/{email_list_uuid}/customers/{email_customer_uuid}/editor_url" : { "get" : { "operationId" : "getEmailListCustomerEditorUrl", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_list_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "email_customer_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCustomerEditorUrlResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email list customer editor url", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/lists/{email_list_uuid}/search" : { "get" : { "operationId" : "searchEmailListCustomers", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_list_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "startsWith", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailListCustomersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Search email list customers", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/lists/{email_list_uuid}/subscribe" : { "post" : { "operationId" : "subscribeToEmailList", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_list_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "items" : { "$ref" : "#/components/schemas/EmailCustomer" }, "type" : "array" } } }, "description" : "Customers", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailListSubscribeResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Subscribe customers to email list", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "customers" } }, "/storefront/{storefront_oid}/email/performance" : { "get" : { "operationId" : "getEmailPerformance", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailPerformanceResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email performance", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/plan" : { "get" : { "operationId" : "getEmailPlan", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailPlanResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email plan", "tags" : [ "storefront" ] }, "post" : { "operationId" : "updateEmailPlan", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailPlan" } } }, "description" : "plan request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailPlanResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Update email plan", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "settings" } }, "/storefront/{storefront_oid}/email/postcards" : { "get" : { "operationId" : "getEmailPostcards", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqPostcardsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email postcards", "tags" : [ "storefront" ] }, "post" : { "operationId" : "insertEmailPostcard", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqPostcard" } } }, "description" : "Email postcard", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqPostcardResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Insert email postcard", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_commseq_postcard" } }, "/storefront/{storefront_oid}/email/postcards/multiple" : { "post" : { "operationId" : "getEmailPostcardsMultiple", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqPostcardsRequest" } } }, "description" : "Request of postcard uuids", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqPostcardsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email postcards multiple", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_commseq_postcards_request" } }, "/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}" : { "delete" : { "operationId" : "deleteEmailPostcard", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_postcard_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Delete email postcard", "tags" : [ "storefront" ] }, "get" : { "operationId" : "getEmailPostcard", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_postcard_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqPostcardResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email postcard", "tags" : [ "storefront" ] }, "put" : { "operationId" : "updateEmailPostcard", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_postcard_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqPostcard" } } }, "description" : "Email commseq postcard", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqPostcardResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Update email postcard", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_commseq_postcard" } }, "/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/test" : { "post" : { "operationId" : "sendPostcardTest", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_postcard_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqPostcardSendTestRequest" } } }, "description" : "Email commseq email test request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqPostcardSendTestResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Send postcard test", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_commseq_postcard_test_request" } }, "/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking" : { "get" : { "operationId" : "getEmailCommseqPostcardTracking", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_postcard_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailPostcardTrackingResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email communication postcard tracking", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/segments" : { "get" : { "operationId" : "getEmailSegments", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailSegmentsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email segments", "tags" : [ "storefront" ] }, "post" : { "operationId" : "insertEmailSegment", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailSegment" } } }, "description" : "Email segment", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailSegmentResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Insert email segment", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_segment" } }, "/storefront/{storefront_oid}/email/segments/{email_segment_uuid}" : { "get" : { "operationId" : "getEmailSegment", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_segment_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailSegmentResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email segment", "tags" : [ "storefront" ] }, "put" : { "operationId" : "updateEmailSegment", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_segment_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailSegment" } } }, "description" : "Email segment", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailSegmentResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Update email segment", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_segment" } }, "/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/archive" : { "post" : { "operationId" : "archiveEmailSegment", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_segment_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailSegmentArchiveResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Archive email segment", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/customers" : { "get" : { "operationId" : "getEmailSegmentCustomers", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_segment_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "pageNumber", "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "query", "name" : "pageSize", "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailSegmentCustomersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email segment customers", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/customers/{email_customer_uuid}/editor_url" : { "get" : { "operationId" : "getEmailSegmentCustomerEditorUrl", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_segment_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "email_customer_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCustomerEditorUrlResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email segment customers editor URL", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/downloadPrepare" : { "post" : { "operationId" : "prepareDownloadEmailSegment", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_segment_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailSegmentDownloadPrepareResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Prepare download of email segment", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/downloadPrepare/{email_segment_rebuild_uuid}" : { "post" : { "operationId" : "checkDownloadEmailSegment", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_segment_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "email_segment_rebuild_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailSegmentDownloadPrepareResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Check download of email segment", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/search" : { "get" : { "operationId" : "searchEmailSegmentCustomers", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_segment_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "startsWith", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailSegmentCustomersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Search email segment customers", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/segments/{email_segment_uuid}/sunset" : { "put" : { "operationId" : "sunsetEmailSegment", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_segment_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Sunset email segment", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/settings" : { "get" : { "operationId" : "getEmailSettings", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailSettingsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email settings", "tags" : [ "storefront" ] }, "post" : { "operationId" : "updateEmailSettings", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailSettings" } } }, "description" : "settings request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailSettingsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Update email settings", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "settings" } }, "/storefront/{storefront_oid}/email/sms/{commseq_uuid}/{commseq_step_uuid}/test" : { "post" : { "operationId" : "sendSmsTest", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "commseq_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "commseq_step_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqSmsSendTestRequest" } } }, "description" : "Email commseq sms test request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqSmsSendTestResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Send SMS test", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_commseq_sms_test_request" } }, "/storefront/{storefront_oid}/email/templates" : { "get" : { "operationId" : "getEmailTemplates", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "query", "name" : "trigger_type", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailTemplatesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email templates", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/templates/{email_template_oid}" : { "get" : { "operationId" : "getEmailTemplate", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_template_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailTemplate" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get email template", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/third_party_providers" : { "get" : { "operationId" : "getEmailThirdPartyProviders", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailThirdPartyProvidersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get a list of third party email providers", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/email/third_party_providers/import" : { "post" : { "operationId" : "importEmailThirdPartyProviderList", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailThirdPartyListImportRequest" } } }, "description" : "lists to import", "required" : true }, "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Import a third party provider list", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "import_request" } }, "/storefront/{storefront_oid}/email/webhooks/test" : { "post" : { "operationId" : "sendWebhookTest", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqWebhookSendTestRequest" } } }, "description" : "Email commseq webhook test request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailCommseqWebhookSendTestResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Send webhook test", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "email_commseq_webhook_test_request" } }, "/storefront/{storefront_oid}/experiments" : { "get" : { "operationId" : "getExperiments", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ExperimentsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get experiments", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/experiments/{storefront_experiment_oid}" : { "delete" : { "operationId" : "deleteExperiment", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "storefront_experiment_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Delete experiment", "tags" : [ "storefront" ] }, "put" : { "operationId" : "updateExperiment", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "storefront_experiment_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Experiment" } } }, "description" : "Experiment", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ExperimentResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Update experiment", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "experiment" } }, "/storefront/{storefront_oid}/pages/{page_oid}/content/attributes" : { "post" : { "description" : "Update a page content attribute, creating it new if it does not yet exist.\n", "operationId" : "insertUpdatePageContentAttribute", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The page oid to modify.", "in" : "path", "name" : "page_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/StoreFrontPageContentAttribute" } } }, "description" : "Page content attribute to upsert", "required" : true }, "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Upsert a page content attribute", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "page_attribute" } }, "/storefront/{storefront_oid}/screen_recordings/heatmap" : { "delete" : { "description" : "Delete screen recording heatmap\n", "operationId" : "deleteHeatmap", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenRecordingHeatmapReset" } } }, "description" : "Query", "required" : true }, "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete screen recording heatmap", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "query" }, "post" : { "description" : "Get screen recording heatmap\n", "operationId" : "getHeatmap", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenRecordingHeatmapRequest" } } }, "description" : "Query", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenRecordingHeatmapResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get screen recording heatmap", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "query" } }, "/storefront/{storefront_oid}/screen_recordings/heatmap/index" : { "post" : { "description" : "Get screen recording heatmap index\n", "operationId" : "getHeatmapIndex", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The maximum number of records to return on this one API call. (Default 100, Max 500)", "in" : "query", "name" : "_limit", "schema" : { "default" : 100, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.", "in" : "query", "name" : "_sort", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenRecordingHeatmapIndexRequest" } } }, "description" : "Query", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenRecordingHeatmapIndexResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get screen recording heatmap index", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "query" } }, "/storefront/{storefront_oid}/screen_recordings/query" : { "post" : { "description" : "Query screen recordings\n", "operationId" : "getScreenRecordingsByQuery", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The maximum number of records to return on this one API call. (Default 100, Max 500)", "in" : "query", "name" : "_limit", "schema" : { "default" : 100, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.", "in" : "query", "name" : "_sort", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenRecordingQueryRequest" } } }, "description" : "Query", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenRecordingQueryResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Query screen recordings", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "query" } }, "/storefront/{storefront_oid}/screen_recordings/segments" : { "get" : { "operationId" : "getScreenRecordingSegments", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenRecordingSegmentsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get screen recording segments", "tags" : [ "storefront" ] }, "post" : { "operationId" : "insertScreenRecordingSegment", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenRecordingSegment" } } }, "description" : "Segment", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenRecordingSegmentResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Insert screen recording segment", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "segment" } }, "/storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid}" : { "delete" : { "operationId" : "deleteScreenRecordingSegment", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "screen_recording_segment_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Delete screen recording segment", "tags" : [ "storefront" ] }, "get" : { "operationId" : "getScreenRecordingSegment", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "screen_recording_segment_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenRecordingSegmentResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get screen recording segment", "tags" : [ "storefront" ] }, "post" : { "operationId" : "updateScreenRecordingSegment", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "screen_recording_segment_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenRecordingSegment" } } }, "description" : "Segment", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenRecordingSegmentResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Update screen recording segment", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "segment" } }, "/storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid}/query" : { "post" : { "description" : "Get screen recordings by segment\n", "operationId" : "getScreenRecordingsBySegment", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "screen_recording_segment_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The maximum number of records to return on this one API call. (Default 100, Max 500)", "in" : "query", "name" : "_limit", "schema" : { "default" : 100, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.", "in" : "query", "name" : "_sort", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenRecordingQueryResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get screen recordings by segment", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/screen_recordings/settings" : { "get" : { "operationId" : "getScreenRecordingSettings", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenRecordingSettingsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get screen recording settings", "tags" : [ "storefront" ] }, "post" : { "operationId" : "updateScreenRecordingSettings", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenRecordingSettings" } } }, "description" : "Settings", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenRecordingSettingsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Update screen recording settings", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "settings" } }, "/storefront/{storefront_oid}/screen_recordings/tags" : { "post" : { "description" : "Get tags used by screen recording\n", "operationId" : "getScreenRecordingTags", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenRecordingTagsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get tags used by screen recording", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}" : { "get" : { "description" : "Get screen recording\n", "operationId" : "getScreenRecording", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "screen_recording_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenRecordingResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get screen recording", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite" : { "delete" : { "description" : "Remove favorite flag on screen recording\n", "operationId" : "unfavoriteScreenRecording", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "screen_recording_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Remove favorite flag on screen recording", "tags" : [ "storefront" ] }, "post" : { "description" : "Update favorite flag on screen recording\n", "operationId" : "favoriteScreenRecording", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "screen_recording_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update favorite flag on screen recording", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/merchant_notes" : { "post" : { "description" : "Update merchant notes on a screen recording\n", "operationId" : "updateScreenRecordingMerchantNotes", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "screen_recording_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenRecordingMerchantNotesRequest" } } }, "description" : "Merchant Notes", "required" : true }, "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update merchant notes on a screen recording", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "merchant_notes_request" } }, "/storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/page_view_data/{screen_recording_page_view_uuid}" : { "get" : { "description" : "Get screen recording page view data\n", "operationId" : "getScreenRecordingPageViewData", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "screen_recording_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "screen_recording_page_view_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenRecordingPageViewDataResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get screen recording page view data", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/tags" : { "post" : { "description" : "Update tags on a screen recording\n", "operationId" : "updateScreenRecordingTags", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "screen_recording_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenRecordingTagsRequest" } } }, "description" : "Tags", "required" : true }, "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update tags on a screen recording", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "tags" } }, "/storefront/{storefront_oid}/transaction_email/list" : { "get" : { "description" : "Obtain a list of all transactional emails and return back just their names\n", "operationId" : "getTransactionEmailList", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TransactionEmailListResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Gets a list of transaction email names", "tags" : [ "storefront" ] } }, "/storefront/{storefront_oid}/transaction_email/list/{email_id}" : { "get" : { "description" : "Fetch a transactional email\n", "operationId" : "getTransactionEmail", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TransactionEmailResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Gets a transaction email object", "tags" : [ "storefront" ] }, "put" : { "description" : "Updates a transactional email\n", "operationId" : "updateTransactionEmail", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TransactionEmail" } } }, "description" : "TransactionEmail", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TransactionEmailResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Updates a transaction email object", "tags" : [ "storefront" ], "x-codegen-request-body-name" : "transaction_email" } }, "/storefront/{storefront_oid}/transaction_email/list/{email_id}/screenshots" : { "get" : { "operationId" : "getTransactionEmailScreenshots", "parameters" : [ { "in" : "path", "name" : "storefront_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "email_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScreenshotsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "storefront_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get transactional email screenshots", "tags" : [ "storefront" ] } }, "/sso/authorize" : { "put" : { "description" : "Starts the process of authorizing a single sign on session.\n", "operationId" : "ssoAuthorize", "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/SingleSignOnAuthorizeRequest" } } }, "description" : "Authorization request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SingleSignOnAuthorizeResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "sso_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Authorize a single sign on session", "tags" : [ "sso" ], "x-codegen-request-body-name" : "authorization_request" } }, "/sso/session/revoke" : { "delete" : { "description" : "This is the equivalent of logging out of the single sign on session\n", "operationId" : "ssoSessionRevoke", "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "sso_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Revoke single sign on session", "tags" : [ "sso" ] } }, "/sso/session/user" : { "get" : { "description" : "This is the equivalent of logging out of the single sign on session\n", "operationId" : "getSsoSessionUser", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/User" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "sso_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get single sign on session user", "tags" : [ "sso" ] } }, "/sso/token" : { "put" : { "description" : "Called by your application after receiving the code back on the redirect URI to obtain a simple key token to make API calls with\n", "operationId" : "ssoToken", "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/SingleSignOnTokenRequest" } } }, "description" : "Token request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SingleSignOnTokenResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "sso_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Exchange a single sign on code for a simple key token", "tags" : [ "sso" ], "x-codegen-request-body-name" : "token_request" } }, "/affiliate/clicks/query" : { "post" : { "description" : "Retrieves a group of clicks from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the clicks returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.\n", "operationId" : "getClicksByQuery", "parameters" : [ { "description" : "The maximum number of records to return on this one API call. (Maximum 10000)", "in" : "query", "name" : "_limit", "schema" : { "default" : 10000, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "The object expansion to perform on the result. Only option is link.", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AffiliateClickQuery" } } }, "description" : "Click query", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AffiliateClicksResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "affiliate_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve clicks", "tags" : [ "affiliate" ], "x-codegen-request-body-name" : "click_query" } }, "/affiliate/ledgers/query" : { "post" : { "description" : "Retrieves a group of ledger entries from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the ledgers returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.\n", "operationId" : "getLedgersByQuery", "parameters" : [ { "description" : "The maximum number of records to return on this one API call. (Maximum 200)", "in" : "query", "name" : "_limit", "schema" : { "default" : 100, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "The object expansion to perform on the result. Only option is link.", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AffiliateLedgerQuery" } } }, "description" : "Ledger query", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AffiliateLedgersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "affiliate_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve ledger entries", "tags" : [ "affiliate" ], "x-codegen-request-body-name" : "ledger_query" } }, "/conversation/agent/auth" : { "put" : { "description" : "Retrieve a JWT to authorize an agent to make a websocket connection.\n", "operationId" : "getAgentWebsocketAuthorization", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationAgentAuthResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get agent websocket authorization", "tags" : [ "conversation" ] } }, "/conversation/agent/keepalive" : { "get" : { "description" : "Called periodically by the conversation API to keep the session alive.\n", "operationId" : "getAgentKeepAlive", "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Agent keep alive", "tags" : [ "conversation" ] } }, "/conversation/agent/profile" : { "get" : { "description" : "Retrieve the agents profile\n", "operationId" : "getAgentProfile", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationAgentProfileResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get agent profile", "tags" : [ "conversation" ] }, "put" : { "description" : "Update agent profile\n", "operationId" : "updateAgentProfile", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationAgentProfile" } } }, "description" : "Profile request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationAgentProfileResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update agent profile", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "profile_request" } }, "/conversation/agent/profiles" : { "get" : { "description" : "Retrieve the agents profile\n", "operationId" : "getAgentProfiles", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationAgentProfilesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get agent profiles", "tags" : [ "conversation" ] } }, "/conversation/agent/profiles/{user_id}/knowledge_base" : { "get" : { "description" : "Retrieve knowledge base documents\n", "operationId" : "getAgentProfileKnowledgeBase", "parameters" : [ { "in" : "path", "name" : "user_id", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationKnowledgeBaseDocumentsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get the list of knowledge base documents associated with this agent profile", "tags" : [ "conversation" ] }, "post" : { "description" : "Insert a knowledge base document\n", "operationId" : "insertAgentProfileKnowledgeBaseDocument", "parameters" : [ { "in" : "path", "name" : "user_id", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationInsertKnowledgeBaseDocumentRequest" } } }, "description" : "Insert request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationInsertKnowledgeBaseDocumentResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Insert a knowledge base document", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "knowledge_base_document_request" } }, "/conversation/agent/profiles/{user_id}/knowledge_base/upload_url/{extension}" : { "get" : { "description" : "Get a pre-signed conversation knowledge base document upload URL\n", "operationId" : "getConversationKnowledgeBaseDocumentUploadUrl", "parameters" : [ { "in" : "path", "name" : "user_id", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "extension", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationKnowledgeBaseDocumentUploadUrlResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get a pre-signed conversation knowledge base document upload URL", "tags" : [ "conversation" ] } }, "/conversation/agent/profiles/{user_id}/knowledge_base/{document_uuid}" : { "delete" : { "description" : "Delete a knowledge base document\n", "operationId" : "deleteAgentProfileKnowledgeBaseDocument", "parameters" : [ { "in" : "path", "name" : "user_id", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "document_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationDeleteKnowledgeBaseDocumentResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete a knowledge base document", "tags" : [ "conversation" ] } }, "/conversation/agent/profiles/{user_id}/mcps" : { "get" : { "description" : "Retrieve MCP servers associated with this agent\n", "operationId" : "getAgentProfileMcps", "parameters" : [ { "in" : "path", "name" : "user_id", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationMcpServersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get the list of MCP servers associated with this agent", "tags" : [ "conversation" ] }, "post" : { "description" : "Insert an agent MCP server\n", "operationId" : "insertAgentProfileMcp", "parameters" : [ { "in" : "path", "name" : "user_id", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationMcpServer" } } }, "description" : "MCP Server", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationMcpServerResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Insert an agent MCP server", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "mcp_server" } }, "/conversation/agent/profiles/{user_id}/mcps/{mcp_server_uuid}" : { "delete" : { "description" : "Delete an agent MCP server\n", "operationId" : "deleteAgentProfileMcp", "parameters" : [ { "in" : "path", "name" : "user_id", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "mcp_server_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete an agent MCP server", "tags" : [ "conversation" ] }, "get" : { "description" : "Retrieve MCP server associated with this agent\n", "operationId" : "getAgentProfileMcp", "parameters" : [ { "in" : "path", "name" : "user_id", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "mcp_server_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationMcpServerResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get an MCP server associated with this agent", "tags" : [ "conversation" ] }, "post" : { "description" : "Update an agent MCP server\n", "operationId" : "updateAgentProfileMcp", "parameters" : [ { "in" : "path", "name" : "user_id", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "mcp_server_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationMcpServer" } } }, "description" : "MCP Server", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationMcpServerResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update an agent MCP server", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "mcp_server" } }, "/conversation/agent/profiles/{user_id}/mcps/{mcp_server_uuid}/tools" : { "get" : { "description" : "Get the tools available from the MCP server\n", "operationId" : "getAgentProfileMcpTools", "parameters" : [ { "in" : "path", "name" : "user_id", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "mcp_server_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationMcpServerToolsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get the tools available from the MCP server", "tags" : [ "conversation" ] } }, "/conversation/agent/status/config" : { "get" : { "description" : "Returns all custom statuses (active and soft-deactivated) for the merchant.\n", "operationId" : "getAgentStatusConfigs", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationAgentStatusConfigsResponse" } } }, "description" : "Successful response" }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "List custom agent statuses", "tags" : [ "conversation" ] }, "post" : { "description" : "Create a custom status. Enforces a 20-active-status-per-merchant cap and the 50-Twilio-Activity-per-workspace cap.\n", "operationId" : "insertAgentStatusConfig", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationAgentStatusConfig" } } }, "description" : "Status config", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationAgentStatusConfigResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Create a custom agent status", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "status_config" } }, "/conversation/agent/status/config/{conversation_status_uuid}" : { "delete" : { "description" : "Sets active=false on the row and the DDB sync record. The Twilio Activity is preserved (Round 2 decision) so historic worker reporting still resolves the SID.\n", "operationId" : "deleteAgentStatusConfig", "parameters" : [ { "in" : "path", "name" : "conversation_status_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Soft-deactivate a custom agent status", "tags" : [ "conversation" ] }, "put" : { "description" : "Update a custom status. Renaming flows through to the Twilio Activity.\n", "operationId" : "updateAgentStatusConfig", "parameters" : [ { "in" : "path", "name" : "conversation_status_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationAgentStatusConfig" } } }, "description" : "Status config", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationAgentStatusConfigResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update a custom agent status", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "status_config" } }, "/conversation/agent/status/heatmap" : { "post" : { "description" : "Returns ECharts-shaped agent x hour grid for the requested metric (availability, call_volume, chat_volume). Multi-day requests average the cell values across the date range.\n", "operationId" : "getAgentStatusHeatmap", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationAgentStatusHeatmapRequest" } } }, "description" : "Heatmap request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationAgentStatusHeatmapResponse" } } }, "description" : "Successful response" } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Agent x hour-of-day heatmap", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "heatmap_request" } }, "/conversation/agent/status/history/search" : { "post" : { "description" : "Paginated search over conversation_agent_status_events_all. Filters: agent_user_id, channel, status, trigger, date range.\n", "operationId" : "searchAgentStatusHistory", "parameters" : [ { "description" : "Maximum records per call (max 200)", "in" : "query", "name" : "_limit", "schema" : { "default" : 100, "type" : "integer" } }, { "description" : "Pagination offset (zero-based)", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationAgentStatusHistorySearchRequest" } } }, "description" : "Search request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationAgentStatusHistorySearchResponse" } } }, "description" : "Successful response" } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Search agent status history", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "search_request" } }, "/conversation/agent/status/history/{agent_user_id}/timeline" : { "get" : { "description" : "Returns merged status events + PBX calls + chat conversations for the agent on the given date. Omitting the channel parameter returns both channels merged.\n", "operationId" : "getAgentStatusTimeline", "parameters" : [ { "in" : "path", "name" : "agent_user_id", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "date", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "channel", "schema" : { "type" : "string" } }, { "description" : "Day to retrieve (YYYY-MM-DD)", "in" : "query", "name" : "date", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Restrict to one channel (omit for both)", "in" : "query", "name" : "channel", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationAgentStatusTimelineResponse" } } }, "description" : "Successful response" } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Day timeline for a single agent", "tags" : [ "conversation" ] } }, "/conversation/agent/status/rollup/search" : { "post" : { "description" : "Aggregated over conversation_agent_status_events_all via date_histogram + terms. Returns one row per (agent, day, channel).\n", "operationId" : "searchAgentStatusRollups", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationAgentStatusRollupSearchRequest" } } }, "description" : "Search request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationAgentStatusRollupSearchResponse" } } }, "description" : "Successful response" } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Search per-(agent, day) rollups", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "search_request" } }, "/conversation/agent/status/rollup/summary" : { "get" : { "description" : "Top-line summary: total_agents, avg_available_pct, status_breakdown, per-agent rollups.\n", "operationId" : "getAgentStatusSummary", "parameters" : [ { "in" : "query", "name" : "date_start", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "date_end", "schema" : { "type" : "string" } }, { "description" : "Range start (YYYY-MM-DD)", "in" : "query", "name" : "date_start", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Range end (YYYY-MM-DD)", "in" : "query", "name" : "date_end", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationAgentStatusSummaryResponse" } } }, "description" : "Successful response" } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Dashboard summary for a date range", "tags" : [ "conversation" ] } }, "/conversation/canned_messages" : { "get" : { "description" : "Retrieve a list of canned messages ordered by short_code\n", "operationId" : "getConversationCannedMessages", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationCannedMessagesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve a list of canned messages ordered by short_code", "tags" : [ "conversation" ] }, "post" : { "description" : "Insert a canned message\n", "operationId" : "insertConversationCannedMessage", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationCannedMessage" } } }, "description" : "Canned message", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationCannedMessageResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Insert a canned message", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "canned_message" } }, "/conversation/canned_messages/search" : { "post" : { "description" : "Search for canned messages by short_code\n", "operationId" : "searchConversationCannedMessages", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationCannedMessagesSearch" } } }, "description" : "Search request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationCannedMessagesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Search for canned messages by short_code", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "search_request" } }, "/conversation/canned_messages/{conversation_canned_message_oid}" : { "delete" : { "description" : "Delete a conversation canned message\n", "operationId" : "deleteConversationCannedMessage", "parameters" : [ { "in" : "path", "name" : "conversation_canned_message_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete a conversation canned message", "tags" : [ "conversation" ] }, "put" : { "description" : "Update a canned message\n", "operationId" : "updateConversationCannedMessage", "parameters" : [ { "in" : "path", "name" : "conversation_canned_message_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationCannedMessage" } } }, "description" : "Canned message", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationCannedMessageResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update a canned message", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "canned_message" } }, "/conversation/conversations" : { "get" : { "description" : "Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.\n", "operationId" : "getConversations", "parameters" : [ { "in" : "query", "name" : "medium", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "before", "schema" : { "type" : "string" } }, { "description" : "The maximum number of records to return on this one API call. (Max 200)", "in" : "query", "name" : "_limit", "schema" : { "default" : 100, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve a list of conversation summaries newest to oldest", "tags" : [ "conversation" ] }, "put" : { "description" : "Start a new conversation\n", "operationId" : "startConversation", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationStartRequest" } } }, "description" : "Start request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationStartResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Start a conversation", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "start_request" } }, "/conversation/conversations/autocomplete" : { "post" : { "description" : "Retrieve a list of matching terms for a search field\n", "operationId" : "getConversationsAutocomplete", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationAutocompleteRequest" } } }, "description" : "Autocomplete Request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationAutocompleteResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve a list of matching terms for a search field", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "autocomplete_request" } }, "/conversation/conversations/queues/statuses" : { "get" : { "description" : "Retrieve a conversation webchat queue statuses including agent status and queue entries\n", "operationId" : "getConversationWebchatQueueStatuses", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationWebchatQueueStatusesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve a conversation webchat queue statuses", "tags" : [ "conversation" ] } }, "/conversation/conversations/queues/{queue_name}/status" : { "put" : { "description" : "Update status within the queue\n", "operationId" : "updateConversationWebchatQueueStatus", "parameters" : [ { "in" : "path", "name" : "queue_name", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationWebchatQueueStatusUpdateRequest" } } }, "description" : "Status request", "required" : true }, "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update status within the queue", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "status_request" } }, "/conversation/conversations/search" : { "post" : { "description" : "Search conversations\n", "operationId" : "getConversationsSearch", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationSearchRequest" } } }, "description" : "Search Request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationSearchResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Search conversations", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "search_request" } }, "/conversation/conversations/{conversation_uuid}" : { "get" : { "description" : "Retrieve a conversation including the participants and messages\n", "operationId" : "getConversation", "parameters" : [ { "in" : "path", "name" : "conversation_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "limit", "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve a conversation", "tags" : [ "conversation" ] } }, "/conversation/conversations/{conversation_uuid}/context" : { "put" : { "description" : "Get a webchat conversation context\n", "operationId" : "getConversationContext", "parameters" : [ { "in" : "path", "name" : "conversation_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationWebchatContext" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get a webchat conversation context", "tags" : [ "conversation" ] } }, "/conversation/conversations/{conversation_uuid}/join" : { "put" : { "description" : "Join a conversation\n", "operationId" : "joinConversation", "parameters" : [ { "in" : "path", "name" : "conversation_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationJoinRequest" } } }, "description" : "Join request", "required" : false }, "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Join a conversation", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "join_request" } }, "/conversation/conversations/{conversation_uuid}/leave" : { "delete" : { "description" : "Leave a conversation\n", "operationId" : "leaveConversation", "parameters" : [ { "in" : "path", "name" : "conversation_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Leave a conversation", "tags" : [ "conversation" ] } }, "/conversation/conversations/{conversation_uuid}/markread" : { "put" : { "description" : "Mark a conversation as read\n", "operationId" : "markReadConversation", "parameters" : [ { "in" : "path", "name" : "conversation_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Mark a conversation as read", "tags" : [ "conversation" ] } }, "/conversation/conversations/{conversation_uuid}/messages/{since}" : { "get" : { "description" : "Retrieve conversation messages since a particular time\n", "operationId" : "getConversationMessages", "parameters" : [ { "in" : "path", "name" : "conversation_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "since", "required" : true, "schema" : { "format" : "int64", "type" : "integer" } }, { "in" : "query", "name" : "limit", "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationMessagesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve conversation messages", "tags" : [ "conversation" ] } }, "/conversation/conversations/{conversation_uuid}/sms_unsubscribe" : { "put" : { "description" : "Unsubscribe any SMS participants in this conversation\n", "operationId" : "smsUnsubscribeConversation", "parameters" : [ { "in" : "path", "name" : "conversation_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Unsubscribe any SMS participants in this conversation", "tags" : [ "conversation" ] } }, "/conversation/department_members" : { "get" : { "description" : "Retrieve a list of possible department members\n", "operationId" : "getConversationDepartmentMemberList", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationDepartmentMembersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve a list of possible department members", "tags" : [ "conversation" ] } }, "/conversation/departments" : { "get" : { "description" : "Retrieve a list of departments ordered by name\n", "operationId" : "getConversationDepartments", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationDepartmentsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve a list of departments ordered by name", "tags" : [ "conversation" ] }, "post" : { "description" : "Insert a department\n", "operationId" : "insertConversationDepartment", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationDepartment" } } }, "description" : "Department", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationDepartmentResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Insert a department", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "department" } }, "/conversation/departments/{conversation_department_oid}" : { "delete" : { "description" : "Delete a conversation department\n", "operationId" : "deleteDepartment", "parameters" : [ { "in" : "path", "name" : "conversation_department_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete a conversation department", "tags" : [ "conversation" ] }, "put" : { "description" : "Update a department\n", "operationId" : "updateConversationDepartment", "parameters" : [ { "in" : "path", "name" : "conversation_department_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationDepartment" } } }, "description" : "Department", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationDepartmentResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update a department", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "department" } }, "/conversation/engagements" : { "get" : { "description" : "Retrieve a list of engagements ordered by name\n", "operationId" : "getConversationEngagements", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationEngagementsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve a list of engagements ordered by name", "tags" : [ "conversation" ] }, "post" : { "description" : "Insert a engagement\n", "operationId" : "insertConversationEngagement", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationEngagement" } } }, "description" : "Engagement", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationEngagementResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Insert a engagement", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "engagement" } }, "/conversation/engagements/{conversation_engagement_oid}" : { "delete" : { "description" : "Delete a conversation engagement\n", "operationId" : "deleteEngagement", "parameters" : [ { "in" : "path", "name" : "conversation_engagement_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete a conversation engagement", "tags" : [ "conversation" ] }, "get" : { "description" : "Retrieve an engagement\n", "operationId" : "getConversationEngagement", "parameters" : [ { "in" : "path", "name" : "conversation_engagement_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationEngagementResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve an engagement", "tags" : [ "conversation" ] }, "put" : { "description" : "Update a engagement\n", "operationId" : "updateConversationEngagement", "parameters" : [ { "in" : "path", "name" : "conversation_engagement_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationEngagement" } } }, "description" : "Engagement", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationEngagementResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update a engagement", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "engagement" } }, "/conversation/items/{merchant_item_id}/variations" : { "get" : { "description" : "Retrieve an item with sparse variations populated\n", "operationId" : "getConversationItemVariations", "parameters" : [ { "in" : "path", "name" : "merchant_item_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve an item with sparse variations populated", "tags" : [ "conversation" ] } }, "/conversation/locations" : { "post" : { "description" : "Get location data for engagement configuration\n", "operationId" : "getLocationsForEngagement", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationLocationsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get location data for engagement configuration", "tags" : [ "conversation" ] } }, "/conversation/pbx/address" : { "get" : { "description" : "Retrieve pbx addresses\n", "operationId" : "getPbxAddresses", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAddressesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get pbx addresses", "tags" : [ "conversation" ] }, "post" : { "description" : "Insert a pbx address\n", "operationId" : "insertPbxAddress", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAddress" } } }, "description" : "Pbx Address", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAddressResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Insert pbx address", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "pbx_address" } }, "/conversation/pbx/address/{conversationPbxAddressUuid}" : { "delete" : { "description" : "Delete a pbx address\n", "operationId" : "deletePbxAddress", "parameters" : [ { "in" : "path", "name" : "conversationPbxAddressUuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAddressResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete pbx address", "tags" : [ "conversation" ] }, "get" : { "description" : "Retrieve a pbx address\n", "operationId" : "getPbxAddress", "parameters" : [ { "in" : "path", "name" : "conversationPbxAddressUuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAddressResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get pbx address", "tags" : [ "conversation" ] }, "put" : { "description" : "Update a pbx address\n", "operationId" : "updatePbxAddress", "parameters" : [ { "in" : "path", "name" : "conversationPbxAddressUuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAddress" } } }, "description" : "Pbx Address", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAddressResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update pbx address", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "pbx_address" } }, "/conversation/pbx/agent" : { "get" : { "description" : "Retrieve pbx agents\n", "operationId" : "getPbxAgents", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAgentsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get pbx agents", "tags" : [ "conversation" ] } }, "/conversation/pbx/agent/voicemails" : { "get" : { "description" : "Retrieve pbx agent Voicemails\n", "operationId" : "getPbxAgentVoicemails", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxVoicemailMessageSummariesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get Agent Voicemails", "tags" : [ "conversation" ] } }, "/conversation/pbx/agent/voicemails/{recording_sid}" : { "delete" : { "description" : "Delete pbx agent Voicemail\n", "operationId" : "deletePbxAgentVoicemail", "parameters" : [ { "in" : "path", "name" : "recording_sid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete Agent Voicemail", "tags" : [ "conversation" ] }, "get" : { "description" : "Retrieve pbx agent Voicemail\n", "operationId" : "getPbxAgentVoicemail", "parameters" : [ { "in" : "path", "name" : "recording_sid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxVoicemailMessageResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get Agent Voicemail", "tags" : [ "conversation" ] } }, "/conversation/pbx/agent/voicemails/{recording_sid}/listened" : { "get" : { "description" : "Listened pbx agent Voicemail\n", "operationId" : "listenedPbxAgentVoicemail", "parameters" : [ { "in" : "path", "name" : "recording_sid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Listened Agent Voicemail", "tags" : [ "conversation" ] } }, "/conversation/pbx/agent/{conversationPbxAgentUuid}" : { "get" : { "description" : "Retrieve a pbx agent\n", "operationId" : "getPbxAgent", "parameters" : [ { "in" : "path", "name" : "conversationPbxAgentUuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAgentResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get pbx agent", "tags" : [ "conversation" ] }, "put" : { "description" : "Update a pbx agent\n", "operationId" : "updatePbxAgent", "parameters" : [ { "in" : "path", "name" : "conversationPbxAgentUuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAgent" } } }, "description" : "Pbx Agent", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAgentResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update pbx agent", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "pbx_agent" } }, "/conversation/pbx/audio" : { "get" : { "description" : "Retrieve pbx audios\n", "operationId" : "getPbxAudios", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAudiosResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get pbx audios", "tags" : [ "conversation" ] }, "post" : { "description" : "Insert a pbx audio\n", "operationId" : "insertPbxAudio", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAudio" } } }, "description" : "Pbx Audio", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAudioResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Insert pbx audio", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "pbx_audio" } }, "/conversation/pbx/audio/upload_url/{extension}" : { "get" : { "description" : "Get a pre-signed conversation multimedia upload URL\n", "operationId" : "getConversationPbxAudioUploadUrl", "parameters" : [ { "in" : "path", "name" : "extension", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAudioUploadUrlResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get a pre-signed conversation multimedia upload URL", "tags" : [ "conversation" ] } }, "/conversation/pbx/audio/user" : { "get" : { "description" : "Retrieve pbx audio files owned by the authenticated user\n", "operationId" : "getUserPbxAudios", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAudiosResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get user pbx audios", "tags" : [ "conversation" ] }, "post" : { "description" : "Insert a pbx audio file for the authenticated user\n", "operationId" : "insertUserPbxAudio", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAudio" } } }, "description" : "Pbx Audio", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAudioResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Insert user pbx audio", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "pbx_audio" } }, "/conversation/pbx/audio/user/{conversationPbxAudioUuid}" : { "delete" : { "description" : "Delete a pbx audio file owned by the authenticated user\n", "operationId" : "deleteUserPbxAudio", "parameters" : [ { "in" : "path", "name" : "conversationPbxAudioUuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAudioResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete user pbx audio", "tags" : [ "conversation" ] }, "get" : { "description" : "Retrieve a pbx audio file owned by the authenticated user\n", "operationId" : "getUserPbxAudio", "parameters" : [ { "in" : "path", "name" : "conversationPbxAudioUuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAudioResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get user pbx audio", "tags" : [ "conversation" ] }, "put" : { "description" : "Update a pbx audio file owned by the authenticated user\n", "operationId" : "updateUserPbxAudio", "parameters" : [ { "in" : "path", "name" : "conversationPbxAudioUuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAudio" } } }, "description" : "Pbx Audio", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAudioResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update user pbx audio", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "pbx_audio" } }, "/conversation/pbx/audio/{conversationPbxAudioUuid}" : { "delete" : { "description" : "Delete a pbx audio\n", "operationId" : "deletePbxAudio", "parameters" : [ { "in" : "path", "name" : "conversationPbxAudioUuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAudioResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete pbx audio", "tags" : [ "conversation" ] }, "get" : { "description" : "Retrieve a pbx audio\n", "operationId" : "getPbxAudio", "parameters" : [ { "in" : "path", "name" : "conversationPbxAudioUuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAudioResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get pbx audio", "tags" : [ "conversation" ] }, "put" : { "description" : "Update a pbx audio\n", "operationId" : "updatePbxAudio", "parameters" : [ { "in" : "path", "name" : "conversationPbxAudioUuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAudio" } } }, "description" : "Pbx Audio", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAudioResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update pbx audio", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "pbx_audio" } }, "/conversation/pbx/audio/{conversationPbxAudioUuid}/usage" : { "get" : { "description" : "Retrieve a pbx audio usage\n", "operationId" : "getPbxAudioUsage", "parameters" : [ { "in" : "path", "name" : "conversationPbxAudioUuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAudioUsageResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get pbx audio usage", "tags" : [ "conversation" ] } }, "/conversation/pbx/call/search" : { "post" : { "description" : "Search and list PBX call records with filtering, sorting, and pagination\n", "operationId" : "searchPbxCalls", "parameters" : [ { "description" : "The maximum number of records to return on this one API call. (Maximum 200)", "in" : "query", "name" : "_limit", "schema" : { "default" : 100, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "The sort order of the calls.", "in" : "query", "name" : "_sort", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxCallSearchRequest" } } }, "description" : "Search Request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxCallSearchResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Search pbx call records", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "search_request" } }, "/conversation/pbx/call/{callUuid}" : { "get" : { "description" : "Retrieve a single PBX call record with full details\n", "operationId" : "getPbxCall", "parameters" : [ { "in" : "path", "name" : "callUuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxCallResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get pbx call record", "tags" : [ "conversation" ] } }, "/conversation/pbx/class_of_service" : { "get" : { "description" : "Retrieve all classes of service for the merchant\n", "operationId" : "getPbxClassesOfService", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxClassOfServicesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get pbx classes of service", "tags" : [ "conversation" ] }, "post" : { "description" : "Create a new class of service\n", "operationId" : "insertPbxClassOfService", "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxClassOfService" } } }, "description" : "Class of service", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxClassOfServiceResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Insert pbx class of service", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "class_of_service" } }, "/conversation/pbx/class_of_service/audit_log" : { "get" : { "description" : "Retrieve audit log entries for class of service enforcement\n", "operationId" : "getPbxCosAuditLogs", "parameters" : [ { "description" : "ISO timestamp to filter entries since", "in" : "query", "name" : "since", "schema" : { "type" : "string" } }, { "description" : "Filter by agent login", "in" : "query", "name" : "agent_login", "schema" : { "type" : "string" } }, { "description" : "Action", "in" : "query", "name" : "action", "schema" : { "type" : "string" } }, { "description" : "Maximum number of entries to return (default 100)", "in" : "query", "name" : "limit", "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxCosAuditLogsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get pbx class of service audit logs", "tags" : [ "conversation" ] } }, "/conversation/pbx/class_of_service/{classOfServiceUuid}" : { "delete" : { "description" : "Delete a class of service\n", "operationId" : "deletePbxClassOfService", "parameters" : [ { "in" : "path", "name" : "classOfServiceUuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete pbx class of service", "tags" : [ "conversation" ] }, "get" : { "description" : "Retrieve a single class of service\n", "operationId" : "getPbxClassOfService", "parameters" : [ { "in" : "path", "name" : "classOfServiceUuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxClassOfServiceResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get pbx class of service", "tags" : [ "conversation" ] }, "put" : { "description" : "Update an existing class of service\n", "operationId" : "updatePbxClassOfService", "parameters" : [ { "in" : "path", "name" : "classOfServiceUuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxClassOfService" } } }, "description" : "Class of service", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxClassOfServiceResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update pbx class of service", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "class_of_service" } }, "/conversation/pbx/config/default-timezone" : { "get" : { "description" : "Returns the merchant's stored default timezone (IANA name). Falls back to America/New_York when unset.\n", "operationId" : "getPbxDefaultTimezone", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxDefaultTimezoneResponse" } } }, "description" : "Successful response" } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get the merchant default timezone", "tags" : [ "conversation" ] }, "put" : { "description" : "Persists the IANA timezone on the Config#/default DDB record (creates on first PUT).\n", "operationId" : "updatePbxDefaultTimezone", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxDefaultTimezoneUpdateRequest" } } }, "description" : "Timezone update", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxDefaultTimezoneResponse" } } }, "description" : "Successful response" } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Set the merchant default timezone", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "timezone_update" } }, "/conversation/pbx/customer_snapshot" : { "post" : { "description" : "Retrieves all the orders, auto orders, and customer profile for a given phone number\n", "operationId" : "getConversationPbxCustomerSnapshot", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxCustomerSnapshotRequest" } } }, "description" : "Conversation pbx customer snapshot request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxCustomerSnapshotResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get orders and customer information for a phone number", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "pbx_customer_snapshot_request" } }, "/conversation/pbx/hardware_phone" : { "get" : { "description" : "Retrieve pbx hardware phones\n", "operationId" : "getPbxHardwarePhones", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxHardwarePhonesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get pbx hardware phones", "tags" : [ "conversation" ] }, "post" : { "description" : "Insert a pbx hardware phone\n", "operationId" : "insertPbxHardwarePhone", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxHardwarePhone" } } }, "description" : "Pbx Hardware Phone", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxHardwarePhoneResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Insert pbx hardware phone", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "pbx_hardware_phone" } }, "/conversation/pbx/hardware_phone/manufacturers" : { "get" : { "description" : "Retrieve pbx hardware phone manufacturers and models for auto-provisioning\n", "operationId" : "getPbxHardwarePhoneManufacturers", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxPhoneManufacturersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get pbx hardware phone manufacturers", "tags" : [ "conversation" ] } }, "/conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid}" : { "delete" : { "description" : "Delete a pbx hardware phone\n", "operationId" : "deletePbxHardwarePhone", "parameters" : [ { "in" : "path", "name" : "conversationPbxHardwarePhoneUuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxHardwarePhoneResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete pbx hardware phone", "tags" : [ "conversation" ] }, "get" : { "description" : "Retrieve a pbx hardware phone\n", "operationId" : "getPbxHardwarePhone", "parameters" : [ { "in" : "path", "name" : "conversationPbxHardwarePhoneUuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxHardwarePhoneResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get pbx hardware phone", "tags" : [ "conversation" ] }, "put" : { "description" : "Update a pbx hardware phone\n", "operationId" : "updatePbxHardwarePhone", "parameters" : [ { "in" : "path", "name" : "conversationPbxHardwarePhoneUuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxHardwarePhone" } } }, "description" : "Pbx Hardware Phone", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxHardwarePhoneResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update pbx hardware phone", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "pbx_hardware_phone" } }, "/conversation/pbx/hardware_phone/{conversationPbxHardwarePhoneUuid}/regenerate_password" : { "post" : { "description" : "Update a pbx hardware phone\n", "operationId" : "regeneratePasswordForPbxHardwarePhone", "parameters" : [ { "in" : "path", "name" : "conversationPbxHardwarePhoneUuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxHardwarePhone" } } }, "description" : "Pbx Hardware Phone", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxHardwarePhoneResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update pbx hardware phone", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "pbx_hardware_phone" } }, "/conversation/pbx/menu" : { "get" : { "description" : "Retrieve pbx menus\n", "operationId" : "getPbxMenus", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxMenusResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get pbx menus", "tags" : [ "conversation" ] }, "post" : { "description" : "Insert a pbx menu\n", "operationId" : "insertPbxMenu", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxMenu" } } }, "description" : "Pbx Menu", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxMenuResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Insert pbx menu", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "pbx_menu" } }, "/conversation/pbx/menu/{conversationPbxMenuUuid}" : { "delete" : { "description" : "Delete a pbx menu\n", "operationId" : "deletePbxMenu", "parameters" : [ { "in" : "path", "name" : "conversationPbxMenuUuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxMenuResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete pbx menu", "tags" : [ "conversation" ] }, "get" : { "description" : "Retrieve a pbx menu\n", "operationId" : "getPbxMenu", "parameters" : [ { "in" : "path", "name" : "conversationPbxMenuUuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxMenuResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get pbx menu", "tags" : [ "conversation" ] }, "put" : { "description" : "Update a pbx menu\n", "operationId" : "updatePbxMenu", "parameters" : [ { "in" : "path", "name" : "conversationPbxMenuUuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxMenu" } } }, "description" : "Pbx Menu", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxMenuResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update pbx menu", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "pbx_menu" } }, "/conversation/pbx/phone_number" : { "get" : { "description" : "Retrieve pbx phoneNumbers\n", "operationId" : "getPbxPhoneNumbers", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxPhoneNumbersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get pbx phoneNumbers", "tags" : [ "conversation" ] }, "post" : { "description" : "Purchase a phone number from Twilio. The phone_number must be from the available phone number search results.\n", "operationId" : "purchasePbxPhoneNumber", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxPhoneNumberPurchaseRequest" } } }, "description" : "Phone number purchase request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxPhoneNumberResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Purchase pbx phone number", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "phone_number_purchase_request" } }, "/conversation/pbx/phone_number/search" : { "get" : { "description" : "Search for available phone numbers from Twilio that can be purchased\n", "operationId" : "searchPbxAvailablePhoneNumbers", "parameters" : [ { "description" : "ISO country code (e.g., US, CA, GB)", "in" : "query", "name" : "country", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Area code filter (e.g., 614)", "in" : "query", "name" : "area_code", "schema" : { "type" : "string" } }, { "description" : "Pattern to match (e.g., 555, *PIZZA)", "in" : "query", "name" : "contains", "schema" : { "type" : "string" } }, { "description" : "Filter for SMS capability", "in" : "query", "name" : "sms_enabled", "schema" : { "type" : "boolean" } }, { "description" : "Filter for voice capability", "in" : "query", "name" : "voice_enabled", "schema" : { "type" : "boolean" } }, { "description" : "Phone number type", "in" : "query", "name" : "type", "schema" : { "type" : "string" } }, { "description" : "Max results (default 20, max 100)", "in" : "query", "name" : "limit", "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxAvailablePhoneNumbersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Search for available phone numbers", "tags" : [ "conversation" ] } }, "/conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid}" : { "delete" : { "description" : "Delete a pbx phoneNumber. Only works if deletion_protected is false.\n", "operationId" : "deletePbxPhoneNumber", "parameters" : [ { "in" : "path", "name" : "conversationPbxPhoneNumberUuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete pbx phoneNumber", "tags" : [ "conversation" ] }, "get" : { "description" : "Retrieve a pbx phoneNumber\n", "operationId" : "getPbxPhoneNumber", "parameters" : [ { "in" : "path", "name" : "conversationPbxPhoneNumberUuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxPhoneNumberResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get pbx phoneNumber", "tags" : [ "conversation" ] }, "put" : { "description" : "Update a pbx phoneNumber\n", "operationId" : "updatePbxPhoneNumber", "parameters" : [ { "in" : "path", "name" : "conversationPbxPhoneNumberUuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxPhoneNumber" } } }, "description" : "Pbx PhoneNumber", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxPhoneNumberResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update pbx phoneNumber", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "pbx_phoneNumber" } }, "/conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid}/protect" : { "put" : { "description" : "Protect a pbx phoneNumber from deletion. This is a one-way operation and cannot be undone through the API.\n", "operationId" : "protectPbxPhoneNumber", "parameters" : [ { "in" : "path", "name" : "conversationPbxPhoneNumberUuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxPhoneNumberResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Protect pbx phoneNumber from deletion", "tags" : [ "conversation" ] } }, "/conversation/pbx/queue" : { "get" : { "description" : "Retrieve pbx queues\n", "operationId" : "getPbxQueues", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxQueuesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get pbx queues", "tags" : [ "conversation" ] }, "post" : { "description" : "Insert a pbx queue\n", "operationId" : "insertPbxQueue", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxQueue" } } }, "description" : "Pbx Queue", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxQueueResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Insert pbx queue", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "pbx_queue" } }, "/conversation/pbx/queue/{conversationPbxQueueUuid}" : { "delete" : { "description" : "Delete a pbx queue\n", "operationId" : "deletePbxQueue", "parameters" : [ { "in" : "path", "name" : "conversationPbxQueueUuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxQueueResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete pbx queue", "tags" : [ "conversation" ] }, "get" : { "description" : "Retrieve a pbx queue\n", "operationId" : "getPbxQueue", "parameters" : [ { "in" : "path", "name" : "conversationPbxQueueUuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxQueueResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get pbx queue", "tags" : [ "conversation" ] }, "put" : { "description" : "Update a pbx queue\n", "operationId" : "updatePbxQueue", "parameters" : [ { "in" : "path", "name" : "conversationPbxQueueUuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxQueue" } } }, "description" : "Pbx Queue", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxQueueResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update pbx queue", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "pbx_queue" } }, "/conversation/pbx/queues/{queue_uuid}/reset_statistics" : { "post" : { "description" : "reset statistics within the queue\n", "operationId" : "resetConversationPbxQueueStatistics", "parameters" : [ { "in" : "path", "name" : "queue_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "reset statistics within the queue", "tags" : [ "conversation" ] } }, "/conversation/pbx/queues/{queue_uuid}/voicemails" : { "get" : { "description" : "Retrieve pbx queue voicemails\n", "operationId" : "getPbxQueueVoicemails", "parameters" : [ { "in" : "path", "name" : "queue_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxVoicemailMessageSummariesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get Queue Voicemails", "tags" : [ "conversation" ] } }, "/conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid}" : { "delete" : { "description" : "Delete pbx queue Voicemail\n", "operationId" : "deletePbxQueueVoicemail", "parameters" : [ { "in" : "path", "name" : "queue_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "recording_sid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete Queue Voicemail", "tags" : [ "conversation" ] }, "get" : { "description" : "Retrieve pbx queue Voicemail\n", "operationId" : "getPbxQueueVoicemail", "parameters" : [ { "in" : "path", "name" : "queue_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "recording_sid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxVoicemailMessageResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get Queue Voicemail", "tags" : [ "conversation" ] } }, "/conversation/pbx/queues/{queue_uuid}/voicemails/{recording_sid}/listened" : { "get" : { "description" : "Listened pbx queue Voicemail\n", "operationId" : "listenedPbxQueueVoicemail", "parameters" : [ { "in" : "path", "name" : "queue_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "recording_sid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Listened Queue Voicemail", "tags" : [ "conversation" ] } }, "/conversation/pbx/time_based" : { "get" : { "description" : "Retrieve pbx timeBaseds\n", "operationId" : "getPbxTimeBaseds", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxTimeBasedsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get pbx timeBaseds", "tags" : [ "conversation" ] }, "post" : { "description" : "Insert a pbx timeBased\n", "operationId" : "insertPbxTimeBased", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxTimeBased" } } }, "description" : "Pbx TimeBased", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxTimeBasedResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Insert pbx timeBased", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "pbx_timeBased" } }, "/conversation/pbx/time_based/{conversationPbxTimeBasedUuid}" : { "delete" : { "description" : "Delete a pbx timeBased\n", "operationId" : "deletePbxTimeBased", "parameters" : [ { "in" : "path", "name" : "conversationPbxTimeBasedUuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxTimeBasedResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete pbx timeBased", "tags" : [ "conversation" ] }, "get" : { "description" : "Retrieve a pbx timeBased\n", "operationId" : "getPbxTimeBased", "parameters" : [ { "in" : "path", "name" : "conversationPbxTimeBasedUuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxTimeBasedResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get pbx timeBased", "tags" : [ "conversation" ] }, "put" : { "description" : "Update a pbx timeBased\n", "operationId" : "updatePbxTimeBased", "parameters" : [ { "in" : "path", "name" : "conversationPbxTimeBasedUuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxTimeBased" } } }, "description" : "Pbx TimeBased", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxTimeBasedResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update pbx timeBased", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "pbx_timeBased" } }, "/conversation/pbx/time_range" : { "get" : { "description" : "Retrieve pbx timeRanges\n", "operationId" : "getPbxTimeRanges", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxTimeRangesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get pbx timeRanges", "tags" : [ "conversation" ] }, "post" : { "description" : "Insert a pbx timeRange\n", "operationId" : "insertPbxTimeRange", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxTimeRange" } } }, "description" : "Pbx TimeRange", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxTimeRangeResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Insert pbx timeRange", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "pbx_timeRange" } }, "/conversation/pbx/time_range/{conversationPbxTimeRangeUuid}" : { "delete" : { "description" : "Delete a pbx timeRange\n", "operationId" : "deletePbxTimeRange", "parameters" : [ { "in" : "path", "name" : "conversationPbxTimeRangeUuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxTimeRangeResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete pbx timeRange", "tags" : [ "conversation" ] }, "get" : { "description" : "Retrieve a pbx timeRange\n", "operationId" : "getPbxTimeRange", "parameters" : [ { "in" : "path", "name" : "conversationPbxTimeRangeUuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxTimeRangeResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get pbx timeRange", "tags" : [ "conversation" ] }, "put" : { "description" : "Update a pbx timeRange\n", "operationId" : "updatePbxTimeRange", "parameters" : [ { "in" : "path", "name" : "conversationPbxTimeRangeUuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxTimeRange" } } }, "description" : "Pbx TimeRange", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxTimeRangeResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update pbx timeRange", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "pbx_timeRange" } }, "/conversation/pbx/voicemail/capabilities" : { "get" : { "description" : "Retrieve voicemail notification capabilities including available channels\n", "operationId" : "getPbxVoicemailCapabilities", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxVoicemailCapabilitiesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get pbx voicemail capabilities", "tags" : [ "conversation" ] } }, "/conversation/pbx/voicemail_mailbox" : { "get" : { "description" : "Retrieve pbx voicemailMailboxes\n", "operationId" : "getPbxVoicemailMailboxes", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxVoicemailMailboxesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get pbx voicemailMailboxes", "tags" : [ "conversation" ] }, "post" : { "description" : "Insert a pbx voicemailMailbox\n", "operationId" : "insertPbxVoicemailMailbox", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxVoicemailMailbox" } } }, "description" : "Pbx VoicemailMailbox", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxVoicemailMailboxResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Insert pbx voicemailMailbox", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "pbx_voicemailMailbox" } }, "/conversation/pbx/voicemail_mailbox/{conversationPbxVoicemailMailboxUuid}" : { "delete" : { "description" : "Delete a pbx voicemailMailbox\n", "operationId" : "deletePbxVoicemailMailbox", "parameters" : [ { "in" : "path", "name" : "conversationPbxVoicemailMailboxUuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxVoicemailMailboxResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete pbx voicemailMailbox", "tags" : [ "conversation" ] }, "get" : { "description" : "Retrieve a pbx voicemailMailbox\n", "operationId" : "getPbxVoicemailMailbox", "parameters" : [ { "in" : "path", "name" : "conversationPbxVoicemailMailboxUuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxVoicemailMailboxResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get pbx voicemailMailbox", "tags" : [ "conversation" ] }, "put" : { "description" : "Update a pbx voicemailMailbox\n", "operationId" : "updatePbxVoicemailMailbox", "parameters" : [ { "in" : "path", "name" : "conversationPbxVoicemailMailboxUuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxVoicemailMailbox" } } }, "description" : "Pbx VoicemailMailbox", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPbxVoicemailMailboxResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update pbx voicemailMailbox", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "pbx_voicemailMailbox" } }, "/conversation/permissions" : { "get" : { "description" : "Retrieve conversation permissions\n", "operationId" : "getConversationPermissions", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationPermissionsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve conversation permissions", "tags" : [ "conversation" ] } }, "/conversation/upload_url/{extension}" : { "get" : { "description" : "Get a presigned conversation multimedia upload URL\n", "operationId" : "getConversationMultimediaUploadUrl", "parameters" : [ { "in" : "path", "name" : "extension", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationMultimediaUploadUrlResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get a presigned conversation multimedia upload URL", "tags" : [ "conversation" ] } }, "/conversation/virtualagent/budget" : { "get" : { "description" : "Retrieve virtual agent budget\n", "operationId" : "getVirtualAgentBudget", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationVirtualAgentBudgetResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get virtual agent budget", "tags" : [ "conversation" ] }, "put" : { "description" : "Update virtual agent budget\n", "operationId" : "updateVirtualAgentBudget", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationVirtualAgentBudget" } } }, "description" : "Virtual Agent Budget", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationVirtualAgentBudgetResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update virtual agent budget", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "virtual_agent_budget" } }, "/conversation/virtualagent/capabilities" : { "get" : { "description" : "Retrieve virtual agent capabilities\n", "operationId" : "getVirtualAgentCapabilities", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationVirtualAgentCapabilitiesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get virtual agent capabilities", "tags" : [ "conversation" ] }, "put" : { "description" : "Update virtual agent capabilities\n", "operationId" : "updateVirtualAgentCapabilities", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationVirtualAgentCapabilities" } } }, "description" : "Virtual Agent Capabilities", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationVirtualAgentCapabilitiesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update virtual agent capabilities", "tags" : [ "conversation" ], "x-codegen-request-body-name" : "virtual_agent_capabilities" } }, "/channel_partner/cancel/by_channel_partner_order_id/{order_id}" : { "delete" : { "description" : "Cancel channel partner order by channel partner order id\n", "operationId" : "cancelOrderByChannelPartnerOrderId", "parameters" : [ { "description" : "The channel partner order id to delete.", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChannelPartnerCancelResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "channel_partner_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Cancel channel partner order by channel partner order id", "tags" : [ "channel partner" ] } }, "/channel_partner/cancel/by_ultracart_order_id/{order_id}" : { "delete" : { "description" : "Cancel channel partner order by UltraCart order id\n", "operationId" : "cancelOrderByUltraCartOrderId", "parameters" : [ { "description" : "The UltraCart order id to delete.", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChannelPartnerCancelResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "channel_partner_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Cancel channel partner order by UltraCart order id", "tags" : [ "channel partner" ] } }, "/channel_partner/channel_partners" : { "get" : { "description" : "Retrieve the channel partners configured on the account.\n", "operationId" : "getChannelPartners", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChannelPartnersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "channel_partner_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve the channel partners configured on the account.", "tags" : [ "channel partner" ] } }, "/channel_partner/channel_partners/{channel_partner_oid}/reason_codes" : { "get" : { "description" : "Retrieve reject and refund reason codes.\n", "operationId" : "getChannelPartnerReasonCodes", "parameters" : [ { "in" : "path", "name" : "channel_partner_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChanelPartnerReasonCodesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "channel_partner_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve reject and refund reason codes.", "tags" : [ "channel partner" ] } }, "/channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences" : { "get" : { "description" : "Retrieve the ship to preferences associated with the channel partner.\n", "operationId" : "getChannelPartnerShipToPreferences", "parameters" : [ { "in" : "path", "name" : "channel_partner_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChannelPartnerShipToPreferencesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "channel_partner_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve the ship to preferences associated with the channel partner.", "tags" : [ "channel partner" ] }, "post" : { "description" : "Insert a ship to preference record for the channel partner.\n", "operationId" : "insertChannelPartnerShipToPreference", "parameters" : [ { "in" : "path", "name" : "channel_partner_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChannelPartnerShipToPreference" } } }, "description" : "Ship to preference to create", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChannelPartnerShipToPreferenceResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "channel_partner_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Insert a ship to preference record for the channel partner.", "tags" : [ "channel partner" ], "x-codegen-request-body-name" : "ship_to_preference" } }, "/channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences/{channel_partner_ship_to_preference_oid}" : { "delete" : { "description" : "Delete a ship to preference record for the channel partner.\n", "operationId" : "deleteChannelPartnerShipToPreference", "parameters" : [ { "in" : "path", "name" : "channel_partner_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "channel_partner_ship_to_preference_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "channel_partner_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete a ship to preference record for the channel partner.", "tags" : [ "channel partner" ] }, "get" : { "description" : "Retrieve the ship to preference associated with the channel partner and the specific id.\n", "operationId" : "getChannelPartnerShipToPreference", "parameters" : [ { "in" : "path", "name" : "channel_partner_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "channel_partner_ship_to_preference_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChannelPartnerShipToPreferenceResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "channel_partner_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve the ship to preference associated with the channel partner and the specific id.", "tags" : [ "channel partner" ] }, "put" : { "description" : "Update a ship to preference record for the channel partner.\n", "operationId" : "updateChannelPartnerShipToPreference", "parameters" : [ { "in" : "path", "name" : "channel_partner_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "in" : "path", "name" : "channel_partner_ship_to_preference_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChannelPartnerShipToPreference" } } }, "description" : "Ship to preference to create", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChannelPartnerShipToPreferenceResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "channel_partner_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update a ship to preference record for the channel partner.", "tags" : [ "channel partner" ], "x-codegen-request-body-name" : "ship_to_preference" } }, "/channel_partner/estimate_shipping" : { "post" : { "description" : "Estimate shipping for order from a channel partner.\n", "operationId" : "estimateShippingForChannelPartnerOrder", "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ChannelPartnerOrder" } } }, "description" : "Order needing shipping estimate", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChannelPartnerEstimateShippingResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "channel_partner_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Estimate shipping for channel partner order", "tags" : [ "channel partner" ], "x-codegen-request-body-name" : "channel_partner_order" } }, "/channel_partner/estimate_tax" : { "post" : { "description" : "Estimate tax for order from a channel partner.\n", "operationId" : "estimateTaxForChannelPartnerOrder", "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ChannelPartnerOrder" } } }, "description" : "Order needing tax estimate", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChannelPartnerEstimateTaxResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "channel_partner_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Estimate tax for channel partner order", "tags" : [ "channel partner" ], "x-codegen-request-body-name" : "channel_partner_order" } }, "/channel_partner/import" : { "post" : { "description" : "Insert order from a channel partner.\n", "operationId" : "importChannelPartnerOrder", "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ChannelPartnerOrder" } } }, "description" : "Order to insert", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChannelPartnerImportResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "channel_partner_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Insert channel partner order", "tags" : [ "channel partner" ], "x-codegen-request-body-name" : "channel_partner_order" } }, "/channel_partner/orders/by_channel_partner_order_id/{order_id}" : { "get" : { "description" : "Retrieves a single order using the channel partner order id, not the ultracart order id. Only orders belonging to this channel partner may be retrieved.\n", "operationId" : "getChannelPartnerOrderByChannelPartnerOrderId", "parameters" : [ { "description" : "The channel partner order id to retrieve.", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See OrderApi.getOrder documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "channel_partner_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve a channel partner order by the channel partner order id", "tags" : [ "channel partner" ] } }, "/channel_partner/orders/{order_id}" : { "get" : { "description" : "Retrieves a single order using the specified order id. Only orders belonging to this channel partner may be retrieved.\n", "operationId" : "getChannelPartnerOrder", "parameters" : [ { "description" : "The order id to retrieve.", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See OrderApi.getOrder documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "channel_partner_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve a channel partner order", "tags" : [ "channel partner" ] } }, "/channel_partner/orders/{order_id}/refund" : { "put" : { "description" : "Perform a refund operation on a channel partner order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.\n", "operationId" : "refundChannelPartnerOrder", "parameters" : [ { "description" : "The order id to refund.", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Reject order after refund", "in" : "query", "name" : "reject_after_refund", "schema" : { "default" : false, "type" : "boolean" } }, { "description" : "Skip customer email notification", "in" : "query", "name" : "skip_customer_notification", "schema" : { "default" : false, "type" : "boolean" } }, { "description" : "Cancel associated auto orders", "in" : "query", "name" : "auto_order_cancel", "schema" : { "default" : false, "type" : "boolean" } }, { "description" : "Consider a manual refund done externally", "in" : "query", "name" : "manual_refund", "schema" : { "default" : false, "type" : "boolean" } }, { "description" : "Reverse affiliate transactions", "in" : "query", "name" : "reverse_affiliate_transactions", "schema" : { "default" : true, "type" : "boolean" } }, { "description" : "Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account", "in" : "query", "name" : "issue_store_credit", "schema" : { "default" : false, "type" : "boolean" } }, { "description" : "Reason for auto orders cancellation", "in" : "query", "name" : "auto_order_cancel_reason", "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See OrderApi.refundOrder documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/Order" } } }, "description" : "Order to refund", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "channel_partner_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Refund a channel partner order", "tags" : [ "channel partner" ], "x-codegen-request-body-name" : "order" } }, "/item/digital_library" : { "get" : { "description" : "Retrieves a group of digital items (file information) from the account. If no parameters are specified, all digital items will be returned. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.\n", "operationId" : "getDigitalItems", "parameters" : [ { "description" : "The maximum number of records to return on this one API call. (Default 100, Max 2000)", "in" : "query", "name" : "_limit", "schema" : { "default" : 100, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "Fetch items that have been created/modified since this date/time.", "in" : "query", "name" : "_since", "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.", "in" : "query", "name" : "_sort", "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } }, { "description" : "Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.", "in" : "query", "name" : "_placeholders", "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemDigitalItemsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve digital items from the digital library which are digital files that may be attached to normal items", "tags" : [ "item" ] }, "post" : { "description" : "Create a file within the digital library. This does not create an item, but makes this digital file available and selectable as part (or all) of an item.\n", "operationId" : "insertDigitalItem", "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ItemDigitalItem" } } }, "description" : "Digital item to create", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemDigitalItemResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Create a file within the digital library", "tags" : [ "item" ], "x-codegen-request-body-name" : "digital_item" } }, "/item/digital_library/by_external/{external_id}" : { "get" : { "description" : "Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items.\n", "operationId" : "getDigitalItemsByExternalId", "parameters" : [ { "description" : "The external id to match against.", "in" : "path", "name" : "external_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemDigitalItemsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id", "tags" : [ "item" ] } }, "/item/digital_library/unassociated" : { "get" : { "description" : "Retrieves a group of digital items (file information) from the account that are not yet associated with any actual items. If no parameters are specified, all digital items will be returned. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.\n", "operationId" : "getUnassociatedDigitalItems", "parameters" : [ { "description" : "The maximum number of records to return on this one API call. (Default 100, Max 2000)", "in" : "query", "name" : "_limit", "schema" : { "default" : 100, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "Fetch items that have been created/modified since this date/time.", "in" : "query", "name" : "_since", "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.", "in" : "query", "name" : "_sort", "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } }, { "description" : "Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.", "in" : "query", "name" : "_placeholders", "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemDigitalItemsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items", "tags" : [ "item" ] } }, "/item/digital_library/{digital_item_oid}" : { "delete" : { "description" : "Delete a digital item on the UltraCart account.\n", "operationId" : "deleteDigitalItem", "parameters" : [ { "description" : "The digital item oid to delete.", "in" : "path", "name" : "digital_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "204" : { "content" : { }, "description" : "No Content" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete a digital item, which is a file within the digital library, not an actual merchant item", "tags" : [ "item" ] }, "get" : { "description" : "Retrieves a digital item (file information) from the account. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items.\n", "operationId" : "getDigitalItem", "parameters" : [ { "description" : "The digital item oid to retrieve.", "in" : "path", "name" : "digital_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemDigitalItemResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve a digital item from the digital library, which are digital files that may be attached to normal items", "tags" : [ "item" ] }, "put" : { "description" : "Updates a file within the digital library. This does not update an item, but updates a digital file available and selectable as part (or all) of an item.\n", "operationId" : "updateDigitalItem", "parameters" : [ { "description" : "The digital item oid to update.", "in" : "path", "name" : "digital_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ItemDigitalItem" } } }, "description" : "Digital item to update", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemDigitalItemResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Updates a file within the digital library", "tags" : [ "item" ], "x-codegen-request-body-name" : "digital_item" } }, "/item/items" : { "get" : { "description" : "Retrieves a group of items from the account. If no parameters are specified, all items will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.\n", "operationId" : "getItems", "parameters" : [ { "description" : "The parent category object id to retrieve items for. Unspecified means all items on the account. 0 = root", "in" : "query", "name" : "parent_category_id", "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The parent category path to retrieve items for. Unspecified means all items on the account. / = root", "in" : "query", "name" : "parent_category_path", "schema" : { "type" : "string" } }, { "description" : "The maximum number of records to return on this one API call. (Default 100, Max 2000)", "in" : "query", "name" : "_limit", "schema" : { "default" : 100, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "Fetch items that have been created/modified since this date/time.", "in" : "query", "name" : "_since", "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.", "in" : "query", "name" : "_sort", "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } }, { "description" : "Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.", "in" : "query", "name" : "_placeholders", "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve items", "tags" : [ "item" ] }, "post" : { "description" : "Create a new item on the UltraCart account.\n", "operationId" : "insertItem", "parameters" : [ { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } }, { "description" : "Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.", "in" : "query", "name" : "_placeholders", "schema" : { "type" : "boolean" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/Item" } } }, "description" : "Item to create", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Create an item", "tags" : [ "item" ], "x-codegen-request-body-name" : "item" } }, "/item/items/batch" : { "put" : { "description" : "Update multiple item on the UltraCart account.\n", "operationId" : "updateItems", "parameters" : [ { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } }, { "description" : "Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.", "in" : "query", "name" : "_placeholders", "schema" : { "type" : "boolean" } }, { "description" : "True if the operation should be run async. No result returned", "in" : "query", "name" : "_async", "schema" : { "type" : "boolean" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ItemsRequest" } } }, "description" : "Items to update (synchronous maximum 20 / asynchronous maximum 100)", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update multiple items", "tags" : [ "item" ], "x-codegen-request-body-name" : "items_request" } }, "/item/items/inventory_snapshot" : { "get" : { "description" : "Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.\n", "operationId" : "getInventorySnapshot", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemInventorySnapshotResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.", "tags" : [ "item" ] } }, "/item/items/merchant_item_id/{merchant_item_id}" : { "get" : { "description" : "Retrieves a single item using the specified item id.\n", "operationId" : "getItemByMerchantItemId", "parameters" : [ { "description" : "The item id to retrieve.", "in" : "path", "name" : "merchant_item_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } }, { "description" : "Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.", "in" : "query", "name" : "_placeholders", "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve an item by item id", "tags" : [ "item" ] } }, "/item/items/{merchant_item_oid}" : { "delete" : { "description" : "Delete an item on the UltraCart account.\n", "operationId" : "deleteItem", "parameters" : [ { "description" : "The item oid to delete.", "in" : "path", "name" : "merchant_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "204" : { "content" : { }, "description" : "No Content" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete an item", "tags" : [ "item" ] }, "get" : { "description" : "Retrieves a single item using the specified item oid.\n", "operationId" : "getItem", "parameters" : [ { "description" : "The item oid to retrieve.", "in" : "path", "name" : "merchant_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } }, { "description" : "Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.", "in" : "query", "name" : "_placeholders", "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve an item", "tags" : [ "item" ] }, "put" : { "description" : "Update a new item on the UltraCart account.\n", "operationId" : "updateItem", "parameters" : [ { "description" : "The item oid to update.", "in" : "path", "name" : "merchant_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } }, { "description" : "Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.", "in" : "query", "name" : "_placeholders", "schema" : { "type" : "boolean" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/Item" } } }, "description" : "Item to update", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update an item", "tags" : [ "item" ], "x-codegen-request-body-name" : "item" } }, "/item/items/{merchant_item_oid}/content/attributes" : { "post" : { "description" : "Update an item content attribute, creating it new if it does not yet exist.\n", "operationId" : "insertUpdateItemContentAttribute", "parameters" : [ { "description" : "The item oid to modify.", "in" : "path", "name" : "merchant_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ItemContentAttribute" } } }, "description" : "Item content attribute to upsert", "required" : true }, "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Upsert an item content attribute", "tags" : [ "item" ], "x-codegen-request-body-name" : "item_attribute" } }, "/item/items/{merchant_item_oid}/gated_codes" : { "delete" : { "description" : "Removes every gated access code currently configured for the item.\n", "operationId" : "deleteAllGatedCodes", "parameters" : [ { "description" : "The item oid.", "in" : "path", "name" : "merchant_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete all gated access codes for an item", "tags" : [ "item" ] }, "get" : { "description" : "Retrieve all unredeemed gated access codes configured for an item.\n", "operationId" : "getGatedCodes", "parameters" : [ { "description" : "The item oid.", "in" : "path", "name" : "merchant_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemGatedCodesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get gated access codes for an item", "tags" : [ "item" ] }, "post" : { "description" : "Insert a single gated access code; the server assigns the OID and created_dts.\n", "operationId" : "insertGatedCode", "parameters" : [ { "description" : "The item oid.", "in" : "path", "name" : "merchant_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ItemGatedCode" } } }, "description" : "Gated code to insert.", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemGatedCodeResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Add a single gated access code to an item", "tags" : [ "item" ], "x-codegen-request-body-name" : "gated_code" }, "put" : { "description" : "Existing codes not present in the request body are deleted. New codes are inserted. Unchanged codes preserve their OID and created_dts.\n", "operationId" : "replaceGatedCodes", "parameters" : [ { "description" : "The item oid.", "in" : "path", "name" : "merchant_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ItemGatedCodesRequest" } } }, "description" : "Codes to replace the existing list with.", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemGatedCodesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Replace the full list of gated access codes for an item", "tags" : [ "item" ], "x-codegen-request-body-name" : "gated_codes_request" } }, "/item/items/{merchant_item_oid}/gated_codes/generate" : { "post" : { "description" : "Returns randomly generated codes using a profanity-safe charset (vowel-free, 0/1 removed). Codes are NOT persisted; submit them via PUT or POST to commit.\n", "operationId" : "generateGatedCodes", "parameters" : [ { "description" : "The item oid.", "in" : "path", "name" : "merchant_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ItemGenerateGatedCodesRequest" } } }, "description" : "Generate request.", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemGatedCodesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Generate a batch of gated access codes", "tags" : [ "item" ], "x-codegen-request-body-name" : "generate_request" } }, "/item/items/{merchant_item_oid}/gated_codes/{merchant_item_gated_code_oid}" : { "delete" : { "description" : "Delete a specific gated access code by its OID.\n", "operationId" : "deleteGatedCode", "parameters" : [ { "description" : "The item oid.", "in" : "path", "name" : "merchant_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The gated code oid.", "in" : "path", "name" : "merchant_item_gated_code_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete a gated access code by OID", "tags" : [ "item" ] } }, "/item/items/{merchant_item_oid}/reviews" : { "get" : { "description" : "Retrieve item reviews.\n", "operationId" : "getReviews", "parameters" : [ { "description" : "The item oid the review is associated with.", "in" : "path", "name" : "merchant_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemReviewsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get reviews for an item", "tags" : [ "item" ] }, "post" : { "description" : "Insert a item review.\n", "operationId" : "insertReview", "parameters" : [ { "description" : "The item oid the review is associated with.", "in" : "path", "name" : "merchant_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ItemReview" } } }, "description" : "Review to insert", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemReviewResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Insert a review", "tags" : [ "item" ], "x-codegen-request-body-name" : "review" } }, "/item/items/{merchant_item_oid}/reviews/{review_oid}" : { "delete" : { "description" : "Delete an item review.\n", "operationId" : "deleteReview", "parameters" : [ { "description" : "The review oid to delete.", "in" : "path", "name" : "review_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The item oid the review is associated with.", "in" : "path", "name" : "merchant_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete a review", "tags" : [ "item" ] }, "get" : { "description" : "Retrieve an item review.\n", "operationId" : "getReview", "parameters" : [ { "description" : "The review oid to retrieve.", "in" : "path", "name" : "review_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The item oid the review is associated with.", "in" : "path", "name" : "merchant_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemReviewResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get a review", "tags" : [ "item" ] }, "put" : { "description" : "Update an item review.\n", "operationId" : "updateReview", "parameters" : [ { "description" : "The review oid to update.", "in" : "path", "name" : "review_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The item oid the review is associated with.", "in" : "path", "name" : "merchant_item_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ItemReview" } } }, "description" : "Review to update", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemReviewResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update a review", "tags" : [ "item" ], "x-codegen-request-body-name" : "review" } }, "/item/pricing_tiers" : { "get" : { "description" : "Retrieves the pricing tiers\n", "operationId" : "getPricingTiers", "parameters" : [ { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PricingTiersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve pricing tiers", "tags" : [ "item" ] } }, "/item/temp_multimedia" : { "post" : { "description" : "Uploads an image and returns back meta information about the image as well as the identifier needed for the item update.\n", "operationId" : "uploadTemporaryMultimedia", "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "$ref" : "#/components/schemas/uploadTemporaryMultimedia_request" } } }, "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TempMultimediaResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "item_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Upload an image to the temporary multimedia.", "tags" : [ "item" ] } }, "/order/accountsReceivableRetryConfig" : { "get" : { "description" : "Retrieve A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.\n", "operationId" : "getAccountsReceivableRetryConfig", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AccountsReceivableRetryConfigResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve A/R Retry Configuration", "tags" : [ "order" ] }, "post" : { "description" : "Update A/R Retry Configuration. This is primarily an internal API call. It is doubtful you would ever need to use it.\n", "operationId" : "updateAccountsReceivableRetryConfig", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AccountsReceivableRetryConfig" } } }, "description" : "AccountsReceivableRetryConfig object", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update A/R Retry Configuration", "tags" : [ "order" ], "x-codegen-request-body-name" : "retry_config" } }, "/order/accountsReceivableRetryConfig/stats" : { "get" : { "description" : "Retrieve A/R Retry Statistics. This is primarily an internal API call. It is doubtful you would ever need to use it.\n", "operationId" : "getAccountsReceivableRetryStats", "parameters" : [ { "in" : "query", "name" : "from", "schema" : { "type" : "string" } }, { "in" : "query", "name" : "to", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AccountsReceivableRetryStatsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve A/R Retry Statistics", "tags" : [ "order" ] } }, "/order/accounts_receivable/detail_value_histogram" : { "get" : { "description" : "For the calling merchant's Accounts Receivable orders, returns a value -> document-count histogram for the named transaction detail, optionally scoped to transactions on the named gateway. Drives the AR filter modal's autocomplete on the detail-value input.\n", "operationId" : "getAccountsReceivableDetailValueHistogram", "parameters" : [ { "description" : "The gateway name to scope to (optional).", "in" : "query", "name" : "gateway", "schema" : { "type" : "string" } }, { "description" : "The transaction-detail name to histogram.", "in" : "query", "name" : "detail", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve a value histogram for a given AR transaction-detail name", "tags" : [ "order" ] } }, "/order/accounts_receivable/gateway_detail_names" : { "get" : { "description" : "For the calling merchant's Accounts Receivable orders, returns the distinct payment gateway names paired with the set of transaction-detail names observed on those gateways. Drives the cascading gateway / detail-name pickers in the AR filter modal.\n", "operationId" : "getAccountsReceivableGatewayDetailNames", "responses" : { "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve gateway / detail-name picker data for the AR filter modal", "tags" : [ "order" ] } }, "/order/orders" : { "get" : { "description" : "Retrieves a group of orders from the account. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.\n", "operationId" : "getOrders", "parameters" : [ { "description" : "Order Id", "in" : "query", "name" : "order_id", "schema" : { "type" : "string" } }, { "description" : "Payment Method", "in" : "query", "name" : "payment_method", "schema" : { "type" : "string" } }, { "description" : "Company", "in" : "query", "name" : "company", "schema" : { "type" : "string" } }, { "description" : "First Name", "in" : "query", "name" : "first_name", "schema" : { "type" : "string" } }, { "description" : "Last Name", "in" : "query", "name" : "last_name", "schema" : { "type" : "string" } }, { "description" : "City", "in" : "query", "name" : "city", "schema" : { "type" : "string" } }, { "description" : "State/Region", "in" : "query", "name" : "state_region", "schema" : { "type" : "string" } }, { "description" : "Postal Code", "in" : "query", "name" : "postal_code", "schema" : { "type" : "string" } }, { "description" : "Country Code (ISO-3166 two letter)", "in" : "query", "name" : "country_code", "schema" : { "type" : "string" } }, { "description" : "Phone", "in" : "query", "name" : "phone", "schema" : { "type" : "string" } }, { "description" : "Email", "in" : "query", "name" : "email", "schema" : { "type" : "string" } }, { "description" : "CC Email", "in" : "query", "name" : "cc_email", "schema" : { "type" : "string" } }, { "description" : "Total", "in" : "query", "name" : "total", "schema" : { "type" : "number" } }, { "description" : "Screen Branding Theme Code", "in" : "query", "name" : "screen_branding_theme_code", "schema" : { "type" : "string" } }, { "description" : "StoreFront Host Name", "in" : "query", "name" : "storefront_host_name", "schema" : { "type" : "string" } }, { "description" : "Creation Date Begin", "in" : "query", "name" : "creation_date_begin", "schema" : { "type" : "string" } }, { "description" : "Creation Date End", "in" : "query", "name" : "creation_date_end", "schema" : { "type" : "string" } }, { "description" : "Payment Date Begin", "in" : "query", "name" : "payment_date_begin", "schema" : { "type" : "string" } }, { "description" : "Payment Date End", "in" : "query", "name" : "payment_date_end", "schema" : { "type" : "string" } }, { "description" : "Shipment Date Begin", "in" : "query", "name" : "shipment_date_begin", "schema" : { "type" : "string" } }, { "description" : "Shipment Date End", "in" : "query", "name" : "shipment_date_end", "schema" : { "type" : "string" } }, { "description" : "RMA", "in" : "query", "name" : "rma", "schema" : { "type" : "string" } }, { "description" : "Purchase Order Number", "in" : "query", "name" : "purchase_order_number", "schema" : { "type" : "string" } }, { "description" : "Item Id", "in" : "query", "name" : "item_id", "schema" : { "type" : "string" } }, { "description" : "Current Stage", "in" : "query", "name" : "current_stage", "schema" : { "type" : "string" } }, { "description" : "Channel Partner Code", "in" : "query", "name" : "channel_partner_code", "schema" : { "type" : "string" } }, { "description" : "Channel Partner Order ID", "in" : "query", "name" : "channel_partner_order_id", "schema" : { "type" : "string" } }, { "description" : "The maximum number of records to return on this one API call. (Maximum 200)", "in" : "query", "name" : "_limit", "schema" : { "default" : 100, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.", "in" : "query", "name" : "_sort", "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result.", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrdersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve orders", "tags" : [ "order" ] }, "post" : { "description" : "Inserts a new order on the UltraCart account. This is probably NOT the method you want. This is for channel orders. For regular orders the customer is entering, use the CheckoutApi. It has many, many more features, checks, and validations.\n", "operationId" : "insertOrder", "parameters" : [ { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/Order" } } }, "description" : "Order to insert", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Insert an order", "tags" : [ "order" ], "x-codegen-request-body-name" : "order" } }, "/order/orders/batch" : { "post" : { "description" : "Retrieves a group of orders from the account based on an array of order ids. If more than 500 order ids are specified, the API call will fail with a bad request error.\n", "operationId" : "getOrdersBatch", "parameters" : [ { "description" : "The object expansion to perform on the result.", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderQueryBatch" } } }, "description" : "Order batch", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrdersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve order batch", "tags" : [ "order" ], "x-codegen-request-body-name" : "order_batch" } }, "/order/orders/query" : { "post" : { "description" : "Retrieves a group of orders from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.\n", "operationId" : "getOrdersByQuery", "parameters" : [ { "description" : "The maximum number of records to return on this one API call. (Maximum 200)", "in" : "query", "name" : "_limit", "schema" : { "default" : 100, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.", "in" : "query", "name" : "_sort", "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result.", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderQuery" } } }, "description" : "Order query", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrdersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve orders by query", "tags" : [ "order" ], "x-codegen-request-body-name" : "order_query" } }, "/order/orders/token" : { "post" : { "description" : "Retrieves a single order using the specified order token.\n", "operationId" : "getOrderByToken", "parameters" : [ { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderByTokenQuery" } } }, "description" : "Order by token query", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve an order using a token", "tags" : [ "order" ], "x-codegen-request-body-name" : "order_by_token_query" } }, "/order/orders/token/{order_id}" : { "get" : { "description" : "Retrieves a single order token for a given order id. The token can be used with the getOrderByToken API.\n", "operationId" : "generateOrderToken", "parameters" : [ { "description" : "The order id to generate a token for.", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderTokenResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Generate an order token for a given order id", "tags" : [ "order" ] } }, "/order/orders/{order_id}" : { "delete" : { "description" : "Delete an order on the UltraCart account.\n", "operationId" : "deleteOrder", "parameters" : [ { "description" : "The order id to delete.", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "content" : { }, "description" : "No Content" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete an order", "tags" : [ "order" ] }, "get" : { "description" : "Retrieves a single order using the specified order id.\n", "operationId" : "getOrder", "parameters" : [ { "description" : "The order id to retrieve.", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve an order", "tags" : [ "order" ] }, "put" : { "description" : "Update a new order on the UltraCart account. This is probably NOT the method you want. It is rare to update a completed order. This will not trigger charges, emails, or any other automation.\n", "operationId" : "updateOrder", "parameters" : [ { "description" : "The order id to update.", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/Order" } } }, "description" : "Order to update", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update an order", "tags" : [ "order" ], "x-codegen-request-body-name" : "order" } }, "/order/orders/{order_id}/adjust_order_total/{desired_total}" : { "post" : { "description" : "Adjusts an order total. Adjusts individual items appropriately and considers taxes. Desired total should be provided in the same currency as the order and must be less than the current total and greater than zero. This call will change the order total. It returns true if the desired total is achieved. If the goal seeking algorithm falls short (usually by pennies), this method returns back false. View the merchant notes for the order for further details.\n", "operationId" : "adjustOrderTotal", "parameters" : [ { "description" : "The order id to cancel.", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The desired total with no formatting. example 123.45", "in" : "path", "name" : "desired_total", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Adjusts an order total", "tags" : [ "order" ] } }, "/order/orders/{order_id}/assignToAffiliate" : { "post" : { "description" : "Assigns an order to an affiliate.\n", "operationId" : "assignToAffiliate", "parameters" : [ { "description" : "The order id to assign to the affiliate.", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderAssignToAffiliateRequest" } } }, "description" : "Assign to affiliate request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Assigns an order to an affiliate", "tags" : [ "order" ], "x-codegen-request-body-name" : "assign_to_affiliate_request" } }, "/order/orders/{order_id}/cancel" : { "post" : { "description" : "Cancel an order on the UltraCart account. If the success flag is false, then consult the error message for why it failed.\n", "operationId" : "cancelOrder", "parameters" : [ { "description" : "The order id to cancel.", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Flag to prevent a order shipping during a refund process", "in" : "query", "name" : "lock_self_ship_orders", "schema" : { "type" : "boolean" } }, { "description" : "Skip refund and move order to Held Orders department", "in" : "query", "name" : "skip_refund_and_hold", "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Cancel an order", "tags" : [ "order" ] } }, "/order/orders/{order_id}/duplicate" : { "post" : { "description" : "Perform a duplicate of the specified order_id and return a new order located in Accounts Receivable.\n", "operationId" : "duplicateOrder", "parameters" : [ { "description" : "The order id to duplicate.", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Duplicate an order", "tags" : [ "order" ] } }, "/order/orders/{order_id}/edi" : { "get" : { "description" : "Retrieve EDI documents associated with this order.\n", "operationId" : "getOrderEdiDocuments", "parameters" : [ { "description" : "The order id to retrieve EDI documents for.", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderEdiDocumentsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve EDI documents associated with this order.", "tags" : [ "order" ] } }, "/order/orders/{order_id}/emails" : { "get" : { "description" : "Retrieves email delivery records associated with the specified order id.\n", "operationId" : "getOrderEmails", "parameters" : [ { "description" : "The order id to retrieve email delivery information for.", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderEmailsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve email delivery information for this order.", "tags" : [ "order" ] } }, "/order/orders/{order_id}/format" : { "post" : { "description" : "Format the order for display at text or html\n", "operationId" : "format", "parameters" : [ { "description" : "The order id to format", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderFormat" } } }, "description" : "Format options", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderFormatResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Format order", "tags" : [ "order" ], "x-codegen-request-body-name" : "format_options" } }, "/order/orders/{order_id}/hold/add_items_and_release" : { "put" : { "description" : "This method adds items to an order in the hold stage and releases it\n", "operationId" : "heldOrderAddItemsAndRelease", "parameters" : [ { "description" : "The order id to release.", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/OrderAddItemsAndReleaseRequest" } } }, "description" : "Add items and release request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Add items and release a held order", "tags" : [ "order" ], "x-codegen-request-body-name" : "add_items_and_release_request" } }, "/order/orders/{order_id}/hold/release" : { "put" : { "description" : "This method releases an order from the hold stage\n", "operationId" : "heldOrderRelease", "parameters" : [ { "description" : "The order id to release.", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Release a held order", "tags" : [ "order" ] } }, "/order/orders/{order_id}/invoice" : { "get" : { "description" : "The invoice PDF that is returned is base 64 encoded\n", "operationId" : "generateInvoice", "parameters" : [ { "description" : "Order ID", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderInvoiceResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Generate an invoice for this order.", "tags" : [ "order" ] } }, "/order/orders/{order_id}/packing_slip" : { "get" : { "description" : "The packing slip PDF that is returned is base 64 encoded\n", "operationId" : "generatePackingSlipAllDC", "parameters" : [ { "description" : "Order ID", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderPackingSlipResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "fulfillment_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Generate a packing slip for this order across all distribution centers.", "tags" : [ "order" ] } }, "/order/orders/{order_id}/packing_slip/{distribution_center_code}" : { "get" : { "description" : "The packing slip PDF that is returned is base 64 encoded\n", "operationId" : "generatePackingSlipSpecificDC", "parameters" : [ { "description" : "Distribution center code", "in" : "path", "name" : "distribution_center_code", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Order ID", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderPackingSlipResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "fulfillment_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Generate a packing slip for this order for the given distribution center.", "tags" : [ "order" ] } }, "/order/orders/{order_id}/page_view_history" : { "get" : { "description" : "Retrieves the page views captured during the session that placed this order.\n", "operationId" : "getOrderPageViewHistory", "parameters" : [ { "description" : "The order id to retrieve page view history for.", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderPageViewHistoryResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve page view history for this order.", "tags" : [ "order" ] } }, "/order/orders/{order_id}/process_payment" : { "post" : { "description" : "Process payment on order\n", "operationId" : "processPayment", "parameters" : [ { "description" : "The order id to process payment on", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderProcessPaymentRequest" } } }, "description" : "Process payment parameters", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderProcessPaymentResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Process payment", "tags" : [ "order" ], "x-codegen-request-body-name" : "process_payment_request" } }, "/order/orders/{order_id}/refund" : { "put" : { "description" : "Perform a refund operation on an order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.\n", "operationId" : "refundOrder", "parameters" : [ { "description" : "The order id to refund.", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Reject order after refund", "in" : "query", "name" : "reject_after_refund", "schema" : { "default" : false, "type" : "boolean" } }, { "description" : "Skip customer email notification", "in" : "query", "name" : "skip_customer_notification", "schema" : { "default" : false, "type" : "boolean" } }, { "description" : "Cancel associated auto orders", "in" : "query", "name" : "auto_order_cancel", "schema" : { "default" : false, "type" : "boolean" } }, { "description" : "Consider a manual refund done externally", "in" : "query", "name" : "manual_refund", "schema" : { "default" : false, "type" : "boolean" } }, { "description" : "Reverse affiliate transactions", "in" : "query", "name" : "reverse_affiliate_transactions", "schema" : { "default" : true, "type" : "boolean" } }, { "description" : "Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account", "in" : "query", "name" : "issue_store_credit", "schema" : { "default" : false, "type" : "boolean" } }, { "description" : "Reason for auto orders cancellation", "in" : "query", "name" : "auto_order_cancel_reason", "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/Order" } } }, "description" : "Order to refund", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Refund an order", "tags" : [ "order" ], "x-codegen-request-body-name" : "order" } }, "/order/orders/{order_id}/refund_block" : { "get" : { "description" : "Sets a refund block on an order to prevent a user from performing a refund. Commonly used when a chargeback has been received.\n", "operationId" : "blockRefundOnOrder", "parameters" : [ { "description" : "The order id to block a refund on.", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Block reason code (optional)", "in" : "query", "name" : "block_reason", "schema" : { "type" : "string" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Set a refund block on an order", "tags" : [ "order" ] } }, "/order/orders/{order_id}/refund_unblock" : { "get" : { "description" : "Removes a refund block on an order to prevent a user from performing a refund.\n", "operationId" : "unblockRefundOnOrder", "parameters" : [ { "description" : "The order id to unblock a refund on.", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Remove a refund block on an order", "tags" : [ "order" ] } }, "/order/orders/{order_id}/refundable" : { "get" : { "description" : "Determine if an order can be refunded based upon payment method and age\n", "operationId" : "isRefundableOrder", "parameters" : [ { "description" : "The order id to check for refundable order.", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderRefundableResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Determine if an order can be refunded", "tags" : [ "order" ] } }, "/order/orders/{order_id}/replace_item_id" : { "put" : { "description" : "Replaces a single order item id with another merchant_item_id, leaving all other attributes and properties unchanged. A custom method requested by a merchant to allow for item id updates due to shipping errors. It is doubtful you will ever need this method. The expansion variable affects the returned order object.\n", "operationId" : "replaceOrderItemMerchantItemId", "parameters" : [ { "description" : "The order id to update.", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/ReplaceOrderItemIdRequest" } } }, "description" : "Replacement Request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Replaces an order item id", "tags" : [ "order" ], "x-codegen-request-body-name" : "replace_order_item_id_request" } }, "/order/orders/{order_id}/replacement" : { "post" : { "description" : "Create a replacement order based upon a previous order\n", "operationId" : "replacement", "parameters" : [ { "description" : "The order id to generate a replacement for.", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderReplacement" } } }, "description" : "Replacement order details", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderReplacementResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Replacement order", "tags" : [ "order" ], "x-codegen-request-body-name" : "replacement" } }, "/order/orders/{order_id}/resend_receipt" : { "post" : { "description" : "Resend the receipt for an order on the UltraCart account.\n", "operationId" : "resendReceipt", "parameters" : [ { "description" : "The order id to resend the receipt for.", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Resend receipt", "tags" : [ "order" ] } }, "/order/orders/{order_id}/resend_shipment_confirmation" : { "post" : { "description" : "Resend shipment confirmation for an order on the UltraCart account.\n", "operationId" : "resendShipmentConfirmation", "parameters" : [ { "description" : "The order id to resend the shipment notification for.", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Resend shipment confirmation", "tags" : [ "order" ] } }, "/order/orders/{order_id}/upsell_with_cart" : { "put" : { "description" : "Creates a new cart using cloned information from the order, but with a specific set of items, coupons and optionally a checkout URL to return the customer to\n", "operationId" : "getOrderUpsellCart", "parameters" : [ { "description" : "The order id to base things on.", "in" : "path", "name" : "order_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/OrderUpsellCartRequest" } } }, "description" : "Request for the upsell cart", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get Order Upsell Cart", "tags" : [ "order" ], "x-codegen-request-body-name" : "upsell_cart_request" } }, "/order/validate" : { "post" : { "description" : "Validate the order for errors. Specific checks can be passed to fine tune what is validated. Read and write permissions are required because the validate method may fix obvious address issues automatically which require update permission.This rest call makes use of the built-in translation of rest objects to UltraCart internal objects which also contains a multitude of validation checks that cannot be trapped. Therefore any time this call is made, you should also trap api exceptions and examine their content because it may contain validation issues. So check the response object and trap any exceptions.\n", "operationId" : "validateOrder", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderValidationRequest" } } }, "description" : "Validation request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrderValidationResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "order_read", "order_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Validate", "tags" : [ "order" ], "x-codegen-request-body-name" : "validation_request" } }, "/checkout/affiliateClick/register" : { "post" : { "description" : "Register an affiliate click. Used by custom checkouts that are completely API based and do not perform checkout handoff.\n", "operationId" : "registerAffiliateClick", "parameters" : [ { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RegisterAffiliateClickRequest" } } }, "description" : "Register affiliate click request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RegisterAffiliateClickResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "checkout_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Register affiliate click", "tags" : [ "checkout" ], "x-codegen-request-body-name" : "register_affiliate_click_request" } }, "/checkout/allowedCountries" : { "post" : { "description" : "Lookup the allowed countries for this merchant id\n", "operationId" : "getAllowedCountries", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CheckoutAllowedCountriesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "checkout_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Allowed countries", "tags" : [ "checkout" ] } }, "/checkout/browser_key" : { "put" : { "description" : "Setup a browser key authenticated application with checkout permissions. This REST call must be made with an authentication scheme that is not browser key. The new application will be linked to the application that makes this call. If this application is disabled / deleted, then so will the application setup by this call. The purpose of this call is to allow an OAuth application, such as the Wordpress plugin, to setup the proper browser based authentication for the REST checkout API to use.\n", "operationId" : "setupBrowserKey", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CheckoutSetupBrowserKeyRequest" } } }, "description" : "Setup browser key request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CheckoutSetupBrowserKeyResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "checkout_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Setup Browser Application", "tags" : [ "checkout" ], "x-codegen-request-body-name" : "browser_key_request" } }, "/checkout/cart" : { "get" : { "description" : "If the cookie is set on the browser making the request then it will return their active cart. Otherwise it will create a new cart.\n", "operationId" : "getCart", "parameters" : [ { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CartResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "checkout_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get cart", "tags" : [ "checkout" ] }, "put" : { "description" : "Update the cart.\n", "operationId" : "updateCart", "parameters" : [ { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Cart" } } }, "description" : "Cart", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CartResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "checkout_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Update cart", "tags" : [ "checkout" ], "x-codegen-request-body-name" : "cart" } }, "/checkout/cart/finalizeOrder" : { "post" : { "description" : "Finalize the cart into an order. This method can not be called with browser key authentication. It is ONLY meant for server side code to call.\n", "operationId" : "finalizeOrder", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CartFinalizeOrderRequest" } } }, "description" : "Finalize request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CartFinalizeOrderResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "checkout_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Finalize Order", "tags" : [ "checkout" ], "x-codegen-request-body-name" : "finalize_request" } }, "/checkout/cart/handoff" : { "post" : { "description" : "Handoff the browser to UltraCart for view cart on StoreFront, transfer to PayPal, transfer to Affirm, transfer to Sezzle or finalization of the order (including upsell processing).\n", "operationId" : "handoffCart", "parameters" : [ { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CheckoutHandoffRequest" } } }, "description" : "Handoff request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CheckoutHandoffResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "checkout_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Handoff cart", "tags" : [ "checkout" ], "x-codegen-request-body-name" : "handoff_request" } }, "/checkout/cart/profile/login" : { "post" : { "description" : "Login in to the customer profile specified by cart.billing.email and password\n", "operationId" : "login", "parameters" : [ { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CartProfileLoginRequest" } } }, "description" : "Login request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CartProfileLoginResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "checkout_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Profile login", "tags" : [ "checkout" ], "x-codegen-request-body-name" : "login_request" } }, "/checkout/cart/profile/logout" : { "post" : { "description" : "Log the cart out of the current profile. No error will occur if they are not logged in.\n", "operationId" : "logout", "parameters" : [ { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Cart" } } }, "description" : "Cart", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CartResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "checkout_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Profile logout", "tags" : [ "checkout" ], "x-codegen-request-body-name" : "cart" } }, "/checkout/cart/profile/register" : { "post" : { "description" : "Register a new customer profile. Requires the cart.billing object to be populated along with the password.\n", "operationId" : "register", "parameters" : [ { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CartProfileRegisterRequest" } } }, "description" : "Register request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CartProfileRegisterResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "checkout_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Profile registration", "tags" : [ "checkout" ], "x-codegen-request-body-name" : "register_request" } }, "/checkout/cart/validate" : { "post" : { "description" : "Validate the cart for errors. Specific checks can be passed and multiple validations can occur throughout your checkout flow.\n", "operationId" : "validateCart", "parameters" : [ { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CartValidationRequest" } } }, "description" : "Validation request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CartValidationResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "checkout_write" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Validate", "tags" : [ "checkout" ], "x-codegen-request-body-name" : "validation_request" } }, "/checkout/cart/{cart_id}" : { "get" : { "description" : "Get a cart specified by the cart_id parameter.\n", "operationId" : "getCartByCartId", "parameters" : [ { "description" : "Cart ID to retrieve", "in" : "path", "name" : "cart_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CartResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "checkout_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get cart (by cart id)", "tags" : [ "checkout" ] } }, "/checkout/cart/{cart_id}/affirmCheckout" : { "get" : { "description" : "Get a Affirm checkout object for the specified cart_id parameter.\n", "operationId" : "getAffirmCheckout", "parameters" : [ { "description" : "Cart ID to retrieve", "in" : "path", "name" : "cart_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CartAffirmCheckoutResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "checkout_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get affirm checkout (by cart id)", "tags" : [ "checkout" ] } }, "/checkout/city_state" : { "post" : { "description" : "Look up the city and state for the shipping zip code. Useful for building an auto complete for parts of the shipping address\n", "operationId" : "cityState", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Cart" } } }, "description" : "Cart", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CityStateZip" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "checkout_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "City/State for Zip", "tags" : [ "checkout" ], "x-codegen-request-body-name" : "cart" } }, "/checkout/relatedItems/{item_id}" : { "post" : { "description" : "Retrieve all the related items for the cart contents. Expansion is limited to content, content.assignments, content.attributes, content.multimedia, content.multimedia.thumbnails, options, pricing, and pricing.tiers.\n", "operationId" : "relatedItemsForItem", "parameters" : [ { "description" : "Item ID to retrieve related items for", "in" : "path", "name" : "item_id", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See item resource documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Cart" } } }, "description" : "Cart", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "checkout_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Related items (specific item)", "tags" : [ "checkout" ], "x-codegen-request-body-name" : "cart" } }, "/checkout/related_items" : { "post" : { "description" : "Retrieve all the related items for the cart contents. Expansion is limited to content, content.assignments, content.attributes, content.multimedia, content.multimedia.thumbnails, options, pricing, and pricing.tiers.\n", "operationId" : "relatedItemsForCart", "parameters" : [ { "description" : "The object expansion to perform on the result. See item resource documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Cart" } } }, "description" : "Cart", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ItemsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "checkout_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Related items", "tags" : [ "checkout" ], "x-codegen-request-body-name" : "cart" } }, "/checkout/return/{return_code}" : { "get" : { "description" : "Get a cart specified by the return code parameter.\n", "operationId" : "getCartByReturnCode", "parameters" : [ { "description" : "Return code to lookup cart ID by", "in" : "path", "name" : "return_code", "required" : true, "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CartResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "checkout_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get cart (by return code)", "tags" : [ "checkout" ] } }, "/checkout/return_token" : { "get" : { "description" : "Get a cart specified by the encrypted return token parameter.\n", "operationId" : "getCartByReturnToken", "parameters" : [ { "description" : "Return token provided by StoreFront Communications", "in" : "query", "name" : "return_token", "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CartResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "checkout_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get cart (by return token)", "tags" : [ "checkout" ] } }, "/checkout/stateProvincesForCountry/{country_code}" : { "post" : { "description" : "Lookup a state/province list for a given country code\n", "operationId" : "getStateProvincesForCountry", "parameters" : [ { "description" : "Two letter ISO country code", "in" : "path", "name" : "country_code", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CheckoutStateProvinceResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "checkout_read" ] }, { "ultraCartSimpleApiKey" : [ ] }, { "ultraCartBrowserApiKey" : [ ] } ], "summary" : "Get state/province list for a country code", "tags" : [ "checkout" ] } }, "/conversation_embed/oauth/device/authorize" : { "post" : { "description" : "RFC 8628 device authorization. Only the embed widget's client_id and the crm_embed scope are accepted.\n", "operationId" : "embedOauthDeviceAuthorize", "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "$ref" : "#/components/schemas/embedOauthDeviceAuthorize_request" } } }, "required" : true }, "responses" : { "200" : { "$ref" : "#/components/responses/" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "summary" : "Initiate a device authorization flow for an embed widget.", "tags" : [ "conversation_embed" ] } }, "/conversation_embed/oauth/device/revoke" : { "post" : { "description" : "RFC 7009 style — the token itself is proof of possession. Accepts either an access token or a refresh token in the 'token' parameter.\n", "operationId" : "embedOauthRevoke", "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "$ref" : "#/components/schemas/embedOauthRevoke_request" } } }, "required" : true }, "responses" : { "200" : { "$ref" : "#/components/responses/" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "summary" : "Revoke an embed widget access or refresh token.", "tags" : [ "conversation_embed" ] } }, "/conversation_embed/oauth/device/token" : { "post" : { "description" : "Accepts grant_type=urn:ietf:params:oauth:grant-type:device_code or grant_type=refresh_token. Other grant types are rejected. Access tokens issued here expire in 60 minutes.\n", "operationId" : "embedOauthToken", "requestBody" : { "content" : { "application/x-www-form-urlencoded" : { "schema" : { "$ref" : "#/components/schemas/embedOauthToken_request" } } }, "required" : true }, "responses" : { "200" : { "$ref" : "#/components/responses/" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "summary" : "Exchange a device_code or refresh_token for an access token (embed widget).", "tags" : [ "conversation_embed" ] } }, "/conversation_embed/pbx-auth" : { "put" : { "description" : "Returns a narrow subset of agent auth fields — only what the softphone widget needs to connect to the PBX relay. Twilio tokens, conversation JWTs, and chat/customer permissions are intentionally excluded.\n", "operationId" : "getEmbedPbxAuth", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConversationEmbedPbxAuthResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "conversation_write" ] } ], "summary" : "Get PBX authorization for the embedded softphone widget.", "tags" : [ "conversation_embed" ] } }, "/datawarehouse/custom_dashboards" : { "get" : { "description" : "Retrieve a custom dashboards\n", "operationId" : "getCustomDashboards", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomDashboardsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get custom dashboards", "tags" : [ "datawarehouse" ] }, "post" : { "description" : "Create a new custom dashboard on the UltraCart account.\n", "operationId" : "insertCustomDashboard", "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/CustomDashboard" } } }, "description" : "Dashboard to create", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomDashboardResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Create a custom dashboard", "tags" : [ "datawarehouse" ], "x-codegen-request-body-name" : "dashboard" } }, "/datawarehouse/custom_dashboards/{custom_dashboard_oid}" : { "delete" : { "description" : "Delete a custom dashboard on the UltraCart account.\n", "operationId" : "deleteCustomDashboard", "parameters" : [ { "description" : "The dashboard oid to delete.", "in" : "path", "name" : "custom_dashboard_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "204" : { "content" : { }, "description" : "No Content" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete a custom dashboard", "tags" : [ "datawarehouse" ] }, "get" : { "description" : "Retrieve a custom dashboard\n", "operationId" : "getCustomDashboard", "parameters" : [ { "in" : "path", "name" : "custom_dashboard_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomDashboardResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get a custom dashboard", "tags" : [ "datawarehouse" ] }, "put" : { "description" : "Update a custom dashboard on the UltraCart account.\n", "operationId" : "updateCustomDashboard", "parameters" : [ { "description" : "The dashboard oid to custom update.", "in" : "path", "name" : "custom_dashboard_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/CustomDashboard" } } }, "description" : "Dashboard to custom update", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomDashboardResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update a custom dashboard", "tags" : [ "datawarehouse" ], "x-codegen-request-body-name" : "dashboard" } }, "/datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules" : { "get" : { "description" : "Retrieve a custom dashboards\n", "operationId" : "getCustomDashboardSchedules", "parameters" : [ { "in" : "path", "name" : "custom_dashboard_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomDashboardSchedulesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get custom dashboards", "tags" : [ "datawarehouse" ] }, "post" : { "description" : "Create a new custom dashboard schedule on the UltraCart account.\n", "operationId" : "insertCustomDashboardSchedule", "parameters" : [ { "in" : "path", "name" : "custom_dashboard_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/CustomDashboardSchedule" } } }, "description" : "Dashboard schedule to create", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomDashboardScheduleResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Create a custom dashboard schedule", "tags" : [ "datawarehouse" ], "x-codegen-request-body-name" : "dashboard_schedule" } }, "/datawarehouse/custom_dashboards/{custom_dashboard_oid}/schedules/{custom_dashboard_schedule_oid}" : { "delete" : { "description" : "delete a custom dashboard schedule on the UltraCart account.\n", "operationId" : "deleteCustomDashboardSchedule", "parameters" : [ { "description" : "The dashboard schedule oid to delete.", "in" : "path", "name" : "custom_dashboard_schedule_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The dashboard oid that owns the schedule.", "in" : "path", "name" : "custom_dashboard_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete a custom dashboard schedule", "tags" : [ "datawarehouse" ] }, "put" : { "description" : "Update a custom dashboard schedule on the UltraCart account.\n", "operationId" : "updateCustomDashboardSchedule", "parameters" : [ { "description" : "The dashboard schedule oid to update.", "in" : "path", "name" : "custom_dashboard_schedule_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The dashboard oid to update.", "in" : "path", "name" : "custom_dashboard_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/CustomDashboardSchedule" } } }, "description" : "Dashboard schedule to update", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomDashboardResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update a custom dashboard schedule", "tags" : [ "datawarehouse" ], "x-codegen-request-body-name" : "dashboard_schedule" } }, "/datawarehouse/custom_reports" : { "get" : { "description" : "Retrieve a custom reports\n", "operationId" : "getCustomReports", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomReportsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get custom reports", "tags" : [ "datawarehouse" ] }, "post" : { "description" : "Create a new custom report on the UltraCart account.\n", "operationId" : "insertCustomReport", "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/CustomReport" } } }, "description" : "Report to create", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomReportResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Create a custom report", "tags" : [ "datawarehouse" ], "x-codegen-request-body-name" : "report" } }, "/datawarehouse/custom_reports/account_config" : { "get" : { "description" : "Retrieve a custom report account configuration\n", "operationId" : "getCustomReportAccountConfig", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomReportAccountConfigResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get custom report account configuration", "tags" : [ "datawarehouse" ] }, "put" : { "description" : "Update custom report account config.\n", "operationId" : "updateCustomReportAccountConfig", "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/CustomReportAccountConfig" } } }, "description" : "Account config to update", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomReportAccountConfigResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update custom report account config", "tags" : [ "datawarehouse" ], "x-codegen-request-body-name" : "account_config" } }, "/datawarehouse/custom_reports/execute" : { "put" : { "description" : "Execute a custom reports on the UltraCart account.\n", "operationId" : "executeCustomReports", "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/CustomReportsExecutionRequest" } } }, "description" : "Request to execute custom reports", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomReportsExecutionResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Execute a custom reports", "tags" : [ "datawarehouse" ], "x-codegen-request-body-name" : "execution_request" } }, "/datawarehouse/custom_reports/{custom_report_oid}" : { "delete" : { "description" : "Delete a custom report on the UltraCart account.\n", "operationId" : "deleteCustomReport", "parameters" : [ { "description" : "The report oid to delete.", "in" : "path", "name" : "custom_report_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "204" : { "content" : { }, "description" : "No Content" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete a custom report", "tags" : [ "datawarehouse" ] }, "get" : { "description" : "Retrieve a custom report\n", "operationId" : "getCustomReport", "parameters" : [ { "in" : "path", "name" : "custom_report_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomReportResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get a custom report", "tags" : [ "datawarehouse" ] }, "put" : { "description" : "Update a custom report on the UltraCart account.\n", "operationId" : "updateCustomReport", "parameters" : [ { "description" : "The report oid to custom update.", "in" : "path", "name" : "custom_report_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/CustomReport" } } }, "description" : "Report to custom update", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomReportResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update a custom report", "tags" : [ "datawarehouse" ], "x-codegen-request-body-name" : "report" } }, "/datawarehouse/custom_reports/{custom_report_oid}/analysis" : { "put" : { "description" : "Analyze a custom report on the UltraCart account.\n", "operationId" : "analyzeCustomReport", "parameters" : [ { "description" : "The report oid to analyze.", "in" : "path", "name" : "custom_report_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/CustomReportAnalysisRequest" } } }, "description" : "Request to analyze custom report", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomReportAnalysisResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Analyze a custom report", "tags" : [ "datawarehouse" ], "x-codegen-request-body-name" : "analyze_request" } }, "/datawarehouse/custom_reports/{custom_report_oid}/chart_png" : { "get" : { "description" : "Upload a PNG of a custom report chart\n", "operationId" : "getCustomReportChartPngUploadUrl", "parameters" : [ { "description" : "The report oid to upload a chart PNG for.", "in" : "path", "name" : "custom_report_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomReportChartPngUploadResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Upload a PNG of a custom report chart", "tags" : [ "datawarehouse" ] } }, "/datawarehouse/custom_reports/{custom_report_oid}/execute" : { "put" : { "description" : "Execute a custom report on the UltraCart account.\n", "operationId" : "executeCustomReport", "parameters" : [ { "description" : "The report oid to execute.", "in" : "path", "name" : "custom_report_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/CustomReportExecutionRequest" } } }, "description" : "Request to execute custom report", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomReportExecutionResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Execute a custom report", "tags" : [ "datawarehouse" ], "x-codegen-request-body-name" : "execution_request" } }, "/datawarehouse/reports" : { "get" : { "description" : "Retrieve a list of reports available\n", "operationId" : "getReports", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ReportsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get list of reports available", "tags" : [ "datawarehouse" ] }, "post" : { "description" : "Create a new report on the UltraCart account.\n", "operationId" : "insertReport", "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/Report" } } }, "description" : "Report to create", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ReportResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Create a report", "tags" : [ "datawarehouse" ], "x-codegen-request-body-name" : "report" } }, "/datawarehouse/reports/auth" : { "put" : { "description" : "Retrieve a JWT to authorize a report to make a websocket connection.\n", "operationId" : "getReportWebsocketAuthorization", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ReportAuthResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get report websocket authorization", "tags" : [ "datawarehouse" ] } }, "/datawarehouse/reports/dataset/{dataset_uuid}" : { "get" : { "description" : "Retrieve a report data set\n", "operationId" : "getReportDataSet", "parameters" : [ { "in" : "path", "name" : "dataset_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ReportDataSetResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get a report data set", "tags" : [ "datawarehouse" ] } }, "/datawarehouse/reports/dataset/{dataset_uuid}/pages/{page_number}" : { "get" : { "description" : "Retrieve a report data set page\n", "operationId" : "getReportDataSetPage", "parameters" : [ { "in" : "path", "name" : "dataset_uuid", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "page_number", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ReportDataSetPageResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get a report data set page", "tags" : [ "datawarehouse" ] } }, "/datawarehouse/reports/dryrun" : { "put" : { "description" : "Dry run the report queries\n", "operationId" : "dryRunReportQueries", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ReportDryRunQueriesRequest" } } }, "description" : "Dry run request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ReportDryRunQueriesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Dry run the report queries", "tags" : [ "datawarehouse" ], "x-codegen-request-body-name" : "query_request" } }, "/datawarehouse/reports/execute" : { "put" : { "description" : "Execute the report queries\n", "operationId" : "executeReportQueries", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ReportExecuteQueriesRequest" } } }, "description" : "Query request", "required" : true }, "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Execute the report queries", "tags" : [ "datawarehouse" ], "x-codegen-request-body-name" : "query_request" } }, "/datawarehouse/reports/{report_oid}" : { "delete" : { "description" : "Delete a report on the UltraCart account.\n", "operationId" : "deleteReport", "parameters" : [ { "description" : "The report oid to delete.", "in" : "path", "name" : "report_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "204" : { "content" : { }, "description" : "No Content" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete a report", "tags" : [ "datawarehouse" ] }, "get" : { "description" : "Retrieve a report\n", "operationId" : "getReport", "parameters" : [ { "in" : "path", "name" : "report_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ReportResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get a report", "tags" : [ "datawarehouse" ] }, "put" : { "description" : "Update a report on the UltraCart account.\n", "operationId" : "updateReport", "parameters" : [ { "description" : "The report oid to update.", "in" : "path", "name" : "report_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/Report" } } }, "description" : "Report to update", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ReportResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "datawarehouse_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update a report", "tags" : [ "datawarehouse" ], "x-codegen-request-body-name" : "report" } }, "/workflow/agent/auth" : { "put" : { "description" : "Retrieve a JWT to authorize an agent to make a websocket connection.\n", "operationId" : "getWorkflowAgentWebsocketAuthorization", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowAgentAuthResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "workflow_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get agent websocket authorization", "tags" : [ "workflow" ] } }, "/workflow/assignment_groups" : { "get" : { "description" : "Retrieve a list of groups that workflow tasks can be assigned to\n", "operationId" : "getWorkflowAssignmentGroups", "parameters" : [ { "description" : "The maximum number of records to return on this one API call. (Max 200)", "in" : "query", "name" : "_limit", "schema" : { "default" : 100, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowGroupsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "workflow_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve a list of groups that workflow tasks can be assigned to", "tags" : [ "workflow" ] } }, "/workflow/assignment_users" : { "get" : { "description" : "Retrieve a list of users that workflow tasks can be assigned to\n", "operationId" : "getWorkflowAssignmentUsers", "parameters" : [ { "description" : "The maximum number of records to return on this one API call. (Max 200)", "in" : "query", "name" : "_limit", "schema" : { "default" : 100, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowUsersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "workflow_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve a list of users that workflow tasks can be assigned to", "tags" : [ "workflow" ] } }, "/workflow/me" : { "get" : { "description" : "Retrieve a user object for myself\n", "operationId" : "getWorkflowMe", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowUserResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "workflow_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve a user object for myself", "tags" : [ "workflow" ] } }, "/workflow/tasks" : { "post" : { "description" : "Insert a workflow task\n", "operationId" : "insertWorkflowTask", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowTask" } } }, "description" : "workflow task", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowTaskResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "workflow_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Insert a workflow task", "tags" : [ "workflow" ], "x-codegen-request-body-name" : "workflow_task" } }, "/workflow/tasks/attachments/{extension}" : { "get" : { "description" : "Get a presigned workflow task attachment upload URL\n", "operationId" : "getWorkflowTaskAttachmentUploadUrl", "parameters" : [ { "in" : "path", "name" : "extension", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowAttachmentUploadUrlResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "workflow_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get a presigned workflow task attachment upload URL", "tags" : [ "workflow" ] } }, "/workflow/tasks/by/{object_type}/{object_id}" : { "get" : { "description" : "Retrieve a workflow task by object type and id\n", "operationId" : "getWorkflowTaskByObjectType", "parameters" : [ { "in" : "path", "name" : "object_type", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "object_id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowTasksResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "workflow_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve a workflow task by object type and id", "tags" : [ "workflow" ] } }, "/workflow/tasks/open_count" : { "get" : { "description" : "Retrieve workflow task open count\n", "operationId" : "getWorkflowTaskOpenCount", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowTaskOpenCountResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "workflow_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve workflow task open count", "tags" : [ "workflow" ] } }, "/workflow/tasks/search" : { "post" : { "description" : "Retrieves a set of workflow tasks from the account based on a query object.\n", "operationId" : "getWorkflowTasks", "parameters" : [ { "description" : "The maximum number of records to return on this one API call. (Default 100, Max 500)", "in" : "query", "name" : "_limit", "schema" : { "default" : 100, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.", "in" : "query", "name" : "_sort", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowTasksRequest" } } }, "description" : "Workflow tasks query", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowTasksResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "workflow_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Search workflow tasks", "tags" : [ "workflow" ], "x-codegen-request-body-name" : "workflow_tasks_query" } }, "/workflow/tasks/tags" : { "get" : { "description" : "Retrieves a unique list of all the existing workflow task tags.\n", "operationId" : "getWorkflowTaskTags", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowTaskTagsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "workflow_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get a list of existing workflow task tags", "tags" : [ "workflow" ] } }, "/workflow/tasks/{task_uuid}" : { "get" : { "description" : "Retrieve a workflow task\n", "operationId" : "getWorkflowTask", "parameters" : [ { "in" : "path", "name" : "task_uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowTaskResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "workflow_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve a workflow task", "tags" : [ "workflow" ] }, "put" : { "description" : "Update a workflow task\n", "operationId" : "updateWorkflowTask", "parameters" : [ { "in" : "path", "name" : "task_uuid", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowTask" } } }, "description" : "Workflow task", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WorkflowTaskResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "workflow_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update a workflow task", "tags" : [ "workflow" ], "x-codegen-request-body-name" : "workflow_task" } }, "/user/groups" : { "get" : { "operationId" : "getGroups", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GroupsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "user_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get groups", "tags" : [ "user" ] }, "post" : { "description" : "Insert a group on the UltraCart account.\n", "operationId" : "insertGroup", "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/Group" } } }, "description" : "Group to insert", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GroupResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "user_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Insert a group", "tags" : [ "user" ], "x-codegen-request-body-name" : "group" } }, "/user/groups/{group_oid}" : { "delete" : { "description" : "Delete a group on the UltraCart account.\n", "operationId" : "deleteGroup", "parameters" : [ { "description" : "The group_oid to delete.", "in" : "path", "name" : "group_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "user_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete a group", "tags" : [ "user" ] }, "get" : { "description" : "Retrieves a single group using the specified group id.\n", "operationId" : "getGroup", "parameters" : [ { "description" : "The group id to retrieve.", "in" : "path", "name" : "group_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "user_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve a group", "tags" : [ "user" ] }, "put" : { "description" : "Update a group on the UltraCart account.\n", "operationId" : "updateGroup", "parameters" : [ { "description" : "The group_oid to update.", "in" : "path", "name" : "group_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/Group" } } }, "description" : "Group to update", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GroupResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "user_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update a group", "tags" : [ "user" ], "x-codegen-request-body-name" : "group" } }, "/user/users" : { "get" : { "operationId" : "getUsers", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UsersResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "user_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Get users", "tags" : [ "user" ] }, "post" : { "description" : "Insert a user on the UltraCart account.\n", "operationId" : "insertUser", "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/User" } } }, "description" : "User to insert", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UserResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "user_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Insert a user", "tags" : [ "user" ], "x-codegen-request-body-name" : "user" } }, "/user/users/{user_id}" : { "delete" : { "description" : "Delete a user on the UltraCart account.\n", "operationId" : "deleteUser", "parameters" : [ { "description" : "The user_id to delete.", "in" : "path", "name" : "user_id", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "user_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete a user", "tags" : [ "user" ] }, "get" : { "description" : "Retrieves a single user using the specified user id.\n", "operationId" : "getUser", "parameters" : [ { "description" : "The user id to retrieve.", "in" : "path", "name" : "user_id", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UserResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "user_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve a user", "tags" : [ "user" ] }, "put" : { "description" : "Update a user on the UltraCart account.\n", "operationId" : "updateUser", "parameters" : [ { "description" : "The user_id to update.", "in" : "path", "name" : "user_id", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/User" } } }, "description" : "User to update", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UserResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "user_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update a user", "tags" : [ "user" ], "x-codegen-request-body-name" : "user" } }, "/user/users/{user_id}/logins" : { "get" : { "description" : "Retrieves logins for a single user using the specified user id.\n", "operationId" : "getUserLogins", "parameters" : [ { "description" : "The user id to retrieve.", "in" : "path", "name" : "user_id", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UserLoginsResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "user_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve a user's login history", "tags" : [ "user" ] } }, "/webhook/webhook_event_categories" : { "get" : { "description" : "Retrieves the available webhook event categories and events with backend-owned metadata (OIDs, names, descriptions, available expansions, flags) independent of whether any webhooks are saved. Used by the New Webhook editor so a merchant with zero webhooks can still see the catalog.\n", "operationId" : "getWebhookEventCategories", "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WebhookEventCategoriesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "webhook_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve webhook event categories", "tags" : [ "webhook" ] } }, "/webhook/webhooks" : { "delete" : { "description" : "Delete a webhook based upon the URL on the webhook_url matching an existing webhook.\n", "operationId" : "deleteWebhookByUrl", "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/Webhook" } } }, "description" : "Webhook to delete", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WebhookResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "webhook_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete a webhook by URL", "tags" : [ "webhook" ], "x-codegen-request-body-name" : "webhook" }, "get" : { "description" : "Retrieves the webhooks associated with this application.\n", "operationId" : "getWebhooks", "parameters" : [ { "description" : "The maximum number of records to return on this one API call.", "in" : "query", "name" : "_limit", "schema" : { "default" : 100, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "The sort order of the webhooks. See documentation for examples", "in" : "query", "name" : "_sort", "schema" : { "type" : "string" } }, { "description" : "Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.", "in" : "query", "name" : "_placeholders", "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WebhooksResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "webhook_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve webhooks", "tags" : [ "webhook" ] }, "post" : { "description" : "Adds a new webhook on the account. If you add a new webhook with the authentication_type set to basic, but do not specify the basic_username and basic_password, UltraCart will automatically generate random ones and return them. This allows your application to have simpler logic on the setup of a secure webhook.\n", "operationId" : "insertWebhook", "parameters" : [ { "description" : "Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.", "in" : "query", "name" : "_placeholders", "schema" : { "type" : "boolean" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/Webhook" } } }, "description" : "Webhook to create", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WebhookResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "webhook_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Add a webhook", "tags" : [ "webhook" ], "x-codegen-request-body-name" : "webhook" } }, "/webhook/webhooks/{webhookOid}" : { "delete" : { "description" : "Delete a webhook on the UltraCart account.\n", "operationId" : "deleteWebhook", "parameters" : [ { "description" : "The webhook oid to delete.", "in" : "path", "name" : "webhookOid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "204" : { "content" : { }, "description" : "No Content" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "webhook_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete a webhook", "tags" : [ "webhook" ] }, "put" : { "description" : "Update a webhook on the account\n", "operationId" : "updateWebhook", "parameters" : [ { "description" : "The webhook oid to update.", "in" : "path", "name" : "webhookOid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.", "in" : "query", "name" : "_placeholders", "schema" : { "type" : "boolean" } } ], "requestBody" : { "content" : { "application/json; charset=UTF-8" : { "schema" : { "$ref" : "#/components/schemas/Webhook" } } }, "description" : "Webhook to update", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WebhookResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "webhook_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update a webhook", "tags" : [ "webhook" ], "x-codegen-request-body-name" : "webhook" } }, "/webhook/webhooks/{webhookOid}/logs" : { "get" : { "description" : "Retrieves the log summary information for a given webhook. This is useful for displaying all the various logs that can be viewed.\n", "operationId" : "getWebhookLogSummaries", "parameters" : [ { "description" : "The webhook oid to retrieve log summaries for.", "in" : "path", "name" : "webhookOid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The maximum number of records to return on this one API call.", "in" : "query", "name" : "_limit", "schema" : { "default" : 100, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "Fetch log summaries that have been delivered since this date/time.", "in" : "query", "name" : "_since", "schema" : { "format" : "dateTime", "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WebhookLogSummariesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "webhook_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve the log summaries", "tags" : [ "webhook" ] } }, "/webhook/webhooks/{webhookOid}/logs/{requestId}" : { "get" : { "description" : "Retrieves an individual log for a webhook given the webhook oid the request id.\n", "operationId" : "getWebhookLog", "parameters" : [ { "description" : "The webhook oid that owns the log.", "in" : "path", "name" : "webhookOid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The request id associated with the log to view.", "in" : "path", "name" : "requestId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WebhookLogResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "webhook_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve an individual log", "tags" : [ "webhook" ] } }, "/webhook/webhooks/{webhookOid}/reflow/{eventName}" : { "post" : { "description" : "This method will resend events to the webhook endpoint. This method can be used for example to send all the existing items on an account to a webhook.\n", "operationId" : "resendEvent", "parameters" : [ { "description" : "The webhook oid that is receiving the reflowed events.", "in" : "path", "name" : "webhookOid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "description" : "The event to reflow.", "in" : "path", "name" : "eventName", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WebhookReflowResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "webhook_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Resend events to the webhook endpoint.", "tags" : [ "webhook" ] } }, "/integration_log/query" : { "post" : { "description" : "Retrieves a set of integration logs from the account based on a query object.\n", "operationId" : "getIntegrationLogsQuery", "parameters" : [ { "description" : "The maximum number of records to return on this one API call. (Default 100, Max 500)", "in" : "query", "name" : "_limit", "schema" : { "default" : 100, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.", "in" : "query", "name" : "_sort", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IntegrationLogQueryRequest" } } }, "description" : "Integration log query", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IntegrationLogQueryResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "integration_log_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve integration logs", "tags" : [ "integration_log" ], "x-codegen-request-body-name" : "integration_log_query" } }, "/integration_log/query/{pk}/{sk}" : { "get" : { "description" : "Retrieve an integration logs from the account based identifiers\n", "operationId" : "getIntegrationLog", "parameters" : [ { "in" : "path", "name" : "pk", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "sk", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IntegrationLogResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "integration_log_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve an integration log", "tags" : [ "integration_log" ] } }, "/integration_log/query/{pk}/{sk}/{uuid}" : { "get" : { "description" : "Retrieve an integration log file from the account based identifiers\n", "operationId" : "getIntegrationLogFile", "parameters" : [ { "in" : "path", "name" : "pk", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "sk", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/octet-stream" : { "schema" : { "format" : "binary", "type" : "string" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/octet-stream" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/octet-stream" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/octet-stream" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/octet-stream" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/octet-stream" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "integration_log_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve an integration log file", "tags" : [ "integration_log" ] } }, "/integration_log/query/{pk}/{sk}/{uuid}/pdf" : { "get" : { "description" : "Retrieve an integration log file from the account based identifiers\n", "operationId" : "getIntegrationLogFilePdf", "parameters" : [ { "in" : "path", "name" : "pk", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "sk", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "uuid", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/octet-stream" : { "schema" : { "format" : "binary", "type" : "string" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/octet-stream" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/octet-stream" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/octet-stream" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/octet-stream" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/octet-stream" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "integration_log_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve an integration log file converted to PDF", "tags" : [ "integration_log" ] } }, "/integration_log/summary/query" : { "post" : { "description" : "Retrieves a set of integration log summaries from the account based on a query object.\n", "operationId" : "getIntegrationLogSummariesQuery", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IntegrationLogSummaryQueryRequest" } } }, "description" : "Integration log summaries query", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IntegrationLogSummaryQueryResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "integration_log_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve integration log summaries", "tags" : [ "integration_log" ], "x-codegen-request-body-name" : "integration_log_summaries_query" } }, "/gift_certificate/gift_certificates" : { "post" : { "description" : "Creates a gift certificate for this merchant account.\n", "operationId" : "createGiftCertificate", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GiftCertificateCreateRequest" } } }, "description" : "Gift certificate create request", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GiftCertificateResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "gift_certificate_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Create a gift certificate", "tags" : [ "gift certificate" ], "x-codegen-request-body-name" : "gift_certificate_create_request" } }, "/gift_certificate/gift_certificates/by_code/{code}" : { "post" : { "description" : "Retrieves a gift certificate from the account based on the code (the value the customer enters at checkout time).\n", "operationId" : "getGiftCertificateByCode", "parameters" : [ { "in" : "path", "name" : "code", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GiftCertificateResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "gift_certificate_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve gift certificate by code", "tags" : [ "gift certificate" ] } }, "/gift_certificate/gift_certificates/by_email/{email}" : { "post" : { "description" : "Retrieves all gift certificates from the account based on customer email.\n", "operationId" : "getGiftCertificatesByEmail", "parameters" : [ { "in" : "path", "name" : "email", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GiftCertificatesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "gift_certificate_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve gift certificate by email", "tags" : [ "gift certificate" ] } }, "/gift_certificate/gift_certificates/query" : { "post" : { "description" : "Retrieves gift certificates from the account. If no parameters are specified, all gift certificates will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.\n", "operationId" : "getGiftCertificatesByQuery", "parameters" : [ { "description" : "The maximum number of records to return on this one API call. (Max 200)", "in" : "query", "name" : "_limit", "schema" : { "default" : 100, "type" : "integer" } }, { "description" : "Pagination of the record set. Offset is a zero based index.", "in" : "query", "name" : "_offset", "schema" : { "default" : 0, "type" : "integer" } }, { "description" : "Fetch customers that have been created/modified since this date/time.", "in" : "query", "name" : "_since", "schema" : { "format" : "dateTime", "type" : "string" } }, { "description" : "The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.", "in" : "query", "name" : "_sort", "schema" : { "type" : "string" } }, { "description" : "The object expansion to perform on the result. See documentation for examples", "in" : "query", "name" : "_expand", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GiftCertificateQuery" } } }, "description" : "Gift certificates query", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GiftCertificatesResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "gift_certificate_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve gift certificates by query", "tags" : [ "gift certificate" ], "x-codegen-request-body-name" : "gift_certificate_query" } }, "/gift_certificate/gift_certificates/{gift_certificate_oid}" : { "delete" : { "description" : "Deletes a gift certificate for this merchant account.\n", "operationId" : "deleteGiftCertificate", "parameters" : [ { "in" : "path", "name" : "gift_certificate_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "gift_certificate_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Delete a gift certificate", "tags" : [ "gift certificate" ] }, "post" : { "description" : "Retrieves a gift certificate from the account based on the internal primary key.\n", "operationId" : "getGiftCertificateByOid", "parameters" : [ { "in" : "path", "name" : "gift_certificate_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GiftCertificateResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "gift_certificate_read" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Retrieve gift certificate by oid", "tags" : [ "gift certificate" ] }, "put" : { "description" : "Update a gift certificate for this merchant account.\n", "operationId" : "updateGiftCertificate", "parameters" : [ { "in" : "path", "name" : "gift_certificate_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GiftCertificate" } } }, "description" : "Gift certificate", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GiftCertificateResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "gift_certificate_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Update a gift certificate", "tags" : [ "gift certificate" ], "x-codegen-request-body-name" : "gift_certificate" } }, "/gift_certificate/gift_certificates/{gift_certificate_oid}/ledger_entry" : { "post" : { "description" : "Adds a ledger entry for this gift certificate.\n", "operationId" : "addGiftCertificateLedgerEntry", "parameters" : [ { "in" : "path", "name" : "gift_certificate_oid", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GiftCertificateLedgerEntry" } } }, "description" : "Gift certificate ledger entry", "required" : true }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GiftCertificateResponse" } } }, "description" : "Successful response" }, "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "security" : [ { "ultraCartOauth" : [ "gift_certificate_write" ] }, { "ultraCartSimpleApiKey" : [ ] } ], "summary" : "Add a gift certificate ledger entry", "tags" : [ "gift certificate" ], "x-codegen-request-body-name" : "gift_certificate_ledger_entry" } } }, "components" : { "responses" : { "400" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 400: bad request input such as invalid json", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "401" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 401: invalid credentials supplied", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "410" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 410: Your authorized application has been disabled by UltraCart", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "429" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 429: you have exceeded the allowed API call rate limit for your application.", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } }, "500" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorResponse" } } }, "description" : "Status Code 500: any server side error. the body will contain a generic server error message", "headers" : { "UC-REST-ERROR" : { "description" : "Contains human readable error message", "schema" : { "type" : "string" } } } } }, "schemas" : { "AccountsReceivableRetryConfig" : { "properties" : { "active" : { "description" : "True if the retry should run daily. False puts the retry service into an inactive state for this merchant.", "type" : "boolean" }, "allow_process_linked_accounts" : { "description" : "True if this account has linked accounts that it can process.", "type" : "boolean" }, "cancel_auto_order" : { "description" : "If true also cancel the auto order if the order is rejected at the end", "type" : "boolean" }, "current_service_plan" : { "description" : "The current service plan that the account is on.", "type" : "string" }, "daily_activity_list" : { "description" : "A list of days and what actions should take place on those days after an order reaches accounts receivable", "items" : { "$ref" : "#/components/schemas/AccountsReceivableRetryDayActivity" }, "type" : "array" }, "managed_by_linked_account_merchant_id" : { "description" : "If not null, this account is managed by the specified parent merchant id.", "type" : "boolean" }, "merchant_id" : { "description" : "UltraCart merchant ID", "type" : "string" }, "notify_emails" : { "description" : "A list of email addresses to receive summary notifications from the retry service.", "items" : { "type" : "string" }, "type" : "array" }, "notify_rejections" : { "description" : "If true, email addresses are notified of rejections.", "type" : "boolean" }, "notify_successes" : { "description" : "If true, email addresses are notified of successful charges.", "type" : "boolean" }, "process_linked_accounts" : { "description" : "If true, all linked accounts are also processed using the same rules.", "type" : "boolean" }, "processing_percentage" : { "description" : "The percentage rate charged for the service.", "type" : "string" }, "reject_at_end" : { "description" : "If true, the order is rejected the day after the last configured activity day", "type" : "boolean" }, "transaction_rejects" : { "description" : "Array of key/value pairs that when found in the response cause the rejection of the transaction.", "items" : { "$ref" : "#/components/schemas/AccountsReceivableRetryTransactionReject" }, "type" : "array" }, "trial_mode" : { "description" : "True if the account is currently in trial mode. Set to false to exit trial mode.", "type" : "boolean" }, "trial_mode_expiration_dts" : { "description" : "The date when trial mode expires. If this date is reached without exiting trial mode, the service will de-activate.", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "AccountsReceivableRetryConfigResponse" : { "properties" : { "config" : { "$ref" : "#/components/schemas/AccountsReceivableRetryConfig" }, "coupon_codes" : { "items" : { "type" : "string" }, "type" : "array" }, "emails" : { "items" : { "type" : "string" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "has_linked_accounts" : { "type" : "boolean" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "AccountsReceivableRetryDayActivity" : { "properties" : { "charge" : { "description" : "True if a charge attempt should be made on this day. False means the order should be rejected on this day.", "type" : "boolean" }, "coupon_code" : { "description" : "The coupon code that should be applied to this order.", "type" : "string" }, "day" : { "description" : "The number of days since the order placed in Accounts Receivable", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "AccountsReceivableRetryStatAccount" : { "properties" : { "days" : { "items" : { "$ref" : "#/components/schemas/AccountsReceivableRetryStatMetrics" }, "type" : "array" }, "merchant_id" : { "type" : "string" }, "overall" : { "$ref" : "#/components/schemas/AccountsReceivableRetryStatMetrics" }, "revenue_for_period" : { "items" : { "$ref" : "#/components/schemas/AccountsReceivableRetryStatRevenue" }, "type" : "array" } }, "type" : "object" }, "AccountsReceivableRetryStatMetrics" : { "properties" : { "attempts" : { "format" : "int32", "type" : "integer" }, "attempts_formatted" : { "type" : "string" }, "conversion_rate" : { "type" : "number" }, "conversion_rate_formatted" : { "type" : "string" }, "day" : { "format" : "int32", "type" : "integer" }, "discounts" : { "type" : "number" }, "discounts_formatted" : { "type" : "string" }, "revenue" : { "type" : "number" }, "revenue_formatted" : { "type" : "string" }, "successes" : { "format" : "int32", "type" : "integer" }, "successes_formatted" : { "type" : "string" } }, "type" : "object" }, "AccountsReceivableRetryStatRevenue" : { "properties" : { "label" : { "type" : "string" }, "revenue" : { "type" : "number" } }, "type" : "object" }, "AccountsReceivableRetryStatsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "linked_accounts" : { "items" : { "$ref" : "#/components/schemas/AccountsReceivableRetryStatAccount" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "overall" : { "$ref" : "#/components/schemas/AccountsReceivableRetryStatAccount" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "AccountsReceivableRetryTransactionReject" : { "properties" : { "name" : { "description" : "Transaction response name", "type" : "string" }, "value" : { "description" : "Transaction response value", "type" : "string" } }, "type" : "object" }, "Activity" : { "properties" : { "action" : { "type" : "string" }, "channel" : { "type" : "string" }, "metric" : { "type" : "string" }, "storefront_oid" : { "format" : "int32", "type" : "integer" }, "subject" : { "type" : "string" }, "ts" : { "format" : "int64", "type" : "integer" }, "type" : { "type" : "string" }, "uuid" : { "type" : "string" } }, "type" : "object" }, "AddLibraryItemRequest" : { "properties" : { "attributes" : { "description" : "Attributes associated with the library item to contain additional configuration.", "items" : { "$ref" : "#/components/schemas/LibraryItemAttribute" }, "type" : "array" }, "cjson" : { "description" : "Cjson to be added to library", "type" : "string" }, "content_type" : { "description" : "flow, campaign, cjson, email, transactional_email, postcard or upsell", "type" : "string" }, "description" : { "description" : "description of library item", "type" : "string" }, "email_name" : { "description" : "Required if content_type is transactional_email. This is the name of the email template (html, not text). This name should have a .vm file extension. An example is auto_order_cancel_html.vm", "type" : "string" }, "email_path" : { "description" : "Required if content_type is transactional_email. This is the full path to the email template stored in the file system. This defines which StoreFront contains the desired email template. An example is /themes/Elements/core/emails/auto_order_cancel_html.vm", "type" : "string" }, "screenshots" : { "description" : "Screenshot urls for display", "items" : { "$ref" : "#/components/schemas/LibraryItemScreenshot" }, "type" : "array" }, "storefront_oid" : { "description" : "StoreFront oid where content originates necessary for tracking down relative assets", "format" : "int32", "type" : "integer" }, "title" : { "description" : "title of library item, usually the name of the flow or campaign, or description of cjson", "type" : "string" }, "upsell_offer_oid" : { "description" : "Required if content_type is upsell. This is object identifier of a StoreFront Upsell Offer.", "format" : "int32", "type" : "integer" }, "uuid" : { "description" : "UUID of communication flow, campaign, email, postcard, or null if this item is something else. transactional_email do not have a uuid because they are singleton objects within a storefront and easily identifiable by name", "type" : "string" } }, "type" : "object" }, "AdjustInternalCertificateRequest" : { "properties" : { "adjustment_amount" : { "description" : "The adjustment amount", "type" : "number" }, "description" : { "description" : "Description of this adjustment, 50 characters max", "type" : "string" }, "entry_dts" : { "description" : "Optional timestamp for the adjustment, defaults to current time", "format" : "dateTime", "type" : "string" }, "expiration_days" : { "description" : "Optional expiration days from the entry_dts when these adjustment becomes worthless", "format" : "int32", "type" : "integer" }, "order_id" : { "description" : "Optional order id if this adjustment is related to a particular order", "type" : "string" }, "vesting_days" : { "description" : "Optional days required for this adjustment to vest", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "AdjustInternalCertificateResponse" : { "properties" : { "adjustment_amount" : { "description" : "The adjustment amount", "type" : "number" }, "balance_amount" : { "description" : "The balance amount after the adjustment was made", "type" : "number" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "AffiliateClick" : { "properties" : { "affiliate_click_oid" : { "description" : "Unique object identifier for this click", "format" : "int32", "type" : "integer" }, "affiliate_link_oid" : { "description" : "Unique object identifier for for the link that this click is associated with", "format" : "int32", "type" : "integer" }, "affiliate_oid" : { "description" : "Affiliate object ID associated with this click", "format" : "int32", "type" : "integer" }, "click_dts" : { "description" : "Date/time that the click was made", "format" : "dateTime", "type" : "string" }, "ip_address" : { "description" : "IP address that generated the click", "type" : "string" }, "landing_page" : { "description" : "URL of the landing page the customer was sent to.", "type" : "string" }, "landing_page_query_string" : { "description" : "Query string on the landing page URL the customer was sent to.", "type" : "string" }, "link" : { "$ref" : "#/components/schemas/AffiliateLink" }, "referrer" : { "description" : "URL that referred the click (Browser Header Referer)", "type" : "string" }, "referrer_query_string" : { "description" : "Query string that was on the referrer URL.", "type" : "string" }, "screen_recording_uuid" : { "description" : "Screen recording UUID", "type" : "string" }, "sub_id" : { "description" : "Sub ID value passed on the click", "type" : "string" }, "ucacid" : { "description" : "UC Analytics Identifier", "type" : "string" } }, "type" : "object" }, "AffiliateClickQuery" : { "properties" : { "affiliate_link_oid" : { "description" : "Unique object identifier for for the link that this click is associated with", "format" : "int32", "type" : "integer" }, "affiliate_oid" : { "description" : "Affiliate ID associated with the click", "format" : "int32", "type" : "integer" }, "click_dts_begin" : { "description" : "Minimum click date/time to return", "format" : "dateTime", "type" : "string" }, "click_dts_end" : { "description" : "Maximum click date/time to return", "format" : "dateTime", "type" : "string" }, "ip_address" : { "description" : "IP address that generated the click", "type" : "string" }, "sub_id" : { "description" : "Sub ID value passed on the click", "type" : "string" } }, "type" : "object" }, "AffiliateClicksResponse" : { "properties" : { "clicks" : { "description" : "clicks", "items" : { "$ref" : "#/components/schemas/AffiliateClick" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "AffiliateLedger" : { "properties" : { "affiliate_click_oid" : { "description" : "Unique object identifier for the click associated with this ledger entry", "format" : "int32", "type" : "integer" }, "affiliate_ledger_oid" : { "description" : "Affiliate ledger object ID associated with this ledger", "format" : "int32", "type" : "integer" }, "affiliate_link_oid" : { "description" : "Unique object identifier for the link that this click is associated with", "format" : "int32", "type" : "integer" }, "affiliate_oid" : { "description" : "Affiliate object ID associated with this transaction", "format" : "int32", "type" : "integer" }, "assigned_by_user" : { "description" : "User that assigned the transaction if it was done manually", "type" : "string" }, "click" : { "$ref" : "#/components/schemas/AffiliateClick" }, "item_id" : { "description" : "Item ID associated with this transaction", "type" : "string" }, "link" : { "$ref" : "#/components/schemas/AffiliateLink" }, "order" : { "$ref" : "#/components/schemas/Order" }, "order_id" : { "description" : "Order ID associated with this transaction", "type" : "string" }, "original_transaction_dts" : { "description" : "Date/time of the original transaction for reversals", "format" : "dateTime", "type" : "string" }, "sub_id" : { "description" : "Sub ID associated with transaction (from the click)", "type" : "string" }, "tier_number" : { "description" : "Tier number that this transaction earned", "format" : "int32", "type" : "integer" }, "transaction_amount" : { "description" : "Transaction amount", "type" : "number" }, "transaction_amount_paid" : { "description" : "Amount of the transaction that has been paid out.", "type" : "number" }, "transaction_dts" : { "description" : "Date/time that the transaction was made", "format" : "dateTime", "type" : "string" }, "transaction_memo" : { "description" : "Memo explaining the transaction", "type" : "string" }, "transaction_percentage" : { "description" : "Percentage associated with this transaction", "type" : "number" }, "transaction_state" : { "description" : "Transaction state", "enum" : [ "Pending", "Posted", "Approved", "Paid", "Rejected", "Partially Paid" ], "type" : "string" } }, "type" : "object" }, "AffiliateLedgerQuery" : { "properties" : { "affiliate_oid" : { "description" : "Affiliate ID associated with the ledger", "format" : "int32", "type" : "integer" }, "item_id" : { "description" : "Item id associated with the ledger entry", "type" : "string" }, "order_id" : { "description" : "Order ID associated with the ledger entries", "type" : "string" }, "sub_id" : { "description" : "Sub ID value passed on the click that generated the ledger", "type" : "string" }, "transaction_dts_begin" : { "description" : "Minimum transaction date/time to return", "format" : "dateTime", "type" : "string" }, "transaction_dts_end" : { "description" : "Maximum transaction date/time to return", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "AffiliateLedgersResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "ledgers" : { "description" : "ledgers", "items" : { "$ref" : "#/components/schemas/AffiliateLedger" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "AffiliateLink" : { "properties" : { "affiliate_link_oid" : { "description" : "Unique object identifier associated with this link", "format" : "int32", "type" : "integer" }, "affiliate_managed_link_oid" : { "description" : "Managed link OID that this link object was generated from", "format" : "int32", "type" : "integer" }, "affiliate_oid" : { "description" : "Affiliate object ID associated with this link", "format" : "int32", "type" : "integer" }, "affiliate_program_item_oid" : { "description" : "The affiliate program item this managed link is associated with", "format" : "int32", "type" : "integer" }, "code" : { "description" : "Code associated with the link", "type" : "string" }, "creative_oid" : { "description" : "Creative (image or text) associated with this link", "format" : "int32", "type" : "integer" }, "custom_html" : { "description" : "Custom HTML associated with this link", "type" : "string" }, "custom_html_approval_status" : { "description" : "Approved status of the custom html", "enum" : [ "Pending", "Approved", "Rejected" ], "type" : "string" }, "custom_landing_url" : { "description" : "Custom landing page URL if configured", "type" : "string" }, "deleted" : { "description" : "True if the link has been deleted", "type" : "boolean" }, "invisible_link_approval_status" : { "description" : "Invisible link approval status", "enum" : [ "Pending", "Approved", "Rejected" ], "type" : "string" }, "invisible_link_url_prefix" : { "description" : "Invisible link URL prefix", "type" : "string" }, "name" : { "description" : "Name of the link", "type" : "string" }, "type" : { "description" : "Type of link", "enum" : [ "image", "text", "invisible", "direct" ], "type" : "string" } }, "type" : "object" }, "AgentSummary" : { "properties" : { "agent_name" : { "description" : "Agent display name", "type" : "string" }, "agent_user_id" : { "description" : "Agent user id", "type" : "string" }, "availability_pct" : { "$ref" : "#/components/schemas/double" }, "available_seconds" : { "description" : "Total Available seconds in the range (incl. Busy)", "format" : "int64", "type" : "integer" }, "calls_taken" : { "description" : "Calls taken in the range (PBX)", "format" : "int32", "type" : "integer" }, "chats_handled" : { "description" : "Chats handled in the range (chat)", "format" : "int32", "type" : "integer" }, "total_tracked_seconds" : { "description" : "Total tracked seconds in the range", "format" : "int64", "type" : "integer" } }, "type" : "object" }, "ApiUserApplicationProfile" : { "properties" : { "api_application_logo_url" : { "description" : "Application logo URL", "type" : "string" }, "application_description" : { "description" : "Application description", "type" : "string" }, "application_name" : { "description" : "Application name", "type" : "string" }, "developer_name" : { "description" : "Developer name", "type" : "string" }, "developer_website" : { "description" : "Developer website", "type" : "string" } }, "type" : "object" }, "ApplyLibraryItemRequest" : { "properties" : { "email_uuid" : { "description" : "Normal emails are applied to an existing email object, so when requesting a library item to be applied to an email, supply the email uuid. This is only for normal emails. Transactional emails do not have a uuid.", "type" : "string" }, "library_item_oid" : { "description" : "Library item oid that you wish to apply to the given StoreFront", "format" : "int32", "type" : "integer" }, "postcard_uuid" : { "description" : "The postcard uuid you wish to apply to a given StoreFront.", "type" : "string" }, "storefront_oid" : { "description" : "StoreFront oid where content originates necessary for tracking down relative assets", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ApplyLibraryItemResponse" : { "properties" : { "attributes" : { "description" : "Attributes from the library item", "items" : { "$ref" : "#/components/schemas/LibraryItemAttribute" }, "type" : "array" }, "cjson" : { "description" : "Cjson from library item, only populated if this library item was a cjson snippet or marketing email (not transactional)", "type" : "string" }, "content_type" : { "description" : "flow, campaign, cjson, upsell, postcard, transactional_email or email", "type" : "string" }, "email_template_vm_path" : { "description" : "If a marketing email was applied, this is the path to the template encapsulating the cjson. This is needed for the UltraCart UI.", "type" : "string" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "storefront_oid" : { "description" : "StoreFront oid where content originates necessary for tracking down relative assets", "format" : "int32", "type" : "integer" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "title" : { "description" : "title of library item, usually the name of the flow or campaign, or description of cjson", "type" : "string" }, "uuid" : { "description" : "UUID of marketing email or communication flow/campaign if this library item was an email, campaign or flow", "type" : "string" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "AutoOrder" : { "properties" : { "add_ons" : { "description" : "Array of addon objects instructing which items to add to auto order and how many times they should be added.", "items" : { "$ref" : "#/components/schemas/AutoOrderAddonItem" }, "type" : "array" }, "auto_order_code" : { "description" : "Unique code assigned to this auto order", "type" : "string" }, "auto_order_oid" : { "description" : "Auto order object identifier", "format" : "int32", "type" : "integer" }, "cancel_after_next_x_orders" : { "description" : "Cancel this auto order after X additional rebills", "format" : "int32", "type" : "integer" }, "cancel_downgrade" : { "description" : "True if the auto order was canceled because the customer purchased a downgrade item", "type" : "boolean" }, "cancel_reason" : { "description" : "The reason this auto order was canceled by either merchant or customer", "type" : "string" }, "cancel_upgrade" : { "description" : "True if the auto order was canceled because the customer purchased an upgrade item", "type" : "boolean" }, "canceled_by_user" : { "description" : "The user that canceled the auto order", "type" : "string" }, "canceled_dts" : { "description" : "The date/time that the auto order was canceled", "format" : "dateTime", "type" : "string" }, "completed" : { "description" : "True if the auto order ran successfully to completion", "type" : "boolean" }, "credit_card_attempt" : { "description" : "The number of credit card attempts that have taken place", "format" : "int32", "type" : "integer" }, "disabled_dts" : { "description" : "The date/time the auto order was disabled due to failed rebills", "format" : "dateTime", "type" : "string" }, "emails" : { "description" : "Email delivery records associated with this auto order.", "items" : { "$ref" : "#/components/schemas/AutoOrderEmail" }, "type" : "array" }, "enabled" : { "description" : "True if this auto order is enabled", "type" : "boolean" }, "failure_reason" : { "description" : "The reason this auto order failed during the last rebill attempt", "type" : "string" }, "items" : { "description" : "The items that are setup to rebill", "items" : { "$ref" : "#/components/schemas/AutoOrderItem" }, "type" : "array" }, "logs" : { "description" : "Logs associated with this auto order", "items" : { "$ref" : "#/components/schemas/AutoOrderLog" }, "type" : "array" }, "management" : { "$ref" : "#/components/schemas/AutoOrderManagement" }, "merchant_id" : { "description" : "UltraCart merchant ID owning this order", "type" : "string" }, "merged_dts" : { "description" : "The date/time the auto order was merged into another auto order", "format" : "dateTime", "type" : "string" }, "merged_into_auto_order_oid" : { "description" : "The auto order that this auto order was merged into", "format" : "int32", "type" : "integer" }, "next_attempt" : { "description" : "The next time that the auto order will be attempted for processing", "format" : "dateTime", "type" : "string" }, "original_order" : { "$ref" : "#/components/schemas/Order" }, "original_order_id" : { "description" : "The original order id that this auto order is associated with.", "type" : "string" }, "override_affiliate_id" : { "description" : "Override the affiliate id given credit for rebills of this auto order", "format" : "int32", "type" : "integer" }, "properties" : { "description" : "Array of property objects", "items" : { "$ref" : "#/components/schemas/AutoOrderProperty" }, "type" : "array" }, "rebill_orders" : { "description" : "Rebill orders that have taken place on this auto order", "items" : { "$ref" : "#/components/schemas/Order" }, "type" : "array" }, "rotating_transaction_gateway_code" : { "description" : "The RTG code associated with this order for future rebills", "type" : "string" }, "status" : { "description" : "The status of the auto order", "enum" : [ "active", "canceled", "disabled", "merged" ], "type" : "string" } }, "type" : "object" }, "AutoOrderAddonItem" : { "properties" : { "arbitrary_unit_cost" : { "type" : "number" }, "free_shipping" : { "type" : "boolean" }, "item_id" : { "type" : "string" }, "next_x_orders" : { "format" : "int32", "type" : "integer" }, "options" : { "description" : "Options associated with this item", "items" : { "$ref" : "#/components/schemas/AutoOrderAddonItemOption" }, "type" : "array" }, "quantity" : { "format" : "int32", "type" : "integer" } }, "type" : "object" }, "AutoOrderAddonItemOption" : { "properties" : { "label" : { "description" : "Label", "maxLength" : 50, "type" : "string" }, "value" : { "description" : "Value", "maxLength" : 1024, "type" : "string" } }, "type" : "object" }, "AutoOrderAddonItemsUpdateRequest" : { "properties" : { "add_on_items" : { "description" : "Add on items to update", "items" : { "$ref" : "#/components/schemas/AutoOrderAddonItem" }, "type" : "array" } }, "type" : "object" }, "AutoOrderConsolidate" : { "properties" : { "source_auto_order_oids" : { "items" : { "type" : "integer" }, "type" : "array" } }, "type" : "object" }, "AutoOrderEmail" : { "properties" : { "bounce_diagnostic_code" : { "type" : "string" }, "bounce_dts" : { "description" : "Date/time that the email was bounced", "format" : "dateTime", "type" : "string" }, "bounce_sub_type" : { "type" : "string" }, "bounce_type" : { "type" : "string" }, "clicked" : { "type" : "boolean" }, "clicked_dts" : { "description" : "Date/time that the email was clicked", "format" : "dateTime", "type" : "string" }, "delivered" : { "type" : "boolean" }, "delivery_dts" : { "description" : "Date/time that the email was delivered", "format" : "dateTime", "type" : "string" }, "email" : { "description" : "Email", "maxLength" : 100, "type" : "string" }, "internal" : { "type" : "boolean" }, "message_id" : { "type" : "string" }, "opened" : { "type" : "boolean" }, "opened_dts" : { "description" : "Date/time that the email was opened", "format" : "dateTime", "type" : "string" }, "reporting_mta" : { "type" : "string" }, "send_dts" : { "description" : "Date/time that the email was sent", "format" : "dateTime", "type" : "string" }, "skip_reason" : { "type" : "string" }, "skipped" : { "type" : "boolean" }, "smtp_response" : { "type" : "string" }, "subject" : { "type" : "string" } }, "type" : "object" }, "AutoOrderEmailsResponse" : { "properties" : { "emails" : { "description" : "emails", "items" : { "$ref" : "#/components/schemas/AutoOrderEmail" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "AutoOrderItem" : { "properties" : { "add_ons" : { "description" : "Array of addon objects instructing which items to add to auto order and how many times they should be added.", "items" : { "$ref" : "#/components/schemas/AutoOrderAddonItem" }, "type" : "array" }, "arbitrary_item_id" : { "description" : "Arbitrary item id that should be rebilled instead of the normal schedule", "type" : "string" }, "arbitrary_percentage_discount" : { "description" : "An arbitrary percentage discount to provide on future rebills", "type" : "number" }, "arbitrary_quantity" : { "description" : "Arbitrary quantity to rebill", "type" : "number" }, "arbitrary_schedule_days" : { "description" : "The number of days to rebill if the frequency is set to an arbitrary number of days", "format" : "int32", "type" : "integer" }, "arbitrary_unit_cost" : { "description" : "Arbitrary unit cost that rebills of this item should occur at", "type" : "number" }, "arbitrary_unit_cost_remaining_orders" : { "description" : "The number of rebills to give the arbitrary unit cost on before reverting to normal pricing.", "format" : "int32", "type" : "integer" }, "auto_order_item_oid" : { "description" : "Primary key of AutoOrderItem", "format" : "int32", "type" : "integer" }, "calculated_next_shipment_dts" : { "description" : "Calculated Date/time that this item is scheduled to rebill. Will be null if no more shipments are going to occur on this item", "format" : "dateTime", "type" : "string" }, "first_order_dts" : { "description" : "Date/time of the first order of this item. Null if item added to auto order and has not been rebilled yet.", "format" : "dateTime", "type" : "string" }, "frequency" : { "description" : "Frequency of the rebill if not a fixed schedule", "enum" : [ "Weekly", "Biweekly", "Every...", "Every 10 Days", "Every 24 Days", "Every 28 Days", "Monthly", "Every 45 Days", "Every 2 Months", "Every 3 Months", "Every 4 Months", "Every 5 Months", "Every 6 Months", "Yearly", "Every 4 Weeks", "Every 6 Weeks", "Every 8 Weeks" ], "type" : "string" }, "future_schedules" : { "description" : "The future rebill schedule for this item up to the next ten rebills", "items" : { "$ref" : "#/components/schemas/AutoOrderItemFutureSchedule" }, "type" : "array" }, "last_order_dts" : { "description" : "Date/time of the last order of this item", "format" : "dateTime", "type" : "string" }, "life_time_value" : { "description" : "The life time value of this item including the original purchase", "type" : "number" }, "next_item_id" : { "description" : "Calculated next item id", "type" : "string" }, "next_preshipment_notice_dts" : { "description" : "The date/time of when the next pre-shipment notice should be sent", "format" : "dateTime", "type" : "string" }, "next_shipment_dts" : { "description" : "Date/time that this item is scheduled to rebill", "format" : "dateTime", "type" : "string" }, "no_order_after_dts" : { "description" : "Date/time after which no additional rebills of this item should occur", "format" : "dateTime", "type" : "string" }, "number_of_rebills" : { "description" : "The number of times this item has rebilled", "format" : "int32", "type" : "integer" }, "options" : { "description" : "Options associated with this item", "items" : { "$ref" : "#/components/schemas/AutoOrderItemOption" }, "type" : "array" }, "original_item_id" : { "description" : "The original item id purchased. This item controls scheduling. If you wish to modify a schedule, for example, from monthly to yearly, change this item from your monthly item to your yearly item, and then change the next_shipment_dts to your desired date.", "type" : "string" }, "original_quantity" : { "description" : "The original quantity purchased", "type" : "number" }, "paused" : { "description" : "True if paused. This field is an object instead of a primitive for backwards compatibility.", "type" : "boolean" }, "paypal_payer_id" : { "description" : "The PayPal Payer ID tied to this item", "type" : "string" }, "paypal_recurring_payment_profile_id" : { "description" : "The PayPal Profile ID tied to this item", "type" : "string" }, "preshipment_notice_sent" : { "description" : "True if the preshipment notice associated with the next rebill has been sent", "type" : "boolean" }, "properties" : { "description" : "Array of property objects", "items" : { "$ref" : "#/components/schemas/AutoOrderProperty" }, "type" : "array" }, "rebill_value" : { "description" : "The value of the rebills of this item", "type" : "number" }, "remaining_repeat_count" : { "description" : "The number of rebills remaining before this item is complete", "format" : "int32", "type" : "integer" }, "simple_schedule" : { "$ref" : "#/components/schemas/AutoOrderItemSimpleSchedule" } }, "type" : "object" }, "AutoOrderItemCancelRequest" : { "properties" : { "append_items" : { "description" : "Specifying these items allows for an easier immutable item contact. Validation will occur before any operations take place. After the end/remove operation is successful, append these additional item(s) to the auto order. The changes will be available in the response if the expansion includes items.", "items" : { "$ref" : "#/components/schemas/AutoOrderItem" }, "type" : "array" }, "auto_order_item_oid" : { "description" : "Optional tiebreaker when more than one item on the auto order shares the same original_item_id. When present, the item with this oid is targeted and its original_item_id must match the URL path parameter (safety check). Leave unset for the common case of a unique original_item_id. For reference the order_item.item_reference_oid is the same value as auto_order_item.auto_order_item_oid UNLESS the a manual edit took place AFTER the original order was placed.", "format" : "int32", "type" : "integer" }, "mode" : { "description" : "Cancellation mode. 'end' soft-cancels the item by setting no_order_after_dts to the current time, preserving the row for reporting. 'remove' hard-deletes the item from the auto order. Defaults to 'end' (the less destructive option) when omitted.", "enum" : [ "end", "remove" ], "type" : "string" }, "no_orders_after_dts" : { "description" : "Date/time that will be used in an END mode (optional)", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "AutoOrderItemFutureSchedule" : { "properties" : { "item_id" : { "description" : "Item ID that should rebill", "type" : "string" }, "rebill_count" : { "description" : "The number of times this rebill represents", "format" : "int32", "type" : "integer" }, "shipment_dts" : { "description" : "Date/time that this item is scheduled to rebill", "format" : "dateTime", "type" : "string" }, "unit_cost" : { "description" : "The unit cost of the item rebilling", "type" : "number" } }, "type" : "object" }, "AutoOrderItemOption" : { "properties" : { "label" : { "description" : "Label", "maxLength" : 50, "type" : "string" }, "value" : { "description" : "Value", "maxLength" : 1024, "type" : "string" } }, "type" : "object" }, "AutoOrderItemSimpleSchedule" : { "properties" : { "frequency" : { "description" : "Frequency of the rebill if not a fixed schedule", "enum" : [ "Weekly", "Biweekly", "Every...", "Every 10 Days", "Every 24 Days", "Every 28 Days", "Monthly", "Every 45 Days", "Every 2 Months", "Every 3 Months", "Every 4 Months", "Every 5 Months", "Every 6 Months", "Yearly", "Every 4 Weeks", "Every 6 Weeks", "Every 8 Weeks" ], "type" : "string" }, "item_id" : { "description" : "Item ID that should rebill", "type" : "string" }, "repeat_count" : { "description" : "The number of times this simple schedule is configured for", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "AutoOrderLog" : { "properties" : { "log_dts" : { "description" : "Date/time that the log message was added", "format" : "dateTime", "type" : "string" }, "log_message" : { "description" : "Log message", "type" : "string" } }, "type" : "object" }, "AutoOrderManagement" : { "properties" : { "update_billing_url" : { "description" : "URL where the customer can go to update their billing information.", "type" : "string" } }, "type" : "object" }, "AutoOrderPropertiesUpdateRequest" : { "properties" : { "properties" : { "description" : "Properties to update", "items" : { "$ref" : "#/components/schemas/AutoOrderProperty" }, "type" : "array" } }, "type" : "object" }, "AutoOrderProperty" : { "properties" : { "name" : { "description" : "Name of the property", "type" : "string" }, "value" : { "description" : "Value of the property", "type" : "string" } }, "type" : "object" }, "AutoOrderQuery" : { "properties" : { "auto_order_code" : { "description" : "Auto order code", "type" : "string" }, "card_type" : { "description" : "Card type", "maxLength" : 100, "type" : "string" }, "city" : { "description" : "City", "type" : "string" }, "company" : { "description" : "Company", "type" : "string" }, "country_code" : { "description" : "ISO-3166 two letter country code", "maxLength" : 2, "type" : "string" }, "customer_profile_oid" : { "description" : "Customer profile object identifier", "format" : "int32", "type" : "integer" }, "email" : { "description" : "Email", "maxLength" : 100, "type" : "string" }, "first_name" : { "description" : "First name", "type" : "string" }, "item_id" : { "description" : "Item ID. Deprecated query field. This incorrectly meant the original order contained this item id.", "type" : "string" }, "last_name" : { "description" : "Last name", "type" : "string" }, "next_item_id" : { "description" : "Next Item ID that is supposed to ship. This is calculated based upon the schedule associated with the original item id.", "type" : "string" }, "next_shipment_date_begin" : { "description" : "Next shipment date begin", "format" : "dateTime", "type" : "string" }, "next_shipment_date_end" : { "description" : "Next shipment date end", "format" : "dateTime", "type" : "string" }, "original_item_id" : { "description" : "Original Item ID purchased on auto order.", "type" : "string" }, "original_order_date_begin" : { "description" : "Original order date begin", "format" : "dateTime", "type" : "string" }, "original_order_date_end" : { "description" : "Original order date end", "format" : "dateTime", "type" : "string" }, "original_order_id" : { "description" : "Original order ID", "type" : "string" }, "phone" : { "description" : "Phone", "maxLength" : 25, "type" : "string" }, "postal_code" : { "description" : "Postal code", "type" : "string" }, "state" : { "description" : "State", "type" : "string" }, "status" : { "description" : "Status", "type" : "string" } }, "type" : "object" }, "AutoOrderQueryBatch" : { "properties" : { "auto_order_oids" : { "description" : "Auto order oids", "items" : { "type" : "integer" }, "type" : "array" } }, "type" : "object" }, "AutoOrderResponse" : { "properties" : { "auto_order" : { "$ref" : "#/components/schemas/AutoOrder" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "AutoOrdersRequest" : { "properties" : { "autoOrders" : { "description" : "auto_orders", "items" : { "$ref" : "#/components/schemas/AutoOrder" }, "type" : "array" } }, "type" : "object" }, "AutoOrdersResponse" : { "properties" : { "auto_orders" : { "items" : { "$ref" : "#/components/schemas/AutoOrder" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "AvalaraConfig" : { "properties" : { "account_id" : { "description" : "Avalara account ID", "type" : "string" }, "active" : { "description" : "True if Avalara is active for this merchant", "type" : "boolean" }, "avalara_oid" : { "description" : "Unique identifier for this avalara config object", "format" : "int32", "type" : "integer" }, "company_id" : { "description" : "Avalara company ID", "type" : "string" }, "enable_upc" : { "description" : "True if this Avalara configuration is set to enable tax valuation by UPC", "type" : "boolean" }, "estimate_only" : { "description" : "True if this Avalara configuration is to estimate taxes only and not report placed orders to Avalara", "type" : "boolean" }, "guest_customer_code" : { "description" : "Optional customer code for customers without profiles, defaults to GuestCustomer", "type" : "string" }, "last_test_dts" : { "description" : "Date/time of the connection test to Avalara", "format" : "dateTime", "type" : "string" }, "license_key" : { "description" : "Avalara license key", "type" : "string" }, "sandbox" : { "description" : "True if this Avalara instance is pointed at the Avalara Sandbox", "type" : "boolean" }, "send_test_orders" : { "description" : "Send test orders through to Avalara. The default is to not transmit test orders to Avalara.", "type" : "boolean" }, "service_url" : { "description" : "Avalara service URL", "type" : "string" }, "test_results" : { "description" : "Test results of the last connection test to Avalara", "type" : "string" } }, "type" : "object" }, "BaseResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "Browser" : { "properties" : { "device" : { "$ref" : "#/components/schemas/BrowserDevice" }, "os" : { "$ref" : "#/components/schemas/BrowserOS" }, "user_agent" : { "$ref" : "#/components/schemas/BrowserUserAgent" } }, "type" : "object" }, "BrowserDevice" : { "properties" : { "family" : { "type" : "string" } }, "type" : "object" }, "BrowserOS" : { "properties" : { "family" : { "type" : "string" }, "major" : { "type" : "string" }, "minor" : { "type" : "string" }, "patch" : { "type" : "string" }, "patch_minor" : { "type" : "string" } }, "type" : "object" }, "BrowserUserAgent" : { "properties" : { "family" : { "type" : "string" }, "major" : { "type" : "string" }, "minor" : { "type" : "string" }, "patch" : { "type" : "string" } }, "type" : "object" }, "Cart" : { "properties" : { "affiliate" : { "$ref" : "#/components/schemas/CartAffiliate" }, "affiliate_network_pixel_oid" : { "description" : "The affiliate network pixel identifier associated with the cart", "format" : "int32", "type" : "integer" }, "base_currency_code" : { "description" : "The ISO-4217 three letter base currency code of the account", "maxLength" : 3, "type" : "string" }, "billing" : { "$ref" : "#/components/schemas/CartBilling" }, "buysafe" : { "$ref" : "#/components/schemas/CartBuysafe" }, "cart_id" : { "description" : "Unique identifier for this cart", "type" : "string" }, "checkout" : { "$ref" : "#/components/schemas/CartCheckout" }, "coupons" : { "description" : "Coupons", "items" : { "$ref" : "#/components/schemas/CartCoupon" }, "type" : "array" }, "currency_code" : { "description" : "The ISO-4217 three letter currency code the customer is viewing prices in", "maxLength" : 3, "type" : "string" }, "currency_conversion" : { "$ref" : "#/components/schemas/CartCurrencyConversion" }, "customer_profile" : { "$ref" : "#/components/schemas/CartCustomerProfile" }, "exchange_rate" : { "description" : "The exchange rate if the customer is viewing a different currency than the base", "type" : "number" }, "gift" : { "$ref" : "#/components/schemas/CartGift" }, "gift_certificate" : { "$ref" : "#/components/schemas/CartGiftCertificate" }, "items" : { "description" : "Items", "items" : { "$ref" : "#/components/schemas/CartItem" }, "type" : "array" }, "language_iso_code" : { "description" : "The ISO-631 three letter code the customer would like to checkout with", "maxLength" : 3, "type" : "string" }, "logged_in" : { "description" : "True if the customer is logged into their profile", "type" : "boolean" }, "marketing" : { "$ref" : "#/components/schemas/CartMarketing" }, "merchant_id" : { "description" : "Merchant ID this cart is associated with", "type" : "string" }, "payment" : { "$ref" : "#/components/schemas/CartPayment" }, "properties" : { "description" : "Properties associated with the cart", "items" : { "$ref" : "#/components/schemas/CartProperty" }, "type" : "array" }, "settings" : { "$ref" : "#/components/schemas/CartSettings" }, "shipping" : { "$ref" : "#/components/schemas/CartShipping" }, "summary" : { "$ref" : "#/components/schemas/CartSummary" }, "taxes" : { "$ref" : "#/components/schemas/CartTaxes" }, "upsell_after" : { "$ref" : "#/components/schemas/CartUpsellAfter" }, "utms" : { "description" : "UTM clicks. The zero index is the most recent (last) UTM click. Only available in BigQuery and on an abandon webhook.", "items" : { "$ref" : "#/components/schemas/CartUtm" }, "type" : "array" } }, "type" : "object" }, "CartAffiliate" : { "properties" : { "affiliate_id" : { "description" : "Affiliate id associated with the cart", "format" : "int32", "type" : "integer" }, "affiliate_sub_id" : { "description" : "Affiliate sub id associated with the cart", "maxLength" : 50, "type" : "string" } }, "type" : "object" }, "CartAffirmCheckoutResponse" : { "properties" : { "checkout_json" : { "description" : "Checkout JSON object", "type" : "string" }, "errors" : { "description" : "Errors that should be displayed to the customer", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CartBilling" : { "properties" : { "address1" : { "description" : "Address line 1", "maxLength" : 50, "type" : "string" }, "address2" : { "description" : "Address line 2", "maxLength" : 50, "type" : "string" }, "cc_emails" : { "description" : "CC emails. Multiple allowed, but total length of all emails can not exceed 100 characters.", "items" : { "type" : "string" }, "type" : "array" }, "cell_phone" : { "description" : "Cell phone", "maxLength" : 25, "type" : "string" }, "cell_phone_e164" : { "description" : "Cell phone (E164 format)", "maxLength" : 25, "type" : "string" }, "city" : { "description" : "City", "maxLength" : 32, "type" : "string" }, "company" : { "description" : "Company", "maxLength" : 50, "type" : "string" }, "country_code" : { "description" : "ISO-3166 two letter country code", "maxLength" : 2, "type" : "string" }, "day_phone" : { "description" : "Day phone", "maxLength" : 25, "type" : "string" }, "email" : { "description" : "Email", "maxLength" : 100, "type" : "string" }, "email_confirm" : { "description" : "Email entered for confirmation", "maxLength" : 100, "type" : "string" }, "evening_phone" : { "description" : "Evening phone", "maxLength" : 25, "type" : "string" }, "first_name" : { "description" : "First name", "maxLength" : 30, "type" : "string" }, "last_name" : { "description" : "Last name", "maxLength" : 30, "type" : "string" }, "postal_code" : { "description" : "Postal code", "maxLength" : 20, "type" : "string" }, "state_region" : { "description" : "State for United States otherwise region or province for other countries", "maxLength" : 32, "type" : "string" }, "title" : { "description" : "Title", "maxLength" : 50, "type" : "string" } }, "type" : "object" }, "CartBuysafe" : { "properties" : { "bond_available" : { "description" : "True if buySAFE is willing to bond the order", "type" : "boolean" }, "bond_cost" : { "$ref" : "#/components/schemas/Currency" }, "bond_free" : { "description" : "True if the bond is free (merchant paying for it)", "type" : "boolean" }, "bond_wanted" : { "description" : "True if the customer wants the bond", "type" : "boolean" }, "cart_display_text" : { "description" : "Recommend text to display to the customer", "type" : "string" }, "cart_display_url" : { "description" : "URL associated with the recommended text", "type" : "string" } }, "type" : "object" }, "CartCheckout" : { "properties" : { "comments" : { "description" : "Comments from the customer. Rarely used on the single page checkout.", "maxLength" : 2000, "type" : "string" }, "current_step" : { "description" : "Current step of the checkout (read only)", "type" : "string" }, "custom_field1" : { "description" : "Custom field 1", "maxLength" : 50, "type" : "string" }, "custom_field10" : { "description" : "Custom field 10", "maxLength" : 200, "type" : "string" }, "custom_field2" : { "description" : "Custom field 2", "maxLength" : 50, "type" : "string" }, "custom_field3" : { "description" : "Custom field 3", "maxLength" : 50, "type" : "string" }, "custom_field4" : { "description" : "Custom field 4", "maxLength" : 50, "type" : "string" }, "custom_field5" : { "description" : "Custom field 5", "maxLength" : 75, "type" : "string" }, "custom_field6" : { "description" : "Custom field 6", "maxLength" : 50, "type" : "string" }, "custom_field7" : { "description" : "Custom field 7", "maxLength" : 50, "type" : "string" }, "custom_field8" : { "description" : "Custom field 8", "maxLength" : 200, "type" : "string" }, "custom_field9" : { "description" : "Custom field 9", "maxLength" : 200, "type" : "string" }, "ip_address" : { "description" : "IP Address (read only unless non-browser key authenticated)", "type" : "string" }, "return_code" : { "description" : "Return code assigned for send return email operation", "type" : "string" }, "return_url" : { "description" : "The URL to redirect the customer to when they return from an abandon cart email. Must be https protocol.", "maxLength" : 2048, "type" : "string" }, "screen_branding_theme_code" : { "description" : "Screen branding theme code", "maxLength" : 10, "type" : "string" }, "storefront_host_name" : { "description" : "StoreFront Host Name", "type" : "string" }, "user_agent" : { "description" : "User agent of the browser", "type" : "string" } }, "type" : "object" }, "CartCoupon" : { "properties" : { "coupon_code" : { "description" : "Coupon code", "type" : "string" } }, "type" : "object" }, "CartCurrencyConversion" : { "properties" : { "base_currency_Code" : { "description" : "Base currency code for this merchant", "type" : "string" }, "currencies" : { "description" : "Conversion information for 1 unit of base currency to target currencies", "items" : { "$ref" : "#/components/schemas/Currency" }, "type" : "array" } }, "type" : "object" }, "CartCustomerProfile" : { "properties" : { "allow_3rd_party_billing" : { "description" : "True if profile is allowed to bill to their 3rd party shipping account", "type" : "boolean" }, "allow_cod" : { "description" : "True if this profile is allowed to use a COD", "type" : "boolean" }, "allow_purchase_order" : { "description" : "True if this profile is allowed to use a purchase order", "type" : "boolean" }, "billing_addresses" : { "description" : "Billing addresses on file for this profile", "items" : { "$ref" : "#/components/schemas/CartCustomerProfileAddress" }, "type" : "array" }, "credit_cards" : { "description" : "Credit cards on file for this profile (masked)", "items" : { "$ref" : "#/components/schemas/CartCustomerProfileCreditCard" }, "type" : "array" }, "customer_profile_oid" : { "description" : "Unique identifier", "format" : "int32", "type" : "integer" }, "dhl_account_number" : { "description" : "DHL account number on file", "type" : "string" }, "dhl_duty_account_number" : { "description" : "DHL duty account number on file", "type" : "string" }, "email" : { "description" : "Email", "type" : "string" }, "fedex_account_number" : { "description" : "FedEx account number on file", "type" : "string" }, "free_shipping" : { "description" : "True if this profile always qualifies for free shipping", "type" : "boolean" }, "free_shipping_minimum" : { "description" : "The minimum amount that this profile has to purchase to qualify for free shipping", "type" : "number" }, "maximum_item_count" : { "description" : "Maximum item count this profile can purchase", "format" : "int32", "type" : "integer" }, "minimum_item_count" : { "description" : "Minimum item count this profile must purchase", "format" : "int32", "type" : "integer" }, "minimum_subtotal" : { "description" : "Minimum subtotal this profile must purchase", "type" : "number" }, "no_coupons" : { "description" : "True if this profile is prevented from using coupons", "type" : "boolean" }, "no_free_shipping" : { "description" : "True if this profile is never given free shipping", "type" : "boolean" }, "no_realtime_charge" : { "description" : "True if this customers orders are not charged in real-time", "type" : "boolean" }, "pricing_tiers" : { "description" : "Pricing tier names this profile qualifies for", "items" : { "type" : "string" }, "type" : "array" }, "shipping_addresses" : { "description" : "Shipping addresses on file for this profile", "items" : { "$ref" : "#/components/schemas/CartCustomerProfileAddress" }, "type" : "array" }, "signup_dts" : { "description" : "Signup date", "type" : "string" }, "tax_exempt" : { "description" : "True if this profile is exempt from sales tax", "type" : "boolean" }, "ups_account_number" : { "description" : "UPS account number on file", "type" : "string" } }, "type" : "object" }, "CartCustomerProfileAddress" : { "properties" : { "address1" : { "description" : "Address 1", "type" : "string" }, "address2" : { "description" : "Address 2", "type" : "string" }, "city" : { "description" : "City", "type" : "string" }, "company" : { "description" : "Company", "type" : "string" }, "country_code" : { "description" : "ISO-3166 Country code", "type" : "string" }, "day_phone" : { "description" : "Day phone", "type" : "string" }, "evening_phone" : { "description" : "Evening phone", "type" : "string" }, "first_name" : { "description" : "First name", "type" : "string" }, "last_name" : { "description" : "Last name", "type" : "string" }, "oid" : { "description" : "Unique identifier for this address", "format" : "int32", "type" : "integer" }, "postal_code" : { "description" : "Postal code", "type" : "string" }, "state_region" : { "description" : "State for United States otherwise region or province for other countries", "type" : "string" }, "tax_county" : { "description" : "Tax county if a billing address", "type" : "string" }, "title" : { "description" : "Title", "type" : "string" } }, "type" : "object" }, "CartCustomerProfileCreditCard" : { "properties" : { "card_expiration_month" : { "description" : "Card expiration month (1-12)", "format" : "int32", "type" : "integer" }, "card_expiration_year" : { "description" : "Card expiration year (four digit)", "format" : "int32", "type" : "integer" }, "card_number" : { "description" : "Card number (masked last 4 digits)", "type" : "string" }, "card_type" : { "description" : "Card type", "enum" : [ "AMEX", "Diners Club", "Discover", "MasterCard", "JCB", "VISA" ], "type" : "string" }, "customer_profile_credit_card_id" : { "description" : "Unique identifier for this stored card", "format" : "int32", "type" : "integer" }, "last_used_date" : { "description" : "Last used", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "CartFinalizeOrderRequest" : { "properties" : { "cart" : { "$ref" : "#/components/schemas/Cart" }, "options" : { "$ref" : "#/components/schemas/CartFinalizeOrderRequestOptions" } }, "type" : "object" }, "CartFinalizeOrderRequestOptions" : { "properties" : { "auto_approve_purchase_order" : { "description" : "Automatically approve the purchase order", "type" : "boolean" }, "channel_partner_code" : { "description" : "Channel partner code to associate this order with", "type" : "string" }, "channel_partner_oid" : { "description" : "Channel partner oid to associate this order with", "format" : "int32", "type" : "integer" }, "channel_partner_order_id" : { "description" : "Channel partner order id for reference", "type" : "string" }, "consider_recurring" : { "description" : "Consider this order a recurring order for the purposes of payment gateway recurring flag", "type" : "boolean" }, "credit_card_authorization_amount" : { "description" : "If the order was authorized outside of UltraCart, this is the amount of the authorization", "type" : "number" }, "credit_card_authorization_date" : { "description" : "If the order was authorized outside of UltraCart, this is the date/time of the authorization", "format" : "dateTime", "type" : "string" }, "credit_card_authorization_reference_number" : { "description" : "If the order was authorized outside of UltraCart, this is the authorization reference number", "maxLength" : 60, "type" : "string" }, "no_realtime_payment_processing" : { "description" : "Prevents normal real-time processing of the payment and sends the order to Accounts Receivable", "type" : "boolean" }, "setup_next_cart" : { "description" : "True if the system should create another cart automatically if the current cart was logged into a profile", "type" : "boolean" }, "skip_payment_processing" : { "description" : "Skip payment processing and move the order on to shipping (or completed if no shipping required)", "type" : "boolean" }, "store_completed" : { "description" : "True the order in the completed stage", "type" : "boolean" }, "store_if_payment_declines" : { "description" : "Store the order in accounts receivable if the payment declines", "type" : "boolean" } }, "type" : "object" }, "CartFinalizeOrderResponse" : { "properties" : { "errors" : { "description" : "Error messages if the order could not be completed", "items" : { "type" : "string" }, "type" : "array" }, "next_cart" : { "$ref" : "#/components/schemas/Cart" }, "order" : { "$ref" : "#/components/schemas/Order" }, "order_id" : { "description" : "Order ID assigned to the order", "type" : "string" }, "successful" : { "description" : "True if the cart was converted successfully to an order", "type" : "boolean" } }, "type" : "object" }, "CartGift" : { "properties" : { "gift" : { "description" : "True if this order is a gift", "type" : "boolean" }, "gift_charge" : { "$ref" : "#/components/schemas/Currency" }, "gift_email" : { "description" : "Email address of the gift recipient", "maxLength" : 100, "type" : "string" }, "gift_message" : { "description" : "Message to the gift recipient", "maxLength" : 10000, "type" : "string" }, "gift_wrap_cost" : { "$ref" : "#/components/schemas/Currency" }, "gift_wrap_title" : { "description" : "Title of the selected gift wrap", "maxLength" : 30, "type" : "string" } }, "type" : "object" }, "CartGiftCertificate" : { "properties" : { "gift_certificate_amount" : { "$ref" : "#/components/schemas/Currency" }, "gift_certificate_code" : { "description" : "Gift certificate code", "type" : "string" }, "gift_certificate_remaining_balance_after_order" : { "$ref" : "#/components/schemas/Currency" } }, "type" : "object" }, "CartItem" : { "properties" : { "arbitrary_unit_cost" : { "$ref" : "#/components/schemas/Currency" }, "attributes" : { "description" : "Attributes", "items" : { "$ref" : "#/components/schemas/CartItemAttribute" }, "type" : "array" }, "auto_order_schedule" : { "description" : "Auto order schedule the customer selected", "type" : "string" }, "default_image_url" : { "description" : "URL to the default multimedia image", "type" : "string" }, "default_thumbnail_url" : { "description" : "URL to the default multimedia thumbnail", "type" : "string" }, "description" : { "description" : "Description of the item", "type" : "string" }, "discount" : { "$ref" : "#/components/schemas/Currency" }, "extended_description" : { "description" : "Extended description of the item", "type" : "string" }, "item_id" : { "description" : "Item ID", "type" : "string" }, "item_oid" : { "description" : "Item object identifier", "format" : "int32", "type" : "integer" }, "kit" : { "description" : "True if this item is a kit", "type" : "boolean" }, "kit_component_options" : { "description" : "Options associated with the kit components", "items" : { "$ref" : "#/components/schemas/CartKitComponentOption" }, "type" : "array" }, "manufacturer_suggested_retail_price" : { "$ref" : "#/components/schemas/Currency" }, "maximum_quantity" : { "description" : "Maximum quantity the customer can purchase", "type" : "number" }, "minimum_quantity" : { "description" : "Minimum quantity the customer can purchase", "type" : "number" }, "multimedia" : { "description" : "Multimedia", "items" : { "$ref" : "#/components/schemas/CartItemMultimedia" }, "type" : "array" }, "options" : { "description" : "Options", "items" : { "$ref" : "#/components/schemas/CartItemOption" }, "type" : "array" }, "phsyical" : { "$ref" : "#/components/schemas/CartItemPhysical" }, "position" : { "description" : "Position of the item in the cart", "format" : "int32", "type" : "integer" }, "preorder" : { "description" : "True if this item is on pre-order", "type" : "boolean" }, "properties" : { "description" : "Properties associated with the item", "items" : { "$ref" : "#/components/schemas/CartItemProperty" }, "type" : "array" }, "quantity" : { "description" : "quantity", "type" : "number" }, "schedules" : { "description" : "Customer selectable auto order schedules", "items" : { "type" : "string" }, "type" : "array" }, "total_cost" : { "$ref" : "#/components/schemas/Currency" }, "total_cost_with_discount" : { "$ref" : "#/components/schemas/Currency" }, "unit_cost" : { "$ref" : "#/components/schemas/Currency" }, "unit_cost_with_discount" : { "$ref" : "#/components/schemas/Currency" }, "upsell" : { "description" : "True if this item was added to the cart as part of an upsell", "type" : "boolean" }, "variations" : { "description" : "Variations", "items" : { "$ref" : "#/components/schemas/CartItemVariationSelection" }, "type" : "array" }, "view_url" : { "description" : "URL to view the product on the site", "type" : "string" } }, "type" : "object" }, "CartItemAttribute" : { "properties" : { "name" : { "description" : "Name of the attribute", "type" : "string" }, "type" : { "description" : "Type of attribute", "type" : "string" }, "value" : { "description" : "Value of the attribute", "type" : "string" } }, "type" : "object" }, "CartItemMultimedia" : { "properties" : { "code" : { "description" : "Code assigned to the multimedia", "type" : "string" }, "description" : { "description" : "Description", "type" : "string" }, "exclude_from_gallery" : { "description" : "True if the image should be excluded from galleries", "type" : "boolean" }, "image_height" : { "description" : "Image height", "format" : "int32", "type" : "integer" }, "image_width" : { "description" : "Image width", "format" : "int32", "type" : "integer" }, "is_default" : { "description" : "True if the multimedia is the default for this type", "type" : "boolean" }, "thumbnails" : { "description" : "Thumbnails of the images", "items" : { "$ref" : "#/components/schemas/CartItemMultimediaThumbnail" }, "type" : "array" }, "type" : { "description" : "Type of multimedia", "enum" : [ "Image", "PDF", "Text", "Unknown", "Video" ], "type" : "string" }, "url" : { "description" : "URL to view multimedia at", "type" : "string" } }, "type" : "object" }, "CartItemMultimediaThumbnail" : { "properties" : { "height" : { "description" : "Height in pixels", "format" : "int32", "type" : "integer" }, "png" : { "description" : "True if thumbnail is a PNG, otherwise its a JPEG", "type" : "boolean" }, "square" : { "description" : "True if the thumbnail is square", "type" : "boolean" }, "url" : { "description" : "URL for the thumbnail", "type" : "string" }, "width" : { "description" : "Width in pixels", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "CartItemOption" : { "properties" : { "cost_if_specified" : { "$ref" : "#/components/schemas/Currency" }, "cost_per_letter" : { "$ref" : "#/components/schemas/Currency" }, "cost_per_line" : { "$ref" : "#/components/schemas/Currency" }, "ignore_if_default" : { "description" : "True if the default answer is ignored", "type" : "boolean" }, "label" : { "description" : "Display label for the option", "type" : "string" }, "name" : { "description" : "Name of the option", "type" : "string" }, "one_time_fee" : { "description" : "Charge the fee a single time instead of multiplying by the quantity", "type" : "boolean" }, "option_oid" : { "description" : "Unique identifier for the option", "format" : "int32", "type" : "integer" }, "required" : { "description" : "True if the customer is required to select a value", "type" : "boolean" }, "selected_value" : { "description" : "The value of the option specified by the customer", "maxLength" : 1024, "type" : "string" }, "type" : { "description" : "Type of option", "enum" : [ "single", "multiline", "dropdown", "hidden", "radio", "fixed" ], "type" : "string" }, "values" : { "description" : "Values that the customer can select from for radio or select type options", "items" : { "$ref" : "#/components/schemas/CartItemOptionValue" }, "type" : "array" } }, "type" : "object" }, "CartItemOptionValue" : { "properties" : { "additional_cost" : { "$ref" : "#/components/schemas/Currency" }, "additional_weight" : { "$ref" : "#/components/schemas/Weight" }, "default_value" : { "description" : "True if this is the default value", "type" : "boolean" }, "display_order" : { "description" : "Display order of the option value", "format" : "int32", "type" : "integer" }, "value" : { "description" : "Value of the option the customer can select", "type" : "string" } }, "type" : "object" }, "CartItemPhysical" : { "properties" : { "height" : { "$ref" : "#/components/schemas/Distance" }, "length" : { "$ref" : "#/components/schemas/Distance" }, "weight" : { "$ref" : "#/components/schemas/Weight" }, "width" : { "$ref" : "#/components/schemas/Distance" } }, "type" : "object" }, "CartItemProperty" : { "properties" : { "display" : { "description" : "True if this property is displayed to the customer", "type" : "boolean" }, "expiration_dts" : { "description" : "The date/time that the property expires and is deleted", "format" : "dateTime", "type" : "string" }, "name" : { "description" : "Name", "maxLength" : 100, "type" : "string" }, "value" : { "description" : "Value", "maxLength" : 3800, "type" : "string" } }, "type" : "object" }, "CartItemVariationSelection" : { "properties" : { "variation_name" : { "description" : "Variation name", "type" : "string" }, "variation_value" : { "description" : "Variation value", "type" : "string" } }, "type" : "object" }, "CartKitComponentOption" : { "properties" : { "cost_if_specified" : { "$ref" : "#/components/schemas/Currency" }, "cost_per_letter" : { "$ref" : "#/components/schemas/Currency" }, "cost_per_line" : { "$ref" : "#/components/schemas/Currency" }, "ignore_if_default" : { "description" : "True if the default answer is ignored", "type" : "boolean" }, "item_id" : { "description" : "Kit component item id", "type" : "string" }, "item_oid" : { "description" : "Unique identifier for the kit component item", "format" : "int32", "type" : "integer" }, "label" : { "description" : "Display label for the option", "type" : "string" }, "name" : { "description" : "Name of the option", "type" : "string" }, "one_time_fee" : { "description" : "Charge the fee a single time instead of multiplying by the quantity", "type" : "boolean" }, "option_oid" : { "description" : "Unique identifier for the option", "format" : "int32", "type" : "integer" }, "required" : { "description" : "True if the customer is required to select a value", "type" : "boolean" }, "selected_value" : { "description" : "The value of the option specified by the customer", "maxLength" : 1024, "type" : "string" }, "type" : { "description" : "Type of option", "enum" : [ "single", "multiline", "dropdown", "hidden", "radio", "fixed" ], "type" : "string" }, "values" : { "description" : "Values that the customer can select from for radio or select type options", "items" : { "$ref" : "#/components/schemas/CartItemOptionValue" }, "type" : "array" } }, "type" : "object" }, "CartMarketing" : { "properties" : { "advertising_source" : { "description" : "The advertising source the customer indicated", "type" : "string" }, "cell_phone_opt_in" : { "description" : "True if the customer agrees to receiving marketing SMS messages", "type" : "boolean" }, "mailing_list_opt_in" : { "description" : "True if the customer agrees to receiving marketing emails", "type" : "boolean" } }, "type" : "object" }, "CartPayment" : { "properties" : { "affirm" : { "$ref" : "#/components/schemas/CartPaymentAffirm" }, "amazon" : { "$ref" : "#/components/schemas/CartPaymentAmazon" }, "check" : { "$ref" : "#/components/schemas/CartPaymentCheck" }, "credit_card" : { "$ref" : "#/components/schemas/CartPaymentCreditCard" }, "health_benefit_card" : { "$ref" : "#/components/schemas/CartPaymentHealthBenefitCard" }, "payment_method" : { "description" : "Payment method", "type" : "string" }, "purchase_order" : { "$ref" : "#/components/schemas/CartPaymentPurchaseOrder" }, "rtg_code" : { "description" : "Rotating transaction gateway code", "type" : "string" } }, "type" : "object" }, "CartPaymentAffirm" : { "properties" : { "affirm_checkout_token" : { "description" : "Affirm checkout token", "type" : "string" } }, "type" : "object" }, "CartPaymentAmazon" : { "properties" : { "amazon_order_reference_id" : { "description" : "Amazon order reference id", "type" : "string" } }, "type" : "object" }, "CartPaymentCheck" : { "properties" : { "check_number" : { "description" : "Check number they are paying with", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "CartPaymentCreditCard" : { "properties" : { "card_expiration_month" : { "description" : "Card expiration month (1-12)", "format" : "int32", "type" : "integer" }, "card_expiration_year" : { "description" : "Card expiration year (four digit year)", "format" : "int32", "type" : "integer" }, "card_number" : { "description" : "Card number (masked to the last 4)", "type" : "string" }, "card_number_token" : { "description" : "Hosted field token for the card number", "type" : "string" }, "card_type" : { "description" : "Card type", "type" : "string" }, "card_verification_number" : { "description" : "Card verification number (masked)", "type" : "string" }, "card_verification_number_token" : { "description" : "Hosted field token for the card verification number", "type" : "string" }, "customer_profile_credit_card_id" : { "description" : "ID of the stored credit card to use", "format" : "int32", "type" : "integer" }, "store_credit_card" : { "description" : "True if the customer wants to store the card on their profile for future re-use", "type" : "boolean" } }, "type" : "object" }, "CartPaymentHealthBenefitCard" : { "properties" : { "health_benefit_card_expiration_month" : { "description" : "Health benefit expiration month (1-12)", "format" : "int32", "type" : "integer" }, "health_benefit_card_expiration_year" : { "description" : "Health benefit card expiration year (four digit year)", "format" : "int32", "type" : "integer" }, "health_benefit_card_number" : { "description" : "Health benefit card number (masked to the last 4)", "type" : "string" }, "health_benefit_card_number_token" : { "description" : "Hosted field token for the card number", "type" : "string" }, "health_benefit_card_verification_number" : { "description" : "Health benefit card verification number (masked)", "type" : "string" }, "health_benefit_card_verification_number_token" : { "description" : "Hosted field token for the health benefit card verification number", "type" : "string" } }, "type" : "object" }, "CartPaymentPurchaseOrder" : { "properties" : { "purchase_order_number" : { "description" : "Purchase order number", "type" : "string" } }, "type" : "object" }, "CartProfileLoginRequest" : { "properties" : { "cart" : { "$ref" : "#/components/schemas/Cart" }, "customer_profile_oid" : { "description" : "Unique identifier for customer profile. Can not be used with browser key authentication type.", "format" : "int32", "type" : "integer" }, "password" : { "description" : "Password for the profile", "type" : "string" } }, "type" : "object" }, "CartProfileLoginResponse" : { "properties" : { "cart" : { "$ref" : "#/components/schemas/Cart" }, "errors" : { "description" : "Errors to display to the customer if they failed any of the validations checked", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CartProfileRegisterRequest" : { "properties" : { "cart" : { "$ref" : "#/components/schemas/Cart" }, "password" : { "description" : "Password for the profile", "type" : "string" } }, "type" : "object" }, "CartProfileRegisterResponse" : { "properties" : { "cart" : { "$ref" : "#/components/schemas/Cart" }, "errors" : { "description" : "Errors to display to the customer if they failed any of the validations checked", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CartProperty" : { "properties" : { "display" : { "description" : "True if this property is displayed to the customer", "type" : "boolean" }, "expiration_dts" : { "description" : "The date/time that the property expires and is deleted", "format" : "dateTime", "type" : "string" }, "name" : { "description" : "Name", "maxLength" : 100, "type" : "string" }, "value" : { "description" : "Value", "maxLength" : 3800, "type" : "string" } }, "type" : "object" }, "CartResponse" : { "properties" : { "cart" : { "$ref" : "#/components/schemas/Cart" }, "errors" : { "description" : "Errors that should be displayed to the customer", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CartSettings" : { "properties" : { "billing" : { "$ref" : "#/components/schemas/CartSettingsBilling" }, "gift" : { "$ref" : "#/components/schemas/CartSettingsGift" }, "payment" : { "$ref" : "#/components/schemas/CartSettingsPayment" }, "shipping" : { "$ref" : "#/components/schemas/CartSettingsShipping" }, "taxes" : { "$ref" : "#/components/schemas/CartSettingsTaxes" }, "terms" : { "$ref" : "#/components/schemas/CartSettingsTerms" } }, "type" : "object" }, "CartSettingsBilling" : { "properties" : { "provinces" : { "description" : "Provinces", "items" : { "$ref" : "#/components/schemas/CartSettingsProvince" }, "type" : "array" } }, "type" : "object" }, "CartSettingsGift" : { "properties" : { "allow_gifts" : { "description" : "True if this checkout supports gift giving", "type" : "boolean" }, "gift_charge" : { "$ref" : "#/components/schemas/Currency" }, "gift_wraps" : { "description" : "The gift wraps available for the customer to select from", "items" : { "$ref" : "#/components/schemas/CartSettingsGiftWrap" }, "type" : "array" }, "max_message_length" : { "description" : "The maximum length of the gift message the giver can enter", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "CartSettingsGiftWrap" : { "properties" : { "cost" : { "$ref" : "#/components/schemas/Currency" }, "title" : { "description" : "Title of the gift wrap", "type" : "string" }, "url" : { "description" : "URL for the sample of the gift wrap", "type" : "string" } }, "type" : "object" }, "CartSettingsPayment" : { "properties" : { "amazon" : { "$ref" : "#/components/schemas/CartSettingsPaymentAmazon" }, "credit_card" : { "$ref" : "#/components/schemas/CartSettingsPaymentCreditCard" }, "need_payment" : { "description" : "True if this card requires a payment from the customer", "type" : "boolean" }, "paypal" : { "$ref" : "#/components/schemas/CartSettingsPaymentPayPal" }, "supports_amazon" : { "description" : "True if Amazon payments are available on this order", "type" : "boolean" }, "supports_check" : { "description" : "True if check payments are available on this order", "type" : "boolean" }, "supports_cod" : { "description" : "True if COD payments are available on this order", "type" : "boolean" }, "supports_credit_card" : { "description" : "True if credit card payments are available on this order", "type" : "boolean" }, "supports_money_order" : { "description" : "True if money order payments are available on this order", "type" : "boolean" }, "supports_paypal" : { "description" : "True if PayPal payments are available on this order", "type" : "boolean" }, "supports_purchase_order" : { "description" : "True if purchase order payments are available on this order", "type" : "boolean" }, "supports_quote_request" : { "description" : "True if quote requests payments are available on this order", "type" : "boolean" }, "supports_wire_transfer" : { "description" : "True if wire transfer payments are available on this order", "type" : "boolean" } }, "type" : "object" }, "CartSettingsPaymentAmazon" : { "properties" : { "amazon_button_url" : { "description" : "Amazon button URL", "type" : "string" }, "amazon_merchant_id" : { "description" : "Amazon merchant ID", "type" : "string" }, "amazon_widget_url" : { "description" : "Amazon widget URL", "type" : "string" } }, "type" : "object" }, "CartSettingsPaymentCreditCard" : { "properties" : { "collect_credit_card_verification_number" : { "description" : "True if the credit card verification number should be collected", "type" : "boolean" }, "collect_credit_card_verification_number_minimum" : { "description" : "If this field is null or the total is greater than or equal to this value then collect the CVV2.", "type" : "number" }, "credit_card_types" : { "description" : "Available credit card types", "items" : { "type" : "string" }, "type" : "array" }, "hosted_fields_shopping_cart_token" : { "description" : "The shoppingCartToken needed for proper initialization of hosted fields collection", "type" : "string" } }, "type" : "object" }, "CartSettingsPaymentPayPal" : { "properties" : { "paypal_button_alt_text" : { "description" : "PayPal button alt text", "type" : "string" }, "paypal_button_url" : { "description" : "PayPal button URL", "type" : "string" }, "paypal_credit_button_url" : { "description" : "PayPal Credit button URL", "type" : "string" }, "paypal_credit_legal_image_url" : { "description" : "PayPal Credit legal image URL", "type" : "string" }, "paypal_credit_legal_url" : { "description" : "PayPal Credit legal URL", "type" : "string" } }, "type" : "object" }, "CartSettingsProvince" : { "properties" : { "code" : { "type" : "string" }, "province" : { "type" : "string" } }, "type" : "object" }, "CartSettingsShipping" : { "properties" : { "deliver_on_date" : { "$ref" : "#/components/schemas/CartSettingsShippingCalendar" }, "estimates" : { "description" : "Estimates for this cart", "items" : { "$ref" : "#/components/schemas/CartSettingsShippingEstimate" }, "type" : "array" }, "need_shipping" : { "description" : "True if this order needs shipping", "type" : "boolean" }, "provinces" : { "description" : "Provinces", "items" : { "$ref" : "#/components/schemas/CartSettingsProvince" }, "type" : "array" }, "ship_on_date" : { "$ref" : "#/components/schemas/CartSettingsShippingCalendar" } }, "type" : "object" }, "CartSettingsShippingCalendar" : { "properties" : { "blackouts" : { "description" : "Specified dates that are blacked out on the calendar in ISO8601 format", "items" : { "type" : "string" }, "type" : "array" }, "days_of_week" : { "description" : "Days of week that should be enabled on the calendar (0 - Sunday through 6 - Saturday)", "items" : { "type" : "boolean" }, "type" : "array" }, "earliest" : { "description" : "The earliest date that can be selected on the calendar", "type" : "string" }, "require" : { "description" : "True if the customer is required to select a date", "type" : "boolean" }, "show" : { "description" : "True if this calendar should be shown to the customer", "type" : "boolean" } }, "type" : "object" }, "CartSettingsShippingEstimate" : { "properties" : { "allow_3rd_party_billing" : { "description" : "True if this method allows the customer to use their own shipper account number", "type" : "boolean" }, "comment" : { "description" : "Comment to display to the customer about this method", "type" : "string" }, "cost" : { "$ref" : "#/components/schemas/Currency" }, "cost_before_discount" : { "$ref" : "#/components/schemas/Currency" }, "default_method" : { "description" : "True if this is the default method", "type" : "boolean" }, "discount" : { "$ref" : "#/components/schemas/Currency" }, "discounted" : { "description" : "True if this method is discounted because of a coupon", "type" : "boolean" }, "display_name" : { "description" : "The name to display to the customer", "type" : "string" }, "estimated_delivery" : { "description" : "Date of the estimated delivery (or range)", "type" : "string" }, "lift_gate_option" : { "description" : "True if a lift gate option for this method should be offered to the customer", "type" : "boolean" }, "name" : { "description" : "Shipping method name", "type" : "string" }, "pickup" : { "description" : "True if this shipping method requires customers to physically pickup product themselves", "type" : "boolean" }, "tax" : { "$ref" : "#/components/schemas/Currency" }, "total_tax" : { "$ref" : "#/components/schemas/Currency" } }, "type" : "object" }, "CartSettingsTaxes" : { "properties" : { "counties" : { "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CartSettingsTerms" : { "properties" : { "html" : { "description" : "HTML version of the terms", "type" : "string" }, "text" : { "description" : "Text version of the terms.", "type" : "string" } }, "type" : "object" }, "CartShipping" : { "properties" : { "address1" : { "description" : "Address line 1", "maxLength" : 50, "type" : "string" }, "address2" : { "description" : "Address line 2", "maxLength" : 50, "type" : "string" }, "city" : { "description" : "City", "maxLength" : 32, "type" : "string" }, "company" : { "description" : "Company", "maxLength" : 50, "type" : "string" }, "country_code" : { "description" : "ISO-3166 two letter country code", "maxLength" : 2, "type" : "string" }, "day_phone" : { "description" : "Day time phone", "maxLength" : 25, "type" : "string" }, "delivery_date" : { "description" : "Date the customer is requesting delivery on. Typically used for perishable product delivery.", "format" : "dateTime", "type" : "string" }, "evening_phone" : { "description" : "Evening phone", "maxLength" : 25, "type" : "string" }, "first_name" : { "description" : "First name", "maxLength" : 30, "type" : "string" }, "last_name" : { "description" : "Last name", "maxLength" : 30, "type" : "string" }, "lift_gate" : { "description" : "Lift gate requested (LTL shipping methods only)", "type" : "boolean" }, "postal_code" : { "description" : "Postal code", "maxLength" : 25, "type" : "string" }, "ship_on_date" : { "description" : "Date the customer is requesting that the order ship on. Typically used for perishable product delivery.", "format" : "dateTime", "type" : "string" }, "ship_to_residential" : { "description" : "True if the shipping adress is residential. Effects the methods that are available to the customer as well as the price of the shipping method.", "type" : "boolean" }, "shipping_3rd_party_account_number" : { "description" : "3rd party account number to ship against for UPS or FedEx", "maxLength" : 20, "type" : "string" }, "shipping_method" : { "description" : "Shipping method", "maxLength" : 40, "type" : "string" }, "special_instructions" : { "description" : "Special instructions from the customer regarding shipping", "maxLength" : 10000, "type" : "string" }, "state_region" : { "description" : "State/Region", "maxLength" : 32, "type" : "string" }, "title" : { "description" : "Title", "maxLength" : 50, "type" : "string" } }, "type" : "object" }, "CartSummary" : { "properties" : { "arbitrary_shipping_handling_total" : { "$ref" : "#/components/schemas/Currency" }, "arbitrary_tax" : { "$ref" : "#/components/schemas/Currency" }, "arbitrary_tax_rate" : { "$ref" : "#/components/schemas/Currency" }, "arbitrary_taxable_subtotal" : { "$ref" : "#/components/schemas/Currency" }, "health_benefit_card_amount" : { "$ref" : "#/components/schemas/Currency" }, "health_benefit_card_balance" : { "$ref" : "#/components/schemas/Currency" }, "health_benefit_card_requirements" : { "description" : "Health benefit card requirements", "type" : "string" }, "internal_gift_certificate_amount" : { "$ref" : "#/components/schemas/Currency" }, "shipping_handling" : { "$ref" : "#/components/schemas/Currency" }, "shipping_handling_discount" : { "$ref" : "#/components/schemas/Currency" }, "shipping_handling_with_discount" : { "$ref" : "#/components/schemas/Currency" }, "subtotal" : { "$ref" : "#/components/schemas/Currency" }, "subtotal_discount" : { "$ref" : "#/components/schemas/Currency" }, "subtotal_with_discount" : { "$ref" : "#/components/schemas/Currency" }, "surcharge" : { "$ref" : "#/components/schemas/Currency" }, "tax" : { "$ref" : "#/components/schemas/Currency" }, "taxable_subtotal" : { "$ref" : "#/components/schemas/Currency" }, "taxable_subtotal_discount" : { "$ref" : "#/components/schemas/Currency" }, "taxable_subtotal_with_discount" : { "$ref" : "#/components/schemas/Currency" }, "total" : { "$ref" : "#/components/schemas/Currency" } }, "type" : "object" }, "CartTaxes" : { "properties" : { "county" : { "description" : "Tax county if the state requires it.", "maxLength" : 32, "type" : "string" }, "exempt" : { "description" : "True if tax exempt", "type" : "boolean" }, "rate" : { "description" : "Tax rate", "type" : "number" } }, "type" : "object" }, "CartUpsellAfter" : { "properties" : { "finalize_after_dts" : { "description" : "The date/time after which the cart will finalize into an order.", "format" : "dateTime", "type" : "string" }, "finalize_after_minutes" : { "description" : "The amount of inactivity in minutes after which the cart should be finalized into an order. This will calculate the finalize_after_dts field.", "format" : "int32", "type" : "integer" }, "upsell_path_code" : { "description" : "Upsell path code (this is for legacy upsells only)", "maxLength" : 5, "type" : "string" }, "upsell_path_name" : { "description" : "Upsell path name to start on (StoreFront Upsells). Will only be respected on a handoff API call.", "type" : "string" }, "upsell_path_variation" : { "description" : "Upsell path variation to start on (StoreFront Upsells). Will only be respected on a handoff API call.", "type" : "string" } }, "type" : "object" }, "CartUtm" : { "properties" : { "attribution_first_click_subtotal" : { "type" : "number" }, "attribution_first_click_total" : { "type" : "number" }, "attribution_last_click_subtotal" : { "type" : "number" }, "attribution_last_click_total" : { "type" : "number" }, "attribution_linear_subtotal" : { "type" : "number" }, "attribution_linear_total" : { "type" : "number" }, "attribution_position_based_subtotal" : { "type" : "number" }, "attribution_position_based_total" : { "type" : "number" }, "click_dts" : { "description" : "Date/time that the click happened", "format" : "dateTime", "type" : "string" }, "facebook_ad_id" : { "type" : "string" }, "fbclid" : { "type" : "string" }, "gbraid" : { "type" : "string" }, "glcid" : { "type" : "string" }, "itm_campaign" : { "type" : "string" }, "itm_content" : { "type" : "string" }, "itm_id" : { "type" : "string" }, "itm_medium" : { "type" : "string" }, "itm_source" : { "type" : "string" }, "itm_term" : { "type" : "string" }, "msclkid" : { "type" : "string" }, "short_code" : { "type" : "string" }, "short_code_backup" : { "type" : "boolean" }, "ttclid" : { "type" : "string" }, "uc_message_id" : { "type" : "string" }, "utm_campaign" : { "type" : "string" }, "utm_content" : { "type" : "string" }, "utm_id" : { "type" : "string" }, "utm_medium" : { "type" : "string" }, "utm_source" : { "type" : "string" }, "utm_term" : { "type" : "string" }, "vmcid" : { "type" : "string" }, "wbraid" : { "type" : "string" } }, "type" : "object" }, "CartValidationRequest" : { "properties" : { "cart" : { "$ref" : "#/components/schemas/Cart" }, "checks" : { "description" : "Checks to perform", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CartValidationResponse" : { "properties" : { "cart" : { "$ref" : "#/components/schemas/Cart" }, "errors" : { "description" : "Errors to display to the customer if they failed any of the validations checked", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "ChanelPartnerReasonCodesResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "item_level_refund_reason_required" : { "description" : "True if the item level refund reason is required", "type" : "boolean" }, "item_level_refund_reasons" : { "description" : "Reason codes available at the item level.", "items" : { "$ref" : "#/components/schemas/OrderReason" }, "type" : "array" }, "item_level_return_reasons" : { "description" : "Return codes available at the item level.", "items" : { "$ref" : "#/components/schemas/OrderReason" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "order_level_refund_reason_required" : { "description" : "True if the order level refund reason is required", "type" : "boolean" }, "order_level_refund_reasons" : { "description" : "Reason codes available at the order level.", "items" : { "$ref" : "#/components/schemas/OrderReason" }, "type" : "array" }, "order_level_reject_reason_required" : { "description" : "True if the order level reject reason is required", "type" : "boolean" }, "order_level_reject_reasons" : { "description" : "Reject codes available at the order level.", "items" : { "$ref" : "#/components/schemas/OrderReason" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ChannelPartner" : { "properties" : { "channel_partner_oid" : { "description" : "Channel partner object id", "format" : "int32", "type" : "integer" }, "code" : { "description" : "Code associated with the channel partner", "type" : "string" }, "communication_method" : { "description" : "Communication method of the channel partner", "type" : "string" }, "dont_hold_shipment" : { "description" : "True if shipments should immediately process for this channel partner.", "type" : "boolean" }, "inactive" : { "description" : "True if the channel partner is inactive", "type" : "boolean" }, "merchant_id" : { "description" : "Merchant ID of the channel partner", "type" : "string" }, "name" : { "description" : "Name of the channel partner", "type" : "string" }, "skip_customer_emails" : { "description" : "True if emails to the customer are skipped for this channel partner.", "type" : "boolean" } }, "type" : "object" }, "ChannelPartnerCancelResponse" : { "properties" : { "cancel_errors" : { "description" : "Array of errors if errors occurred", "items" : { "type" : "string" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ChannelPartnerEstimateShippingResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "estimates" : { "description" : "An array of shipping methods and their costs", "items" : { "$ref" : "#/components/schemas/ChannelPartnerShippingEstimate" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ChannelPartnerEstimateTaxResponse" : { "properties" : { "arbitrary_tax" : { "type" : "number" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ChannelPartnerImportResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "import_errors" : { "description" : "Array of errors if errors occurred", "items" : { "type" : "string" }, "type" : "array" }, "import_warnings" : { "description" : "Array of warnings if warnings occurred", "items" : { "type" : "string" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "order_id" : { "description" : "The order id of the newly imported order if successful", "type" : "string" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ChannelPartnerOrder" : { "properties" : { "advertisingSource" : { "description" : "advertising_source", "type" : "string" }, "affiliate_id" : { "description" : "Affiliate Id", "type" : "string" }, "affiliate_sub_id" : { "description" : "Affiliate Sub Id", "type" : "string" }, "arbitrary_shipping_handling_total" : { "description" : "Arbitrary shipping handling total", "type" : "number" }, "arbitrary_tax" : { "description" : "Arbitrary tax for overriding calculated taxes", "type" : "number" }, "arbitrary_tax_rate" : { "description" : "Arbitrary tax rate", "type" : "number" }, "arbitrary_taxable_subtotal" : { "description" : "Arbitrary taxable subtotal", "type" : "number" }, "associate_with_customer_profile_if_present" : { "description" : "If true any matching customer profile based on email is associated with this order", "type" : "boolean" }, "auto_approve_purchase_order" : { "description" : "If true any purchase orders are automatically approved", "type" : "boolean" }, "billto_address1" : { "description" : "Billing Address line 1", "maxLength" : 50, "type" : "string" }, "billto_address2" : { "description" : "Billing Address line 2", "maxLength" : 50, "type" : "string" }, "billto_city" : { "description" : "Billing City", "maxLength" : 32, "type" : "string" }, "billto_company" : { "description" : "Billing Company", "maxLength" : 50, "type" : "string" }, "billto_country_code" : { "description" : "Billing ISO-3166 two letter country code", "maxLength" : 2, "type" : "string" }, "billto_day_phone" : { "description" : "Billing Day phone", "maxLength" : 25, "type" : "string" }, "billto_evening_phone" : { "description" : "Billing Evening phone", "maxLength" : 25, "type" : "string" }, "billto_first_name" : { "description" : "Billing First name", "maxLength" : 30, "type" : "string" }, "billto_last_name" : { "description" : "Billing Last name", "maxLength" : 30, "type" : "string" }, "billto_postal_code" : { "description" : "Billing Postal code", "maxLength" : 20, "type" : "string" }, "billto_state_region" : { "description" : "Billing State for United States otherwise region or province for other countries", "maxLength" : 32, "type" : "string" }, "billto_title" : { "description" : "Billing Title", "maxLength" : 50, "type" : "string" }, "cc_email" : { "description" : "CC email.", "maxLength" : 100, "type" : "string" }, "channel_partner_order_id" : { "description" : "The id for this order within the channel partner system.", "type" : "string" }, "consider_recurring" : { "description" : "If true this order is marked as an auto order (recurring)", "type" : "boolean" }, "coupons" : { "description" : "Array of coupon codes", "items" : { "type" : "string" }, "type" : "array" }, "credit_card_authorization_amount" : { "description" : "The amount authorized externally", "type" : "number" }, "credit_card_authorization_dts" : { "description" : "Date/Time of credit card authorization in ISO8601 format", "format" : "dateTime", "type" : "string" }, "credit_card_authorization_number" : { "description" : "The reference number provided by an externally processed transaction", "type" : "string" }, "credit_card_expiration_month" : { "description" : "Credit card expiration month", "format" : "int32", "type" : "integer" }, "credit_card_expiration_year" : { "description" : "Credit card expiration year", "format" : "int32", "type" : "integer" }, "credit_card_type" : { "description" : "Credit card type", "type" : "string" }, "custom_field1" : { "description" : "Custom field 1", "maxLength" : 50, "type" : "string" }, "custom_field2" : { "description" : "Custom field 2", "maxLength" : 50, "type" : "string" }, "custom_field3" : { "description" : "Custom field 3", "maxLength" : 50, "type" : "string" }, "custom_field4" : { "description" : "Custom field 4", "maxLength" : 50, "type" : "string" }, "custom_field5" : { "description" : "Custom field 5", "maxLength" : 75, "type" : "string" }, "custom_field6" : { "description" : "Custom field 6", "maxLength" : 50, "type" : "string" }, "custom_field7" : { "description" : "Custom field 7", "maxLength" : 50, "type" : "string" }, "delivery_date" : { "description" : "Date the customer is requesting delivery on. Typically used for perishable product delivery.", "format" : "dateTime", "type" : "string" }, "echeck_bank_aba_code" : { "description" : "eCheck bank ABA code", "type" : "string" }, "echeck_bank_account_name" : { "description" : "eCheck bank account name", "type" : "string" }, "echeck_bank_account_number" : { "description" : "eCheck bank account number", "type" : "string" }, "echeck_bank_account_type" : { "description" : "eCheck bank account type", "enum" : [ "Checking", "Savings" ], "type" : "string" }, "echeck_bank_name" : { "description" : "eCheck bank name", "type" : "string" }, "echeck_bank_owner_type" : { "description" : "eCheck bank owner type", "enum" : [ "Business", "Personal" ], "type" : "string" }, "echeck_customer_tax_id" : { "description" : "eCheck customer tax id", "type" : "string" }, "echeck_drivers_license_dob" : { "description" : "eCheck drivers license dob", "type" : "string" }, "echeck_drivers_license_number" : { "description" : "eCheck drivers license number", "type" : "string" }, "echeck_drivers_license_state" : { "description" : "eCheck drivers license state", "type" : "string" }, "email" : { "description" : "Email", "maxLength" : 100, "type" : "string" }, "gift" : { "description" : "True if this order is a gift", "type" : "boolean" }, "gift_email" : { "description" : "Email address of the gift recipient", "maxLength" : 100, "type" : "string" }, "gift_message" : { "description" : "Message to the gift recipient", "maxLength" : 10000, "type" : "string" }, "hosted_fields_card_token" : { "description" : "The token provided by UltraCart hosted fields when a credit card number is uploaded into the system. This is the only way to provide a credit card number.", "type" : "string" }, "hosted_fields_cvv_token" : { "description" : "The token provided by UltraCart hosted fields when a credit card cvv is uploaded into the system. This is the only way to provide a cvv number.", "type" : "string" }, "insurance_application_id" : { "description" : "Insurance application id", "type" : "string" }, "insurance_claim_id" : { "description" : "Insurance claim id", "type" : "string" }, "ip_address" : { "description" : "IP Address of the customer", "type" : "string" }, "items" : { "description" : "Items", "items" : { "$ref" : "#/components/schemas/ChannelPartnerOrderItem" }, "type" : "array" }, "least_cost_route" : { "description" : "If true the least expensive shipping method is automatically chosen during the order import", "type" : "boolean" }, "least_cost_route_shipping_methods" : { "description" : "An optional array of shipping methods to restict choices if least_cost_route is true", "items" : { "type" : "string" }, "type" : "array" }, "mailing_list_opt_in" : { "description" : "If true the customer is subscribed to any configured mailing lists", "type" : "boolean" }, "no_realtime_payment_processing" : { "description" : "If true no payment processing is done and the order is placed into Accounts Receivable", "type" : "boolean" }, "payment_method" : { "description" : "Payment method", "enum" : [ "Affirm", "Amazon", "Check", "COD", "Credit Card", "eCheck", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Wire Transfer", "PayPal Fastlane" ], "type" : "string" }, "purchase_order_number" : { "description" : "Purchase order number", "type" : "string" }, "rotating_transaction_gateway_code" : { "description" : "The rotating transaction gateway code for the gateway used to charge this order", "type" : "string" }, "sales_rep_code" : { "description" : "Sales rep code", "type" : "string" }, "screen_branding_theme_code" : { "description" : "Screen branding theme code", "maxLength" : 10, "type" : "string" }, "ship_on_date" : { "description" : "Date the customer is requesting that the order ship on. Typically used for perishable product delivery.", "format" : "dateTime", "type" : "string" }, "ship_to_residential" : { "description" : "True if the shipping adress is residential. Effects the methods that are available to the customer as well as the price of the shipping method.", "type" : "boolean" }, "shipping_method" : { "description" : "Shipping method", "type" : "string" }, "shipto_address1" : { "description" : "Shipping Address line 1", "maxLength" : 50, "type" : "string" }, "shipto_address2" : { "description" : "Shipping Address line 2", "maxLength" : 50, "type" : "string" }, "shipto_city" : { "description" : "Shipping City", "maxLength" : 32, "type" : "string" }, "shipto_company" : { "description" : "Shipping Company", "maxLength" : 50, "type" : "string" }, "shipto_country_code" : { "description" : "Shipping ISO-3166 two letter country code", "maxLength" : 2, "type" : "string" }, "shipto_day_phone" : { "description" : "Shipping Day phone", "maxLength" : 25, "type" : "string" }, "shipto_evening_phone" : { "description" : "Shipping Evening phone", "maxLength" : 25, "type" : "string" }, "shipto_first_name" : { "description" : "Shipping First name", "maxLength" : 30, "type" : "string" }, "shipto_last_name" : { "description" : "Shipping Last name", "maxLength" : 30, "type" : "string" }, "shipto_postal_code" : { "description" : "Shipping Postal code", "maxLength" : 20, "type" : "string" }, "shipto_state_region" : { "description" : "Shipping State for United States otherwise region or province for other countries", "maxLength" : 32, "type" : "string" }, "shipto_title" : { "description" : "Shipping Title", "maxLength" : 50, "type" : "string" }, "skip_payment_processing" : { "description" : "If true the order is placed directly into the shipping department", "type" : "boolean" }, "special_instructions" : { "description" : "Special instructions from the customer regarding shipping", "maxLength" : 10000, "type" : "string" }, "store_completed" : { "description" : "If true the order bypasses shipping and is marked completed", "type" : "boolean" }, "store_if_payment_declines" : { "description" : "If true any failed payments are placed into Accounts Receivable. If false any failed payments result in a rejected order resulting in errors thrown during the insert routine", "type" : "boolean" }, "storefront_host_name" : { "description" : "StoreFront host name associated with the order", "type" : "string" }, "tax_county" : { "description" : "The optional shipping county used to determine exact taxes", "type" : "string" }, "tax_exempt" : { "description" : "If true this order is marked as being tax exempt", "type" : "boolean" }, "transaction" : { "$ref" : "#/components/schemas/ChannelPartnerOrderTransaction" }, "treat_warnings_as_errors" : { "description" : "If true all warnings are considered errors, this is true by default", "type" : "boolean" }, "use_prior_payment_information_from_order_id" : { "description" : "An Order Id from a prior purchase of this customer which is used to retrieve vaulted payment information in order to pay for this current order.", "type" : "string" } }, "type" : "object" }, "ChannelPartnerOrderItem" : { "properties" : { "arbitrary_unit_cost" : { "description" : "Arbitrary unit cost for this item that differs from the listed price", "type" : "number" }, "auto_order_last_rebill_dts" : { "description" : "Optional date/time of the last rebill if this item is part of an auto (recurring) order", "format" : "dateTime", "type" : "string" }, "auto_order_schedule" : { "description" : "The frequency schedule for this item if this item is part of an auto (recurring) order", "enum" : [ "Weekly", "Every 10 Days", "Biweekly", "Every 24 Days", "Every 28 Days", "Monthly", "Every 45 Days", "Every 2 Months", "Every 3 Months", "Every 4 Months", "Every 5 Months", "Every 6 Months", "Yearly", "Every 4 Weeks", "Every 6 Weeks", "Every 8 Weeks" ], "type" : "string" }, "merchant_item_id" : { "description" : "Item ID", "maxLength" : 20, "type" : "string" }, "options" : { "description" : "Item options", "items" : { "$ref" : "#/components/schemas/ChannelPartnerOrderItemOption" }, "type" : "array" }, "properties" : { "description" : "Properties", "items" : { "$ref" : "#/components/schemas/ChannelPartnerOrderItemProperty" }, "type" : "array" }, "quantity" : { "description" : "Quantity", "type" : "number" }, "upsell" : { "description" : "True if this item was an upsell item.", "type" : "boolean" } }, "type" : "object" }, "ChannelPartnerOrderItemOption" : { "properties" : { "name" : { "description" : "The name of the item option.", "type" : "string" }, "value" : { "description" : "The value of the item option.", "type" : "string" } }, "type" : "object" }, "ChannelPartnerOrderItemProperty" : { "properties" : { "display" : { "description" : "True if this property is displayed to the customer", "type" : "boolean" }, "expiration_dts" : { "description" : "The date/time that the property expires and is deleted", "format" : "dateTime", "type" : "string" }, "name" : { "description" : "Name", "maxLength" : 100, "type" : "string" }, "value" : { "description" : "Value", "maxLength" : 3800, "type" : "string" } }, "type" : "object" }, "ChannelPartnerOrderTransaction" : { "properties" : { "details" : { "description" : "Transaction gateway details", "items" : { "$ref" : "#/components/schemas/ChannelPartnerOrderTransactionDetail" }, "type" : "array" }, "successful" : { "description" : "True if the transaction was successfully charged", "type" : "boolean" } }, "type" : "object" }, "ChannelPartnerOrderTransactionDetail" : { "properties" : { "name" : { "description" : "The name of the item option.", "type" : "string" }, "value" : { "description" : "The value of the item option.", "type" : "string" } }, "type" : "object" }, "ChannelPartnerShippingEstimate" : { "properties" : { "shipping_handling_total" : { "description" : "The total estimate for this shipping method based on the provided order.", "type" : "number" }, "shipping_method" : { "description" : "The name of the shipping method", "type" : "string" } }, "type" : "object" }, "ChannelPartnerShipToPreference" : { "properties" : { "additional_kit_component_item_ids" : { "description" : "Additional item ids to add as kit components to the order with a zero price.", "items" : { "type" : "string" }, "type" : "array" }, "channel_partner_oid" : { "description" : "The channel partner object identifier this preference is associated with", "format" : "int32", "type" : "integer" }, "channel_partner_ship_to_preference_oid" : { "description" : "Object identifier for the ship to preference", "format" : "int32", "type" : "integer" }, "description" : { "description" : "A description that is meaningful to the merchant.", "maxLength" : 100, "type" : "string" }, "merchant_id" : { "description" : "The merchant id that owns the channel partner", "type" : "string" }, "return_policy" : { "description" : "Alternate return policy to print on the packing slip.", "type" : "string" }, "ship_to_edi_code" : { "description" : "The ship to EDI code that the preferences are for", "type" : "string" } }, "type" : "object" }, "ChannelPartnerShipToPreferenceResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "ship_to_preference" : { "$ref" : "#/components/schemas/ChannelPartnerShipToPreference" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ChannelPartnerShipToPreferencesResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "shipToPreferences" : { "description" : "ship_to_preferences", "items" : { "$ref" : "#/components/schemas/ChannelPartnerShipToPreference" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ChannelPartnersResponse" : { "properties" : { "channelPartners" : { "description" : "channel_partners", "items" : { "$ref" : "#/components/schemas/ChannelPartner" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "CheckoutAllowedCountriesResponse" : { "properties" : { "countries" : { "items" : { "$ref" : "#/components/schemas/Country" }, "type" : "array" } }, "type" : "object" }, "CheckoutHandoffRequest" : { "properties" : { "cart" : { "$ref" : "#/components/schemas/Cart" }, "error_parameter_name" : { "description" : "If any error happen during the processing on the UltraCart side, the browser will be redirected to your error_return_url with the error passed in this parameter name.", "type" : "string" }, "error_return_url" : { "description" : "The URL to return the browser to if there are processing errors on the UltraCart side.", "type" : "string" }, "operation" : { "description" : "The type of handoff operation to perform", "enum" : [ "checkout", "payPal", "payPalCredit", "view", "affirm", "sezzle" ], "type" : "string" }, "paypal_maximum_upsell_revenue" : { "description" : "The maximum amount of revenue that you think the customer could add during a custom upsell after sequence on your checkout.", "type" : "number" }, "paypal_return_url" : { "description" : "The URl to return the customers browser to after they have completed the PayPal process.", "type" : "string" }, "secure_host_name" : { "description" : "The desired secure host name to perform the handoff on. This should match the desired StoreFront.", "type" : "string" }, "ucacid" : { "description" : "The UltraCart Analytics cookie value. Populate this if you're handing off from a different domain than the checkout.", "type" : "string" } }, "type" : "object" }, "CheckoutHandoffResponse" : { "properties" : { "cart" : { "$ref" : "#/components/schemas/Cart" }, "errors" : { "description" : "Errors that occurred which are preventing the handoff operation. Display these to the customer.", "items" : { "type" : "string" }, "type" : "array" }, "redirect_to_url" : { "description" : "The URL that you should redirect the customers browser to", "type" : "string" } }, "type" : "object" }, "CheckoutSetupBrowserKeyRequest" : { "properties" : { "allowed_referrers" : { "description" : "Allowed referrers. If URLs are specified, automatic translation will convert them to proper allowed referrer maskes.", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CheckoutSetupBrowserKeyResponse" : { "properties" : { "browser_key" : { "description" : "Browser key that is used to authenticate against the new linked application.", "type" : "string" } }, "type" : "object" }, "CheckoutStateProvinceResponse" : { "properties" : { "stateProvinces" : { "items" : { "$ref" : "#/components/schemas/StateProvince" }, "type" : "array" } }, "type" : "object" }, "CityStateZip" : { "properties" : { "city" : { "type" : "string" }, "error" : { "type" : "string" }, "state" : { "type" : "string" }, "validZip" : { "type" : "boolean" }, "zip" : { "type" : "string" } }, "type" : "object" }, "Conversation" : { "properties" : { "base_language_iso_code" : { "description" : "The base language iso code for the StoreFront that everything is translated into", "type" : "string" }, "closed" : { "type" : "boolean" }, "conversation_arn" : { "type" : "string" }, "conversation_uuid" : { "type" : "string" }, "customer_first_message_unresponded_to_dts" : { "description" : "Date/time of the first customer message that is unresponded to.", "format" : "dateTime", "type" : "string" }, "last_conversation_message_body" : { "type" : "string" }, "last_conversation_participant_arn" : { "type" : "string" }, "last_conversation_participant_name" : { "type" : "string" }, "last_interactive_message_dts" : { "description" : "Last interactive message date/time", "format" : "dateTime", "type" : "string" }, "last_message_dts" : { "description" : "Last message date/time", "format" : "dateTime", "type" : "string" }, "medium" : { "description" : "The communication medium of the customer.", "enum" : [ "sms", "websocket" ], "type" : "string" }, "merchant_id" : { "type" : "string" }, "message_count" : { "format" : "int32", "type" : "integer" }, "messages" : { "items" : { "$ref" : "#/components/schemas/ConversationMessage" }, "type" : "array" }, "participants" : { "items" : { "$ref" : "#/components/schemas/ConversationParticipant" }, "type" : "array" }, "sentiment" : { "$ref" : "#/components/schemas/ConversationSentiment" }, "start_dts" : { "description" : "Start of the conversation date/time", "format" : "dateTime", "type" : "string" }, "unread_messages" : { "type" : "boolean" }, "virtual_agent" : { "description" : "True if a virtual agent answered the conversation", "type" : "boolean" }, "virtual_agent_cost" : { "description" : "The cost of this conversation performed by the virtual agent", "type" : "number" }, "visible" : { "type" : "boolean" } }, "type" : "object" }, "ConversationAgentAuth" : { "properties" : { "chat_admin" : { "type" : "boolean" }, "chat_user" : { "type" : "boolean" }, "conversation_participant_arn" : { "type" : "string" }, "conversation_participant_name" : { "type" : "string" }, "customer_profile" : { "type" : "boolean" }, "default_phone_number" : { "description" : "The default phone number this agent should use when making an outbound call.", "type" : "string" }, "group_ids" : { "description" : "UltraCart Groups this user belongs to", "items" : { "type" : "integer" }, "type" : "array" }, "jwt" : { "type" : "string" }, "merchant_id" : { "type" : "string" }, "merchants" : { "description" : "List of merchants in this linked merchant group", "items" : { "$ref" : "#/components/schemas/ConversationAgentAuthMerchant" }, "type" : "array" }, "parent_merchant_id" : { "description" : "The parent merchant ID for PBX. For non-linked merchants, equals merchant_id.", "type" : "string" }, "pbx_admin" : { "type" : "boolean" }, "pbx_jwt" : { "type" : "string" }, "pbx_supervisor" : { "type" : "boolean" }, "pbx_user" : { "type" : "boolean" }, "pbx_voice_identity" : { "type" : "string" }, "pbx_voice_token" : { "type" : "string" }, "pbx_worker_token" : { "type" : "string" }, "pbx_worker_token_v2" : { "type" : "string" }, "twilio_accounts" : { "items" : { "$ref" : "#/components/schemas/ConversationTwilioAccount" }, "type" : "array" }, "user_id" : { "description" : "UltraCart User ID", "format" : "int32", "type" : "integer" }, "websocket_url" : { "type" : "string" } }, "type" : "object" }, "ConversationAgentAuthMerchant" : { "properties" : { "company" : { "description" : "The company name for this merchant", "type" : "string" }, "is_parent" : { "description" : "True if this is the parent merchant that owns the Twilio account", "type" : "boolean" }, "merchant_id" : { "description" : "The merchant ID", "maxLength" : 20, "type" : "string" } }, "type" : "object" }, "ConversationAgentAuthResponse" : { "properties" : { "agent_auth" : { "$ref" : "#/components/schemas/ConversationAgentAuth" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationAgentCallEvent" : { "properties" : { "call_uuid" : { "description" : "Call UUID", "type" : "string" }, "direction" : { "description" : "Direction", "enum" : [ "inbound", "outbound" ], "type" : "string" }, "disposition" : { "description" : "Call disposition (e.g. 'answered', 'missed')", "type" : "string" }, "duration_seconds" : { "description" : "Total call duration in seconds", "format" : "int32", "type" : "integer" }, "end_dts" : { "description" : "Call ended", "format" : "dateTime", "type" : "string" }, "phone_number" : { "description" : "Counterparty phone number", "type" : "string" }, "start_dts" : { "description" : "Call started", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "ConversationAgentChatEvent" : { "properties" : { "conversation_uuid" : { "description" : "Conversation UUID", "type" : "string" }, "customer_name" : { "description" : "Customer display name (when known)", "type" : "string" }, "end_dts" : { "description" : "Chat ended", "format" : "dateTime", "type" : "string" }, "message_count" : { "description" : "Total messages in the conversation", "format" : "int32", "type" : "integer" }, "start_dts" : { "description" : "Chat started", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "ConversationAgentProfile" : { "properties" : { "ai" : { "description" : "AI powered chat bot", "type" : "boolean" }, "ai_capabilities" : { "$ref" : "#/components/schemas/ConversationVirtualAgentCapabilities" }, "ai_chat_instructions" : { "description" : "Additional instructions for this AI when handle web chats", "type" : "string" }, "ai_persona" : { "description" : "Persona of this AI agent", "type" : "string" }, "ai_sms_instructions" : { "description" : "Additional instructions for this AI when handle SMS messages", "type" : "string" }, "ai_ticket_instructions" : { "description" : "Additional instructions for this AI when handling ticket draft replies", "type" : "string" }, "ai_voice_instructions" : { "description" : "Additional voice instructions for this AI when handling voice calls", "type" : "string" }, "ai_voice_personality" : { "description" : "Which AI voice personality to use when handling the call.", "enum" : [ "Ara", "Rex", "Sal", "Eve", "Leo" ], "type" : "string" }, "chat_limit" : { "description" : "The number of engagement chats that can be pushed on them at any given time.", "format" : "int32", "type" : "integer" }, "default_language_iso_code" : { "description" : "The default language the agent is chatting in", "type" : "string" }, "default_status" : { "description" : "Default status when the agent loads conversations app.", "enum" : [ "available", "busy", "unavailable" ], "type" : "string" }, "display_name" : { "description" : "An alternate name that the agent wants to use in chat.", "type" : "string" }, "name" : { "description" : "Their actual user name for profile settings display as placeholder test", "type" : "string" }, "profile_image_upload_key" : { "description" : "An upload key used to update the profile image.", "type" : "string" }, "profile_image_url" : { "description" : "Their current profile image URL", "type" : "string" }, "user_id" : { "description" : "User ID associated with the agent. Populated by getAgentProfiles call only.", "format" : "int32", "type" : "integer" }, "zohodesk_classifications" : { "description" : "Restrict this agent to drafting replies only to tickets with these classifications", "items" : { "type" : "string" }, "type" : "array" }, "zohodesk_departments" : { "description" : "Restrict this agent to drafting replies only to these department ids", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "ConversationAgentProfileResponse" : { "properties" : { "agent_profile" : { "$ref" : "#/components/schemas/ConversationAgentProfile" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationAgentProfilesResponse" : { "properties" : { "agent_profiles" : { "items" : { "$ref" : "#/components/schemas/ConversationAgentProfile" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationAgentStatusConfig" : { "properties" : { "active" : { "description" : "Whether the status is active and selectable. DELETE soft-deactivates by setting this to false.", "type" : "boolean" }, "channel" : { "description" : "Channel this status applies to", "enum" : [ "pbx", "chat", "both" ], "type" : "string" }, "color" : { "description" : "Hex color for UI (e.g. '#FF5733')", "maxLength" : 7, "type" : "string" }, "conversation_status_uuid" : { "description" : "Conversation agent status unique identifier", "type" : "string" }, "created_at" : { "description" : "Created at", "format" : "dateTime", "type" : "string" }, "icon" : { "description" : "Icon name", "maxLength" : 40, "type" : "string" }, "merchant_id" : { "description" : "Merchant Id", "maxLength" : 5, "type" : "string" }, "name" : { "description" : "Display name shown to agents", "maxLength" : 100, "type" : "string" }, "parent_status" : { "description" : "Channel-native parent status", "type" : "string" }, "routing_effect" : { "description" : "Canonical routing semantic. Derived server-side from (channel, parent_status).", "enum" : [ "available", "busy", "unavailable" ], "type" : "string" }, "sort_order" : { "description" : "Sort order in lists; lower = first", "format" : "int32", "type" : "integer" }, "twilio_activity_sid" : { "description" : "Twilio TaskRouter Activity SID (PBX-only; null for chat-only statuses)", "maxLength" : 40, "type" : "string" }, "updated_at" : { "description" : "Updated at", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "ConversationAgentStatusConfigResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "status_config" : { "$ref" : "#/components/schemas/ConversationAgentStatusConfig" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationAgentStatusConfigsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "status_configs" : { "description" : "Agent status configurations", "items" : { "$ref" : "#/components/schemas/ConversationAgentStatusConfig" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationAgentStatusEvent" : { "properties" : { "agent_identifier" : { "description" : "Agent identifier — voice_identity for PBX (e.g. 'client:login'), participant_arn for chat, synthetic 'ai:' for AI flag events. Stable across an agent's events; participates in DDB pk and GSI1 sk.", "type" : "string" }, "agent_name" : { "description" : "Agent display name at the time of the event", "type" : "string" }, "agent_type" : { "description" : "Agent type", "enum" : [ "human", "ai" ], "type" : "string" }, "agent_user_id" : { "description" : "Agent user id (links across channels)", "type" : "string" }, "channel" : { "description" : "Channel", "enum" : [ "pbx", "chat" ], "type" : "string" }, "custom_status_name" : { "description" : "Custom status name (when applicable)", "type" : "string" }, "custom_status_uuid" : { "description" : "Custom status uuid (when applicable)", "maxLength" : 50, "type" : "string" }, "duration_in_previous_seconds" : { "description" : "Time spent in the previous status, in seconds", "format" : "int64", "type" : "integer" }, "event_dts" : { "description" : "Event timestamp (ISO 8601)", "format" : "dateTime", "type" : "string" }, "event_uuid" : { "description" : "Event UUID (natural key for ES + BQ)", "maxLength" : 36, "type" : "string" }, "merchant_id" : { "description" : "Merchant Id", "maxLength" : 5, "type" : "string" }, "new_routing_effect" : { "description" : "Canonical new routing semantic", "enum" : [ "available", "busy", "unavailable" ], "type" : "string" }, "new_status" : { "description" : "Channel-native new status name", "type" : "string" }, "parent_merchant_id" : { "description" : "Parent merchant id (denormalized for ES routing parity)", "maxLength" : 5, "type" : "string" }, "previous_routing_effect" : { "description" : "Canonical previous routing semantic", "enum" : [ "available", "busy", "unavailable" ], "type" : "string" }, "previous_status" : { "description" : "Channel-native previous status name", "type" : "string" }, "trigger" : { "description" : "What triggered the transition", "enum" : [ "manual", "system", "auto_disconnect" ], "type" : "string" } }, "type" : "object" }, "ConversationAgentStatusHeatmapRequest" : { "properties" : { "channel" : { "description" : "Optional channel filter", "enum" : [ "pbx", "chat" ], "type" : "string" }, "date_end" : { "description" : "Range end (YYYY-MM-DD)", "type" : "string" }, "date_start" : { "description" : "Range start (YYYY-MM-DD)", "type" : "string" }, "metric" : { "description" : "Cell metric", "enum" : [ "availability", "call_volume", "chat_volume" ], "type" : "string" } }, "type" : "object" }, "ConversationAgentStatusHeatmapResponse" : { "properties" : { "agents" : { "description" : "Y-axis labels (one per agent)", "items" : { "type" : "string" }, "type" : "array" }, "data" : { "description" : "Sparse cells. Each row is [agent_index, hour, value]; empty cells are omitted.", "items" : { "$ref" : "#/components/schemas/double[]" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "hours" : { "description" : "X-axis values (hours of day, 0-23)", "items" : { "type" : "integer" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationAgentStatusHistorySearchRequest" : { "properties" : { "agent_user_id" : { "description" : "Optional agent_user_id filter", "type" : "string" }, "channel" : { "description" : "Optional channel filter", "enum" : [ "pbx", "chat" ], "type" : "string" }, "date_end" : { "description" : "Date range end (ISO 8601 or YYYY-MM-DD)", "type" : "string" }, "date_start" : { "description" : "Date range start (ISO 8601 or YYYY-MM-DD)", "type" : "string" }, "status" : { "description" : "Optional new_status filter", "type" : "string" }, "trigger" : { "description" : "Optional trigger filter", "enum" : [ "manual", "system", "auto_disconnect" ], "type" : "string" } }, "type" : "object" }, "ConversationAgentStatusHistorySearchResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "events" : { "description" : "Status transition events", "items" : { "$ref" : "#/components/schemas/ConversationAgentStatusEvent" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "total" : { "description" : "Total matching events (pre-pagination)", "format" : "int32", "type" : "integer" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationAgentStatusRollup" : { "properties" : { "agent_name" : { "description" : "Agent display name", "type" : "string" }, "agent_user_id" : { "description" : "Agent user id", "type" : "string" }, "availability_pct" : { "$ref" : "#/components/schemas/double" }, "available_seconds" : { "description" : "Seconds spent Available (incl. Busy per OVERVIEW reporting convention)", "format" : "int64", "type" : "integer" }, "calls_taken" : { "description" : "Calls handled by the agent on this day (PBX channel only)", "format" : "int32", "type" : "integer" }, "channel" : { "description" : "Channel", "enum" : [ "pbx", "chat" ], "type" : "string" }, "chats_handled" : { "description" : "Chats handled by the agent on this day (chat channel only)", "format" : "int32", "type" : "integer" }, "rollup_date" : { "description" : "Day this rollup covers (YYYY-MM-DD)", "type" : "string" }, "status_breakdown" : { "description" : "Per-status duration breakdown in seconds (status name -> seconds)", "type" : "object" }, "total_tracked_seconds" : { "description" : "Total seconds tracked across all statuses for the day", "format" : "int64", "type" : "integer" }, "unavailable_seconds" : { "description" : "Seconds spent Unavailable", "format" : "int64", "type" : "integer" } }, "type" : "object" }, "ConversationAgentStatusRollupSearchRequest" : { "properties" : { "agent_user_id" : { "description" : "Optional agent_user_id filter", "type" : "string" }, "channel" : { "description" : "Optional channel filter", "enum" : [ "pbx", "chat" ], "type" : "string" }, "date_end" : { "description" : "Date range end (YYYY-MM-DD)", "type" : "string" }, "date_start" : { "description" : "Date range start (YYYY-MM-DD)", "type" : "string" } }, "type" : "object" }, "ConversationAgentStatusRollupSearchResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "rollups" : { "description" : "Per-(agent, day, channel) rollups", "items" : { "$ref" : "#/components/schemas/ConversationAgentStatusRollup" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationAgentStatusSummaryResponse" : { "properties" : { "agents" : { "description" : "Per-agent enriched summary (status totals + activity metrics)", "items" : { "$ref" : "#/components/schemas/AgentSummary" }, "type" : "array" }, "avg_available_pct" : { "$ref" : "#/components/schemas/double" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "status_breakdown" : { "description" : "Total seconds-in-status across all agents, keyed by status name", "type" : "object" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "total_agents" : { "description" : "Distinct agents with at least one transition in the range", "format" : "int32", "type" : "integer" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationAgentStatusTimelineResponse" : { "properties" : { "call_events" : { "description" : "PBX call records for the agent on the requested day", "items" : { "$ref" : "#/components/schemas/ConversationAgentCallEvent" }, "type" : "array" }, "chat_events" : { "description" : "Chat conversations for the agent on the requested day", "items" : { "$ref" : "#/components/schemas/ConversationAgentChatEvent" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "status_events" : { "description" : "Status transitions for the agent on the requested day", "items" : { "$ref" : "#/components/schemas/ConversationAgentStatusEvent" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "summary" : { "$ref" : "#/components/schemas/TimelineSummary" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationAutocompleteRequest" : { "properties" : { "field" : { "type" : "string" }, "term" : { "type" : "string" } }, "type" : "object" }, "ConversationAutocompleteResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "field" : { "type" : "string" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "results" : { "items" : { "$ref" : "#/components/schemas/ConversationAutocompleteValue" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "term" : { "type" : "string" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationAutocompleteValue" : { "properties" : { "description" : { "type" : "string" }, "value" : { "type" : "string" } }, "type" : "object" }, "ConversationCannedMessage" : { "properties" : { "canned_message" : { "type" : "string" }, "conversation_canned_message_oid" : { "format" : "int32", "type" : "integer" }, "conversation_department_oids" : { "items" : { "type" : "integer" }, "type" : "array" }, "short_code" : { "type" : "string" } }, "type" : "object" }, "ConversationCannedMessageResponse" : { "properties" : { "conversation_canned_message" : { "$ref" : "#/components/schemas/ConversationCannedMessage" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationCannedMessagesResponse" : { "properties" : { "conversation_canned_messages" : { "items" : { "$ref" : "#/components/schemas/ConversationCannedMessage" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationCannedMessagesSearch" : { "properties" : { "max_results" : { "format" : "int32", "type" : "integer" }, "short_code" : { "type" : "string" } }, "type" : "object" }, "ConversationDeleteKnowledgeBaseDocumentResponse" : { "properties" : { "document_id" : { "type" : "string" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationDepartment" : { "properties" : { "conversation_department_oid" : { "format" : "int32", "type" : "integer" }, "department_name" : { "type" : "string" }, "members" : { "items" : { "$ref" : "#/components/schemas/ConversationDepartmentMember" }, "type" : "array" }, "merchant_id" : { "type" : "string" }, "settings" : { "$ref" : "#/components/schemas/ConversationDepartmentSettings" } }, "type" : "object" }, "ConversationDepartmentMember" : { "properties" : { "ai" : { "type" : "boolean" }, "member" : { "type" : "boolean" }, "name" : { "type" : "string" }, "user_id" : { "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ConversationDepartmentMembersResponse" : { "properties" : { "conversation_department_members" : { "items" : { "$ref" : "#/components/schemas/ConversationDepartmentMember" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationDepartmentResponse" : { "properties" : { "conversation_department" : { "$ref" : "#/components/schemas/ConversationDepartment" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationDepartmentSettings" : { "type" : "object" }, "ConversationDepartmentsResponse" : { "properties" : { "conversation_departments" : { "items" : { "$ref" : "#/components/schemas/ConversationDepartment" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationEmbedPbxAuthResponse" : { "properties" : { "merchant_id" : { "description" : "Merchant identifier the agent belongs to.", "type" : "string" }, "pbx_admin" : { "description" : "True if this agent has PBX admin privileges.", "type" : "boolean" }, "pbx_jwt" : { "description" : "JWT used by the softphone widget to authenticate to the PBX WebSocket relay.", "type" : "string" }, "pbx_supervisor" : { "description" : "True if this agent has PBX supervisor privileges.", "type" : "boolean" }, "pbx_user" : { "description" : "True if this agent has baseline PBX access.", "type" : "boolean" }, "pbx_voice_identity" : { "description" : "Voice identity string identifying this agent to the PBX (e.g., client:user_123).", "type" : "string" } }, "type" : "object" }, "ConversationEngagement" : { "properties" : { "active" : { "type" : "boolean" }, "conversation_engagement_oid" : { "format" : "int32", "type" : "integer" }, "customer_greeting" : { "type" : "string" }, "customer_initiated" : { "type" : "boolean" }, "department_oids" : { "items" : { "type" : "integer" }, "type" : "array" }, "engagement_name" : { "type" : "string" }, "equation" : { "$ref" : "#/components/schemas/ConversationEngagementEquation" }, "time_on_page" : { "format" : "int32", "type" : "integer" }, "visitor_type" : { "description" : "The type of visitor", "enum" : [ "all", "first time", "returning" ], "type" : "string" } }, "type" : "object" }, "ConversationEngagementEquation" : { "properties" : { "groups" : { "items" : { "$ref" : "#/components/schemas/ConversationEngagementEquationGroup" }, "type" : "array" } }, "type" : "object" }, "ConversationEngagementEquationFunction" : { "properties" : { "any_page_url_logic" : { "description" : "Logic operation to perform on an any page url function type", "enum" : [ "contains", "does not contain", "is exactly", "is not" ], "type" : "string" }, "any_page_url_value" : { "type" : "string" }, "current_page_url_logic" : { "description" : "Logic operation to perform on a current page url function type", "enum" : [ "contains", "does not contain", "is exactly", "is not" ], "type" : "string" }, "current_page_url_value" : { "type" : "string" }, "customers_browsing_time_logic" : { "description" : "Logic operation to perform on a customer's browsing time function type", "enum" : [ "is at least", "is more than", "is less than", "is at most" ], "type" : "string" }, "customers_browsing_time_seconds" : { "format" : "int32", "type" : "integer" }, "customers_location_country" : { "type" : "string" }, "customers_location_logic" : { "description" : "Logic operation to perform on a customer's location function type", "enum" : [ "is", "is not" ], "type" : "string" }, "customers_location_state" : { "type" : "string" }, "number_of_viewed_pages_logic" : { "description" : "Logic operation to perform on a customer's browsing time function type", "enum" : [ "is at least", "is more than", "is less than", "is at most" ], "type" : "string" }, "number_of_viewed_pages_value" : { "format" : "int32", "type" : "integer" }, "referring_website_logic" : { "description" : "Logic operation to perform on a referring website function type", "enum" : [ "contains", "does not contain", "is exactly", "is not" ], "type" : "string" }, "referring_website_value" : { "type" : "string" }, "type" : { "description" : "Type of function", "enum" : [ "current page url", "customers location", "customers browsing time", "number of viewed pages", "referring website address", "any page from session" ], "type" : "string" } }, "type" : "object" }, "ConversationEngagementEquationGroup" : { "properties" : { "functions" : { "items" : { "$ref" : "#/components/schemas/ConversationEngagementEquationFunction" }, "type" : "array" } }, "type" : "object" }, "ConversationEngagementResponse" : { "properties" : { "conversation_engagement" : { "$ref" : "#/components/schemas/ConversationEngagement" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationEngagementsResponse" : { "properties" : { "conversation_engagements" : { "items" : { "$ref" : "#/components/schemas/ConversationEngagement" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationEventAddCoupon" : { "properties" : { "agent_arn" : { "type" : "string" }, "agent_name" : { "type" : "string" }, "coupon_code" : { "type" : "string" } }, "type" : "object" }, "ConversationEventAddItem" : { "properties" : { "agent_arn" : { "type" : "string" }, "agent_name" : { "type" : "string" }, "items" : { "items" : { "$ref" : "#/components/schemas/CartItem" }, "type" : "array" } }, "type" : "object" }, "ConversationEventQueuePosition" : { "properties" : { "available" : { "description" : "True if agents are logged into the queue", "type" : "boolean" }, "position" : { "description" : "Position in the queue. Value will be -1 if they cant be found in the queue.", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ConversationEventReadMessage" : { "properties" : { "conversation_message_uuid" : { "type" : "string" }, "message_dts" : { "description" : "Message date/time", "format" : "dateTime", "type" : "string" }, "message_epoch" : { "format" : "int64", "type" : "integer" } }, "type" : "object" }, "ConversationEventRRWeb" : { "properties" : { "data" : { "type" : "string" }, "data_part" : { "format" : "int32", "type" : "integer" }, "data_sha256" : { "type" : "string" }, "data_total_parts" : { "format" : "int32", "type" : "integer" }, "data_total_sha256" : { "type" : "string" }, "event_index" : { "format" : "int32", "type" : "integer" }, "type" : { "description" : "Type of event", "enum" : [ "init", "events" ], "type" : "string" } }, "type" : "object" }, "ConversationEventTyping" : { "properties" : { "author_conversation_participant_arn" : { "type" : "string" }, "author_conversation_participant_name" : { "type" : "string" }, "value" : { "type" : "string" } }, "type" : "object" }, "ConversationEventWebchatContext" : { "properties" : { "cart_id" : { "type" : "string" }, "ucacid" : { "type" : "string" }, "url" : { "type" : "string" } }, "type" : "object" }, "ConversationInsertKnowledgeBaseDocumentRequest" : { "properties" : { "original_file_name" : { "type" : "string" }, "presigned_url" : { "type" : "string" } }, "type" : "object" }, "ConversationInsertKnowledgeBaseDocumentResponse" : { "properties" : { "document_uuid" : { "type" : "string" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "s3_key" : { "type" : "string" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "vector_keys" : { "items" : { "type" : "string" }, "type" : "array" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationJoinRequest" : { "properties" : { "participant_language_iso_code" : { "type" : "string" } }, "type" : "object" }, "ConversationKnowledgeBaseDocument" : { "properties" : { "chunk_count" : { "format" : "int32", "type" : "integer" }, "description" : { "type" : "string" }, "document_id" : { "description" : "Human readable identifier. Filename is recommended.", "type" : "string" }, "document_uuid" : { "type" : "string" }, "metadata" : { "type" : "string" }, "mime_type" : { "type" : "string" }, "s3_key" : { "type" : "string" }, "s3_url" : { "type" : "string" } }, "type" : "object" }, "ConversationKnowledgeBaseDocumentsResponse" : { "properties" : { "documents" : { "description" : "documents", "items" : { "$ref" : "#/components/schemas/ConversationKnowledgeBaseDocument" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationKnowledgeBaseDocumentUploadUrl" : { "properties" : { "key" : { "type" : "string" }, "url" : { "type" : "string" } }, "type" : "object" }, "ConversationKnowledgeBaseDocumentUploadUrlResponse" : { "properties" : { "conversation_knowledge_base_document_upload_url" : { "$ref" : "#/components/schemas/ConversationKnowledgeBaseDocumentUploadUrl" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationLocationCountry" : { "properties" : { "iso2" : { "type" : "string" }, "name" : { "type" : "string" }, "state_provinces" : { "items" : { "$ref" : "#/components/schemas/ConversationLocationStateProvince" }, "type" : "array" } }, "type" : "object" }, "ConversationLocationsResponse" : { "properties" : { "countries" : { "items" : { "$ref" : "#/components/schemas/ConversationLocationCountry" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationLocationStateProvince" : { "properties" : { "abbreviation" : { "type" : "string" }, "name" : { "type" : "string" } }, "type" : "object" }, "ConversationMcpServer" : { "properties" : { "auth_method" : { "description" : "Authorization Method", "enum" : [ "none", "header", "basic" ], "type" : "string" }, "basic_password" : { "description" : "Basic password", "type" : "string" }, "basic_user_name" : { "description" : "Basic user name", "type" : "string" }, "header_name" : { "description" : "Header name", "type" : "string" }, "header_value" : { "description" : "Header value", "type" : "string" }, "mcp_server_uuid" : { "description" : "UUID of the MCP server configuration", "type" : "string" }, "priority" : { "description" : "Priority on which the MCP server tools are incorporated into the model. Lower number comes first", "format" : "int32", "type" : "integer" }, "url" : { "description" : "URL to the MCP server (must be https)", "type" : "string" } }, "type" : "object" }, "ConversationMcpServerResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "mcp_server" : { "$ref" : "#/components/schemas/ConversationMcpServer" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationMcpServersResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "mcp_servers" : { "items" : { "$ref" : "#/components/schemas/ConversationMcpServer" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationMcpServerToolsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "tools_json" : { "type" : "string" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationMessage" : { "properties" : { "author_conversation_participant_arn" : { "type" : "string" }, "author_conversation_participant_name" : { "type" : "string" }, "body" : { "type" : "string" }, "client_message_id" : { "type" : "string" }, "conversation_message_uuid" : { "type" : "string" }, "delay_until_dts" : { "description" : "Delay message transmission until date/time", "format" : "dateTime", "type" : "string" }, "language_iso_code" : { "type" : "string" }, "media_urls" : { "items" : { "type" : "string" }, "type" : "array" }, "merchant_id" : { "type" : "string" }, "message_dts" : { "description" : "Message date/time", "format" : "dateTime", "type" : "string" }, "message_epoch" : { "description" : "Message epoch milliseconds", "format" : "int64", "type" : "integer" }, "message_type" : { "type" : "string" }, "translations" : { "items" : { "$ref" : "#/components/schemas/ConversationMessageTranslation" }, "type" : "array" }, "transport_statuses" : { "items" : { "$ref" : "#/components/schemas/ConversationMessageTransportStatus" }, "type" : "array" }, "type" : { "description" : "Message type", "enum" : [ "message", "notice", "engagement prompt" ], "type" : "string" }, "upload_keys" : { "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "ConversationMessagesResponse" : { "properties" : { "conversation_messages" : { "items" : { "$ref" : "#/components/schemas/ConversationMessage" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationMessageTranslation" : { "properties" : { "body" : { "type" : "string" }, "language_iso_code" : { "type" : "string" } }, "type" : "object" }, "ConversationMessageTransportStatus" : { "properties" : { "conversation_participant_arn" : { "type" : "string" }, "status" : { "description" : "The status of the message transport", "enum" : [ "accepted", "scheduled", "queued", "sending", "sent", "read", "TWILIO_CREDENTIALS_MISSING", "SENT_TO_TWILIO", "TWILIO_ERROR", "SENT_TO_PINPOINT", "PINPOINT_ERROR" ], "type" : "string" } }, "type" : "object" }, "ConversationMultimediaUploadUrl" : { "properties" : { "key" : { "type" : "string" }, "url" : { "type" : "string" } }, "type" : "object" }, "ConversationMultimediaUploadUrlResponse" : { "properties" : { "conversation_multimedia_upload_url" : { "$ref" : "#/components/schemas/ConversationMultimediaUploadUrl" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationParticipant" : { "properties" : { "conversation_participant_arn" : { "type" : "string" }, "conversation_participant_name" : { "type" : "string" }, "conversation_participant_uuid" : { "type" : "string" }, "email" : { "type" : "string" }, "joined_dts" : { "description" : "Joined conversation date/time", "format" : "dateTime", "type" : "string" }, "language_iso_code" : { "type" : "string" }, "last_message_dts" : { "description" : "Last message date/time", "format" : "dateTime", "type" : "string" }, "left_dts" : { "description" : "Left conversation date/time", "format" : "dateTime", "type" : "string" }, "profile_image_url" : { "type" : "string" }, "sms_phone_number" : { "type" : "string" }, "status" : { "type" : "string" }, "timezone" : { "type" : "string" }, "unread_messages" : { "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ConversationPbxAddress" : { "properties" : { "address_sid" : { "description" : "Twilio Address SID", "maxLength" : 50, "type" : "string" }, "city" : { "description" : "City", "maxLength" : 100, "type" : "string" }, "conversation_pbx_address_uuid" : { "description" : "Conversation Pbx Address UUID", "maxLength" : 50, "type" : "string" }, "country_code" : { "description" : "ISO country code (2 characters)", "maxLength" : 2, "type" : "string" }, "customer_name" : { "description" : "Customer name", "maxLength" : 100, "type" : "string" }, "friendly_name" : { "description" : "Friendly name for the address", "maxLength" : 100, "type" : "string" }, "merchant_id" : { "description" : "Merchant Id", "maxLength" : 5, "type" : "string" }, "postal_code" : { "description" : "Postal code", "maxLength" : 20, "type" : "string" }, "region" : { "description" : "State/Province/Region", "maxLength" : 50, "type" : "string" }, "street" : { "description" : "Street address", "maxLength" : 200, "type" : "string" }, "valid" : { "description" : "Whether the address is valid (validated or verified)", "type" : "boolean" }, "validated" : { "description" : "Whether the address has been validated by Twilio", "type" : "boolean" }, "verified" : { "description" : "Whether the address has been verified by Twilio", "type" : "boolean" } }, "type" : "object" }, "ConversationPbxAddressesResponse" : { "properties" : { "addresses" : { "items" : { "$ref" : "#/components/schemas/ConversationPbxAddress" }, "type" : "array" } }, "type" : "object" }, "ConversationPbxAddressResponse" : { "properties" : { "address" : { "$ref" : "#/components/schemas/ConversationPbxAddress" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxAgent" : { "properties" : { "ai" : { "description" : "Flag to indicate if the agent is AI", "type" : "boolean" }, "call_routing_preference" : { "description" : "The call routing preference", "enum" : [ "softphone", "hardware_phone", "cellphone" ], "type" : "string" }, "cellphone" : { "description" : "Cellphone number of agent in E.164 format", "maxLength" : 50, "type" : "string" }, "conversation_pbx_agent_uuid" : { "description" : "Conversation Pbx Agent unique identifier", "type" : "string" }, "cos_uuid" : { "description" : "Class of Service UUID. If null, the merchant default CoS applies.", "type" : "string" }, "default_phone_number_uuid" : { "description" : "The default phone number that this agent should dial out to the PSTN with.", "type" : "string" }, "extension" : { "description" : "Extension", "format" : "int32", "type" : "integer" }, "full_name" : { "description" : "Full name", "type" : "string" }, "hardware_phone_uuids" : { "description" : "Array of hardware phones UUIDs associated with this agent", "items" : { "type" : "string" }, "type" : "array" }, "login" : { "description" : "Agent login", "type" : "string" }, "merchant_id" : { "description" : "Merchant Id", "maxLength" : 5, "type" : "string" }, "personal_conversation_pbx_voicemail_mailbox_uuid" : { "description" : "Personal Conversation Pbx Voicemail Mailbox UUID", "maxLength" : 50, "type" : "string" }, "preferred_hardware_phone_uuid" : { "description" : "The hardware phone that will be dialed on an incoming call if routing preference is hardware_phone", "type" : "string" }, "record_outgoing_automatically" : { "description" : "True if outgoing calls should be automatically recorded", "type" : "boolean" }, "shared_conversation_pbx_voicemail_mailbox_uuid" : { "description" : "Shared Conversation Pbx Voicemail Mailbox UUID", "maxLength" : 50, "type" : "string" }, "twilio_taskrouter_worker_id" : { "description" : "Twilio taskrouter worker Id", "maxLength" : 100, "type" : "string" }, "unavailable_play_audio_uuid" : { "description" : "Unavailable play audio UUID", "maxLength" : 50, "type" : "string" }, "unavailable_say" : { "description" : "Unavailable say", "type" : "string" }, "unavailable_say_voice" : { "description" : "Unavailable say voice", "enum" : [ "man", "woman" ], "maxLength" : 50, "type" : "string" }, "user_id" : { "description" : "User Id", "format" : "int32", "type" : "integer" }, "voicemail" : { "description" : "True if this agent has voicemail configured", "type" : "boolean" } }, "type" : "object" }, "ConversationPbxAgentResponse" : { "properties" : { "agent" : { "$ref" : "#/components/schemas/ConversationPbxAgent" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxAgentsResponse" : { "properties" : { "agents" : { "items" : { "$ref" : "#/components/schemas/ConversationPbxAgent" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxAudio" : { "properties" : { "audio_s3_listing_key" : { "description" : "Audio S3 Listing Key", "maxLength" : 250, "type" : "string" }, "context_merchant_id" : { "description" : "Optional child merchant ID this resource is assigned to. Null = shared across the linked merchant group.", "maxLength" : 20, "type" : "string" }, "conversation_pbx_audio_uuid" : { "description" : "Conversation Pbx Audio UUID", "maxLength" : 50, "type" : "string" }, "default_hold_music" : { "description" : "If true, this will be the default hold music", "type" : "boolean" }, "description" : { "description" : "Description of this audio", "maxLength" : 100, "type" : "string" }, "filename" : { "description" : "Filename", "maxLength" : 100, "type" : "string" }, "merchant_id" : { "description" : "Merchant Id", "maxLength" : 5, "type" : "string" }, "mime_type" : { "description" : "Mime Type", "maxLength" : 100, "type" : "string" }, "url" : { "description" : "URL", "type" : "string" }, "user_id" : { "description" : "User Id", "format" : "int32", "type" : "integer" }, "version" : { "description" : "Version", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ConversationPbxAudioResponse" : { "properties" : { "audio" : { "$ref" : "#/components/schemas/ConversationPbxAudio" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxAudiosResponse" : { "properties" : { "audios" : { "items" : { "$ref" : "#/components/schemas/ConversationPbxAudio" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxAudioUploadUrl" : { "properties" : { "key" : { "type" : "string" }, "url" : { "type" : "string" } }, "type" : "object" }, "ConversationPbxAudioUploadUrlResponse" : { "properties" : { "conversation_pbx_audio_upload_url" : { "$ref" : "#/components/schemas/ConversationPbxAudioUploadUrl" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxAudioUsageResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "menus" : { "items" : { "$ref" : "#/components/schemas/ConversationPbxMenu" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "queues" : { "items" : { "$ref" : "#/components/schemas/ConversationPbxQueue" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "voicemail_mailboxes" : { "items" : { "$ref" : "#/components/schemas/ConversationPbxVoicemailMailbox" }, "type" : "array" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxAvailablePhoneNumber" : { "properties" : { "address_requirements" : { "description" : "Address requirements", "enum" : [ "none", "any", "local", "foreign" ], "type" : "string" }, "country" : { "description" : "ISO country code", "maxLength" : 2, "type" : "string" }, "friendly_name" : { "description" : "Friendly formatted phone number", "maxLength" : 50, "type" : "string" }, "locality" : { "description" : "City/Locality", "maxLength" : 100, "type" : "string" }, "mms" : { "description" : "MMS capability", "type" : "boolean" }, "monthly_cost" : { "description" : "Monthly cost for this phone number", "type" : "number" }, "phone_number" : { "description" : "Phone number in E.164 format", "maxLength" : 50, "type" : "string" }, "region" : { "description" : "State/Province/Region", "maxLength" : 50, "type" : "string" }, "sms" : { "description" : "SMS capability", "type" : "boolean" }, "voice" : { "description" : "Voice capability", "type" : "boolean" } }, "type" : "object" }, "ConversationPbxAvailablePhoneNumbersResponse" : { "properties" : { "available_phone_numbers" : { "items" : { "$ref" : "#/components/schemas/ConversationPbxAvailablePhoneNumber" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxCall" : { "properties" : { "account_sid" : { "description" : "Twilio account SID", "type" : "string" }, "agents" : { "description" : "List of agents who participated in this call", "items" : { "$ref" : "#/components/schemas/ConversationPbxCallAgent" }, "type" : "array" }, "ai_agent_engagements" : { "description" : "List of AI agent engagements during the call", "items" : { "$ref" : "#/components/schemas/ConversationPbxCallAiEngagement" }, "type" : "array" }, "ai_summary" : { "$ref" : "#/components/schemas/ConversationPbxCallAiSummary" }, "call_sid" : { "description" : "Twilio call SID for the primary (customer) call leg", "type" : "string" }, "call_uuid" : { "description" : "Unique identifier for this call record", "type" : "string" }, "caller" : { "$ref" : "#/components/schemas/ConversationPbxCallCaller" }, "conference_sid" : { "description" : "Twilio conference SID if this call used conferencing", "type" : "string" }, "context_merchant_id" : { "description" : "Optional child merchant ID this call is attributed to. Null = no child attribution (parent-level call).", "type" : "string" }, "created_at_dts" : { "description" : "Timestamp when the call record was created", "format" : "dateTime", "type" : "string" }, "customer_name" : { "description" : "Customer name associated with this call", "type" : "string" }, "customer_profile_oid" : { "description" : "UltraCart customer profile OID if the caller was matched to a customer", "type" : "string" }, "disposition" : { "description" : "Call disposition describing how the call ended", "type" : "string" }, "email" : { "description" : "Email address of the caller if known", "type" : "string" }, "financial" : { "$ref" : "#/components/schemas/ConversationPbxCallFinancial" }, "holds" : { "description" : "List of hold events during the call", "items" : { "$ref" : "#/components/schemas/ConversationPbxCallHold" }, "type" : "array" }, "merchant_id" : { "description" : "Merchant identifier", "type" : "string" }, "recording_sids" : { "description" : "List of all Twilio recording SIDs associated with this call", "items" : { "type" : "string" }, "type" : "array" }, "recordings" : { "description" : "List of recordings made during the call", "items" : { "$ref" : "#/components/schemas/ConversationPbxCallRecording" }, "type" : "array" }, "routing" : { "$ref" : "#/components/schemas/ConversationPbxCallRouting" }, "status" : { "description" : "Final status of the call", "type" : "string" }, "timeline" : { "$ref" : "#/components/schemas/ConversationPbxCallTimeline" }, "transfers" : { "description" : "List of transfer events during the call", "items" : { "$ref" : "#/components/schemas/ConversationPbxCallTransfer" }, "type" : "array" }, "updated_at_dts" : { "description" : "Timestamp when the call record was last updated", "format" : "dateTime", "type" : "string" }, "zoho_desk_ticket_id" : { "description" : "Zoho Desk ticket ID if a ticket was created for this call", "type" : "string" }, "zoho_desk_ticket_url" : { "description" : "URL to the Zoho Desk ticket if a ticket was created for this call", "type" : "string" } }, "type" : "object" }, "ConversationPbxCallAgent" : { "properties" : { "agent_extension" : { "description" : "Agent's phone extension", "type" : "string" }, "agent_id" : { "description" : "Unique identifier for the agent", "type" : "string" }, "agent_name" : { "description" : "Display name of the agent", "type" : "string" }, "agent_user_id" : { "description" : "UltraCart user id for the agent (denormalized at index time so reporting endpoints can join on agent_user_id without translating from the agent_id login).", "type" : "string" }, "answered" : { "description" : "Whether the agent answered the call", "type" : "boolean" }, "call_sid" : { "description" : "Twilio call SID for the agent's call leg", "type" : "string" }, "joined_at_dts" : { "description" : "Timestamp when the agent joined the call", "format" : "dateTime", "type" : "string" }, "left_at_dts" : { "description" : "Timestamp when the agent left the call", "format" : "dateTime", "type" : "string" }, "role" : { "description" : "Role of the agent in the call", "type" : "string" }, "worker_sid" : { "description" : "Twilio TaskRouter worker SID", "type" : "string" } }, "type" : "object" }, "ConversationPbxCallAiCost" : { "properties" : { "amount" : { "description" : "Total cost amount in the specified currency", "type" : "number" }, "billed_minutes" : { "description" : "Number of minutes billed for AI usage", "type" : "number" }, "cost_per_minute" : { "description" : "Cost per minute for AI usage", "type" : "number" }, "currency" : { "description" : "Currency code (always USD)", "type" : "string" } }, "type" : "object" }, "ConversationPbxCallAiEngagement" : { "properties" : { "agent_name" : { "description" : "Display name of the AI agent", "type" : "string" }, "agent_uuid" : { "description" : "UUID of the AI agent configuration used", "type" : "string" }, "cost" : { "$ref" : "#/components/schemas/ConversationPbxCallAiCost" }, "ended_at_dts" : { "description" : "Timestamp when the AI engagement ended", "format" : "dateTime", "type" : "string" }, "engagement_type" : { "description" : "Type of AI engagement", "enum" : [ "ai_agent", "ai_coach" ], "type" : "string" }, "session_uuid" : { "description" : "Unique identifier for this AI engagement session", "type" : "string" }, "started_at_dts" : { "description" : "Timestamp when the AI engagement started", "format" : "dateTime", "type" : "string" }, "status" : { "description" : "Status of the AI engagement", "type" : "string" }, "tool_calls" : { "description" : "List of tool calls made by the AI agent during this engagement", "items" : { "$ref" : "#/components/schemas/ConversationPbxCallAiToolCall" }, "type" : "array" }, "whispers" : { "description" : "List of coaching whispers sent during this engagement", "items" : { "$ref" : "#/components/schemas/ConversationPbxCallAiWhisper" }, "type" : "array" } }, "type" : "object" }, "ConversationPbxCallAiSummary" : { "properties" : { "action_items" : { "description" : "Action items identified during the call", "items" : { "type" : "string" }, "type" : "array" }, "call_category" : { "description" : "Category of the call (e.g. support, sales, billing)", "type" : "string" }, "completion_tokens" : { "description" : "Number of output tokens used to generate the summary", "format" : "int32", "type" : "integer" }, "cost" : { "description" : "Cost of generating the summary in the specified currency", "type" : "number" }, "cost_currency" : { "description" : "Currency code for the summary cost (always USD)", "type" : "string" }, "generated_at_dts" : { "description" : "Timestamp when the summary was generated", "format" : "dateTime", "type" : "string" }, "key_topics" : { "description" : "Key topics discussed during the call", "items" : { "type" : "string" }, "type" : "array" }, "model" : { "description" : "AI model used to generate the summary (e.g. grok-4.1-fast)", "type" : "string" }, "prompt_tokens" : { "description" : "Number of input tokens used to generate the summary", "format" : "int32", "type" : "integer" }, "sentiment" : { "description" : "Overall sentiment of the call", "enum" : [ "positive", "neutral", "negative" ], "type" : "string" }, "summary" : { "description" : "2-3 sentence synopsis of the call", "type" : "string" } }, "type" : "object" }, "ConversationPbxCallAiToolCall" : { "properties" : { "called_at_dts" : { "description" : "Timestamp when the tool was called", "format" : "dateTime", "type" : "string" }, "completed_at_dts" : { "description" : "Timestamp when the tool call completed", "format" : "dateTime", "type" : "string" }, "duration_ms" : { "description" : "Duration of the tool call in milliseconds", "format" : "int32", "type" : "integer" }, "error_message" : { "description" : "Error message if the tool call failed", "type" : "string" }, "parameters" : { "description" : "Parameters passed to the tool (structure varies by tool)", "type" : "object" }, "result" : { "description" : "Result returned by the tool (structure varies by tool)", "type" : "object" }, "success" : { "description" : "Whether the tool call succeeded", "type" : "boolean" }, "tool_call_uuid" : { "description" : "Unique identifier for this tool call", "type" : "string" }, "tool_name" : { "description" : "Name of the tool that was called", "type" : "string" } }, "type" : "object" }, "ConversationPbxCallAiWhisper" : { "properties" : { "message" : { "description" : "The whisper message content", "type" : "string" }, "priority" : { "description" : "Priority level of the whisper", "type" : "string" }, "whisper_uuid" : { "description" : "Unique identifier for this whisper", "type" : "string" }, "whispered_at_dts" : { "description" : "Timestamp when the whisper was sent", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "ConversationPbxCallCaller" : { "properties" : { "caller_id" : { "description" : "Caller ID name if available", "type" : "string" }, "city" : { "description" : "City associated with the phone number", "type" : "string" }, "country" : { "description" : "Country associated with the phone number (ISO 3166-1 alpha-2)", "type" : "string" }, "phone_number" : { "description" : "Phone number in E.164 format", "type" : "string" }, "state" : { "description" : "State or province associated with the phone number", "type" : "string" } }, "type" : "object" }, "ConversationPbxCallFinancial" : { "properties" : { "ai_agent_billed_minutes" : { "description" : "Total AI agent billed minutes for this call", "type" : "number" }, "ai_agent_cost" : { "description" : "Total AI agent cost for this call", "type" : "number" }, "ai_agent_cost_currency" : { "description" : "Currency for AI agent cost", "type" : "string" }, "ai_summary_cost" : { "description" : "AI summary generation cost (LLM call made by pbx-transcript-formatter after the call ends)", "type" : "number" }, "call_currency" : { "description" : "Currency for call price (default USD)", "type" : "string" }, "call_price" : { "description" : "Twilio call cost", "type" : "number" }, "call_price_estimated" : { "description" : "True if call price is a fallback-rate estimate, false if Twilio-confirmed", "type" : "boolean" }, "transcription_cost" : { "description" : "AWS Transcribe transcription cost", "type" : "number" } }, "type" : "object" }, "ConversationPbxCallHold" : { "properties" : { "held_by_agent_id" : { "description" : "ID of the agent who placed the caller on hold", "type" : "string" }, "hold_duration_seconds" : { "description" : "Duration of the hold in seconds", "format" : "int32", "type" : "integer" }, "hold_end_dts" : { "description" : "Timestamp when the hold ended", "format" : "dateTime", "type" : "string" }, "hold_start_dts" : { "description" : "Timestamp when the hold started", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "ConversationPbxCallQueue" : { "properties" : { "answered_at_dts" : { "description" : "Timestamp when the call was answered from the queue", "format" : "dateTime", "type" : "string" }, "entered_at_dts" : { "description" : "Timestamp when the call entered the queue", "format" : "dateTime", "type" : "string" }, "queue_name" : { "description" : "Display name of the queue", "type" : "string" }, "queue_uuid" : { "description" : "Unique identifier for the queue", "type" : "string" }, "result" : { "description" : "Result of queue routing (e.g., answered, abandoned, timeout)", "type" : "string" }, "wait_seconds" : { "description" : "Number of seconds the caller waited in the queue", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ConversationPbxCallRecording" : { "properties" : { "channels" : { "description" : "Number of audio channels in the recording (1 for mono, 2 for stereo/dual-channel)", "format" : "int32", "type" : "integer" }, "duration_seconds" : { "description" : "Duration of the recording in seconds", "format" : "int32", "type" : "integer" }, "is_primary" : { "description" : "Whether this is the primary recording for the call", "type" : "boolean" }, "recording_s3_key" : { "description" : "S3 key for the recording audio file", "type" : "string" }, "recording_sid" : { "description" : "Twilio recording SID", "type" : "string" }, "recording_url" : { "description" : "URL to access the recording", "type" : "string" }, "status" : { "description" : "Status of the recording", "type" : "string" }, "transcript" : { "$ref" : "#/components/schemas/ConversationPbxCallTranscript" } }, "type" : "object" }, "ConversationPbxCallResponse" : { "properties" : { "call" : { "$ref" : "#/components/schemas/ConversationPbxCall" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxCallRouting" : { "properties" : { "call_type" : { "description" : "Type of call routing used", "type" : "string" }, "direction" : { "description" : "Direction of the call", "type" : "string" }, "queue" : { "$ref" : "#/components/schemas/ConversationPbxCallQueue" } }, "type" : "object" }, "ConversationPbxCallSearchRequest" : { "properties" : { "agent_ids" : { "description" : "Filter by agent IDs", "items" : { "type" : "string" }, "type" : "array" }, "customer_name" : { "description" : "Filter by customer name", "type" : "string" }, "direction" : { "description" : "Filter by call direction (inbound/outbound)", "type" : "string" }, "disposition" : { "description" : "Filter by call disposition", "type" : "string" }, "end_date" : { "description" : "Filter calls created on or before this date (ISO 8601)", "type" : "string" }, "has_ai_engagement" : { "description" : "Filter to calls with AI agent engagement", "type" : "boolean" }, "has_recording" : { "description" : "Filter to calls that have a recording", "type" : "boolean" }, "has_transcript" : { "description" : "Filter to calls that have a transcript", "type" : "boolean" }, "max_duration_seconds" : { "description" : "Filter by maximum call duration in seconds", "format" : "int32", "type" : "integer" }, "min_duration_seconds" : { "description" : "Filter by minimum call duration in seconds", "format" : "int32", "type" : "integer" }, "phone_number" : { "description" : "Filter by phone number (partial match supported)", "type" : "string" }, "queue_uuids" : { "description" : "Filter by queue UUIDs", "items" : { "type" : "string" }, "type" : "array" }, "search_term" : { "description" : "Free text search term - smart-routed based on content (phone, email, UUID, or general text)", "type" : "string" }, "start_date" : { "description" : "Filter calls created on or after this date (ISO 8601)", "type" : "string" }, "statuses" : { "description" : "Filter by call statuses", "items" : { "type" : "string" }, "type" : "array" }, "transcript_search" : { "description" : "Search within transcript text", "type" : "string" } }, "type" : "object" }, "ConversationPbxCallSearchResponse" : { "properties" : { "calls" : { "description" : "calls", "items" : { "$ref" : "#/components/schemas/ConversationPbxCall" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxCallTimeline" : { "properties" : { "answer_dts" : { "description" : "Timestamp when the call was answered", "format" : "dateTime", "type" : "string" }, "created_dts" : { "description" : "Timestamp when the call was created/initiated", "format" : "dateTime", "type" : "string" }, "end_dts" : { "description" : "Timestamp when the call ended", "format" : "dateTime", "type" : "string" }, "queue_wait_seconds" : { "description" : "Time spent waiting in queue in seconds", "format" : "int32", "type" : "integer" }, "talk_time_seconds" : { "description" : "Actual talk time in seconds (excluding hold time and queue wait)", "format" : "int32", "type" : "integer" }, "total_duration_seconds" : { "description" : "Total duration of the call in seconds from creation to end", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ConversationPbxCallTranscript" : { "properties" : { "full_transcript_s3_key" : { "description" : "S3 key for the full transcript text file", "type" : "string" }, "job_name" : { "description" : "AWS Transcribe job name", "type" : "string" }, "language_code" : { "description" : "Language code for transcription", "type" : "string" }, "provider" : { "description" : "Transcription service provider", "type" : "string" }, "segments" : { "description" : "Transcript segments with speaker labels and timestamps", "items" : { "$ref" : "#/components/schemas/ConversationPbxCallTranscriptSegment" }, "type" : "array" }, "status" : { "description" : "Status of the transcription", "type" : "string" }, "transcript_json_s3_key" : { "description" : "S3 key for the detailed transcript JSON with speaker diarization", "type" : "string" } }, "type" : "object" }, "ConversationPbxCallTranscriptSegment" : { "properties" : { "agent_id" : { "description" : "Agent ID if speaker is an agent", "type" : "string" }, "channel" : { "description" : "Audio channel identifier (e.g. ch_0, ch_1)", "type" : "string" }, "confidence" : { "description" : "Transcription confidence score (0-1)", "type" : "number" }, "end_time" : { "description" : "End time in seconds from beginning of recording", "type" : "number" }, "speaker" : { "description" : "Speaker role", "enum" : [ "customer", "agent" ], "type" : "string" }, "start_time" : { "description" : "Start time in seconds from beginning of recording", "type" : "number" }, "text" : { "description" : "Transcribed text for this segment", "type" : "string" } }, "type" : "object" }, "ConversationPbxCallTransfer" : { "properties" : { "transfer_reason" : { "description" : "Reason provided for the transfer", "type" : "string" }, "transfer_type" : { "description" : "Type of transfer performed", "type" : "string" }, "transferred_at_dts" : { "description" : "Timestamp when the transfer occurred", "format" : "dateTime", "type" : "string" }, "transferred_by_agent_id" : { "description" : "ID of the agent who initiated the transfer", "type" : "string" }, "transferred_to" : { "description" : "Destination of the transfer (agent ID, queue name, or phone number)", "type" : "string" } }, "type" : "object" }, "ConversationPbxClassOfService" : { "properties" : { "allowed_countries" : { "description" : "E.164 country calling codes (e.g. 1 for US/Canada, 44 for UK). Empty means domestic only.", "items" : { "type" : "string" }, "type" : "array" }, "block_premium_numbers" : { "description" : "Block calls to 900, 976, premium-rate, and shortcode destinations", "type" : "boolean" }, "context_merchant_id" : { "description" : "Optional child merchant ID this resource is assigned to. Null = shared across the linked merchant group.", "maxLength" : 20, "type" : "string" }, "conversation_pbx_class_of_service_uuid" : { "description" : "Class of Service unique identifier", "type" : "string" }, "default_flag" : { "description" : "If true, this CoS applies to all agents without an explicit cos_uuid. Only one per merchant.", "type" : "boolean" }, "description" : { "description" : "Description of the class of service", "maxLength" : 500, "type" : "string" }, "merchant_id" : { "description" : "Merchant Id", "maxLength" : 5, "type" : "string" }, "name" : { "description" : "Display name for the class of service", "maxLength" : 100, "type" : "string" }, "outbound_enabled" : { "description" : "Whether agents with this CoS can make outbound calls", "type" : "boolean" }, "time_range_uuid" : { "description" : "UUID of a time range. If set, outbound calls only permitted during those time windows.", "type" : "string" } }, "type" : "object" }, "ConversationPbxClassOfServiceResponse" : { "properties" : { "class_of_service" : { "$ref" : "#/components/schemas/ConversationPbxClassOfService" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxClassOfServicesResponse" : { "properties" : { "classes_of_services" : { "description" : "Array of class of service records", "items" : { "$ref" : "#/components/schemas/ConversationPbxClassOfService" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxCosAuditLog" : { "properties" : { "action" : { "description" : "Action taken", "enum" : [ "blocked", "override_requested", "override_approved", "override_denied", "override_timeout" ], "type" : "string" }, "agent_login" : { "description" : "Login of the agent who attempted the call", "type" : "string" }, "audit_log_uuid" : { "description" : "Audit log entry unique identifier", "type" : "string" }, "class_of_service_name" : { "description" : "Name of the class of service (denormalized for display)", "type" : "string" }, "class_of_service_uuid" : { "description" : "UUID of the class of service that was evaluated", "type" : "string" }, "destination" : { "description" : "Phone number the agent tried to dial", "type" : "string" }, "merchant_id" : { "description" : "Merchant Id", "maxLength" : 5, "type" : "string" }, "rule_triggered" : { "description" : "Rule that triggered the action", "enum" : [ "outbound_disabled", "time_range", "country_blocked", "premium_blocked" ], "type" : "string" }, "supervisor_login" : { "description" : "Login of supervisor who approved/denied (null for timeouts and direct blocks)", "type" : "string" }, "timestamp" : { "description" : "ISO 8601 timestamp of the event", "type" : "string" } }, "type" : "object" }, "ConversationPbxCosAuditLogsResponse" : { "properties" : { "audit_logs" : { "description" : "Array of audit log entries", "items" : { "$ref" : "#/components/schemas/ConversationPbxCosAuditLog" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxCustomerSnapshotRequest" : { "properties" : { "auto_order_expand" : { "type" : "string" }, "customer_expand" : { "type" : "string" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "order_expand" : { "type" : "string" }, "phone_number" : { "type" : "string" }, "search_linked_accounts" : { "type" : "boolean" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxCustomerSnapshotResponse" : { "properties" : { "auto_orders" : { "items" : { "$ref" : "#/components/schemas/AutoOrder" }, "type" : "array" }, "customers" : { "items" : { "$ref" : "#/components/schemas/Customer" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "orders" : { "items" : { "$ref" : "#/components/schemas/Order" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxDefaultTimezoneResponse" : { "properties" : { "default_timezone" : { "description" : "Merchant default timezone (IANA name). Falls back to America/New_York when unset.", "maxLength" : 60, "type" : "string" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxDefaultTimezoneUpdateRequest" : { "properties" : { "default_timezone" : { "description" : "Merchant default timezone (IANA name, e.g. 'America/New_York')", "maxLength" : 60, "type" : "string" } }, "type" : "object" }, "ConversationPbxHardwarePhone" : { "properties" : { "admin_username" : { "description" : "Admin Username", "type" : "string" }, "conversation_pbx_agent_uuid" : { "description" : "Associated Agent UUID", "type" : "string" }, "conversation_pbx_hardware_phone_uuid" : { "description" : "Conversation Pbx Hardware Phone UUID", "maxLength" : 50, "type" : "string" }, "created_at" : { "description" : "Created At", "type" : "object" }, "description" : { "description" : "Description", "maxLength" : 500, "type" : "string" }, "mac_address" : { "description" : "MAC Address", "maxLength" : 17, "type" : "string" }, "manufacturer" : { "description" : "Manufacturer", "maxLength" : 100, "type" : "string" }, "merchant_id" : { "description" : "Merchant Id", "maxLength" : 5, "type" : "string" }, "model" : { "description" : "Model", "maxLength" : 100, "type" : "string" }, "name" : { "description" : "Name", "maxLength" : 100, "type" : "string" }, "provisioning_url" : { "description" : "Auto-provisioning URL for phone configuration", "type" : "string" }, "sip_domain" : { "description" : "SIP Domain", "maxLength" : 200, "type" : "string" }, "sip_edge_location" : { "description" : "SIP Edge Location", "maxLength" : 50, "type" : "string" }, "sip_password" : { "description" : "SIP Password (only on create or regenerate password requests)", "maxLength" : 100, "type" : "string" }, "sip_username" : { "description" : "SIP Username", "maxLength" : 100, "type" : "string" }, "twilio_credential_sid" : { "description" : "Twilio Credential SID", "type" : "string" }, "updated_at" : { "description" : "Updated At", "type" : "object" } }, "type" : "object" }, "ConversationPbxHardwarePhoneResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "hardware_phone" : { "$ref" : "#/components/schemas/ConversationPbxHardwarePhone" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxHardwarePhonesResponse" : { "properties" : { "hardware_phones" : { "items" : { "$ref" : "#/components/schemas/ConversationPbxHardwarePhone" }, "type" : "array" } }, "type" : "object" }, "ConversationPbxMenu" : { "properties" : { "allow_direct_extensions" : { "description" : "If true, the customer is allowed to input direct extensions within this menu", "type" : "boolean" }, "context_merchant_id" : { "description" : "Optional child merchant ID this resource is assigned to. Null = shared across the linked merchant group.", "maxLength" : 20, "type" : "string" }, "conversation_pbx_menu_uuid" : { "description" : "Conversation Pbx Menu UUID", "maxLength" : 50, "type" : "string" }, "default_action" : { "description" : "The default action for this menu", "maxLength" : 30, "type" : "string" }, "default_action_target" : { "description" : "The default action target for this menu", "maxLength" : 50, "type" : "string" }, "mappings" : { "description" : "Action mappings for this menu", "items" : { "$ref" : "#/components/schemas/ConversationPbxMenuMapping" }, "type" : "array" }, "merchant_id" : { "description" : "Merchant Id", "maxLength" : 5, "type" : "string" }, "name" : { "description" : "Menu name", "maxLength" : 50, "type" : "string" }, "play_audio_uuid" : { "description" : "An optional audio clip that plays when a customer enters this menu", "maxLength" : 50, "type" : "string" }, "say" : { "description" : "An optional saying that plays when a customer enters this menu", "type" : "string" }, "say_voice" : { "description" : "say voice", "enum" : [ "man", "woman" ], "maxLength" : 50, "type" : "string" }, "timeout" : { "description" : "The idle seconds before this menu times out", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ConversationPbxMenuMapping" : { "properties" : { "action" : { "description" : "Action", "enum" : [ "time based", "menu", "queue", "voicemail", "agent" ], "maxLength" : 30, "type" : "string" }, "action_target" : { "description" : "Action target. This is the UUID associated with the configuration object of that particular type.", "maxLength" : 50, "type" : "string" }, "digits" : { "description" : "Digits", "format" : "int32", "type" : "integer" }, "speech" : { "description" : "Speech", "type" : "string" } }, "type" : "object" }, "ConversationPbxMenuResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "menu" : { "$ref" : "#/components/schemas/ConversationPbxMenu" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxMenusResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "menus" : { "items" : { "$ref" : "#/components/schemas/ConversationPbxMenu" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxPhoneManufacturer" : { "properties" : { "manufacturer_id" : { "type" : "string" }, "models" : { "items" : { "$ref" : "#/components/schemas/ConversationPbxPhoneModel" }, "type" : "array" }, "name" : { "type" : "string" } }, "type" : "object" }, "ConversationPbxPhoneManufacturersResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "manufacturers" : { "items" : { "$ref" : "#/components/schemas/ConversationPbxPhoneManufacturer" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxPhoneModel" : { "properties" : { "model_id" : { "type" : "string" }, "name" : { "type" : "string" } }, "type" : "object" }, "ConversationPbxPhoneNumber" : { "properties" : { "action" : { "description" : "Action", "enum" : [ "time based", "menu", "queue", "voicemail", "agent" ], "maxLength" : 30, "type" : "string" }, "action_target" : { "description" : "Action target. This is the UUID associated with the configuration object of that particular type.", "maxLength" : 50, "type" : "string" }, "address_sid" : { "description" : "Twilio Address SID linked to this phone number for regulatory compliance", "maxLength" : 50, "type" : "string" }, "context_merchant_id" : { "description" : "Optional child merchant ID this resource is assigned to. Null = shared across the linked merchant group.", "maxLength" : 20, "type" : "string" }, "conversation_pbx_phone_number_uuid" : { "description" : "Conversation Pbx Phone Number UUID", "maxLength" : 50, "type" : "string" }, "default_phone_number" : { "description" : "Default phone number for outbound calling.", "type" : "boolean" }, "deletion_protected" : { "description" : "If true, this phone number cannot be deleted through the API. It must be deleted via the Twilio console.", "type" : "boolean" }, "merchant_id" : { "description" : "Merchant Id", "maxLength" : 5, "type" : "string" }, "phone_number" : { "description" : "Phone number", "maxLength" : 50, "type" : "string" } }, "type" : "object" }, "ConversationPbxPhoneNumberPurchaseRequest" : { "properties" : { "action" : { "description" : "Initial action for incoming calls", "enum" : [ "time based", "menu", "queue", "voicemail", "agent" ], "maxLength" : 30, "type" : "string" }, "action_target" : { "description" : "Initial action target UUID", "maxLength" : 50, "type" : "string" }, "address_sid" : { "description" : "Address SID if required for regulatory compliance", "maxLength" : 50, "type" : "string" }, "friendly_name" : { "description" : "Friendly name for the phone number", "maxLength" : 64, "type" : "string" }, "phone_number" : { "description" : "Phone number to purchase in E.164 format (from search results)", "maxLength" : 50, "type" : "string" } }, "type" : "object" }, "ConversationPbxPhoneNumberResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "phone_number" : { "$ref" : "#/components/schemas/ConversationPbxPhoneNumber" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxPhoneNumbersResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "phone_numbers" : { "items" : { "$ref" : "#/components/schemas/ConversationPbxPhoneNumber" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxQueue" : { "properties" : { "ai_priority" : { "description" : "AI Agent Priority compared to human agents", "enum" : [ "neutral", "first", "backup" ], "type" : "string" }, "ai_summary_enabled" : { "description" : "If true, AI summaries are generated for answered calls in this queue", "type" : "boolean" }, "ai_summary_instructions" : { "description" : "Custom instructions injected into the AI summary system prompt for this queue", "maxLength" : 100000, "type" : "string" }, "ai_timeout_seconds" : { "description" : "AI timeout seconds", "format" : "int32", "type" : "integer" }, "announce_queue_position" : { "description" : "If true, the customer is told their queue position upon entering the queue", "type" : "boolean" }, "automatic_coach_agent_uuid" : { "description" : "AI Agent UUID to automatically engage to provide coaching", "type" : "string" }, "callback_announce_audio_uuid" : { "description" : "Custom audio file UUID for the callback offer prompt", "maxLength" : 50, "type" : "string" }, "callback_announce_say" : { "description" : "Custom TTS text for the callback offer prompt", "type" : "string" }, "callback_confirm_audio_uuid" : { "description" : "Custom audio file UUID for the callback confirmation message", "maxLength" : 50, "type" : "string" }, "callback_confirm_say" : { "description" : "Custom TTS text for the callback confirmation message", "type" : "string" }, "callback_enabled" : { "description" : "If true, the callback option is enabled for this queue", "type" : "boolean" }, "callback_hours_only" : { "description" : "When true, only offer callbacks during business hours", "type" : "boolean" }, "callback_max_attempts" : { "description" : "Maximum number of times the system will attempt to call the customer back", "format" : "int32", "type" : "integer" }, "callback_max_offers" : { "description" : "Maximum number of times the callback option is offered to a caller per call", "format" : "int32", "type" : "integer" }, "callback_max_pending" : { "description" : "Maximum number of pending callbacks allowed per queue", "format" : "int32", "type" : "integer" }, "callback_offer_after_seconds" : { "description" : "Seconds a caller must wait in queue before the callback option is offered", "format" : "int32", "type" : "integer" }, "callback_offer_interval_seconds" : { "description" : "Seconds between repeat callback offers to the same caller", "format" : "int32", "type" : "integer" }, "callback_retry_delay_seconds" : { "description" : "Delay in seconds between callback retry attempts", "format" : "int32", "type" : "integer" }, "context_merchant_id" : { "description" : "Optional child merchant ID this resource is assigned to. Null = shared across the linked merchant group.", "maxLength" : 20, "type" : "string" }, "conversation_pbx_queue_uuid" : { "description" : "Conversation Pbx Queue unique identifier", "type" : "string" }, "conversation_voicemail_mailbox_uuid" : { "description" : "The voicemail mailbox associated with this queue", "maxLength" : 50, "type" : "string" }, "hold_conversation_pbx_audio_uuid" : { "description" : "The audio to play while holding in a queue", "maxLength" : 50, "type" : "string" }, "max_hold_seconds" : { "description" : "The maximum number of seconds for a customer to hold in a queue", "format" : "int32", "type" : "integer" }, "members" : { "$ref" : "#/components/schemas/ConversationPbxQueueMembers" }, "merchant_id" : { "description" : "Merchant Id", "maxLength" : 5, "type" : "string" }, "name" : { "description" : "Name of queue", "maxLength" : 50, "type" : "string" }, "no_agent_available_play_audio_uuid" : { "description" : "When no agent is available after the max_hold_seconds, say this", "maxLength" : 50, "type" : "string" }, "no_agent_available_say" : { "description" : "When no agent is available after the max_hold_seconds, say this", "type" : "string" }, "no_agent_available_say_voice" : { "description" : "The type of voice used to say text when no agent is available", "enum" : [ "man", "woman" ], "maxLength" : 50, "type" : "string" }, "play_audio_uuid" : { "description" : "Audio played when customer enters a queue", "maxLength" : 50, "type" : "string" }, "record_call" : { "description" : "If true, any calls in this queue are recorded", "type" : "boolean" }, "say" : { "description" : "Say text when a customer enters queue", "type" : "string" }, "say_voice" : { "description" : "The type of voice to use when say text is spoken", "enum" : [ "man", "woman" ], "maxLength" : 50, "type" : "string" }, "twilio_taskrouter_workflow_sid" : { "description" : "Twilio taskrouter workflow sid", "maxLength" : 100, "type" : "string" }, "twilio_workspace_queue_sid" : { "description" : "Twilio workspace queue sid", "maxLength" : 50, "type" : "string" }, "voicemail" : { "description" : "If true, this queue has a voicemail associated with it", "type" : "boolean" }, "wait_critical_seconds" : { "description" : "Wait time in seconds before critical", "format" : "int32", "type" : "integer" }, "wait_warning_seconds" : { "description" : "Wait time in seconds before warning", "format" : "int32", "type" : "integer" }, "wrap_up_seconds" : { "description" : "Wrap up time in seconds", "format" : "int32", "type" : "integer" }, "zoho_desk_department_id" : { "description" : "Zoho Desk department ID to create tickets in", "maxLength" : 50, "type" : "string" }, "zoho_desk_ticket_enabled" : { "description" : "If true, a Zoho Desk ticket is automatically created for answered calls in this queue", "type" : "boolean" } }, "type" : "object" }, "ConversationPbxQueueMembers" : { "properties" : { "groups" : { "items" : { "type" : "integer" }, "type" : "array" }, "users" : { "items" : { "type" : "integer" }, "type" : "array" } }, "type" : "object" }, "ConversationPbxQueueResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "queue" : { "$ref" : "#/components/schemas/ConversationPbxQueue" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxQueuesResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "queues" : { "items" : { "$ref" : "#/components/schemas/ConversationPbxQueue" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxTimeBased" : { "properties" : { "context_merchant_id" : { "type" : "string" }, "conversation_pbx_time_based_uuid" : { "type" : "string" }, "mapping_config" : { "$ref" : "#/components/schemas/ConversationPbxTimeBasedMappingConfig" }, "merchant_id" : { "type" : "string" }, "time_based_name" : { "type" : "string" } }, "type" : "object" }, "ConversationPbxTimeBasedMapping" : { "properties" : { "action" : { "description" : "Action", "enum" : [ "time based", "menu", "queue", "voicemail", "agent" ], "maxLength" : 30, "type" : "string" }, "action_target" : { "description" : "Action target. This is the UUID associated with the configuration object of that particular type.", "maxLength" : 50, "type" : "string" }, "name" : { "description" : "Name", "maxLength" : 50, "type" : "string" }, "time_range_uuid" : { "description" : "Time range UUID", "maxLength" : 50, "type" : "string" } }, "type" : "object" }, "ConversationPbxTimeBasedMappingConfig" : { "properties" : { "default_mapping" : { "$ref" : "#/components/schemas/ConversationPbxTimeBasedMapping" }, "mappings" : { "description" : "Mappings", "items" : { "$ref" : "#/components/schemas/ConversationPbxTimeBasedMapping" }, "type" : "array" } }, "type" : "object" }, "ConversationPbxTimeBasedResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "time_based" : { "$ref" : "#/components/schemas/ConversationPbxTimeBased" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxTimeBasedsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "time_baseds" : { "items" : { "$ref" : "#/components/schemas/ConversationPbxTimeBased" }, "type" : "array" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxTimeRange" : { "properties" : { "configs" : { "description" : "Configurations for all ranges in this time range", "items" : { "$ref" : "#/components/schemas/ConversationPbxTimeRangeConfig" }, "type" : "array" }, "context_merchant_id" : { "description" : "Optional child merchant ID this resource is assigned to. Null = shared across the linked merchant group.", "maxLength" : 20, "type" : "string" }, "conversation_pbx_time_range_uuid" : { "description" : "Conversation Pbx Time Range UUID", "maxLength" : 50, "type" : "string" }, "merchant_id" : { "description" : "Merchant Id", "maxLength" : 5, "type" : "string" }, "time_range_name" : { "description" : "Time range name", "maxLength" : 50, "type" : "string" }, "timezone" : { "description" : "Timezone", "maxLength" : 100, "type" : "string" } }, "type" : "object" }, "ConversationPbxTimeRangeConfig" : { "properties" : { "end_date" : { "description" : "End date", "format" : "dateTime", "type" : "string" }, "end_day_of_week" : { "description" : "End day of week", "format" : "int32", "type" : "integer" }, "end_time" : { "description" : "End time", "type" : "string" }, "start_date" : { "description" : "Start date", "format" : "dateTime", "type" : "string" }, "start_day_of_week" : { "description" : "Start day of week", "format" : "int32", "type" : "integer" }, "start_time" : { "description" : "Start time", "type" : "string" } }, "type" : "object" }, "ConversationPbxTimeRangeResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "time_range" : { "$ref" : "#/components/schemas/ConversationPbxTimeRange" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxTimeRangesResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "time_ranges" : { "items" : { "$ref" : "#/components/schemas/ConversationPbxTimeRange" }, "type" : "array" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxVoicemailCapabilitiesResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" }, "zoho_desk_available" : { "description" : "True if Zoho Desk is connected to UltraCart", "type" : "boolean" }, "zoho_desk_departments" : { "description" : "Array of Zoho Desk Departments if Zoho Desk is connected to UltraCart", "items" : { "$ref" : "#/components/schemas/ConversationVirtualAgentCapabilityZohoDeskDepartment" }, "type" : "array" } }, "type" : "object" }, "ConversationPbxVoicemailMailbox" : { "properties" : { "context_merchant_id" : { "description" : "Optional child merchant ID this resource is assigned to. Null = shared across the linked merchant group.", "maxLength" : 20, "type" : "string" }, "conversation_pbx_voicemail_mailbox_uuid" : { "description" : "Conversation Pbx Voicemail Mailbox UUID", "maxLength" : 50, "type" : "string" }, "merchant_id" : { "description" : "Merchant Id", "maxLength" : 5, "type" : "string" }, "send_notices_to_channel" : { "description" : "Send notices to channel", "enum" : [ "none", "email", "zoho_desk_ticket", "ultracart_task" ], "maxLength" : 50, "type" : "string" }, "send_notices_to_email" : { "description" : "Send notices to email", "maxLength" : 250, "type" : "string" }, "send_notices_to_zoho_desk_department_id" : { "description" : "Send notices to Zoho Desk department id", "maxLength" : 50, "type" : "string" }, "user_id" : { "description" : "User Id", "format" : "int32", "type" : "integer" }, "voicemail_followup_play_audio_uuid" : { "description" : "Voicemail follow play audio UUID", "maxLength" : 50, "type" : "string" }, "voicemail_followup_say" : { "description" : "Voicemail followup say", "type" : "string" }, "voicemail_followup_say_voice" : { "description" : "Voicemail followup say voice", "enum" : [ "man", "woman" ], "maxLength" : 50, "type" : "string" }, "voicemail_mailbox_id" : { "description" : "Voicemail mailbox id", "maxLength" : 50, "type" : "string" }, "voicemail_mailbox_type" : { "description" : "Voicemail mailbox type", "enum" : [ "agent", "shared" ], "maxLength" : 50, "type" : "string" }, "voicemail_prompt_play_audio_uuid" : { "description" : "Voicemail prompt play audio UUID", "maxLength" : 50, "type" : "string" }, "voicemail_prompt_say" : { "description" : "Voicemail prompt say", "type" : "string" }, "voicemail_prompt_say_voice" : { "description" : "Voicemail prompt say voice", "enum" : [ "man", "woman" ], "maxLength" : 50, "type" : "string" } }, "type" : "object" }, "ConversationPbxVoicemailMailboxesResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "voicemail_mailboxes" : { "items" : { "$ref" : "#/components/schemas/ConversationPbxVoicemailMailbox" }, "type" : "array" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxVoicemailMailboxResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "voicemail_mailbox" : { "$ref" : "#/components/schemas/ConversationPbxVoicemailMailbox" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxVoicemailMessage" : { "properties" : { "call_sid" : { "description" : "Call SID", "type" : "string" }, "duration" : { "description" : "Duration in seconds", "format" : "int32", "type" : "integer" }, "from" : { "description" : "From phone number in E.164", "type" : "string" }, "from_caller_id" : { "description" : "From caller id (if available)", "type" : "string" }, "listened" : { "description" : "True if the voicemail has been listened to in the user interface", "type" : "boolean" }, "merchant_id" : { "description" : "Merchant ID", "type" : "string" }, "recording_sid" : { "description" : "Recording SID", "type" : "string" }, "recording_size_bytes" : { "description" : "Recording size in bytes", "format" : "int32", "type" : "integer" }, "recording_status" : { "description" : "Recording Status", "enum" : [ "completed" ], "type" : "string" }, "recording_url" : { "description" : "Recording URL (expires in 4 hours)", "type" : "string" }, "transcript_json" : { "description" : "JSON version of the transcript", "format" : "dateTime", "type" : "string" }, "transcript_text" : { "description" : "Formatted text of the transcript", "type" : "string" }, "voicemail_dts" : { "description" : "Voicemail date/time", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "ConversationPbxVoicemailMessageResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "voicemail_message" : { "$ref" : "#/components/schemas/ConversationPbxVoicemailMessage" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxVoicemailMessageSummariesResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "voicemail_message_summaries" : { "items" : { "$ref" : "#/components/schemas/ConversationPbxVoicemailMessageSummary" }, "type" : "array" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationPbxVoicemailMessageSummary" : { "properties" : { "call_sid" : { "description" : "Call SID", "type" : "string" }, "duration" : { "description" : "Duration in seconds", "format" : "int32", "type" : "integer" }, "from" : { "description" : "From phone number in E.164", "type" : "string" }, "from_caller_id" : { "description" : "From caller id (if available)", "type" : "string" }, "listened" : { "description" : "True if the voicemail has been listened to in the user interface", "type" : "boolean" }, "merchant_id" : { "description" : "Merchant ID", "type" : "string" }, "recording_sid" : { "description" : "Recording SID", "type" : "string" }, "recording_size_bytes" : { "description" : "Recording size in bytes", "format" : "int32", "type" : "integer" }, "recording_status" : { "description" : "Recording Status", "enum" : [ "completed" ], "type" : "string" }, "voicemail_dts" : { "description" : "Voicemail date/time", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "ConversationPermissions" : { "properties" : { "edit_settings" : { "type" : "boolean" } }, "type" : "object" }, "ConversationPermissionsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "permissions" : { "$ref" : "#/components/schemas/ConversationPermissions" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationResponse" : { "properties" : { "conversation" : { "$ref" : "#/components/schemas/Conversation" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationSearchRequest" : { "properties" : { "date_end" : { "description" : "End of the range", "format" : "dateTime", "type" : "string" }, "date_start" : { "description" : "Start of the range", "format" : "dateTime", "type" : "string" }, "email_filter" : { "type" : "string" }, "language_filter" : { "type" : "string" }, "medium_filter" : { "type" : "string" }, "order_by_newest" : { "type" : "boolean" }, "order_by_oldest" : { "type" : "boolean" }, "range_begin" : { "format" : "int32", "type" : "integer" }, "range_end" : { "format" : "int32", "type" : "integer" }, "sms_phone_number_filter" : { "type" : "string" }, "text_search" : { "type" : "string" }, "visible_filter" : { "type" : "boolean" } }, "type" : "object" }, "ConversationSearchResponse" : { "properties" : { "range_begin" : { "format" : "int32", "type" : "integer" }, "range_end" : { "format" : "int32", "type" : "integer" }, "records" : { "items" : { "$ref" : "#/components/schemas/ConversationSummary" }, "type" : "array" }, "total" : { "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ConversationSentiment" : { "properties" : { "last_detect_sentiment" : { "description" : "The last time the detect sentiment was run on this conversation", "format" : "dateTime", "type" : "string" }, "mixed" : { "description" : "The mixed score", "type" : "number" }, "negative" : { "description" : "The negative score", "type" : "number" }, "neutral" : { "description" : "The neutral score", "type" : "number" }, "positive" : { "description" : "The positive score", "type" : "number" }, "sentiment" : { "description" : "The overall sentiment", "enum" : [ "POSITIVE", "NEUTRAL", "NEGATIVE", "MIXED" ], "type" : "string" } }, "type" : "object" }, "ConversationsResponse" : { "properties" : { "conversations" : { "items" : { "$ref" : "#/components/schemas/ConversationSummary" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationStartRequest" : { "properties" : { "add_conversation_participant_arns" : { "items" : { "type" : "string" }, "type" : "array" }, "conversation_arn" : { "type" : "string" }, "conversation_webchat_queue_uuid" : { "type" : "string" } }, "type" : "object" }, "ConversationStartResponse" : { "properties" : { "conversation" : { "$ref" : "#/components/schemas/Conversation" } }, "type" : "object" }, "ConversationSummary" : { "properties" : { "closed" : { "type" : "boolean" }, "conversation_arn" : { "type" : "string" }, "conversation_uuid" : { "type" : "string" }, "customer_first_message_unresponded_to_dts" : { "description" : "Date/time of the first customer message that is unresponded to.", "format" : "dateTime", "type" : "string" }, "last_conversation_message_body" : { "type" : "string" }, "last_conversation_participant_arn" : { "type" : "string" }, "last_conversation_participant_name" : { "type" : "string" }, "last_interactive_message_dts" : { "description" : "Last interactive message date/time", "format" : "dateTime", "type" : "string" }, "last_message_dts" : { "description" : "Last message date/time", "format" : "dateTime", "type" : "string" }, "medium" : { "description" : "The communication medium of the customer.", "enum" : [ "sms", "websocket" ], "type" : "string" }, "merchant_id" : { "type" : "string" }, "message_count" : { "format" : "int32", "type" : "integer" }, "participants" : { "items" : { "$ref" : "#/components/schemas/ConversationParticipant" }, "type" : "array" }, "sentiment" : { "$ref" : "#/components/schemas/ConversationSentiment" }, "start_dts" : { "description" : "Start of the conversation date/time", "format" : "dateTime", "type" : "string" }, "unread_messages" : { "type" : "boolean" }, "visible" : { "type" : "boolean" } }, "type" : "object" }, "ConversationTwilioAccount" : { "properties" : { "merchant_id" : { "type" : "string" }, "twilio_phone_numbers" : { "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "ConversationVirtualAgentBudget" : { "properties" : { "budget_daily" : { "type" : "number" }, "budget_monthly" : { "type" : "number" }, "used_daily" : { "type" : "number" }, "used_monthly" : { "type" : "number" } }, "type" : "object" }, "ConversationVirtualAgentBudgetResponse" : { "properties" : { "budget" : { "$ref" : "#/components/schemas/ConversationVirtualAgentBudget" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationVirtualAgentCapabilities" : { "properties" : { "access_storefront_and_item" : { "description" : "Permission flag to allow this Agent access to the storefront and item information.", "type" : "boolean" }, "cancel_subscription" : { "type" : "boolean" }, "delay_subscription" : { "type" : "boolean" }, "generate_coupon" : { "description" : "Permission flag to allow this Agent to generate coupons based upon the agent prompt instructions", "type" : "boolean" }, "lookup_order_information" : { "type" : "boolean" }, "lookup_subscription_information" : { "type" : "boolean" }, "open_support_ticket" : { "type" : "boolean" }, "open_support_ticket_channel" : { "description" : "Channel to use to open the support ticket", "enum" : [ "none", "email", "ultracart_task", "zoho_desk_ticket" ], "type" : "string" }, "open_support_ticket_channel_email" : { "description" : "Email to send support ticket to", "type" : "string" }, "open_support_ticket_zoho_desk_department_id" : { "description" : "Department ID to open a Zoho Desk ticket for", "type" : "string" }, "pause_subscription" : { "type" : "boolean" }, "resume_subscription" : { "type" : "boolean" }, "transfer_chat_to_live_agent" : { "type" : "boolean" }, "update_subscription_credit_card" : { "type" : "boolean" }, "zoho_desk_available" : { "description" : "True if Zoho Desk is connected to UltraCart", "type" : "boolean" }, "zoho_desk_departments" : { "description" : "Array of Zoho Desk Department if zoho desk is connected to UltraCart", "items" : { "$ref" : "#/components/schemas/ConversationVirtualAgentCapabilityZohoDeskDepartment" }, "type" : "array" } }, "type" : "object" }, "ConversationVirtualAgentCapabilitiesResponse" : { "properties" : { "capabilities" : { "$ref" : "#/components/schemas/ConversationVirtualAgentCapabilities" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationVirtualAgentCapabilityZohoDeskDepartment" : { "properties" : { "department_id" : { "type" : "string" }, "department_name" : { "type" : "string" } }, "type" : "object" }, "ConversationWebchatContext" : { "properties" : { "auto_orders" : { "items" : { "$ref" : "#/components/schemas/AutoOrder" }, "type" : "array" }, "cart" : { "$ref" : "#/components/schemas/Cart" }, "current_url" : { "type" : "string" }, "orders" : { "items" : { "$ref" : "#/components/schemas/Order" }, "type" : "array" }, "page_view" : { "items" : { "$ref" : "#/components/schemas/HitPageView" }, "type" : "array" }, "session_start" : { "$ref" : "#/components/schemas/HitSessionStart" }, "session_start_dts" : { "description" : "Date/time that the session was started (if known)", "format" : "dateTime", "type" : "string" }, "session_utm" : { "$ref" : "#/components/schemas/HitSessionUtm" } }, "type" : "object" }, "ConversationWebchatQueueStatus" : { "properties" : { "agent_available_count" : { "format" : "int32", "type" : "integer" }, "agent_busy_count" : { "format" : "int32", "type" : "integer" }, "agent_count" : { "format" : "int32", "type" : "integer" }, "agent_unavailable_count" : { "format" : "int32", "type" : "integer" }, "agents" : { "items" : { "$ref" : "#/components/schemas/ConversationWebchatQueueStatusAgent" }, "type" : "array" }, "customer_abandon_count" : { "format" : "int32", "type" : "integer" }, "customer_active_count" : { "format" : "int32", "type" : "integer" }, "customer_average_abandon_time_seconds" : { "format" : "int32", "type" : "integer" }, "customer_average_chat_time_seconds" : { "format" : "int32", "type" : "integer" }, "customer_average_hold_time_seconds" : { "format" : "int32", "type" : "integer" }, "customer_chat_count" : { "format" : "int32", "type" : "integer" }, "customer_waiting_count" : { "format" : "int32", "type" : "integer" }, "customer_waiting_join_dts" : { "description" : "Date/time that the oldest person joined the queue", "format" : "dateTime", "type" : "string" }, "queue_entries" : { "items" : { "$ref" : "#/components/schemas/ConversationWebchatQueueStatusQueueEntry" }, "type" : "array" }, "queue_name" : { "type" : "string" } }, "type" : "object" }, "ConversationWebchatQueueStatusAgent" : { "properties" : { "agent_status" : { "description" : "Status of the agent", "enum" : [ "available", "busy", "unavailable" ], "type" : "string" }, "agent_user_id" : { "description" : "Agent user id (populated by Java so the dispatch-scheduler Lambda can read it directly without parsing conversation_participant_arn)", "type" : "string" }, "conversation_participant_arn" : { "type" : "string" }, "conversation_participant_name" : { "type" : "string" }, "custom_status_name" : { "description" : "Active custom status display name for this agent (denormalized)", "type" : "string" }, "custom_status_uuid" : { "description" : "Active custom status uuid for this agent (null when on a system status)", "type" : "string" }, "last_chat_dts" : { "description" : "Date/time that this agent took their last chat", "format" : "dateTime", "type" : "string" }, "next_round_robin" : { "type" : "boolean" }, "profile_image_url" : { "description" : "Profile image URL", "type" : "string" } }, "type" : "object" }, "ConversationWebchatQueueStatusesResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "queue_statuses" : { "items" : { "$ref" : "#/components/schemas/ConversationWebchatQueueStatus" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ConversationWebchatQueueStatusQueueEntry" : { "properties" : { "conversation_participant_arn" : { "type" : "string" }, "conversation_participant_name" : { "type" : "string" }, "conversation_webchat_queue_uuid" : { "type" : "string" }, "email" : { "type" : "string" }, "join_dts" : { "description" : "Date/time the customer joined the queue", "format" : "dateTime", "type" : "string" }, "participant_language_iso_code" : { "type" : "string" }, "question" : { "type" : "string" }, "queue_name" : { "type" : "string" } }, "type" : "object" }, "ConversationWebchatQueueStatusUpdateRequest" : { "properties" : { "agent_status" : { "description" : "Status of the agent", "enum" : [ "available", "busy", "unavailable" ], "type" : "string" }, "custom_status_name" : { "description" : "Custom status display name (denormalized so the queue panel can render without a config lookup)", "type" : "string" }, "custom_status_uuid" : { "description" : "Custom status uuid (when picking a custom status). Pair with custom_status_name.", "type" : "string" } }, "type" : "object" }, "ConversationWebsocketMessage" : { "properties" : { "conversation_arn" : { "description" : "Conversation ARN", "type" : "string" }, "conversation_uuid" : { "description" : "Conversation UUID if the websocket message is tied to a specific conversation", "type" : "string" }, "event_add_coupon" : { "$ref" : "#/components/schemas/ConversationEventAddCoupon" }, "event_add_item" : { "$ref" : "#/components/schemas/ConversationEventAddItem" }, "event_conversation_closed" : { "$ref" : "#/components/schemas/ConversationSummary" }, "event_engage_customer" : { "$ref" : "#/components/schemas/ConversationWebchatQueueStatusQueueEntry" }, "event_new_conversation" : { "$ref" : "#/components/schemas/ConversationSummary" }, "event_new_message" : { "$ref" : "#/components/schemas/ConversationSummary" }, "event_participant_join" : { "$ref" : "#/components/schemas/ConversationSummary" }, "event_participant_join_participant" : { "$ref" : "#/components/schemas/ConversationParticipant" }, "event_participant_left" : { "$ref" : "#/components/schemas/ConversationSummary" }, "event_participant_left_participant" : { "$ref" : "#/components/schemas/ConversationParticipant" }, "event_participant_update" : { "$ref" : "#/components/schemas/ConversationSummary" }, "event_queue_new_member" : { "$ref" : "#/components/schemas/ConversationWebchatQueueStatusQueueEntry" }, "event_queue_position" : { "$ref" : "#/components/schemas/ConversationEventQueuePosition" }, "event_queue_status_update" : { "$ref" : "#/components/schemas/ConversationWebchatQueueStatus" }, "event_read_message" : { "$ref" : "#/components/schemas/ConversationEventReadMessage" }, "event_rrweb" : { "$ref" : "#/components/schemas/ConversationEventRRWeb" }, "event_type" : { "description" : "Type of event", "enum" : [ "queue position", "webchat start conversation", "conversation closed", "new conversation", "new message", "updated message", "queue status update", "rrweb", "participant update", "participant join", "participant left", "read message", "typing", "add coupon", "add item", "webchat context", "engage customer", "queue new member" ], "type" : "string" }, "event_typing" : { "$ref" : "#/components/schemas/ConversationEventTyping" }, "event_updated_message" : { "$ref" : "#/components/schemas/ConversationMessage" }, "event_webchat_context" : { "$ref" : "#/components/schemas/ConversationEventWebchatContext" }, "message" : { "$ref" : "#/components/schemas/ConversationMessage" }, "type" : { "description" : "Type of message", "enum" : [ "message", "event", "ping", "check queue position" ], "type" : "string" } }, "type" : "object" }, "CountriesResponse" : { "properties" : { "countries" : { "items" : { "$ref" : "#/components/schemas/Country" }, "type" : "array" } }, "type" : "object" }, "Country" : { "properties" : { "iso_2_code" : { "description" : "iso_2_code", "maxLength" : 2, "type" : "string" }, "name" : { "description" : "name", "maxLength" : 50, "type" : "string" } }, "type" : "object" }, "Coupon" : { "properties" : { "affiliate_oid" : { "description" : "Associates an order with an affiliate when this value is set.", "format" : "int32", "type" : "integer" }, "allow_multiple_one_time_codes" : { "description" : "True if multiple one time codes for this coupon can be used on a cart at the same time.", "type" : "boolean" }, "amount_off_items" : { "$ref" : "#/components/schemas/CouponAmountOffItems" }, "amount_off_shipping" : { "$ref" : "#/components/schemas/CouponAmountOffShipping" }, "amount_off_shipping_with_items_purchase" : { "$ref" : "#/components/schemas/CouponAmountOffShippingWithItemsPurchase" }, "amount_off_subtotal" : { "$ref" : "#/components/schemas/CouponAmountOffSubtotal" }, "amount_off_subtotal_and_free_shipping" : { "$ref" : "#/components/schemas/CouponAmountOffSubtotalFreeShippingWithPurchase" }, "amount_off_subtotal_and_shipping" : { "$ref" : "#/components/schemas/CouponAmountOffSubtotalAndShipping" }, "amount_off_subtotal_with_block_purchase" : { "$ref" : "#/components/schemas/CouponAmountOffSubtotalWithBlockPurchase" }, "amount_off_subtotal_with_items_purchase" : { "$ref" : "#/components/schemas/CouponAmountOffSubtotalWithItemsPurchase" }, "amount_off_subtotal_with_purchase" : { "$ref" : "#/components/schemas/CouponAmountOffSubtotalWithPurchase" }, "amount_shipping_with_subtotal" : { "$ref" : "#/components/schemas/CouponAmountShippingWithSubtotal" }, "automatically_apply_coupon_codes" : { "$ref" : "#/components/schemas/CouponAutomaticallyApplyCouponCodes" }, "buy_one_get_one" : { "$ref" : "#/components/schemas/CouponBuyOneGetOneLimit" }, "calculated_description" : { "description" : "Calculated description displayed to the customer if no description is specified.", "type" : "string" }, "can_be_used_with_other_coupons" : { "description" : "True if this coupon can be used with other coupons in a single order.", "type" : "boolean" }, "coupon_oid" : { "description" : "Coupon oid.", "format" : "int32", "type" : "integer" }, "coupon_type" : { "description" : "Coupon type.", "maxLength" : 65, "type" : "string" }, "description" : { "description" : "Description of the coupon up to 50 characters.", "maxLength" : 50, "type" : "string" }, "discount_item_with_item_purchase" : { "$ref" : "#/components/schemas/CouponDiscountItemWithItemPurchase" }, "discount_items" : { "$ref" : "#/components/schemas/CouponDiscountItems" }, "expiration_dts" : { "description" : "Date/time when coupon expires", "format" : "dateTime", "type" : "string" }, "free_item_and_shipping_with_subtotal" : { "$ref" : "#/components/schemas/CouponFreeItemAndShippingWithSubtotal" }, "free_item_with_item_purchase" : { "$ref" : "#/components/schemas/CouponFreeItemWithItemPurchase" }, "free_item_with_item_purchase_and_free_shipping" : { "$ref" : "#/components/schemas/CouponFreeItemWithItemPurchaseAndFreeShipping" }, "free_item_with_subtotal" : { "$ref" : "#/components/schemas/CouponFreeItemWithSubtotal" }, "free_items_with_item_purchase" : { "$ref" : "#/components/schemas/CouponFreeItemsWithItemPurchase" }, "free_items_with_mixmatch_purchase" : { "$ref" : "#/components/schemas/CouponFreeItemsWithMixMatchPurchase" }, "free_shipping" : { "$ref" : "#/components/schemas/CouponFreeShipping" }, "free_shipping_specific_items" : { "$ref" : "#/components/schemas/CouponFreeShippingSpecificItems" }, "free_shipping_with_items_purchase" : { "$ref" : "#/components/schemas/CouponFreeShippingWithItemsPurchase" }, "free_shipping_with_subtotal" : { "$ref" : "#/components/schemas/CouponFreeShippingWithSubtotal" }, "hide_from_customer" : { "description" : "Hide coupon from customer during checkout. Often used when coupons are automatic discounting mechanisms.", "type" : "boolean" }, "merchant_code" : { "description" : "Merchant code of coupon up to 20 characters.", "maxLength" : 20, "type" : "string" }, "merchant_notes" : { "description" : "Internal notes about this coupon. These are not visible to customer.", "maxLength" : 250, "type" : "string" }, "more_loyalty_cashback" : { "$ref" : "#/components/schemas/CouponMoreLoyaltyCashback" }, "more_loyalty_points" : { "$ref" : "#/components/schemas/CouponMoreLoyaltyPoints" }, "multiple_amounts_off_items" : { "$ref" : "#/components/schemas/CouponMultipleAmountsOffItems" }, "no_discount" : { "$ref" : "#/components/schemas/CouponNoDiscount" }, "percent_more_loyalty_cashback" : { "$ref" : "#/components/schemas/CouponPercentMoreLoyaltyCashback" }, "percent_more_loyalty_points" : { "$ref" : "#/components/schemas/CouponPercentMoreLoyaltyPoints" }, "percent_off_item_with_items_quantity_purchase" : { "$ref" : "#/components/schemas/CouponPercentOffItemWithItemsQuantityPurchase" }, "percent_off_items" : { "$ref" : "#/components/schemas/CouponPercentOffItems" }, "percent_off_items_and_free_shipping" : { "$ref" : "#/components/schemas/CouponPercentOffItemsAndFreeShipping" }, "percent_off_items_with_items_purchase" : { "$ref" : "#/components/schemas/CouponPercentOffItemsWithItemsPurchase" }, "percent_off_items_with_minimum_item_amount" : { "$ref" : "#/components/schemas/CouponPercentOffItemsWithMinimumItemAmount" }, "percent_off_msrp_items" : { "$ref" : "#/components/schemas/CouponPercentOffMsrpItems" }, "percent_off_retail_price_items" : { "$ref" : "#/components/schemas/CouponPercentOffRetailPriceItems" }, "percent_off_shipping" : { "$ref" : "#/components/schemas/CouponPercentOffShipping" }, "percent_off_subtotal" : { "$ref" : "#/components/schemas/CouponPercentOffSubtotal" }, "percent_off_subtotal_and_free_shipping" : { "$ref" : "#/components/schemas/CouponPercentOffSubtotalAndFreeShipping" }, "percent_off_subtotal_limit" : { "$ref" : "#/components/schemas/CouponPercentOffSubtotalLimit" }, "percent_off_subtotal_with_items_purchase" : { "$ref" : "#/components/schemas/CouponPercentOffSubtotalWithItemsPurchase" }, "percent_off_subtotal_with_subtotal" : { "$ref" : "#/components/schemas/CouponPercentOffSubtotalWithSubtotal" }, "quickbooks_code" : { "description" : "Quickbooks accounting code.", "maxLength" : 20, "type" : "string" }, "restrict_by_postal_codes" : { "description" : "Optional list of postal codes which restrict a coupon to within these postal codes.", "items" : { "type" : "string" }, "type" : "array" }, "restrict_by_screen_branding_theme_codes" : { "description" : "Optional list of legacy screen branding theme codes to limit coupon use to only those themes.", "items" : { "$ref" : "#/components/schemas/CouponRestriction" }, "type" : "array" }, "restrict_by_storefronts" : { "description" : "Optional list of storefronts to limit coupon use to only those storefronts.", "items" : { "$ref" : "#/components/schemas/CouponRestriction" }, "type" : "array" }, "skip_on_rebill" : { "description" : "Skip this coupon when it is on a rebill of an auto order.", "type" : "boolean" }, "start_dts" : { "description" : "Date/time when coupon is valid", "format" : "dateTime", "type" : "string" }, "super_coupon" : { "description" : "If true, this coupon can be used with ANY other coupon regardless of the other coupons configuration", "type" : "boolean" }, "tiered_amount_off_items" : { "$ref" : "#/components/schemas/CouponTieredAmountOffItems" }, "tiered_amount_off_subtotal" : { "$ref" : "#/components/schemas/CouponTieredAmountOffSubtotal" }, "tiered_percent_off_items" : { "$ref" : "#/components/schemas/CouponTieredPercentOffItems" }, "tiered_percent_off_shipping" : { "$ref" : "#/components/schemas/CouponTieredPercentOffShipping" }, "tiered_percent_off_subtotal" : { "$ref" : "#/components/schemas/CouponTieredPercentOffSubtotal" }, "tiered_percent_off_subtotal_based_on_msrp" : { "$ref" : "#/components/schemas/CouponTieredPercentOffSubtotalBasedOnMSRP" }, "usable_by" : { "description" : "Who may use this coupon.", "enum" : [ "Anyone", "UniqueCode", "OncePerCustomer", "OncePerNewCustomer", "OncePerNewCustomerForItem" ], "maxLength" : 50, "type" : "string" } }, "type" : "object" }, "CouponAmountOffItems" : { "properties" : { "currency_code" : { "description" : "The ISO-4217 three letter currency code the customer is viewing prices in", "maxLength" : 3, "type" : "string" }, "discount_amount" : { "description" : "The amount of shipping discount", "type" : "number" }, "item_tags" : { "description" : "An optional list of item tags which will receive a discount.", "items" : { "type" : "string" }, "type" : "array" }, "items" : { "description" : "A list of items which are eligible for the discount amount.", "items" : { "type" : "string" }, "type" : "array" }, "limit" : { "description" : "The limit of items which are eligible for the discount amount.", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "CouponAmountOffShipping" : { "properties" : { "currency_code" : { "description" : "The ISO-4217 three letter currency code the customer is viewing prices in", "maxLength" : 3, "type" : "string" }, "discount_amount" : { "description" : "The amount of subtotal discount", "type" : "number" }, "shipping_methods" : { "description" : "One or more shipping methods that may be used with this coupon", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CouponAmountOffShippingWithItemsPurchase" : { "properties" : { "currency_code" : { "description" : "The ISO-4217 three letter currency code the customer is viewing prices in", "maxLength" : 3, "type" : "string" }, "discount_amount" : { "description" : "The amount of shipping discount", "type" : "number" }, "items" : { "description" : "A list of items of which at least one must be purchased for coupon to be valid.", "items" : { "type" : "string" }, "type" : "array" }, "shipping_methods" : { "description" : "One or more shipping methods that may receive this discount", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CouponAmountOffSubtotal" : { "properties" : { "currency_code" : { "description" : "The ISO-4217 three letter currency code the customer is viewing prices in", "maxLength" : 3, "type" : "string" }, "discount_amount" : { "description" : "The amount of subtotal discount", "type" : "number" } }, "type" : "object" }, "CouponAmountOffSubtotalAndShipping" : { "properties" : { "currency_code" : { "description" : "The ISO-4217 three letter currency code the customer is viewing prices in", "maxLength" : 3, "type" : "string" }, "discount_amount" : { "description" : "The amount of subtotal discount", "type" : "number" } }, "type" : "object" }, "CouponAmountOffSubtotalFreeShippingWithPurchase" : { "properties" : { "currency_code" : { "description" : "The ISO-4217 three letter currency code the customer is viewing prices in", "maxLength" : 3, "type" : "string" }, "discount_amount" : { "description" : "The amount of subtotal discount", "type" : "number" }, "purchase_amount" : { "description" : "The purchase amount to qualify for subtotal discount and free shipping", "type" : "number" }, "shipping_methods" : { "description" : "One or more shipping methods that may be free", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CouponAmountOffSubtotalWithBlockPurchase" : { "properties" : { "currency_code" : { "description" : "The ISO-4217 three letter currency code the customer is viewing prices in", "maxLength" : 3, "type" : "string" }, "discount_amount" : { "description" : "The amount of subtotal discount", "type" : "number" }, "required_purchase_item" : { "description" : "Required item that must be purchased for coupon to be valid", "type" : "string" }, "required_purchase_quantity" : { "description" : "Discount amount is multiplied by the number of blocks. A block is this many quantity of the required item.", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "CouponAmountOffSubtotalWithItemsPurchase" : { "properties" : { "currency_code" : { "description" : "The ISO-4217 three letter currency code the customer is viewing prices in", "maxLength" : 3, "type" : "string" }, "discount_amount" : { "description" : "The amount of shipping discount", "type" : "number" }, "items" : { "description" : "A list of items of which a quantity of one or many must be purchased for coupon to be valid.", "items" : { "type" : "string" }, "type" : "array" }, "required_purchase_quantity" : { "description" : "The quantity of items that must be purchased for the discount to be applied.", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "CouponAmountOffSubtotalWithPurchase" : { "properties" : { "currency_code" : { "description" : "The ISO-4217 three letter currency code the customer is viewing prices in", "maxLength" : 3, "type" : "string" }, "discount_amount" : { "description" : "The amount of subtotal discount", "type" : "number" }, "purchase_amount" : { "description" : "The purchase amount to qualify for subtotal discount and free shipping", "type" : "number" } }, "type" : "object" }, "CouponAmountShippingWithSubtotal" : { "properties" : { "currency_code" : { "description" : "The ISO-4217 three letter currency code the customer is viewing prices in", "maxLength" : 3, "type" : "string" }, "purchase_amount" : { "description" : "The purchase amount to qualify for subtotal discount and free shipping", "type" : "number" }, "shipping_amount" : { "description" : "The amount of the shipping cost (this is not a discount, this is the actual cost of shipping)", "type" : "number" }, "shipping_methods" : { "description" : "One or more shipping methods that may be used with this coupon", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CouponAutoApplyCondition" : { "properties" : { "coupon_code" : { "type" : "string" }, "minimum_subtotal" : { "description" : "The minimum subtotal that must be purchased to receive this coupon. Item and subtotal are exclusive. Only one can be populated.", "type" : "number" }, "required_item_id" : { "description" : "The item that must be purchased to receive this coupon. Item and subtotal are exclusive. Only one can be populated.", "type" : "string" } }, "type" : "object" }, "CouponAutoApplyConditions" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "required_items" : { "items" : { "$ref" : "#/components/schemas/CouponAutoApplyCondition" }, "type" : "array" }, "subtotal_levels" : { "items" : { "$ref" : "#/components/schemas/CouponAutoApplyCondition" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "CouponAutomaticallyApplyCouponCodes" : { "properties" : { "coupon_codes" : { "description" : "The coupon codes to automatically apply if this coupon is applied", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CouponBuyOneGetOneLimit" : { "properties" : { "item_tags" : { "description" : "An optional list of item tags which will receive a discount.", "items" : { "type" : "string" }, "type" : "array" }, "items" : { "description" : "An optional list of items of which one must be purchased to receive free quantity of the same item.", "items" : { "type" : "string" }, "type" : "array" }, "limit" : { "description" : "The limit of free items that may be received when purchasing multiple items", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "CouponCodesRequest" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "expiration_dts" : { "description" : "Expiration Date", "type" : "string" }, "expiration_seconds" : { "description" : "Expiration seconds", "format" : "int32", "type" : "integer" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "prefix" : { "description" : "Optional prefix for generated codes", "maxLength" : 12, "type" : "string" }, "quantity" : { "description" : "Quantity", "format" : "int32", "type" : "integer" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "CouponCodesResponse" : { "properties" : { "coupon_codes" : { "description" : "Coupon codes", "items" : { "type" : "string" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "expiration_dts" : { "description" : "Expiration date", "format" : "dateTime", "type" : "string" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "CouponDeletesRequest" : { "properties" : { "coupon_codes" : { "description" : "Coupon codes", "items" : { "type" : "string" }, "type" : "array" }, "coupon_oids" : { "description" : "Coupon oids", "items" : { "type" : "integer" }, "type" : "array" } }, "type" : "object" }, "CouponDiscountItems" : { "properties" : { "currency_code" : { "description" : "The ISO-4217 three letter currency code the customer is viewing prices in", "maxLength" : 3, "type" : "string" }, "discount_price" : { "description" : "The price (unit cost) of the discounted item", "type" : "number" }, "items" : { "description" : "A list of items that are eligible for this discount_price.", "items" : { "type" : "string" }, "type" : "array" }, "limit" : { "description" : "The (optional) maximum quantity of discounted items.", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "CouponDiscountItemWithItemPurchase" : { "properties" : { "currency_code" : { "description" : "The ISO-4217 three letter currency code the customer is viewing prices in", "maxLength" : 3, "type" : "string" }, "discount_item" : { "description" : "The item that will be sold at the discount_price when required_purchase_item is purchased.", "type" : "string" }, "discount_item_tags" : { "description" : "An optional list of item tags which will receive a discount of one of the required purchased items is purchased.", "items" : { "type" : "string" }, "type" : "array" }, "discount_price" : { "description" : "The price (unit cost) of the discounted item", "type" : "number" }, "limit" : { "description" : "The (optional) maximum quantity of discounted items.", "format" : "int32", "type" : "integer" }, "required_purchase_item" : { "description" : "The item that must be purchased for the discount to be applied to the discount item.", "type" : "string" }, "required_purchase_items_tags" : { "description" : "An optional list of item tags which are required to be purchased.", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CouponEditorValues" : { "properties" : { "affiliates" : { "description" : "affiliates", "items" : { "$ref" : "#/components/schemas/SimpleValue" }, "type" : "array" }, "coupon_types" : { "description" : "coupon_types", "items" : { "type" : "string" }, "type" : "array" }, "coupon_types_for_display" : { "description" : "coupon_types_for_display", "items" : { "$ref" : "#/components/schemas/CouponType" }, "type" : "array" }, "currency_codes" : { "description" : "currency_codes", "items" : { "type" : "string" }, "type" : "array" }, "deprecated_themes" : { "description" : "deprecated_themes", "items" : { "$ref" : "#/components/schemas/SimpleValue" }, "type" : "array" }, "item_tags" : { "description" : "Item tags", "items" : { "type" : "string" }, "type" : "array" }, "mix_and_match_names" : { "description" : "mix_and_match_names", "items" : { "type" : "string" }, "type" : "array" }, "shipping_methods" : { "description" : "shipping_methods", "items" : { "type" : "string" }, "type" : "array" }, "storefronts" : { "description" : "storefronts", "items" : { "$ref" : "#/components/schemas/SimpleValue" }, "type" : "array" }, "usable_by" : { "description" : "usable_by", "items" : { "$ref" : "#/components/schemas/SimpleValue" }, "type" : "array" }, "valid_with_other_coupons" : { "description" : "valid_with_other_coupons", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CouponExistsResponse" : { "properties" : { "coupon_code" : { "description" : "Coupon Code", "type" : "string" }, "error" : { "$ref" : "#/components/schemas/Error" }, "exists" : { "description" : "Exists", "type" : "boolean" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "CouponFreeItemAndShippingWithSubtotal" : { "properties" : { "currency_code" : { "description" : "The ISO-4217 three letter currency code the customer is viewing prices in", "maxLength" : 3, "type" : "string" }, "items" : { "description" : "A list of items that are eligible for this discount_price.", "items" : { "type" : "string" }, "type" : "array" }, "limit" : { "description" : "The limit of free items that may be received when purchasing multiple items", "format" : "int32", "type" : "integer" }, "shipping_methods" : { "description" : "One or more shipping methods that may be free", "items" : { "type" : "string" }, "type" : "array" }, "subtotal_amount" : { "description" : "The amount of subtotal required to receive the discount percent", "type" : "number" } }, "type" : "object" }, "CouponFreeItemsWithItemPurchase" : { "properties" : { "free_item" : { "description" : "The item id of the free item that will be received when the required mix and match group quantity is purchased.", "type" : "string" }, "free_quantity" : { "description" : "The quantity of free item that will be received.", "format" : "int32", "type" : "integer" }, "limit" : { "description" : "The limit of free items that may be received when purchasing multiple items", "format" : "int32", "type" : "integer" }, "required_purchase_item" : { "description" : "Required item that must be purchased for coupon to be valid", "type" : "string" }, "required_purchase_quantity" : { "description" : "Required quantity of mix and match group items that must be purchased for coupon to be valid", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "CouponFreeItemsWithMixMatchPurchase" : { "properties" : { "free_item" : { "description" : "The item id of the free item that will be received when the required mix and match group quantity is purchased.", "type" : "string" }, "free_quantity" : { "description" : "The quantity of free item that will be received.", "format" : "int32", "type" : "integer" }, "limit" : { "description" : "The limit of free items that may be received when purchasing multiple mix and match group items", "format" : "int32", "type" : "integer" }, "required_purchase_mix_and_match_group" : { "description" : "Required mix and match group that must be purchased for coupon to be valid", "type" : "string" }, "required_purchase_quantity" : { "description" : "Required quantity of mix and match group items that must be purchased for coupon to be valid", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "CouponFreeItemWithItemPurchase" : { "properties" : { "item_tags" : { "description" : "An optional list of item tags which will receive a discount of one of the required purchased items is purchased.", "items" : { "type" : "string" }, "type" : "array" }, "items" : { "description" : "A list of free items which will receive a discount if one of the required purchase items is purchased.", "items" : { "type" : "string" }, "type" : "array" }, "limit" : { "description" : "The (optional) maximum quantity of discounted items.", "format" : "int32", "type" : "integer" }, "match_required_purchase_item_to_free_item" : { "description" : "If true then the free item is matched 1:1 with the free item in the list.", "type" : "boolean" }, "required_purchase_items" : { "description" : "Required items (at least one from the list) that must be purchased for coupon to be valid", "items" : { "type" : "string" }, "type" : "array" }, "required_purchase_items_tags" : { "description" : "An optional list of item tags which are required to be purchased.", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CouponFreeItemWithItemPurchaseAndFreeShipping" : { "properties" : { "items" : { "description" : "A list of free items which will receive a discount if one of the required purchase items is purchased.", "items" : { "type" : "string" }, "type" : "array" }, "limit" : { "description" : "The (optional) maximum quantity of discounted items. Free shipping will apply to all units of the free item ids though.", "format" : "int32", "type" : "integer" }, "match_required_purchase_item_to_free_item" : { "description" : "If true then the free item is matched 1:1 with the free item in the list.", "type" : "boolean" }, "required_purchase_items" : { "description" : "Required items (at least one from the list) that must be purchased for coupon to be valid", "items" : { "type" : "string" }, "type" : "array" }, "shipping_methods" : { "description" : "One or more shipping methods that may be used with this coupon. If not specified or empty, methods that are marked as qualifies for free shipping will be the only free methods", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CouponFreeItemWithSubtotal" : { "properties" : { "currency_code" : { "description" : "The ISO-4217 three letter currency code the customer is viewing prices in", "maxLength" : 3, "type" : "string" }, "items" : { "description" : "A list of items that are eligible for this discount_price.", "items" : { "type" : "string" }, "type" : "array" }, "limit" : { "description" : "The limit of free items that may be received when purchasing multiple items", "format" : "int32", "type" : "integer" }, "subtotal_amount" : { "description" : "The amount of subtotal required to receive the discount percent", "type" : "number" } }, "type" : "object" }, "CouponFreeShipping" : { "properties" : { "shipping_methods" : { "description" : "One or more shipping methods that may be used with this coupon", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CouponFreeShippingSpecificItems" : { "properties" : { "items" : { "description" : "A list of items of which at least one must be purchased for coupon to be valid.", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CouponFreeShippingWithItemsPurchase" : { "properties" : { "items" : { "description" : "A list of items of which at least one must be purchased for coupon to be valid.", "items" : { "type" : "string" }, "type" : "array" }, "shipping_methods" : { "description" : "One or more shipping methods that may receive this discount", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CouponFreeShippingWithSubtotal" : { "properties" : { "currency_code" : { "description" : "The ISO-4217 three letter currency code the customer is viewing prices in", "maxLength" : 3, "type" : "string" }, "purchase_amount" : { "description" : "The purchase amount to qualify for subtotal discount and free shipping", "type" : "number" }, "shipping_methods" : { "description" : "One or more shipping methods that may be used with this coupon", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CouponItemSearchResult" : { "properties" : { "cost" : { "description" : "The cost of this item.", "type" : "string" }, "description" : { "description" : "A human readable description of this item.", "type" : "string" }, "manufacturer_name" : { "description" : "The manufacturer of this item.", "type" : "string" }, "manufacturer_sku" : { "description" : "The manufacturer sku of this item.", "type" : "string" }, "merchant_item_id" : { "description" : "The merchant item identifier, which is unique for this merchant, but not across all of UltraCart.", "type" : "string" }, "merchant_item_oid" : { "description" : "The unique internal identifier used by UltraCart to manage this item.", "format" : "int32", "type" : "integer" }, "score" : { "description" : "The search score of this item. Larger scores mean more accurate matches against the search term.", "type" : "string" }, "thumbnail_url" : { "description" : "A url for displaying a thumbnail of this item", "type" : "string" } }, "type" : "object" }, "CouponItemSearchResultsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "search_results" : { "description" : "search_results", "items" : { "$ref" : "#/components/schemas/CouponItemSearchResult" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "CouponMoreLoyaltyCashback" : { "properties" : { "loyalty_cashback" : { "description" : "The additional loyalty cashback", "type" : "number" } }, "type" : "object" }, "CouponMoreLoyaltyPoints" : { "properties" : { "loyalty_points" : { "description" : "The additional loyalty points", "type" : "number" } }, "type" : "object" }, "CouponMultipleAmountsOffItems" : { "properties" : { "discounts" : { "description" : "A list of item discounts.", "items" : { "$ref" : "#/components/schemas/CouponTierItemDiscount" }, "type" : "array" }, "limit" : { "description" : "The (optional) maximum quantity of items that may receive a discount.", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "CouponNoDiscount" : { "properties" : { "ignore_this_property" : { "description" : "This property does nothing but is included in this object to ensure the object is generated by our sdk builders.", "type" : "boolean" } }, "type" : "object" }, "CouponPercentMoreLoyaltyCashback" : { "properties" : { "percent_more_loyalty_cashback" : { "description" : "The percentage of additional loyalty cashback", "type" : "number" } }, "type" : "object" }, "CouponPercentMoreLoyaltyPoints" : { "properties" : { "percent_more_loyalty_points" : { "description" : "The percentage of additional loyalty points", "type" : "number" } }, "type" : "object" }, "CouponPercentOffItems" : { "properties" : { "discount_percent" : { "description" : "The percentage of subtotal discount", "type" : "number" }, "excluded_item_tags" : { "description" : "A list of item tags which cannot be discounted.", "items" : { "type" : "string" }, "type" : "array" }, "excluded_items" : { "description" : "A list of items which cannot be discounted.", "items" : { "type" : "string" }, "type" : "array" }, "item_tags" : { "description" : "An optional list of item tags which will receive a discount. If blank, discount applies to all items except excluded items.", "items" : { "type" : "string" }, "type" : "array" }, "items" : { "description" : "An optional list of items which will receive a discount. If blank, discount applies to all items except excluded items.", "items" : { "type" : "string" }, "type" : "array" }, "limit" : { "description" : "The (optional) maximum quantity of discounted items.", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "CouponPercentOffItemsAndFreeShipping" : { "properties" : { "discount_percent" : { "description" : "The percentage of subtotal discount", "type" : "number" }, "excluded_item_tags" : { "description" : "A list of item tags which cannot be discounted.", "items" : { "type" : "string" }, "type" : "array" }, "excluded_items" : { "description" : "A list of items which cannot be discounted.", "items" : { "type" : "string" }, "type" : "array" }, "item_tags" : { "description" : "An optional list of item tags which will receive a discount. If blank, discount applies to all items except excluded items.", "items" : { "type" : "string" }, "type" : "array" }, "items" : { "description" : "An optional list of items which will receive a discount. If blank, discount applies to all items except excluded items.", "items" : { "type" : "string" }, "type" : "array" }, "shipping_methods" : { "description" : "One or more shipping methods that may be used with this coupon. If not specified or empty, methods that are marked as qualifies for free shipping will be the only free methods", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CouponPercentOffItemsWithItemsPurchase" : { "properties" : { "discount_percent" : { "description" : "The percentage of subtotal discount", "type" : "number" }, "item_tags" : { "description" : "An optional list of item tags which will receive a discount of one of the required purchased items is purchased.", "items" : { "type" : "string" }, "type" : "array" }, "items" : { "description" : "A list of items which will receive a discount if one of the required purchase items is purchased.", "items" : { "type" : "string" }, "type" : "array" }, "limit" : { "description" : "The (optional) maximum quantity of discounted items.", "format" : "int32", "type" : "integer" }, "required_purchase_items" : { "description" : "Required items (at least one from the list) that must be purchased for coupon to be valid", "items" : { "type" : "string" }, "type" : "array" }, "required_purchase_items_tags" : { "description" : "An optional list of item tags which are required to be purchased.", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CouponPercentOffItemsWithMinimumItemAmount" : { "properties" : { "currency_code" : { "description" : "The ISO-4217 three letter currency code the customer is viewing prices in", "maxLength" : 3, "type" : "string" }, "discount_percent" : { "description" : "The percentage of subtotal discount", "type" : "number" }, "excluded_item_tags" : { "description" : "A list of item tags which cannot be discounted.", "items" : { "type" : "string" }, "type" : "array" }, "excluded_items" : { "description" : "A list of items which cannot be discounted.", "items" : { "type" : "string" }, "type" : "array" }, "item_tags" : { "description" : "An optional list of item tags which will receive a discount. If blank, discount applies to all items except excluded items.", "items" : { "type" : "string" }, "type" : "array" }, "items" : { "description" : "An optional list of items which will receive a discount. If blank, discount applies to all items except excluded items.", "items" : { "type" : "string" }, "type" : "array" }, "limit" : { "description" : "The (optional) maximum quantity of discounted items.", "format" : "int32", "type" : "integer" }, "minimum_item_amount" : { "description" : "The minimum item amount (dollars) required for the discount to apply", "type" : "number" } }, "type" : "object" }, "CouponPercentOffItemWithItemsQuantityPurchase" : { "properties" : { "discount_percent" : { "description" : "The percentage of subtotal discount", "type" : "number" }, "item_tags" : { "description" : "An optional list of item tags which will receive a discount if one of the required purchased items is purchased.", "items" : { "type" : "string" }, "type" : "array" }, "items" : { "description" : "A list of items which will receive a discount if one of the required purchase items is purchased.", "items" : { "type" : "string" }, "type" : "array" }, "limit" : { "description" : "The (optional) maximum quantity of discounted items.", "format" : "int32", "type" : "integer" }, "required_purchase_items" : { "description" : "Required items (at least one from the list) that must be purchased for coupon to be valid", "items" : { "type" : "string" }, "type" : "array" }, "required_purchase_items_tags" : { "description" : "Required item tags (at least one from the list) that must be purchase for coupon to be valid.", "items" : { "type" : "string" }, "type" : "array" }, "required_purchase_quantity" : { "description" : "The quantity of items that must be purchased for the discount to be applied.", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "CouponPercentOffMsrpItems" : { "properties" : { "discount_percent" : { "description" : "The percentage of subtotal discount", "type" : "number" }, "excluded_items" : { "description" : "A list of items which cannot be discounted.", "items" : { "type" : "string" }, "type" : "array" }, "items" : { "description" : "An list of items which will receive a discount.", "items" : { "type" : "string" }, "type" : "array" }, "limit" : { "description" : "The (optional) maximum quantity of discounted items.", "format" : "int32", "type" : "integer" }, "minimum_cumulative_msrp" : { "description" : "The (optional) minimum cumulative msrp of qualifying items.", "type" : "number" }, "minimum_subtotal" : { "description" : "The (optional) minimum subtotal of qualifying items.", "type" : "number" } }, "type" : "object" }, "CouponPercentOffRetailPriceItems" : { "properties" : { "discount_percent" : { "description" : "The percentage of subtotal discount", "type" : "number" }, "excluded_items" : { "description" : "A list of items which cannot be discounted.", "items" : { "type" : "string" }, "type" : "array" }, "items" : { "description" : "An optional list of items which will receive a discount. If blank, discount applies to all items except excluded items.", "items" : { "type" : "string" }, "type" : "array" }, "limit" : { "description" : "The (optional) maximum quantity of discounted items.", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "CouponPercentOffShipping" : { "properties" : { "discount_percent" : { "description" : "The percentage of subtotal discount", "type" : "number" }, "shipping_methods" : { "description" : "One or more shipping methods that may be used with this coupon", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CouponPercentOffSubtotal" : { "properties" : { "discount_percent" : { "description" : "The percentage of subtotal discount", "type" : "number" } }, "type" : "object" }, "CouponPercentOffSubtotalAndFreeShipping" : { "properties" : { "discount_percent" : { "description" : "The percentage of subtotal discount", "type" : "number" }, "shipping_methods" : { "description" : "One or more shipping methods that may be free", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CouponPercentOffSubtotalLimit" : { "properties" : { "currency_code" : { "description" : "The ISO-4217 three letter currency code the customer is viewing prices in", "maxLength" : 3, "type" : "string" }, "discount_percent" : { "description" : "The percentage of subtotal discount", "type" : "number" }, "limit" : { "description" : "The maximum amount of subtotal used to determine discount.", "type" : "number" } }, "type" : "object" }, "CouponPercentOffSubtotalWithItemsPurchase" : { "properties" : { "discount_percent" : { "description" : "The percentage of subtotal discount", "type" : "number" }, "items" : { "description" : "A list of items of which at least one must be purchased for coupon to be valid.", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CouponPercentOffSubtotalWithSubtotal" : { "properties" : { "currency_code" : { "description" : "The ISO-4217 three letter currency code the customer is viewing prices in", "maxLength" : 3, "type" : "string" }, "discount_percent" : { "description" : "The percentage of subtotal discount", "type" : "number" }, "subtotal_amount" : { "description" : "The amount of subtotal required to receive the discount percent", "type" : "number" } }, "type" : "object" }, "CouponQuery" : { "properties" : { "affiliate_oid" : { "description" : "Affiliate oid", "format" : "int32", "type" : "integer" }, "coupon_type" : { "description" : "The type of coupon.", "type" : "string" }, "description" : { "description" : "Description of this coupon", "type" : "string" }, "exclude_expired" : { "description" : "Exclude expired coupons if true", "type" : "boolean" }, "expiration_dts_begin" : { "description" : "Expiration date begin", "format" : "dateTime", "type" : "string" }, "expiration_dts_end" : { "description" : "Expiration date begin", "format" : "dateTime", "type" : "string" }, "merchant_code" : { "description" : "Merchant code is a unique character string for this coupon.", "type" : "string" }, "merchant_code_or_description" : { "description" : "Merchant code description used for searching", "type" : "string" }, "start_dts_begin" : { "description" : "Start date begin", "format" : "dateTime", "type" : "string" }, "start_dts_end" : { "description" : "Start date end", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "CouponResponse" : { "properties" : { "coupon" : { "$ref" : "#/components/schemas/Coupon" }, "error" : { "$ref" : "#/components/schemas/Error" }, "items_invalid_for_coupons" : { "description" : "Items invalid for coupons. These will display as warnings within the UI.", "items" : { "type" : "string" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "CouponRestriction" : { "properties" : { "invalidForThis" : { "type" : "boolean" }, "name" : { "type" : "string" }, "validForThis" : { "type" : "boolean" }, "validOnlyForThis" : { "type" : "boolean" } }, "type" : "object" }, "CouponsRequest" : { "properties" : { "coupons" : { "description" : "coupons", "items" : { "$ref" : "#/components/schemas/Coupon" }, "type" : "array" } }, "type" : "object" }, "CouponsResponse" : { "properties" : { "coupons" : { "items" : { "$ref" : "#/components/schemas/Coupon" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "CouponTierAmount" : { "properties" : { "discount_amount" : { "description" : "The amount of subtotal discount", "type" : "number" }, "quickbooks_code" : { "description" : "Quickbooks accounting code.", "maxLength" : 20, "type" : "string" }, "subtotal_amount" : { "description" : "The amount of subtotal required to receive the discount amount", "type" : "number" } }, "type" : "object" }, "CouponTieredAmountOffItems" : { "properties" : { "item_tags" : { "description" : "An optional list of item tags which will receive a discount. If blank, discount applies to all items except excluded items.", "items" : { "type" : "string" }, "type" : "array" }, "items" : { "description" : "The items being discounted by this coupon.", "items" : { "type" : "string" }, "type" : "array" }, "limit" : { "description" : "The maximum number of discounted items.", "type" : "number" }, "tiers" : { "description" : "A list of discount tiers.", "items" : { "$ref" : "#/components/schemas/CouponTierQuantityAmount" }, "type" : "array" } }, "type" : "object" }, "CouponTieredAmountOffSubtotal" : { "properties" : { "items" : { "description" : "An optional list of items of which a quantity of one or many must be purchased for coupon to be valid. If empty, all items apply toward subtotal amount.", "items" : { "type" : "string" }, "type" : "array" }, "tiers" : { "description" : "A list of discount tiers.", "items" : { "$ref" : "#/components/schemas/CouponTierAmount" }, "type" : "array" } }, "type" : "object" }, "CouponTieredPercentOffItems" : { "properties" : { "item_tags" : { "description" : "An optional list of item tags which will receive a discount. If blank, discount applies to all items except excluded items.", "items" : { "type" : "string" }, "type" : "array" }, "items" : { "description" : "A list of items of which at least one must be purchased for coupon to be valid.", "items" : { "type" : "string" }, "type" : "array" }, "limit" : { "description" : "The (optional) maximum quantity of discounted items.", "type" : "number" }, "tiers" : { "description" : "A list of discount tiers.", "items" : { "$ref" : "#/components/schemas/CouponTierQuantityPercent" }, "type" : "array" } }, "type" : "object" }, "CouponTieredPercentOffShipping" : { "properties" : { "quickbooks_code" : { "description" : "Quickbooks accounting code.", "maxLength" : 20, "type" : "string" }, "shipping_methods" : { "description" : "One or more shipping methods that may receive this discount", "items" : { "type" : "string" }, "type" : "array" }, "tiers" : { "description" : "A list of discount tiers.", "items" : { "$ref" : "#/components/schemas/CouponTierPercent" }, "type" : "array" } }, "type" : "object" }, "CouponTieredPercentOffSubtotal" : { "properties" : { "items" : { "description" : "An optional list of items of which a quantity of one or many must be purchased for coupon to be valid. If empty, all items apply toward subtotal amount.", "items" : { "type" : "string" }, "type" : "array" }, "tiers" : { "description" : "A list of discount tiers.", "items" : { "$ref" : "#/components/schemas/CouponTierPercent" }, "type" : "array" } }, "type" : "object" }, "CouponTieredPercentOffSubtotalBasedOnMSRP" : { "properties" : { "items" : { "description" : "An optional list of items of which a quantity of one or many must be purchased for coupon to be valid. If empty, all items apply toward subtotal amount.", "items" : { "type" : "string" }, "type" : "array" }, "tiers" : { "description" : "A list of discount tiers.", "items" : { "$ref" : "#/components/schemas/CouponTierPercent" }, "type" : "array" } }, "type" : "object" }, "CouponTierItemDiscount" : { "properties" : { "discount_amount" : { "description" : "The amount of subtotal discount", "type" : "number" }, "items" : { "description" : "A list of items which will receive this discount.", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CouponTierPercent" : { "properties" : { "discount_percent" : { "description" : "The percent of subtotal discount", "type" : "number" }, "quickbooks_code" : { "description" : "Quickbooks accounting code.", "maxLength" : 20, "type" : "string" }, "subtotal_amount" : { "description" : "The amount of subtotal required to receive the discount percent", "type" : "number" } }, "type" : "object" }, "CouponTierQuantityAmount" : { "properties" : { "discount_amount" : { "description" : "The amount of discount per item.", "type" : "number" }, "item_quantity" : { "description" : "The quantity of item purchased (in units)", "format" : "int32", "type" : "integer" }, "quickbooks_code" : { "description" : "Quickbooks accounting code.", "maxLength" : 20, "type" : "string" } }, "type" : "object" }, "CouponTierQuantityPercent" : { "properties" : { "discount_percent" : { "description" : "The percent of discount per item.", "type" : "number" }, "item_quantity" : { "description" : "The quantity of item purchased (in units)", "format" : "int32", "type" : "integer" }, "quickbooks_code" : { "description" : "Quickbooks accounting code.", "maxLength" : 20, "type" : "string" } }, "type" : "object" }, "CouponType" : { "properties" : { "localized" : { "description" : "A friendly display of the coupon type suitable for human reading", "type" : "string" }, "name" : { "description" : "The name of the coupon type", "type" : "string" } }, "type" : "object" }, "Currency" : { "properties" : { "currency_code" : { "description" : "Currency code of the localized value", "type" : "string" }, "exchange_rate" : { "description" : "Exchange rate used to localize", "type" : "number" }, "localized" : { "description" : "Value localized to the customer", "type" : "number" }, "localized_formatted" : { "description" : "Value localized and formatted for the customer", "type" : "string" }, "value" : { "description" : "Value in base currency", "type" : "number" } }, "type" : "object" }, "CustomDashboard" : { "properties" : { "data_warehouse_custom_dashboard_oid" : { "format" : "int32", "type" : "integer" }, "merchant_id" : { "type" : "string" }, "name" : { "type" : "string" }, "pages" : { "items" : { "$ref" : "#/components/schemas/CustomDashboardPage" }, "type" : "array" }, "parameters" : { "items" : { "$ref" : "#/components/schemas/CustomDashboardExecutionParameter" }, "type" : "array" } }, "type" : "object" }, "CustomDashboardExecutionParameter" : { "properties" : { "name" : { "type" : "string" }, "quick_pick_key" : { "type" : "string" }, "type" : { "type" : "string" }, "value" : { "type" : "string" } }, "type" : "object" }, "CustomDashboardPage" : { "properties" : { "page_height_inches" : { "type" : "number" }, "page_width_inches" : { "type" : "number" }, "reports" : { "items" : { "$ref" : "#/components/schemas/CustomDashboardPageReport" }, "type" : "array" } }, "type" : "object" }, "CustomDashboardPageReport" : { "properties" : { "data_warehouse_report_config_oid" : { "format" : "int32", "type" : "integer" }, "grid_height" : { "format" : "int32", "type" : "integer" }, "grid_width" : { "format" : "int32", "type" : "integer" }, "grid_x" : { "format" : "int32", "type" : "integer" }, "grid_y" : { "format" : "int32", "type" : "integer" } }, "type" : "object" }, "CustomDashboardResponse" : { "properties" : { "dashboard" : { "$ref" : "#/components/schemas/CustomDashboard" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "CustomDashboardSchedule" : { "properties" : { "cron_trigger_expression" : { "type" : "string" }, "data_warehouse_custom_dashboard_oid" : { "format" : "int32", "type" : "integer" }, "data_warehouse_custom_dashboard_schedule_oid" : { "format" : "int32", "type" : "integer" }, "emails" : { "items" : { "type" : "string" }, "type" : "array" }, "next_send_dts" : { "description" : "Date/time that the next send will occur.", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "CustomDashboardScheduleResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "schedule" : { "$ref" : "#/components/schemas/CustomDashboardSchedule" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "CustomDashboardSchedulesResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "schedules" : { "description" : "schedules", "items" : { "$ref" : "#/components/schemas/CustomDashboardSchedule" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "CustomDashboardsResponse" : { "properties" : { "dashboards" : { "description" : "reports", "items" : { "$ref" : "#/components/schemas/CustomDashboard" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "Customer" : { "properties" : { "activity" : { "$ref" : "#/components/schemas/CustomerActivity" }, "affiliate_oid" : { "description" : "Affiliate oid", "format" : "int32", "type" : "integer" }, "allow_3rd_party_billing" : { "description" : "Allow 3rd party billing", "type" : "boolean" }, "allow_cod" : { "description" : "Allow COD", "type" : "boolean" }, "allow_drop_shipping" : { "description" : "Allow Drop Shipping", "type" : "boolean" }, "allow_purchase_order" : { "description" : "Allow purchase orders by this customer", "type" : "boolean" }, "allow_quote_request" : { "description" : "Allow quote request", "type" : "boolean" }, "allow_selection_of_address_type" : { "description" : "Allow selection of residential or business address type", "type" : "boolean" }, "attachments" : { "description" : "Attachments", "items" : { "$ref" : "#/components/schemas/CustomerAttachment" }, "type" : "array" }, "auto_approve_cod" : { "description" : "Auto approve COD", "type" : "boolean" }, "auto_approve_purchase_order" : { "description" : "Auto approve purchase orders by this customer", "type" : "boolean" }, "automatic_merchant_notes" : { "description" : "Automatic merchant notes are added to every order placed", "type" : "string" }, "billing" : { "description" : "Billing addresses for this customer", "items" : { "$ref" : "#/components/schemas/CustomerBilling" }, "type" : "array" }, "business_notes" : { "description" : "Business notes (internally visible only)", "maxLength" : 2000, "type" : "string" }, "cards" : { "description" : "Credit Cards for this customer", "items" : { "$ref" : "#/components/schemas/CustomerCard" }, "type" : "array" }, "cc_emails" : { "description" : "Additional emails to CC notification", "items" : { "$ref" : "#/components/schemas/CustomerEmail" }, "type" : "array" }, "customer_profile_oid" : { "description" : "Customer profile object identifier", "format" : "int32", "type" : "integer" }, "dhl_account_number" : { "description" : "DHL account number", "maxLength" : 20, "type" : "string" }, "dhl_duty_account_number" : { "description" : "DHL duty account number", "maxLength" : 20, "type" : "string" }, "do_not_send_mail" : { "description" : "Do not send mail (null will not update)", "type" : "boolean" }, "edi" : { "$ref" : "#/components/schemas/CustomerEDI" }, "email" : { "description" : "Email address of this customer profile", "type" : "string" }, "exempt_shipping_handling_charge" : { "description" : "Exempt shipping handling charge", "type" : "boolean" }, "fax" : { "description" : "Fax Number", "maxLength" : 32, "type" : "string" }, "fedex_account_number" : { "description" : "FedEx account number", "maxLength" : 20, "type" : "string" }, "free_shipping" : { "description" : "This customer always receives free shipping", "type" : "boolean" }, "free_shipping_minimum" : { "description" : "If free_shipping is true, this is the minimum subtotal required for free shipping", "type" : "number" }, "last_modified_by" : { "description" : "Last modified by", "maxLength" : 100, "type" : "string" }, "last_modified_dts" : { "description" : "Last modified date", "format" : "dateTime", "type" : "string" }, "loyalty" : { "$ref" : "#/components/schemas/CustomerLoyalty" }, "maximum_item_count" : { "description" : "Maximum item count", "format" : "int32", "type" : "integer" }, "merchant_id" : { "description" : "Merchant ID", "type" : "string" }, "minimum_item_count" : { "description" : "Minimum item count", "format" : "int32", "type" : "integer" }, "minimum_subtotal" : { "description" : "Minimum subtotal", "type" : "number" }, "no_coupons" : { "description" : "No coupons", "type" : "boolean" }, "no_free_shipping" : { "description" : "No free shipping regardless of coupons or item level settings", "type" : "boolean" }, "no_realtime_charge" : { "description" : "No realtime charge", "type" : "boolean" }, "orders" : { "description" : "Orders associated with this customer profile", "items" : { "$ref" : "#/components/schemas/Order" }, "type" : "array" }, "orders_summary" : { "$ref" : "#/components/schemas/CustomerOrdersSummary" }, "password" : { "description" : "Password (may only be set, never read)", "maxLength" : 30, "type" : "string" }, "pricing_tiers" : { "description" : "Pricing tiers for this customer", "items" : { "$ref" : "#/components/schemas/CustomerPricingTier" }, "type" : "array" }, "privacy" : { "$ref" : "#/components/schemas/CustomerPrivacy" }, "properties" : { "description" : "Properties for this customer", "items" : { "$ref" : "#/components/schemas/CustomerProperty" }, "type" : "array" }, "qb_class" : { "description" : "QuickBooks class to import this customer as", "type" : "string" }, "qb_code" : { "description" : "QuickBooks name to import this customer as", "type" : "string" }, "qb_tax_exemption_reason_code" : { "description" : "QuickBooks tax exemption reason code", "format" : "int32", "type" : "integer" }, "quotes" : { "description" : "Quotes associated with this customer profile", "items" : { "$ref" : "#/components/schemas/Order" }, "type" : "array" }, "quotes_summary" : { "$ref" : "#/components/schemas/CustomerQuotesSummary" }, "referral_source" : { "description" : "Referral Source specified on the wholesale customer signup form. No other meaning than that signup flow.", "maxLength" : 50, "type" : "string" }, "reviewer" : { "$ref" : "#/components/schemas/CustomerReviewer" }, "sales_rep_code" : { "description" : "Sales rep code", "maxLength" : 10, "type" : "string" }, "send_signup_notification" : { "description" : "Send signup notification, if true during customer creation, will send a notification.", "type" : "boolean" }, "shipping" : { "description" : "Shipping addresses for this customer", "items" : { "$ref" : "#/components/schemas/CustomerShipping" }, "type" : "array" }, "signup_dts" : { "description" : "Signup date", "type" : "string" }, "software_entitlements" : { "description" : "Software entitlements owned by this customer", "items" : { "$ref" : "#/components/schemas/CustomerSoftwareEntitlement" }, "type" : "array" }, "suppress_buysafe" : { "description" : "Suppress buySAFE (deprecated)", "type" : "boolean" }, "tags" : { "description" : "Tags for this customer", "items" : { "$ref" : "#/components/schemas/CustomerTag" }, "type" : "array" }, "tax_codes" : { "$ref" : "#/components/schemas/CustomerTaxCodes" }, "tax_exempt" : { "description" : "True if the customer is tax exempt", "type" : "boolean" }, "tax_id" : { "description" : "Tax ID", "maxLength" : 15, "type" : "string" }, "terms" : { "description" : "Terms for this customer", "type" : "string" }, "track_separately" : { "description" : "True if the customer should be tracked separately in QuickBooks", "type" : "boolean" }, "unapproved" : { "description" : "Unapproved", "type" : "boolean" }, "ups_account_number" : { "description" : "UPS account number", "maxLength" : 20, "type" : "string" }, "website_url" : { "description" : "Website url", "maxLength" : 100, "type" : "string" } }, "type" : "object" }, "CustomerActivity" : { "properties" : { "activities" : { "items" : { "$ref" : "#/components/schemas/Activity" }, "type" : "array" }, "global_unsubscribed" : { "type" : "boolean" }, "global_unsubscribed_dts" : { "type" : "string" }, "memberships" : { "items" : { "$ref" : "#/components/schemas/ListSegmentMembership" }, "type" : "array" }, "metrics" : { "items" : { "$ref" : "#/components/schemas/Metric" }, "type" : "array" }, "properties_list" : { "items" : { "$ref" : "#/components/schemas/Property" }, "type" : "array" }, "sms" : { "type" : "string" }, "sms_stop" : { "type" : "boolean" }, "spam_complaint" : { "type" : "boolean" }, "spam_complaint_dts" : { "type" : "string" } }, "type" : "object" }, "CustomerAffiliate" : { "properties" : { "affiliate_oid" : { "description" : "Affiliate object identifier", "format" : "int32", "type" : "integer" }, "email" : { "description" : "email", "type" : "string" }, "first_name" : { "description" : "First name", "type" : "string" }, "last_name" : { "description" : "Last name", "type" : "string" } }, "type" : "object" }, "CustomerAttachment" : { "properties" : { "customer_profile_attachment_oid" : { "description" : "Attachment identifier", "format" : "int32", "type" : "integer" }, "description" : { "description" : "Description", "type" : "string" }, "file_name" : { "description" : "File name", "type" : "string" }, "mime_type" : { "description" : "Mime type", "type" : "string" }, "upload_dts" : { "description" : "Upload date/time", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "CustomerBilling" : { "properties" : { "address1" : { "description" : "Address line 1", "maxLength" : 50, "type" : "string" }, "address2" : { "description" : "Address line 2", "maxLength" : 50, "type" : "string" }, "city" : { "description" : "City", "maxLength" : 32, "type" : "string" }, "company" : { "description" : "Company", "maxLength" : 50, "type" : "string" }, "country_code" : { "description" : "ISO-3166 two letter country code", "maxLength" : 2, "type" : "string" }, "customer_billing_oid" : { "description" : "Customer profile billing object identifier", "format" : "int32", "type" : "integer" }, "customer_profile_oid" : { "description" : "Customer profile object identifier", "format" : "int32", "type" : "integer" }, "day_phone" : { "description" : "Day phone", "maxLength" : 25, "type" : "string" }, "day_phone_e164" : { "description" : "Day phone in E.164 format (derived — read only)", "type" : "string" }, "default_billing" : { "description" : "Default billing", "type" : "boolean" }, "evening_phone" : { "description" : "Evening phone", "maxLength" : 25, "type" : "string" }, "evening_phone_e164" : { "description" : "Evening phone in E.164 format (derived — read only)", "type" : "string" }, "first_name" : { "description" : "First name", "maxLength" : 30, "type" : "string" }, "last_name" : { "description" : "Last name", "maxLength" : 30, "type" : "string" }, "last_used_dts" : { "description" : "Last used date", "format" : "dateTime", "type" : "string" }, "postal_code" : { "description" : "Postal code", "maxLength" : 20, "type" : "string" }, "state_region" : { "description" : "State for United States otherwise region or province for other countries", "maxLength" : 32, "type" : "string" }, "tax_county" : { "description" : "Tax County", "maxLength" : 32, "type" : "string" }, "title" : { "description" : "Title", "maxLength" : 50, "type" : "string" } }, "type" : "object" }, "CustomerCard" : { "properties" : { "card_expiration_month" : { "description" : "Card expiration month (1-12)", "format" : "int32", "type" : "integer" }, "card_expiration_year" : { "description" : "Card expiration year (four digit year)", "format" : "int32", "type" : "integer" }, "card_number" : { "description" : "Card number (masked to the last 4)", "type" : "string" }, "card_number_token" : { "description" : "Hosted field token for the card number", "type" : "string" }, "card_type" : { "description" : "Card type", "type" : "string" }, "customer_profile_credit_card_id" : { "description" : "ID of the stored credit card to use", "format" : "int32", "type" : "integer" }, "customer_profile_oid" : { "description" : "Customer profile object identifier", "format" : "int32", "type" : "integer" }, "last_used_dts" : { "description" : "Last used date", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "CustomerEDI" : { "properties" : { "channel_partner_oid" : { "description" : "EDI channel partner this customer profile is associated with", "format" : "int32", "type" : "integer" }, "distribution_center_number" : { "description" : "The EDI distribution center number associated with this customer profile.", "type" : "string" }, "store_number" : { "description" : "The EDI store number associated with this customer profile.", "type" : "string" } }, "type" : "object" }, "CustomerEditorValues" : { "properties" : { "affiliates" : { "description" : "affiliates", "items" : { "$ref" : "#/components/schemas/CustomerAffiliate" }, "type" : "array" }, "card_exp_months" : { "description" : "card_exp_months", "items" : { "type" : "string" }, "type" : "array" }, "card_exp_years" : { "description" : "card_exp_years", "items" : { "type" : "string" }, "type" : "array" }, "card_types" : { "description" : "card_types", "items" : { "type" : "string" }, "type" : "array" }, "countries" : { "description" : "countries", "items" : { "$ref" : "#/components/schemas/Country" }, "type" : "array" }, "edi_channel_partners" : { "description" : "EDI channel partners", "items" : { "$ref" : "#/components/schemas/ChannelPartner" }, "type" : "array" }, "loyalty_ledger_descriptions" : { "description" : "loyalty_ledger_descriptions", "items" : { "type" : "string" }, "type" : "array" }, "loyalty_program_type" : { "description" : "loyalty_program_type", "type" : "string" }, "qb_classes" : { "description" : "qb_classes", "items" : { "type" : "string" }, "type" : "array" }, "sales_rep_codes" : { "description" : "sales_rep_codes", "items" : { "type" : "string" }, "type" : "array" }, "state_optional_countries" : { "description" : "state_optional_countries", "items" : { "$ref" : "#/components/schemas/Country" }, "type" : "array" }, "terms" : { "description" : "terms", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CustomerEmail" : { "properties" : { "customer_profile_email_oid" : { "description" : "ID of the email", "format" : "int32", "type" : "integer" }, "email" : { "description" : "Email", "maxLength" : 100, "type" : "string" }, "label" : { "description" : "Label", "maxLength" : 100, "type" : "string" }, "receipt_notification" : { "description" : "CC this email on receipt notifications", "type" : "boolean" }, "refund_notification" : { "description" : "CC this email on refund notifications", "type" : "boolean" }, "shipment_notification" : { "description" : "CC this email on shipment notifications", "type" : "boolean" } }, "type" : "object" }, "CustomerEmailListChanges" : { "properties" : { "add_to_lists" : { "description" : "Add this customer to these email lists", "items" : { "type" : "string" }, "type" : "array" }, "remove_from_lists" : { "description" : "Remove this customer from these email lists", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "CustomerLoyalty" : { "properties" : { "current_points" : { "description" : "Current points", "format" : "int32", "type" : "integer" }, "internal_gift_certificate" : { "$ref" : "#/components/schemas/GiftCertificate" }, "internal_gift_certificate_balance" : { "description" : "Loyalty Cashback / Store credit balance (internal gift certificate balance)", "type" : "string" }, "internal_gift_certificate_oid" : { "description" : "Internal gift certificate oid used to tracking loyalty cashback / store credit.", "format" : "int32", "type" : "integer" }, "ledger_entries" : { "description" : "Ledger entries", "items" : { "$ref" : "#/components/schemas/CustomerLoyaltyLedger" }, "type" : "array" }, "loyalty_tier_expiration_dts" : { "description" : "Loyalty tier expiration date (read only because of SDK addition)", "format" : "dateTime", "type" : "string" }, "loyalty_tier_name" : { "description" : "Loyalty tier name", "type" : "string" }, "loyalty_tier_oid" : { "description" : "Loyalty tier oid (set to zero to remove the tier)", "format" : "int32", "type" : "integer" }, "pending_points" : { "description" : "Pending Points", "format" : "int32", "type" : "integer" }, "redemptions" : { "description" : "Redemptions", "items" : { "$ref" : "#/components/schemas/CustomerLoyaltyRedemption" }, "type" : "array" } }, "type" : "object" }, "CustomerLoyaltyLedger" : { "properties" : { "created_by" : { "description" : "Created By", "type" : "string" }, "created_dts" : { "description" : "Created date", "format" : "dateTime", "type" : "string" }, "description" : { "description" : "Description", "type" : "string" }, "email" : { "description" : "Email", "type" : "string" }, "item_id" : { "description" : "Item Id", "type" : "string" }, "item_index" : { "description" : "Item Index", "format" : "int32", "type" : "integer" }, "ledger_dts" : { "description" : "Ledger date", "format" : "dateTime", "type" : "string" }, "loyalty_campaign_oid" : { "description" : "Loyalty campaign oid", "format" : "int32", "type" : "integer" }, "loyalty_ledger_oid" : { "description" : "Loyalty ledger oid", "format" : "int32", "type" : "integer" }, "loyalty_points" : { "description" : "Loyalty points", "format" : "int32", "type" : "integer" }, "modified_by" : { "description" : "Modified By", "type" : "string" }, "modified_dts" : { "description" : "Modified date", "format" : "dateTime", "type" : "string" }, "order_id" : { "description" : "Order Id", "type" : "string" }, "quantity" : { "description" : "Quantity", "format" : "int32", "type" : "integer" }, "vesting_dts" : { "description" : "Vesting date", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "CustomerLoyaltyRedemption" : { "properties" : { "coupon_code" : { "description" : "Coupon code", "type" : "string" }, "coupon_code_oid" : { "description" : "Coupon code OID", "format" : "int32", "type" : "integer" }, "coupon_used" : { "description" : "Coupon used", "type" : "boolean" }, "description_for_customer" : { "description" : "Description for customer", "type" : "string" }, "expiration_dts" : { "description" : "Expiration date", "format" : "dateTime", "type" : "string" }, "gift_certificate_code" : { "description" : "Gift certificate code", "type" : "string" }, "gift_certificate_oid" : { "description" : "Gift certificate oid", "format" : "int32", "type" : "integer" }, "loyalty_ledger_oid" : { "description" : "Loyalty ledger OID", "format" : "int32", "type" : "integer" }, "loyalty_points" : { "description" : "Loyalty points", "format" : "int32", "type" : "integer" }, "loyalty_redemption_oid" : { "description" : "Loyalty redemption OID", "format" : "int32", "type" : "integer" }, "order_id" : { "description" : "Order id", "type" : "string" }, "redemption_dts" : { "description" : "Redemption date", "format" : "dateTime", "type" : "string" }, "remaining_balance" : { "description" : "Remaining balance", "type" : "number" } }, "type" : "object" }, "CustomerMagicLinkResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "url" : { "description" : "URL", "type" : "string" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "CustomerMergeRequest" : { "properties" : { "customer_profile_oid" : { "description" : "Customer profile oid to merge", "format" : "int32", "type" : "integer" }, "email" : { "description" : "Email of the customer profile to merge", "type" : "string" } }, "type" : "object" }, "CustomerOrdersSummary" : { "properties" : { "first_order_dts" : { "description" : "First order date", "format" : "dateTime", "type" : "string" }, "last_order_dts" : { "description" : "Last order date", "format" : "dateTime", "type" : "string" }, "order_count" : { "description" : "Total number of orders", "format" : "int32", "type" : "integer" }, "total" : { "description" : "Total amount associated with the orders", "type" : "number" } }, "type" : "object" }, "CustomerPricingTier" : { "properties" : { "name" : { "description" : "Name", "maxLength" : 50, "type" : "string" }, "pricing_tier_oid" : { "description" : "Pricing Tier Oid", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "CustomerPrivacy" : { "properties" : { "last_update_dts" : { "description" : "Last update date", "format" : "dateTime", "type" : "string" }, "marketing" : { "description" : "The customer has opted in to marketing", "type" : "boolean" }, "preference" : { "description" : "The customer has opted in to preference tracking", "type" : "boolean" }, "statistics" : { "description" : "The customer has opted in to statistics collection", "type" : "boolean" } }, "type" : "object" }, "CustomerProperty" : { "properties" : { "customer_profile_property_oid" : { "description" : "Customer profile property oid", "format" : "int32", "type" : "integer" }, "expiration_dts" : { "description" : "The date/time that the property expires and is deleted", "format" : "dateTime", "type" : "string" }, "name" : { "description" : "Name", "maxLength" : 100, "type" : "string" }, "value" : { "description" : "Value", "maxLength" : 1500, "type" : "string" } }, "type" : "object" }, "CustomerQuery" : { "properties" : { "all_tags" : { "description" : "All tags the customer must have", "items" : { "type" : "string" }, "type" : "array" }, "any_tags" : { "description" : "Any of these tags the customer must have", "items" : { "type" : "string" }, "type" : "array" }, "billing_city" : { "description" : "Billing city", "maxLength" : 32, "type" : "string" }, "billing_company" : { "description" : "Billing company", "maxLength" : 50, "type" : "string" }, "billing_country_code" : { "description" : "Billing country code", "maxLength" : 2, "type" : "string" }, "billing_day_phone" : { "description" : "Billing day phone", "maxLength" : 25, "type" : "string" }, "billing_evening_phone" : { "description" : "Billing evening phone", "maxLength" : 25, "type" : "string" }, "billing_first_name" : { "description" : "Billing first name", "maxLength" : 30, "type" : "string" }, "billing_last_name" : { "description" : "Billing last name", "maxLength" : 30, "type" : "string" }, "billing_postal_code" : { "description" : "Billing postal code", "maxLength" : 20, "type" : "string" }, "billing_state" : { "description" : "Billing state", "maxLength" : 32, "type" : "string" }, "email" : { "description" : "Email address of this customer profile", "type" : "string" }, "emails" : { "description" : "Emails allows for searching on multiple email addresses and work with our without the single email variable. You may specify a single email address here or use the email property.", "items" : { "type" : "string" }, "type" : "array" }, "last_modified_dts_end" : { "description" : "Last modified date end", "format" : "dateTime", "type" : "string" }, "last_modified_dts_start" : { "description" : "Last modified date start", "format" : "dateTime", "type" : "string" }, "pricing_tier_name" : { "description" : "Pricing tier name", "maxLength" : 50, "type" : "string" }, "pricing_tier_oid" : { "description" : "Pricing tier oid", "format" : "int32", "type" : "integer" }, "qb_class" : { "description" : "QuickBooks class to import this customer as", "type" : "string" }, "query_target" : { "description" : "Query Target", "enum" : [ "origin", "cache" ], "type" : "string" }, "quickbooks_code" : { "description" : "QuickBooks name to import this customer as", "type" : "string" }, "shipping_city" : { "description" : "Billing city", "maxLength" : 32, "type" : "string" }, "shipping_company" : { "description" : "Billing company", "maxLength" : 50, "type" : "string" }, "shipping_country_code" : { "description" : "Billing country code", "maxLength" : 2, "type" : "string" }, "shipping_day_phone" : { "description" : "Billing day phone", "maxLength" : 25, "type" : "string" }, "shipping_evening_phone" : { "description" : "Billing evening phone", "maxLength" : 25, "type" : "string" }, "shipping_first_name" : { "description" : "Billing first name", "maxLength" : 30, "type" : "string" }, "shipping_last_name" : { "description" : "Billing last name", "maxLength" : 30, "type" : "string" }, "shipping_postal_code" : { "description" : "Billing postal code", "maxLength" : 20, "type" : "string" }, "shipping_state" : { "description" : "Billing state", "maxLength" : 32, "type" : "string" }, "signup_dts_end" : { "description" : "Signup date end", "format" : "dateTime", "type" : "string" }, "signup_dts_start" : { "description" : "Signup date start", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "CustomerQuotesSummary" : { "properties" : { "first_quote_dts" : { "description" : "First quote date", "format" : "dateTime", "type" : "string" }, "last_quote_dts" : { "description" : "Last quote date", "format" : "dateTime", "type" : "string" }, "quote_count" : { "description" : "Total number of quote", "format" : "int32", "type" : "integer" }, "total" : { "description" : "Total amount associated with the quotes", "type" : "number" } }, "type" : "object" }, "CustomerResponse" : { "properties" : { "customer" : { "$ref" : "#/components/schemas/Customer" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "CustomerReviewer" : { "properties" : { "auto_approve" : { "description" : "True if reviewes from this customer profile should automatically be approved", "type" : "boolean" }, "average_overall_rating" : { "description" : "Average overall rating of items reviewed", "type" : "number" }, "expert" : { "description" : "True if the customer is an expert", "type" : "boolean" }, "first_review" : { "description" : "First review", "format" : "dateTime", "type" : "string" }, "last_review" : { "description" : "Last review", "format" : "dateTime", "type" : "string" }, "location" : { "description" : "Location of the reviewer", "type" : "string" }, "nickname" : { "description" : "Nickname of the reviewer", "type" : "string" }, "number_helpful_review_votes" : { "description" : "Number of helpful review votes", "format" : "int32", "type" : "integer" }, "rank" : { "description" : "Rank of this reviewer", "format" : "int32", "type" : "integer" }, "reviews_contributed" : { "description" : "Number of reviews contributed", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "CustomerShipping" : { "properties" : { "address1" : { "description" : "Address line 1", "maxLength" : 50, "type" : "string" }, "address2" : { "description" : "Address line 2", "maxLength" : 50, "type" : "string" }, "city" : { "description" : "City", "maxLength" : 32, "type" : "string" }, "company" : { "description" : "Company", "maxLength" : 50, "type" : "string" }, "country_code" : { "description" : "ISO-3166 two letter country code", "maxLength" : 2, "type" : "string" }, "customer_profile_oid" : { "description" : "Customer profile object identifier", "format" : "int32", "type" : "integer" }, "customer_shipping_oid" : { "description" : "Customer profile shipping object identifier", "format" : "int32", "type" : "integer" }, "day_phone" : { "description" : "Day phone", "maxLength" : 25, "type" : "string" }, "day_phone_e164" : { "description" : "Day phone in E.164 format (derived — read only)", "type" : "string" }, "default_shipping" : { "description" : "Default shipping", "type" : "boolean" }, "evening_phone" : { "description" : "Evening phone", "maxLength" : 25, "type" : "string" }, "evening_phone_e164" : { "description" : "Evening phone in E.164 format (derived — read only)", "type" : "string" }, "first_name" : { "description" : "First name", "maxLength" : 30, "type" : "string" }, "last_name" : { "description" : "Last name", "maxLength" : 30, "type" : "string" }, "last_used_dts" : { "description" : "Last used date", "format" : "dateTime", "type" : "string" }, "postal_code" : { "description" : "Postal code", "maxLength" : 20, "type" : "string" }, "state_region" : { "description" : "State for United States otherwise region or province for other countries", "maxLength" : 32, "type" : "string" }, "tax_county" : { "description" : "Tax County", "maxLength" : 32, "type" : "string" }, "title" : { "description" : "Title", "maxLength" : 50, "type" : "string" } }, "type" : "object" }, "CustomerSoftwareEntitlement" : { "properties" : { "activation_code" : { "description" : "Activation Code Associated with the software", "maxLength" : 50, "type" : "string" }, "activation_dts" : { "description" : "Date/time when the activation code was created", "format" : "dateTime", "type" : "string" }, "customer_software_entitlement_oid" : { "description" : "Customer profile software entitlement object identifier", "format" : "int32", "type" : "integer" }, "expiration_dts" : { "description" : "Date/time when the activation code will expire", "format" : "dateTime", "type" : "string" }, "purchased_via_item_description" : { "description" : "Item description used to purchase this software.", "maxLength" : 512, "type" : "string" }, "purchased_via_item_id" : { "description" : "Item ID used to purchase this software.", "maxLength" : 20, "type" : "string" }, "purchased_via_order_id" : { "description" : "Order ID used to purchase this software.", "maxLength" : 30, "type" : "string" }, "software_sku" : { "description" : "SKU of the software", "maxLength" : 30, "type" : "string" } }, "type" : "object" }, "CustomersResponse" : { "properties" : { "customers" : { "items" : { "$ref" : "#/components/schemas/Customer" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "CustomerStoreCredit" : { "properties" : { "available" : { "description" : "Available store credit which is defined as unused and vested", "type" : "number" }, "expiring" : { "description" : "Amount of store credit expiring within 30 days", "type" : "number" }, "future_ledgers" : { "description" : "Array of future ledger entries including expiring entries", "items" : { "$ref" : "#/components/schemas/CustomerStoreCreditLedgerEntry" }, "type" : "array" }, "past_ledgers" : { "description" : "Array of past ledger entries including accrual, usage, and expiring entries", "items" : { "$ref" : "#/components/schemas/CustomerStoreCreditLedgerEntry" }, "type" : "array" }, "total" : { "description" : "Total lifetime store credit for this customer.", "type" : "number" }, "vesting" : { "description" : "Amount of store credit vesting", "type" : "number" } }, "type" : "object" }, "CustomerStoreCreditAddRequest" : { "properties" : { "amount" : { "description" : "Amount of store credit", "type" : "number" }, "description" : { "description" : "Description or reason for the store credit", "type" : "string" }, "expiration_days" : { "description" : "Optional days for store credit to expire or zero for no expiration", "format" : "int32", "type" : "integer" }, "vesting_days" : { "description" : "Optional days for store credit to vesting or zero for immediately available", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "CustomerStoreCreditLedgerEntry" : { "properties" : { "action" : { "description" : "Identifies the state of this ledger entry whether the entry is Vesting or Expiring", "type" : "string" }, "amount" : { "description" : "The amount of the activity.", "type" : "number" }, "description" : { "description" : "Description of what this ledger entry is used.", "maxLength" : 50, "type" : "string" }, "entry_dts" : { "description" : "Date time of this ledger activity.", "type" : "string" }, "gift_certificate_ledger_oid" : { "description" : "Gift certificate ledger oid is a primary key for this object, used internally.", "format" : "int32", "type" : "integer" }, "gift_certificate_oid" : { "description" : "Gift certificate oid.", "format" : "int32", "type" : "integer" }, "reference_order_id" : { "description" : "The order id if this gift certificate was used as part of the payment.", "type" : "string" } }, "type" : "object" }, "CustomerStoreCreditResponse" : { "properties" : { "customer_store_credit" : { "$ref" : "#/components/schemas/CustomerStoreCredit" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "CustomerTag" : { "properties" : { "tag_value" : { "description" : "Tag Value", "maxLength" : 250, "type" : "string" } }, "type" : "object" }, "CustomerTaxCodes" : { "properties" : { "avalara_customer_code" : { "description" : "Avalara customer code", "type" : "string" }, "avalara_entity_use_code" : { "description" : "Avalara entity use code", "type" : "string" }, "sovos_customer_code" : { "description" : "Sovos customer code", "type" : "string" }, "taxjar_customer_id" : { "description" : "TaxJar customer id", "type" : "string" }, "taxjar_exemption_type" : { "description" : "TaxJar exemption type", "type" : "string" } }, "type" : "object" }, "CustomerWishListItem" : { "properties" : { "add_dts" : { "description" : "Add date", "format" : "dateTime", "type" : "string" }, "comments" : { "description" : "Comments", "maxLength" : 1024, "type" : "string" }, "customer_profile_oid" : { "description" : "Customer profile object identifier", "format" : "int32", "type" : "integer" }, "customer_wishlist_item_oid" : { "description" : "Customer wishlist item object identifier", "format" : "int32", "type" : "integer" }, "merchant_item_oid" : { "description" : "Merchant item object identifier", "format" : "int32", "type" : "integer" }, "position" : { "description" : "Position in wishlist", "format" : "int32", "type" : "integer" }, "priority" : { "description" : "Priority of wishlist item, 3 being low priority and 5 is high priority.", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "CustomerWishListItemResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" }, "wishlist_item" : { "$ref" : "#/components/schemas/CustomerWishListItem" } }, "type" : "object" }, "CustomerWishListItemsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" }, "wishlist_items" : { "items" : { "$ref" : "#/components/schemas/CustomerWishListItem" }, "type" : "array" } }, "type" : "object" }, "CustomReport" : { "properties" : { "business_analysis_prompt" : { "type" : "string" }, "chart_javascript" : { "type" : "string" }, "chart_javascript_url" : { "type" : "string" }, "data_warehouse_report_config_oid" : { "format" : "int32", "type" : "integer" }, "dataset_security_level" : { "type" : "string" }, "group_name" : { "type" : "string" }, "merchant_id" : { "type" : "string" }, "name" : { "type" : "string" }, "parameters" : { "items" : { "$ref" : "#/components/schemas/CustomReportParameter" }, "type" : "array" }, "queries" : { "items" : { "$ref" : "#/components/schemas/CustomReportQuery" }, "type" : "array" }, "tooltips" : { "items" : { "$ref" : "#/components/schemas/CustomReportTooltip" }, "type" : "array" } }, "type" : "object" }, "CustomReportAccountConfig" : { "properties" : { "ai_budget" : { "type" : "number" }, "ai_usage" : { "description" : "Current AI usage creating reports", "type" : "number" }, "ai_usage_breakdowns" : { "items" : { "$ref" : "#/components/schemas/CustomReportUsageBreakdown" }, "type" : "array" }, "merchant_id" : { "description" : "Current BigQuery SQL usage running reports", "type" : "string" }, "novice_sql_comments" : { "type" : "boolean" }, "opt_in" : { "description" : "True if they have opted into custom reports", "type" : "boolean" }, "opt_in_by_user" : { "description" : "User that opted into custom reporting", "type" : "string" }, "opt_in_date" : { "description" : "Date/time that custom reporting was opted in to", "format" : "dateTime", "type" : "string" }, "read_only" : { "type" : "boolean" }, "sql_budget" : { "type" : "number" }, "sql_usage" : { "type" : "number" } }, "type" : "object" }, "CustomReportAccountConfigResponse" : { "properties" : { "account_config" : { "$ref" : "#/components/schemas/CustomReportAccountConfig" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "CustomReportAnalysisRequest" : { "properties" : { "png_url" : { "type" : "string" }, "result_url" : { "type" : "string" } }, "type" : "object" }, "CustomReportAnalysisResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "html" : { "type" : "string" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "CustomReportChartPngUploadResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "signed_download_url" : { "type" : "string" }, "signed_upload_url" : { "type" : "string" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "CustomReportExecutionParameter" : { "properties" : { "name" : { "type" : "string" }, "quick_pick_key" : { "type" : "string" }, "type" : { "type" : "string" }, "value" : { "type" : "string" } }, "type" : "object" }, "CustomReportExecutionRequest" : { "properties" : { "parameters" : { "items" : { "$ref" : "#/components/schemas/CustomReportExecutionParameter" }, "type" : "array" } }, "type" : "object" }, "CustomReportExecutionResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "parameters" : { "items" : { "$ref" : "#/components/schemas/CustomReportExecutionParameter" }, "type" : "array" }, "report" : { "$ref" : "#/components/schemas/CustomReport" }, "result_schema_json" : { "type" : "string" }, "result_url" : { "type" : "string" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "CustomReportParameter" : { "properties" : { "display_name" : { "type" : "string" }, "meta" : { "type" : "string" }, "name" : { "type" : "string" }, "options" : { "items" : { "$ref" : "#/components/schemas/CustomReportParameterOption" }, "type" : "array" }, "required" : { "type" : "boolean" }, "type" : { "type" : "string" } }, "type" : "object" }, "CustomReportParameterOption" : { "properties" : { "description" : { "type" : "string" }, "value" : { "type" : "string" } }, "type" : "object" }, "CustomReportQuery" : { "properties" : { "conditional_formatting_start_column" : { "format" : "int32", "type" : "integer" }, "freeze_columns" : { "format" : "int32", "type" : "integer" }, "pii_columns" : { "items" : { "type" : "string" }, "type" : "array" }, "query" : { "type" : "string" }, "sheet_name" : { "type" : "string" }, "title" : { "type" : "string" } }, "type" : "object" }, "CustomReportResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "report" : { "$ref" : "#/components/schemas/CustomReport" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "CustomReportsExecutionReportData" : { "properties" : { "data_warehouse_report_config_oid" : { "format" : "int32", "type" : "integer" }, "error_message" : { "type" : "string" }, "result_url" : { "type" : "string" } }, "type" : "object" }, "CustomReportsExecutionRequest" : { "properties" : { "data_warehouse_report_config_oids" : { "items" : { "type" : "integer" }, "type" : "array" }, "parameters" : { "items" : { "$ref" : "#/components/schemas/CustomReportExecutionParameter" }, "type" : "array" } }, "type" : "object" }, "CustomReportsExecutionResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "parameters" : { "items" : { "$ref" : "#/components/schemas/CustomReportExecutionParameter" }, "type" : "array" }, "reports" : { "items" : { "$ref" : "#/components/schemas/CustomReportsExecutionReportData" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "CustomReportsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "reports" : { "description" : "reports", "items" : { "$ref" : "#/components/schemas/CustomReport" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "CustomReportTooltip" : { "properties" : { "column_name" : { "type" : "string" }, "tooltip" : { "type" : "string" } }, "type" : "object" }, "CustomReportUsageBreakdown" : { "properties" : { "usage" : { "type" : "number" }, "usage_date" : { "description" : "Date/time that usage occurred", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "DataTablesServerSideResponse" : { "properties" : { "data" : { "items" : { "$ref" : "#/components/schemas/Customer" }, "type" : "array" }, "draw" : { "format" : "int32", "type" : "integer" }, "recordsFiltered" : { "format" : "int32", "type" : "integer" }, "recordsTotal" : { "format" : "int32", "type" : "integer" } }, "type" : "object" }, "Distance" : { "properties" : { "uom" : { "description" : "Unit of measure", "enum" : [ "IN", "CM" ], "type" : "string" }, "value" : { "description" : "The distance measured in UOM", "type" : "number" } }, "type" : "object" }, "DistributionCenter" : { "properties" : { "address1" : { "description" : "Address line 1 of the distribution center", "type" : "string" }, "address2" : { "description" : "Address line 2 of the distribution center", "type" : "string" }, "city" : { "description" : "City of the distribution center", "type" : "string" }, "code" : { "description" : "Unique code for this distribution center", "type" : "string" }, "country_code" : { "description" : "Country code of the distribution center", "type" : "string" }, "default_center" : { "description" : "True if this is the default distribution center on the account", "type" : "boolean" }, "default_handles_all_items" : { "description" : "True if this distribution center handles all new items by default", "type" : "boolean" }, "distribution_center_oid" : { "description" : "Distribution center object identifier", "format" : "int32", "type" : "integer" }, "duns" : { "description" : "DUNS number assigned to this distribution center (EDI)", "type" : "string" }, "estimate_from_distribution_center_oid" : { "description" : "Estimate shipments for this distribution center as if they came from the other distribution center", "format" : "int32", "type" : "integer" }, "ftp_password" : { "description" : "Password associated with the virtual FTP", "type" : "string" }, "hold_before_shipment_minutes" : { "description" : "The number of minutes to hold a shipment", "format" : "int32", "type" : "integer" }, "hold_before_transmission" : { "description" : "True if the shipment should be held before transmission and require a manual release", "type" : "boolean" }, "holdAutoOrderBeforeShipmentMinutes" : { "format" : "int32", "type" : "integer" }, "latitude" : { "description" : "Latitude where the distribution center is located", "type" : "number" }, "longitude" : { "description" : "Longitude where the distribution center is located", "type" : "number" }, "name" : { "description" : "Name of this distribution center", "type" : "string" }, "no_customer_direct_shipments" : { "description" : "True if this distribution center does not handle customer direct shipments", "type" : "boolean" }, "no_split_shipment" : { "description" : "True if this distribution center is not allowed to participate in a split shipment.", "type" : "boolean" }, "pickup_cutoff_time_friday" : { "description" : "The time (EST) after which pickups will not be available on Friday", "type" : "string" }, "pickup_cutoff_time_monday" : { "description" : "The time (EST) after which pickups will not be available on Monday", "type" : "string" }, "pickup_cutoff_time_saturday" : { "description" : "The time (EST) after which pickups will not be available on Saturday", "type" : "string" }, "pickup_cutoff_time_sunday" : { "description" : "The time (EST) after which pickups will not be available on Sunday", "type" : "string" }, "pickup_cutoff_time_thursday" : { "description" : "The time (EST) after which pickups will not be available on Thursday", "type" : "string" }, "pickup_cutoff_time_tuesday" : { "description" : "The time (EST) after which pickups will not be available on Tuesday", "type" : "string" }, "pickup_cutoff_time_wednesday" : { "description" : "The time (EST) after which pickups will not be available on Wednesday", "type" : "string" }, "pickup_start_time_friday" : { "description" : "The time (EST) after which pickups are available on Friday", "type" : "string" }, "pickup_start_time_monday" : { "description" : "The time (EST) after which pickups are available on Monday", "type" : "string" }, "pickup_start_time_saturday" : { "description" : "The time (EST) after which pickups are available on Saturday", "type" : "string" }, "pickup_start_time_sunday" : { "description" : "The time (EST) after which pickups are available on Sunday", "type" : "string" }, "pickup_start_time_thursday" : { "description" : "The time (EST) after which pickups are available on Thursday", "type" : "string" }, "pickup_start_time_tuesday" : { "description" : "The time (EST) after which pickups are available on Tuesday", "type" : "string" }, "pickup_start_time_wednesday" : { "description" : "The time (EST) after which pickups are available on Wednesday", "type" : "string" }, "pickup_tz" : { "description" : "The IANA timezone for all pickup times", "type" : "string" }, "postal_code" : { "description" : "Postal code of the distribution center", "type" : "string" }, "process_days" : { "description" : "The number of processing days required before an order ships", "format" : "int32", "type" : "integer" }, "process_inventory_start_time" : { "description" : "The time (EST) after which inventory updates will be processed", "type" : "string" }, "process_inventory_stop_time" : { "description" : "The time (EST) before which inventory updates will be processed", "type" : "string" }, "require_asn" : { "description" : "True if ASNs are required for this distribution center (EDI)", "type" : "boolean" }, "send_kit_instead_of_components" : { "description" : "True if we should send the kit instead of the components", "type" : "boolean" }, "shipment_cutoff_time_friday" : { "description" : "The time (EST) after which shipments will not be processed on Friday", "type" : "string" }, "shipment_cutoff_time_monday" : { "description" : "The time (EST) after which shipments will not be processed on Monday", "type" : "string" }, "shipment_cutoff_time_saturday" : { "description" : "The time (EST) after which shipments will not be processed on Saturday", "type" : "string" }, "shipment_cutoff_time_sunday" : { "description" : "The time (EST) after which shipments will not be processed on Sunday", "type" : "string" }, "shipment_cutoff_time_thursday" : { "description" : "The time (EST) after which shipments will not be processed on Thursday", "type" : "string" }, "shipment_cutoff_time_tuesday" : { "description" : "The time (EST) after which shipments will not be processed on Tuesday", "type" : "string" }, "shipment_cutoff_time_wednesday" : { "description" : "The time (EST) after which shipments will not be processed on Wednesday", "type" : "string" }, "state" : { "description" : "State of the distribution center", "type" : "string" }, "transmit_blank_costs" : { "description" : "True if monetary amounts should be zeroed before transmission", "type" : "boolean" }, "transport" : { "description" : "Transport mechanism for this distribution center", "type" : "string" } }, "type" : "object" }, "DistributionCentersResponse" : { "properties" : { "distribution_centers" : { "items" : { "$ref" : "#/components/schemas/DistributionCenter" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "double" : { "type" : "object" }, "double[]" : { "type" : "object" }, "EmailBaseTemplateListResponse" : { "properties" : { "templatePaths" : { "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "EmailCampaign" : { "properties" : { "click_rate_formatted" : { "description" : "Click rate of emails", "type" : "string" }, "created_dts" : { "description" : "Created date", "format" : "dateTime", "type" : "string" }, "deleted" : { "description" : "True if this campaign was deleted", "type" : "boolean" }, "email_campaign_uuid" : { "description" : "Email campaign UUID", "type" : "string" }, "email_communication_sequence_uuid" : { "description" : "Email communication sequence UUID", "type" : "string" }, "end_once_customer_purchases" : { "description" : "True if the customer should end the flow once they purchase from this campaign", "type" : "boolean" }, "end_once_customer_purchases_anywhere" : { "description" : "True if the customer should end the flow once they purchase from anywhere", "type" : "boolean" }, "esp_campaign_folder_uuid" : { "description" : "Campaign folder UUID. Null for uncategorized", "type" : "string" }, "esp_domain_user" : { "description" : "User of the sending address", "type" : "string" }, "esp_domain_uuid" : { "description" : "UUID of the sending domain", "type" : "string" }, "esp_friendly_name" : { "description" : "Friendly name of the sending email", "type" : "string" }, "library_item_oid" : { "description" : "If this item was ever added to the Code Library, this is the oid for that library item, or 0 if never added before. This value is used to determine if a library item should be inserted or updated.", "format" : "int32", "type" : "integer" }, "memberships" : { "description" : "List and segment memberships", "items" : { "$ref" : "#/components/schemas/EmailListSegmentMembership" }, "type" : "array" }, "merchant_id" : { "description" : "Merchant ID", "type" : "string" }, "name" : { "description" : "Name of email campaign", "maxLength" : 250, "type" : "string" }, "open_rate_formatted" : { "description" : "Open rate of emails", "type" : "string" }, "prevent_sending_due_to_spam" : { "description" : "True if this campaign is prevented from sending at this time due to spam complaints.", "type" : "boolean" }, "repeat_monthly" : { "description" : "True if the campaign should repeat on a monthly basis", "type" : "boolean" }, "repeat_weekly" : { "description" : "True if the campaign should repeat on a weekly basis", "type" : "boolean" }, "revenue_formatted" : { "description" : "Revenue associated with campaign", "type" : "string" }, "revenue_per_customer_formatted" : { "description" : "Revenue per customer associated with campaign", "type" : "string" }, "scheduled_dts" : { "description" : "Scheduled date", "format" : "dateTime", "type" : "string" }, "screenshot_large_full_url" : { "description" : "URL to a large full length screenshot", "type" : "string" }, "sms_esp_twilio_uuid" : { "description" : "Twilio Account UUID. Null for none", "type" : "string" }, "sms_phone_number" : { "description" : "Twilio SMS Phone Number. Null for none", "type" : "string" }, "status" : { "description" : "Status of the campaign of draft, archived, and sent", "type" : "string" }, "status_dts" : { "description" : "Timestamp when the last status change happened", "format" : "dateTime", "type" : "string" }, "storefront_oid" : { "description" : "Storefront oid", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "EmailCampaignFolder" : { "properties" : { "esp_campaign_folder_uuid" : { "description" : "Email campaign folder UUID", "type" : "string" }, "merchant_id" : { "description" : "Merchant ID", "type" : "string" }, "name" : { "description" : "Name of email campaign folder", "maxLength" : 250, "type" : "string" }, "storefront_oid" : { "description" : "Storefront oid", "format" : "int32", "type" : "integer" }, "system_generated" : { "description" : "System generated folder", "type" : "boolean" } }, "type" : "object" }, "EmailCampaignFolderResponse" : { "properties" : { "campaign_folder" : { "$ref" : "#/components/schemas/EmailCampaignFolder" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailCampaignFoldersResponse" : { "properties" : { "campaign_folders" : { "items" : { "$ref" : "#/components/schemas/EmailCampaignFolder" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailCampaignResponse" : { "properties" : { "campaign" : { "$ref" : "#/components/schemas/EmailCampaign" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailCampaignsResponse" : { "properties" : { "campaigns" : { "items" : { "$ref" : "#/components/schemas/EmailCampaign" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailClick" : { "properties" : { "click_count" : { "description" : "Click Count", "format" : "int32", "type" : "integer" }, "url" : { "description" : "url", "type" : "string" } }, "type" : "object" }, "EmailClicksResponse" : { "properties" : { "clicks" : { "items" : { "$ref" : "#/components/schemas/EmailClick" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailCommseq" : { "properties" : { "email_communication_sequence_steps" : { "description" : "Array of steps", "items" : { "$ref" : "#/components/schemas/EmailCommseqStep" }, "type" : "array" }, "email_communication_sequence_uuid" : { "description" : "Email commseq UUID", "type" : "string" }, "merchant_id" : { "description" : "Merchant ID", "type" : "string" }, "storefront_oid" : { "description" : "Storefront oid", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "EmailCommseqEmail" : { "properties" : { "ai_generation" : { "type" : "boolean" }, "ai_generation_prompt" : { "type" : "string" }, "ai_generation_user_id" : { "format" : "int32", "type" : "integer" }, "deleted" : { "description" : "Deleted", "type" : "boolean" }, "edited_by_user" : { "description" : "Edited by user", "type" : "string" }, "email_communication_sequence_email_uuid" : { "description" : "Email communication sequence email uuid", "type" : "string" }, "email_communication_sequence_uuid" : { "description" : "Email commseq UUID", "type" : "string" }, "email_container_cjson" : { "description" : "Email container cjson", "type" : "string" }, "email_container_cjson_last_modified_dts" : { "description" : "Timestamp the last time the container was modified.", "format" : "dateTime", "type" : "string" }, "email_template_vm_path" : { "description" : "Email template virtual path", "type" : "string" }, "external_generation" : { "type" : "boolean" }, "external_generation_authentication" : { "type" : "string" }, "external_generation_basic_password" : { "type" : "string" }, "external_generation_basic_username" : { "type" : "string" }, "external_generation_header_name" : { "type" : "string" }, "external_generation_header_value" : { "type" : "string" }, "external_generation_id" : { "type" : "string" }, "external_generation_url" : { "type" : "string" }, "filter_profile_equation_json" : { "description" : "Filter profile equation json", "type" : "string" }, "individually_render" : { "description" : "Individually render", "type" : "boolean" }, "library_item_oid" : { "description" : "If this item was ever added to the Code Library, this is the oid for that library item, or 0 if never added before. This value is used to determine if a library item should be inserted or updated.", "format" : "int32", "type" : "integer" }, "magic_link" : { "description" : "True if email links should contain magic link tokens to log the customer in automatically", "type" : "boolean" }, "merchant_id" : { "description" : "Merchant ID", "type" : "string" }, "pending_review" : { "description" : "True if the content of this email is pending review by UltraCart", "type" : "boolean" }, "preview_text" : { "description" : "Preview text", "type" : "string" }, "rejected" : { "description" : "True if the content of this email was rejected during review by UltraCart", "type" : "boolean" }, "requires_review" : { "description" : "True if the content of this email is requires review by UltraCart", "type" : "boolean" }, "screenshot_large_full_url" : { "description" : "URL to screenshot in large form factor full page", "type" : "string" }, "screenshot_large_viewport_url" : { "description" : "URL to screenshot in large form factor viewport", "type" : "string" }, "screenshot_small_full_url" : { "description" : "URL to screenshot in small form factor full page", "type" : "string" }, "screenshot_small_viewport_url" : { "description" : "URL to screenshot in small form factor viewport", "type" : "string" }, "smart_sending" : { "description" : "Smart sending", "type" : "boolean" }, "storefront_oid" : { "description" : "Storefront oid", "format" : "int32", "type" : "integer" }, "subject" : { "description" : "Subject", "type" : "string" }, "suspended_for_spam" : { "description" : "True if the email was suspended for too high of a spam rate.", "type" : "boolean" }, "transactional_email" : { "description" : "Transactional email", "type" : "boolean" }, "version" : { "description" : "Version", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "EmailCommseqEmailResponse" : { "properties" : { "email" : { "$ref" : "#/components/schemas/EmailCommseqEmail" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailCommseqEmailSendTestRequest" : { "properties" : { "cart_id" : { "type" : "string" }, "cart_item_ids" : { "items" : { "type" : "string" }, "type" : "array" }, "esp_commseq_email_uuid" : { "type" : "string" }, "esp_commseq_step_uuid" : { "type" : "string" }, "esp_commseq_uuid" : { "type" : "string" }, "name" : { "type" : "string" }, "order_id" : { "type" : "string" }, "please_review" : { "type" : "boolean" }, "send_to_additional_emails" : { "items" : { "type" : "string" }, "type" : "array" }, "send_to_logged_in_user" : { "type" : "boolean" } }, "type" : "object" }, "EmailCommseqEmailSendTestResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailCommseqEmailsRequest" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "esp_commseq_email_uuids" : { "items" : { "type" : "string" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailCommseqEmailsResponse" : { "properties" : { "emails" : { "items" : { "$ref" : "#/components/schemas/EmailCommseqEmail" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailCommseqPostcard" : { "properties" : { "deleted" : { "description" : "Deleted", "type" : "boolean" }, "edited_by_user" : { "description" : "Edited by user", "type" : "string" }, "email_communication_sequence_postcard_uuid" : { "description" : "communication sequence postcard uuid", "type" : "string" }, "filter_profile_equation_json" : { "description" : "Filter profile equation json", "type" : "string" }, "merchant_id" : { "description" : "Merchant ID", "type" : "string" }, "postcard_back_container_cjson" : { "description" : "Postcard back container cjson", "type" : "string" }, "postcard_back_container_uuid" : { "description" : "Postcard back container uuid", "type" : "string" }, "postcard_container_cjson_last_modified_dts" : { "description" : "Timestamp the last time the container was modified.", "format" : "dateTime", "type" : "string" }, "postcard_front_container_cjson" : { "description" : "Postcard front container cjson", "type" : "string" }, "postcard_front_container_uuid" : { "description" : "Postcard front container uuid", "type" : "string" }, "screenshot_back_url" : { "description" : "URL to screenshot of the back of the postcard", "type" : "string" }, "screenshot_front_url" : { "description" : "URL to screenshot of the front of the postcard", "type" : "string" }, "storefront_oid" : { "description" : "Storefront oid", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "EmailCommseqPostcardResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "postcard" : { "$ref" : "#/components/schemas/EmailCommseqPostcard" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailCommseqPostcardSendTestRequest" : { "properties" : { "address_1" : { "type" : "string" }, "address_2" : { "type" : "string" }, "cart_id" : { "type" : "string" }, "cart_item_ids" : { "items" : { "type" : "string" }, "type" : "array" }, "city" : { "type" : "string" }, "esp_commseq_postcard_uuid" : { "type" : "string" }, "esp_commseq_step_uuid" : { "type" : "string" }, "esp_commseq_uuid" : { "type" : "string" }, "mail_card" : { "type" : "boolean" }, "name" : { "type" : "string" }, "order_id" : { "type" : "string" }, "postal_code" : { "type" : "string" }, "state" : { "type" : "string" } }, "type" : "object" }, "EmailCommseqPostcardSendTestResponse" : { "properties" : { "backThumbnail" : { "type" : "string" }, "error" : { "$ref" : "#/components/schemas/Error" }, "frontThumbnail" : { "type" : "string" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "renderedPdf" : { "type" : "string" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailCommseqPostcardsRequest" : { "properties" : { "esp_commseq_postcard_uuids" : { "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "EmailCommseqPostcardsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "postcards" : { "items" : { "$ref" : "#/components/schemas/EmailCommseqPostcard" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailCommseqResponse" : { "properties" : { "communication_sequence" : { "$ref" : "#/components/schemas/EmailCommseq" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailCommseqSequenceTestRequest" : { "properties" : { "address_1" : { "type" : "string" }, "address_2" : { "type" : "string" }, "cart_id" : { "type" : "string" }, "cart_item_ids" : { "items" : { "type" : "string" }, "type" : "array" }, "city" : { "type" : "string" }, "esp_commseq_uuid" : { "type" : "string" }, "mail_card" : { "type" : "boolean" }, "name" : { "type" : "string" }, "order_id" : { "type" : "string" }, "please_review" : { "type" : "boolean" }, "postal_code" : { "type" : "string" }, "send_to_cellphone_e164" : { "type" : "string" }, "send_to_email" : { "type" : "string" }, "send_to_logged_in_user" : { "type" : "boolean" }, "state" : { "type" : "string" } }, "type" : "object" }, "EmailCommseqSequenceTestResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailCommseqSmsSendTestRequest" : { "properties" : { "esp_commseq_step_uuid" : { "type" : "string" }, "esp_commseq_uuid" : { "type" : "string" }, "send_to_cellphone_e164" : { "type" : "string" } }, "type" : "object" }, "EmailCommseqSmsSendTestResponse" : { "properties" : { "body" : { "type" : "string" }, "error" : { "$ref" : "#/components/schemas/Error" }, "media_urls" : { "items" : { "type" : "string" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailCommseqsResponse" : { "properties" : { "communication_sequences" : { "items" : { "$ref" : "#/components/schemas/EmailCommseq" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailCommseqStat" : { "properties" : { "click_count" : { "description" : "Count of clicked emails", "format" : "int32", "type" : "integer" }, "click_count_formatted" : { "description" : "Count of clicked emails, formatted", "type" : "string" }, "conversion_count" : { "description" : "Count of conversion", "format" : "int32", "type" : "integer" }, "conversion_count_formatted" : { "description" : "Count of conversions, formatted", "type" : "string" }, "delivered_count" : { "description" : "Count of delivered emails", "format" : "int32", "type" : "integer" }, "delivered_count_formatted" : { "description" : "Count of delivered emails, formatted", "type" : "string" }, "email_communication_sequence_uuid" : { "description" : "UUID associated with the communication sequence", "type" : "string" }, "finished_count" : { "description" : "Count of customers that finished the sequence", "format" : "int32", "type" : "integer" }, "finished_count_formatted" : { "description" : "Count of customers that finished the sequence, formatted", "type" : "string" }, "in_progress_count" : { "description" : "Count of customers in progress", "format" : "int32", "type" : "integer" }, "in_progress_count_formatted" : { "description" : "Count of customers in progress, formatted", "type" : "string" }, "kickbox_count" : { "description" : "Count of emails kicked", "format" : "int32", "type" : "integer" }, "kickbox_count_formatted" : { "description" : "Count of emails kicked, formatted", "type" : "string" }, "merchant_id" : { "description" : "Merchant ID", "type" : "string" }, "open_count" : { "description" : "Count of opened emails", "format" : "int32", "type" : "integer" }, "open_count_formatted" : { "description" : "Count of opened emails, formatted", "type" : "string" }, "order_count" : { "description" : "Count of orders", "format" : "int32", "type" : "integer" }, "order_count_formatted" : { "description" : "Count of orders, formatted", "type" : "string" }, "permanent_bounce_count" : { "description" : "Count of emails permanently bounced", "format" : "int32", "type" : "integer" }, "permanent_bounce_count_formatted" : { "description" : "Count of emails permanently bounced, formatted", "type" : "string" }, "profit" : { "description" : "Profit", "type" : "number" }, "profit_formatted" : { "description" : "Profit, formatted", "type" : "string" }, "revenue" : { "description" : "Revenue", "type" : "number" }, "revenue_formatted" : { "description" : "Revenue, formatted", "type" : "string" }, "send_count" : { "description" : "Count of emails sent", "format" : "int32", "type" : "integer" }, "send_count_formatted" : { "description" : "Count of emails sent, formatted", "type" : "string" }, "skipped_count" : { "description" : "Count of skipped emails", "format" : "int32", "type" : "integer" }, "skipped_count_formatted" : { "description" : "Count of skipped emails, formatted", "type" : "string" }, "spam_count" : { "description" : "Count of emails classified as spam", "format" : "int32", "type" : "integer" }, "spam_count_formatted" : { "description" : "Count of emails classified as spam, formatted", "type" : "string" }, "started_count" : { "description" : "Count of customers that started the sequence", "format" : "int32", "type" : "integer" }, "started_count_formatted" : { "description" : "Count of customers that started the sequence, formatted", "type" : "string" }, "storefront_oid" : { "description" : "Storefront oid", "format" : "int32", "type" : "integer" }, "unsubscribe_count" : { "description" : "Count of unsubscribes caused", "format" : "int32", "type" : "integer" }, "unsubscribe_count_formatted" : { "description" : "Count of unsubscribes caused, formatted", "type" : "string" }, "view_count" : { "description" : "Count of views", "format" : "int32", "type" : "integer" }, "view_count_formatted" : { "description" : "Count of views, formatted", "type" : "string" } }, "type" : "object" }, "EmailCommseqStatResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "stats" : { "$ref" : "#/components/schemas/EmailCommseqStat" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailCommseqStep" : { "properties" : { "alt_child_email_communication_sequence_steps" : { "description" : "Array of child steps for the alternate path", "items" : { "$ref" : "#/components/schemas/EmailCommseqStep" }, "type" : "array" }, "child_email_communication_sequence_steps" : { "description" : "Array of child steps", "items" : { "$ref" : "#/components/schemas/EmailCommseqStep" }, "type" : "array" }, "email_communication_sequence_step_uuid" : { "description" : "Email commseq step UUID", "type" : "string" }, "email_pending_review" : { "description" : "True if the content of the email associated with this step is pending review by UltraCart", "type" : "boolean" }, "email_rejected" : { "description" : "True if the content of the email associated with this step was rejected during review by UltraCart", "type" : "boolean" }, "email_requires_review" : { "description" : "True if the content of the email associated with this step requires review by UltraCart", "type" : "boolean" }, "filter_profile_equation_json" : { "description" : "Filter profile equation JSON", "type" : "string" }, "merchant_notes" : { "description" : "Internal merchant notes", "type" : "string" }, "step_config_json" : { "description" : "Arbitrary Configuration for a step", "type" : "string" }, "type" : { "description" : "Type of step", "enum" : [ "begin", "wait", "email", "merge", "condition", "end" ], "type" : "string" } }, "type" : "object" }, "EmailCommseqStepLog" : { "properties" : { "email" : { "description" : "Email", "type" : "string" }, "log" : { "description" : "Log text", "type" : "string" }, "log_dts" : { "description" : "Log date/time", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "EmailCommseqStepLogsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "logs" : { "items" : { "$ref" : "#/components/schemas/EmailCommseqStepLog" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailCommseqWebhookSendTestRequest" : { "properties" : { "cart_id" : { "type" : "string" }, "cart_item_ids" : { "items" : { "type" : "string" }, "type" : "array" }, "email" : { "type" : "string" }, "esp_commseq_step_uuid" : { "type" : "string" }, "esp_commseq_uuid" : { "type" : "string" }, "name" : { "type" : "string" }, "order_id" : { "type" : "string" } }, "type" : "object" }, "EmailCommseqWebhookSendTestResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "request" : { "description" : "HTTP Request", "type" : "string" }, "response" : { "description" : "HTTP Response", "type" : "string" }, "status_code" : { "description" : "HTTP Status Code", "format" : "int32", "type" : "integer" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailCustomer" : { "properties" : { "active" : { "description" : "True if the customer is flagged as active within StoreFront Communications", "type" : "boolean" }, "email" : { "description" : "Email", "type" : "string" }, "email_customer_uuid" : { "description" : "Email customer UUID", "type" : "string" }, "first_name" : { "description" : "First name", "type" : "string" }, "global_unsubscribe" : { "description" : "True if the customer has globally unsubscribed from all communication.", "type" : "boolean" }, "last_interaction_dts" : { "description" : "Last interaction", "format" : "dateTime", "type" : "string" }, "last_name" : { "description" : "Last name", "type" : "string" }, "list_uuids" : { "description" : "UUIDs of the lists they are subscribed to", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "EmailCustomerEditorUrlResponse" : { "properties" : { "editor_url" : { "type" : "string" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailCustomersResponse" : { "properties" : { "customers" : { "description" : "Customers on the page", "items" : { "$ref" : "#/components/schemas/EmailCustomer" }, "type" : "array" }, "page_number" : { "description" : "Page number (one based offset)", "format" : "int32", "type" : "integer" }, "page_size" : { "description" : "Number of records per page", "format" : "int32", "type" : "integer" }, "total_customers" : { "description" : "Total customers", "format" : "int32", "type" : "integer" }, "total_pages" : { "description" : "Total number of pages", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "EmailDashboardActivity" : { "properties" : { "action" : { "description" : "Type of action such as add, remove, subscribe, unsubscribe", "type" : "string" }, "activity_dts" : { "description" : "Date/time of the activity", "format" : "dateTime", "type" : "string" }, "destination_name" : { "description" : "List or segment name", "type" : "string" }, "destination_uuid" : { "description" : "List or segment uuid", "type" : "string" }, "email" : { "description" : "Email address", "type" : "string" }, "is_list" : { "description" : "true if activity is related to list", "type" : "boolean" }, "is_segment" : { "description" : "true if activity is related to segment", "type" : "boolean" } }, "type" : "object" }, "EmailDashboardActivityResponse" : { "properties" : { "activity" : { "items" : { "$ref" : "#/components/schemas/EmailDashboardActivity" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailDashboardStatsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "stats" : { "items" : { "$ref" : "#/components/schemas/EmailStat" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailDomain" : { "properties" : { "comment" : { "type" : "string" }, "dkim" : { "items" : { "$ref" : "#/components/schemas/VerificationRecord" }, "type" : "array" }, "dkim_status" : { "type" : "string" }, "domain" : { "type" : "string" }, "esp_domain_uuid" : { "type" : "string" }, "identity_status" : { "type" : "string" }, "mailgun" : { "$ref" : "#/components/schemas/Mailgun" }, "merchant_id" : { "type" : "string" }, "provider" : { "type" : "string" }, "spf" : { "$ref" : "#/components/schemas/VerificationRecord" }, "start_dkim_dts" : { "type" : "string" }, "start_identity_dts" : { "type" : "string" }, "verification" : { "$ref" : "#/components/schemas/VerificationRecord" } }, "type" : "object" }, "EmailEditorTokenResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "token" : { "type" : "string" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailEditorValuesResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "loyalty_tiers" : { "items" : { "type" : "string" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailFlow" : { "properties" : { "allow_multiple_concurrent_enrollments" : { "description" : "True if a customer may be enrolled in this flow multiple times", "type" : "boolean" }, "back_populating" : { "description" : "True if the flow is currently performing a back population.", "type" : "boolean" }, "click_rate_formatted" : { "description" : "Click rate of emails, formatted", "type" : "string" }, "created_dts" : { "description" : "Created date", "format" : "dateTime", "type" : "string" }, "deleted" : { "description" : "True if this campaign was deleted", "type" : "boolean" }, "email_communication_sequence_uuid" : { "description" : "Email communication sequence UUID", "type" : "string" }, "email_flow_uuid" : { "description" : "Email flow UUID", "type" : "string" }, "end_once_customer_purchases" : { "description" : "True if the customer should end the flow once they purchase from an email on this flow", "type" : "boolean" }, "end_once_customer_purchases_anywhere" : { "description" : "True if the customer should end the flow once they purchase from any source", "type" : "boolean" }, "enrolled_customers" : { "description" : "Number of enrolled customers.", "format" : "int32", "type" : "integer" }, "esp_domain_user" : { "description" : "Username of sending email", "type" : "string" }, "esp_domain_uuid" : { "description" : "UUID of sending domain", "type" : "string" }, "esp_flow_folder_uuid" : { "description" : "Flow folder UUID. Null for uncategorized", "type" : "string" }, "esp_friendly_name" : { "description" : "Friendly name of the sending email", "type" : "string" }, "filter_profile_equation_json" : { "description" : "File profile equation json", "type" : "string" }, "library_item_oid" : { "description" : "If this item was ever added to the Code Library, this is the oid for that library item, or 0 if never added before. This value is used to determine if a library item should be inserted or updated.", "format" : "int32", "type" : "integer" }, "maximum_enrolled" : { "description" : "The number of maximum customers for the plan are currently enrolled in this flow.", "type" : "boolean" }, "merchant_id" : { "description" : "Merchant ID", "type" : "string" }, "name" : { "description" : "Name of email flow", "maxLength" : 250, "type" : "string" }, "open_rate_formatted" : { "description" : "Open rate of emails, formatted", "type" : "string" }, "revenue_formatted" : { "description" : "Revenue, formatted", "type" : "string" }, "revenue_per_customer_formatted" : { "description" : "Revenue per customer, formatted", "type" : "string" }, "screenshot_large_full_url" : { "description" : "URL to a large full length screenshot", "type" : "string" }, "sms_esp_twilio_uuid" : { "description" : "Twilio Account UUID. Null for none", "type" : "string" }, "sms_phone_number" : { "description" : "Twilio SMS Phone Number. Null for none", "type" : "string" }, "status" : { "description" : "Status of the campaign of draft, archived, active, and inactive", "type" : "string" }, "status_dts" : { "description" : "Timestamp when the last status change happened", "format" : "dateTime", "type" : "string" }, "storefront_oid" : { "description" : "Storefront oid", "format" : "int32", "type" : "integer" }, "trigger_parameter" : { "description" : "Trigger parameter", "type" : "string" }, "trigger_parameter_name" : { "description" : "Trigger parameter name", "type" : "string" }, "trigger_type" : { "description" : "Trigger type", "type" : "string" } }, "type" : "object" }, "EmailFlowBackPopulateRequest" : { "properties" : { "order_days_old" : { "description" : "The age of the orders that should be considered for order triggers.", "format" : "int32", "type" : "integer" }, "relative_to_event" : { "description" : "True if the age of the event should be considered when reducing the initial flow wait step", "type" : "boolean" } }, "type" : "object" }, "EmailFlowBackPopulateResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailFlowFolder" : { "properties" : { "esp_flow_folder_uuid" : { "description" : "Email flow folder UUID", "type" : "string" }, "merchant_id" : { "description" : "Merchant ID", "type" : "string" }, "name" : { "description" : "Name of email flow folder", "maxLength" : 250, "type" : "string" }, "storefront_oid" : { "description" : "Storefront oid", "format" : "int32", "type" : "integer" }, "system_generated" : { "description" : "System generated folder", "type" : "boolean" } }, "type" : "object" }, "EmailFlowFolderResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "flow_folder" : { "$ref" : "#/components/schemas/EmailFlowFolder" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailFlowFoldersResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "flow_folders" : { "items" : { "$ref" : "#/components/schemas/EmailFlowFolder" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailFlowResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "flow" : { "$ref" : "#/components/schemas/EmailFlow" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailFlowsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "flows" : { "items" : { "$ref" : "#/components/schemas/EmailFlow" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailGlobalSettings" : { "properties" : { "dedicated_ip" : { "type" : "boolean" } }, "type" : "object" }, "EmailGlobalSettingsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "global_settings" : { "$ref" : "#/components/schemas/EmailGlobalSettings" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailGlobalUnsubscribeRequest" : { "properties" : { "email" : { "type" : "string" } }, "type" : "object" }, "EmailGlobalUnsubscribeResponse" : { "properties" : { "listsUnsubscribed" : { "format" : "int32", "type" : "integer" } }, "type" : "object" }, "EmailHistogramPropertyNamesResponse" : { "properties" : { "property_names" : { "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "EmailHistogramPropertyValuesResponse" : { "properties" : { "property_values" : { "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "EmailList" : { "properties" : { "allow_csv_download" : { "description" : "True if the current user has the rights to download this list.", "type" : "boolean" }, "created_dts" : { "description" : "Created date", "format" : "dateTime", "type" : "string" }, "deleted" : { "description" : "True if this campaign was deleted", "type" : "boolean" }, "email_list_uuid" : { "description" : "Email list UUID", "type" : "string" }, "esp_list_segment_folder_uuid" : { "description" : "List/Segment folder UUID", "type" : "string" }, "member_count" : { "description" : "Count of members in this list", "format" : "int32", "type" : "integer" }, "merchant_id" : { "description" : "Merchant ID", "type" : "string" }, "name" : { "description" : "Name of email list", "maxLength" : 250, "type" : "string" }, "public_description" : { "description" : "Description of list shown to customer.", "type" : "string" }, "public_list" : { "description" : "True if this list is public", "type" : "boolean" }, "storefront_oid" : { "description" : "Storefront oid", "format" : "int32", "type" : "integer" }, "used_by" : { "description" : "Details on the flows or campaigns that use this list.", "items" : { "$ref" : "#/components/schemas/EmailListSegmentUsedBy" }, "type" : "array" } }, "type" : "object" }, "EmailListArchiveResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "list_in_use" : { "type" : "boolean" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailListCustomer" : { "properties" : { "add_dts" : { "description" : "Added timestamp", "format" : "dateTime", "type" : "string" }, "email" : { "description" : "Email", "type" : "string" }, "email_customer_uuid" : { "description" : "Email customer UUID", "type" : "string" }, "email_list_member_uuid" : { "description" : "Email list member UUID", "type" : "string" } }, "type" : "object" }, "EmailListCustomersResponse" : { "properties" : { "customers" : { "description" : "Customers on the page", "items" : { "$ref" : "#/components/schemas/EmailListCustomer" }, "type" : "array" }, "page_number" : { "description" : "Page number (one based offset)", "format" : "int32", "type" : "integer" }, "page_size" : { "description" : "Number of records per page", "format" : "int32", "type" : "integer" }, "total_customers" : { "description" : "Total customers", "format" : "int32", "type" : "integer" }, "total_pages" : { "description" : "Total number of pages", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "EmailListResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "list" : { "$ref" : "#/components/schemas/EmailList" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailListSegmentFolder" : { "properties" : { "esp_list_segment_folder_uuid" : { "description" : "Email list segment folder UUID", "type" : "string" }, "merchant_id" : { "description" : "Merchant ID", "type" : "string" }, "name" : { "description" : "Name of email campaign folder", "maxLength" : 250, "type" : "string" }, "storefront_oid" : { "description" : "Storefront oid", "format" : "int32", "type" : "integer" }, "system_generated" : { "description" : "System generated folder", "type" : "boolean" } }, "type" : "object" }, "EmailListSegmentFolderResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "list_segment_folder" : { "$ref" : "#/components/schemas/EmailListSegmentFolder" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailListSegmentFoldersResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "list_segment_folders" : { "items" : { "$ref" : "#/components/schemas/EmailListSegmentFolder" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailListSegmentMembership" : { "properties" : { "email_list_uuid" : { "description" : "UUID identifying this email list or null if this is a segment", "type" : "string" }, "email_segment_uuid" : { "description" : "UUID identifying this email segment or null if this is a list", "type" : "string" }, "exclude" : { "description" : "true if customers from this list/segment is excluded from membership", "type" : "boolean" }, "name" : { "description" : "Name of this email list or segment", "type" : "string" } }, "type" : "object" }, "EmailListSegmentUsedBy" : { "properties" : { "email_campaign_uuid" : { "description" : "Email campaign UUID", "type" : "string" }, "email_flow_uuid" : { "description" : "Email flow UUID", "type" : "string" }, "name" : { "description" : "Name of the list or segment.", "type" : "string" } }, "type" : "object" }, "EmailListsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "lists" : { "items" : { "$ref" : "#/components/schemas/EmailList" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailListSubscribeResponse" : { "properties" : { "added" : { "format" : "int32", "type" : "integer" }, "memberCount" : { "format" : "int32", "type" : "integer" } }, "type" : "object" }, "EmailOrder" : { "properties" : { "email" : { "description" : "email", "type" : "string" }, "order_dts" : { "description" : "order_dts", "format" : "dateTime", "type" : "string" }, "order_id" : { "description" : "order_id", "type" : "string" }, "total" : { "$ref" : "#/components/schemas/Currency" } }, "type" : "object" }, "EmailOrdersResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "orders" : { "items" : { "$ref" : "#/components/schemas/EmailOrder" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailPerformance" : { "properties" : { "active_customers" : { "description" : "Active customers. The value will be -1 if calculation is pending.", "format" : "int32", "type" : "integer" }, "actual_customers" : { "description" : "Actual customers that they have regardless of active state. The value will be -1 if calculation is pending.", "format" : "int32", "type" : "integer" }, "bounce_count" : { "description" : "Bounce count", "format" : "int32", "type" : "integer" }, "bounce_percentage" : { "description" : "bounce percentage rate based upon our look back window. This should be under five percent or the account will be paused for sending.", "type" : "number" }, "bounce_percentage_formatted" : { "description" : "bounce percentage rate (formatted) based upon our look back window. This should be under five percent or the account will be paused for sending.", "type" : "string" }, "customer_histogram" : { "$ref" : "#/components/schemas/EmailPerformanceCustomerHistogram" }, "daily_stats" : { "description" : "Daily statistics used for charting", "items" : { "$ref" : "#/components/schemas/EmailPerformanceDaily" }, "type" : "array" }, "delivered_count" : { "description" : "Delivered count", "format" : "int32", "type" : "integer" }, "loyalty_program_type" : { "description" : "Loyalty Program Type", "enum" : [ "disabled", "points", "cashback" ], "type" : "string" }, "max_active_customers" : { "description" : "Maximum active customers allowed under their billing plan", "format" : "int32", "type" : "integer" }, "max_emails_per_day" : { "description" : "Max emails per day", "format" : "int32", "type" : "integer" }, "max_emails_per_hour" : { "description" : "Max emails per hour", "format" : "int32", "type" : "integer" }, "max_emails_per_month" : { "description" : "Max emails per month", "format" : "int32", "type" : "integer" }, "paused_for_spam" : { "description" : "True if campaign/flow emails are paused due to spam complaints.", "type" : "boolean" }, "revenue" : { "description" : "Revenue", "type" : "number" }, "sent_emails_per_day" : { "description" : "Sent emails last 24 hours", "format" : "int32", "type" : "integer" }, "sent_emails_per_hour" : { "description" : "Sent emails last hour", "format" : "int32", "type" : "integer" }, "sent_emails_per_month" : { "description" : "Sent emails last 31 days", "format" : "int32", "type" : "integer" }, "sequence_send_count" : { "description" : "Total sequence (campaign/flow) emails sent", "format" : "int32", "type" : "integer" }, "spam_count" : { "description" : "Spam complaints", "format" : "int32", "type" : "integer" }, "spam_percentage" : { "description" : "Spam percentage rate based upon our look back window. This should be under one half a percent or the account will be paused for sending.", "type" : "number" }, "spam_percentage_formatted" : { "description" : "Spam percentage rate (formatted) based upon our look back window. This should be under one half a percent or the account will be paused for sending.", "type" : "string" }, "transactional_send_count" : { "description" : "Total transactions emails sent", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "EmailPerformanceCustomerHistogram" : { "properties" : { "periods" : { "description" : "Periods (newest to oldest)", "items" : { "$ref" : "#/components/schemas/EmailPerformanceCustomerHistogramPeriod" }, "type" : "array" } }, "type" : "object" }, "EmailPerformanceCustomerHistogramPeriod" : { "properties" : { "active" : { "description" : "Active customers last active in this period", "format" : "int32", "type" : "integer" }, "inactive" : { "description" : "Inactive customers last active in this period", "format" : "int32", "type" : "integer" }, "month" : { "description" : "Month (1 = January)", "format" : "int32", "type" : "integer" }, "total" : { "description" : "Total customers last active in this period", "format" : "int32", "type" : "integer" }, "year" : { "description" : "Year (four digits)", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "EmailPerformanceDaily" : { "properties" : { "bounce_count" : { "description" : "Bounce count", "format" : "int32", "type" : "integer" }, "delivered_count" : { "description" : "Delivered count", "format" : "int32", "type" : "integer" }, "revenue" : { "description" : "Revenue", "type" : "number" }, "sequence_send_count" : { "description" : "Total sequence (campaign/flow) emails sent", "format" : "int32", "type" : "integer" }, "spam_count" : { "description" : "Spam complaints", "format" : "int32", "type" : "integer" }, "stat_dts" : { "description" : "The date that these statistcs are for", "format" : "dateTime", "type" : "string" }, "transactional_send_count" : { "description" : "Total transactions emails sent", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "EmailPerformanceResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "performance" : { "$ref" : "#/components/schemas/EmailPerformance" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailPlan" : { "properties" : { "additional_customers" : { "format" : "int32", "type" : "integer" }, "additional_emails" : { "format" : "int32", "type" : "integer" }, "additional_fee" : { "type" : "number" }, "allow_list_import" : { "type" : "boolean" }, "allow_tracking_emails" : { "type" : "boolean" }, "customer_tiers" : { "items" : { "$ref" : "#/components/schemas/EmailPlanAdditional" }, "type" : "array" }, "initial_sending_limits" : { "format" : "int32", "type" : "integer" }, "plan_customers" : { "format" : "int32", "type" : "integer" }, "plan_emails" : { "format" : "int32", "type" : "integer" }, "plan_name" : { "type" : "string" }, "plan_name_formatted" : { "type" : "string" }, "require_order_within_last_days" : { "format" : "int32", "type" : "integer" }, "revenue_percent" : { "format" : "int32", "type" : "integer" }, "spam_percent_limit" : { "format" : "int32", "type" : "integer" }, "total_customers" : { "format" : "int32", "type" : "integer" }, "total_emails" : { "format" : "int32", "type" : "integer" }, "upgrade_to" : { "format" : "int32", "type" : "integer" } }, "type" : "object" }, "EmailPlanAdditional" : { "properties" : { "active" : { "type" : "boolean" }, "can_downgrade" : { "type" : "boolean" }, "can_upgrade" : { "type" : "boolean" }, "cost" : { "type" : "number" }, "cost_change" : { "type" : "number" }, "cost_change_formatted" : { "type" : "string" }, "cost_formatted" : { "type" : "string" }, "customers" : { "format" : "int32", "type" : "integer" }, "emails" : { "format" : "int32", "type" : "integer" } }, "type" : "object" }, "EmailPlanResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "plan" : { "$ref" : "#/components/schemas/EmailPlan" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailPostcardStat" : { "properties" : { "click_count" : { "description" : "Count of clicked emails", "format" : "int32", "type" : "integer" }, "click_count_formatted" : { "description" : "Count of clicked emails, formatted", "type" : "string" }, "conversion_count" : { "description" : "Count of conversions", "format" : "int32", "type" : "integer" }, "conversion_count_formatted" : { "description" : "Count of conversions, formatted", "type" : "string" }, "delivered_count" : { "description" : "Count of delivered emails", "format" : "int32", "type" : "integer" }, "delivered_count_formatted" : { "description" : "Count of delivered emails, formatted", "type" : "string" }, "merchant_id" : { "description" : "Merchant ID", "type" : "string" }, "name" : { "description" : "List or segment name", "type" : "string" }, "order_count" : { "description" : "Count of orders", "format" : "int32", "type" : "integer" }, "order_count_formatted" : { "description" : "Count of orders, formatted", "type" : "string" }, "profit" : { "description" : "Profit", "type" : "number" }, "profit_formatted" : { "description" : "Profit, formatted", "type" : "string" }, "return_to_sender_count" : { "description" : "Count of return to sender", "format" : "int32", "type" : "integer" }, "return_to_sender_count_formatted" : { "description" : "Count of return to sender, formatted", "type" : "string" }, "revenue" : { "description" : "Revenue", "type" : "number" }, "revenue_formatted" : { "description" : "Revenue, formatted", "type" : "string" }, "send_count" : { "description" : "Count of emails sent", "format" : "int32", "type" : "integer" }, "send_count_formatted" : { "description" : "Count of emails sent, formatted", "type" : "string" }, "skipped_count" : { "description" : "Count of skipped emails", "format" : "int32", "type" : "integer" }, "skipped_count_formatted" : { "description" : "Count of skipped emails, formatted", "type" : "string" }, "spam_count" : { "description" : "Count of emails classified as spam", "format" : "int32", "type" : "integer" }, "spam_count_formatted" : { "description" : "Count of emails classified as spam, formatted", "type" : "string" }, "stat_type" : { "description" : "Campaign, Flow or None (for anything else)", "type" : "string" }, "status" : { "description" : "Status of campaign or flow", "type" : "string" }, "status_dts" : { "description" : "Status dts of campaign or flow", "type" : "string" }, "steps" : { "items" : { "$ref" : "#/components/schemas/EmailPostcardStat" }, "type" : "array" }, "storefront_oid" : { "description" : "Storefront oid", "format" : "int32", "type" : "integer" }, "unsubscribe_count" : { "description" : "Count of emails classified as unsubscribe", "format" : "int32", "type" : "integer" }, "unsubscribe_count_formatted" : { "description" : "Count of emails classified as unsubscribe, formatted", "type" : "string" }, "uuid" : { "description" : "List or segment uuid", "type" : "string" }, "view_count" : { "description" : "Count of views", "format" : "int32", "type" : "integer" }, "view_count_formatted" : { "description" : "Count of views, formatted", "type" : "string" } }, "type" : "object" }, "EmailPostcardTracking" : { "properties" : { "commseq_postcard_uuid" : { "type" : "string" }, "commseq_step_uuid" : { "type" : "string" }, "commseq_uuid" : { "type" : "string" }, "conversion_dts" : { "description" : "Conversion date time.", "format" : "dateTime", "type" : "string" }, "cost" : { "type" : "number" }, "customer_uuid" : { "type" : "string" }, "delivered_dts" : { "description" : "Delivered date time.", "format" : "dateTime", "type" : "string" }, "from_address_line1" : { "type" : "string" }, "from_address_line2" : { "type" : "string" }, "from_city" : { "type" : "string" }, "from_name" : { "type" : "string" }, "from_state" : { "type" : "string" }, "from_zip" : { "type" : "string" }, "mailed_dts" : { "description" : "Mailed date time.", "format" : "dateTime", "type" : "string" }, "order_id" : { "type" : "string" }, "postcard_tracking_uuid" : { "type" : "string" }, "status" : { "type" : "string" }, "submit_dts" : { "description" : "Submit date time.", "format" : "dateTime", "type" : "string" }, "to_address_line1" : { "type" : "string" }, "to_address_line2" : { "type" : "string" }, "to_city" : { "type" : "string" }, "to_name" : { "type" : "string" }, "to_state" : { "type" : "string" }, "to_zip" : { "type" : "string" }, "tracking_description" : { "type" : "string" } }, "type" : "object" }, "EmailPostcardTrackingResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "tracking" : { "$ref" : "#/components/schemas/EmailPostcardTracking" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailRateLimiter" : { "properties" : { "available" : { "format" : "int32", "type" : "integer" }, "limit" : { "format" : "int32", "type" : "integer" }, "name" : { "type" : "string" } }, "type" : "object" }, "EmailRateLimitersResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "rate_limiters" : { "items" : { "$ref" : "#/components/schemas/EmailRateLimiter" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailSegment" : { "properties" : { "allow_csv_download" : { "description" : "True if the current user has the rights to download this segment.", "type" : "boolean" }, "allow_facebook_audiences" : { "description" : "True if this StoreFront has the Facebook Analytics app connected and supports them", "type" : "boolean" }, "created_dts" : { "description" : "Created date", "format" : "dateTime", "type" : "string" }, "deleted" : { "description" : "True if this campaign was deleted", "type" : "boolean" }, "email_segment_uuid" : { "description" : "Email segment UUID", "type" : "string" }, "esp_list_segment_folder_uuid" : { "description" : "List/Segment folder UUID", "type" : "string" }, "facebook_custom_audience" : { "description" : "True if you want to sync to a facebook custom audience", "type" : "boolean" }, "filter_profile_equation_json" : { "description" : "File profile equation json", "type" : "string" }, "member_count" : { "description" : "Count of members in this segment", "format" : "int32", "type" : "integer" }, "merchant_id" : { "description" : "Merchant ID", "type" : "string" }, "name" : { "description" : "Name of email segment", "maxLength" : 250, "type" : "string" }, "rank_json" : { "description" : "Rank settings json", "type" : "string" }, "rebuild_percentage" : { "description" : "Percentage of completion for a rebuild. The value range will be 0-1. Multiply by 100 to format for display.", "type" : "number" }, "rebuild_required" : { "description" : "True if a rebuild is required because some part of the segment has changed", "type" : "boolean" }, "storefront_oid" : { "description" : "Storefront oid", "format" : "int32", "type" : "integer" }, "thirdparty_join_add_tags" : { "description" : "Third party provider tags to add when a customer joins the segment.", "items" : { "type" : "string" }, "type" : "array" }, "thirdparty_join_remove_tags" : { "description" : "Third party provider tags to remove when a customer joins the segment.", "items" : { "type" : "string" }, "type" : "array" }, "thirdparty_leave_add_tags" : { "description" : "Third party provider tags to add when a customer leaves the segment.", "items" : { "type" : "string" }, "type" : "array" }, "thirdparty_leave_remove_tags" : { "description" : "Third party provider tags to remove when a customer leaves the segment.", "items" : { "type" : "string" }, "type" : "array" }, "thirdparty_list_id" : { "description" : "List id of third party provider to sync with.", "type" : "string" }, "thirdparty_provider_name" : { "description" : "Name of third party provider to sync segment to a list with.", "type" : "string" }, "used_by" : { "description" : "Details on the flows or campaigns that use this list.", "items" : { "$ref" : "#/components/schemas/EmailListSegmentUsedBy" }, "type" : "array" } }, "type" : "object" }, "EmailSegmentArchiveResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "segment_in_use" : { "type" : "boolean" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailSegmentCustomer" : { "properties" : { "add_dts" : { "description" : "Added timestamp", "format" : "dateTime", "type" : "string" }, "email" : { "description" : "Email", "type" : "string" }, "email_customer_uuid" : { "description" : "Email customer UUID", "type" : "string" }, "email_segment_member_uuid" : { "description" : "Email segment member UUID", "type" : "string" } }, "type" : "object" }, "EmailSegmentCustomersResponse" : { "properties" : { "customers" : { "description" : "Customers on the page", "items" : { "$ref" : "#/components/schemas/EmailSegmentCustomer" }, "type" : "array" }, "page_number" : { "description" : "Page number (one based offset)", "format" : "int32", "type" : "integer" }, "page_size" : { "description" : "Number of records per page", "format" : "int32", "type" : "integer" }, "total_customers" : { "description" : "Total customers", "format" : "int32", "type" : "integer" }, "total_pages" : { "description" : "Total number of pages", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "EmailSegmentDownloadPrepareResponse" : { "properties" : { "email_segment_rebuild_uuid" : { "type" : "string" }, "email_segment_uuid" : { "type" : "string" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "percentage_complete" : { "type" : "number" }, "proceed" : { "type" : "boolean" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailSegmentResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "segment" : { "$ref" : "#/components/schemas/EmailSegment" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailSegmentsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "segments" : { "items" : { "$ref" : "#/components/schemas/EmailSegment" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailSendingDomainResponse" : { "properties" : { "domain" : { "$ref" : "#/components/schemas/EmailDomain" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailSendingDomainsResponse" : { "properties" : { "domains" : { "items" : { "$ref" : "#/components/schemas/EmailDomain" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailSettings" : { "properties" : { "emails_per_day" : { "description" : "Emails per day allowed", "format" : "int32", "type" : "integer" }, "emails_per_hour" : { "description" : "Emails per hour allowed", "format" : "int32", "type" : "integer" }, "emails_per_month" : { "description" : "Emails per month allowed", "format" : "int32", "type" : "integer" }, "marketing_esp_domain_user" : { "type" : "string" }, "marketing_esp_domain_uuid" : { "type" : "string" }, "marketing_esp_friendly_name" : { "type" : "string" }, "postcard_from_address1" : { "type" : "string" }, "postcard_from_address2" : { "type" : "string" }, "postcard_from_city" : { "type" : "string" }, "postcard_from_name" : { "type" : "string" }, "postcard_from_postal_code" : { "type" : "string" }, "postcard_from_state" : { "type" : "string" }, "require_order_within_last" : { "description" : "Require order within last", "format" : "int32", "type" : "integer" }, "reviews_io_configured" : { "description" : "True if the Reviews.io integration is configured", "type" : "boolean" }, "sms_esp_twilio_uuid" : { "type" : "string" }, "sms_phone_number" : { "type" : "string" }, "transactional_esp_domain_user" : { "type" : "string" }, "transactional_esp_domain_uuid" : { "type" : "string" }, "transactional_esp_friendly_name" : { "type" : "string" } }, "type" : "object" }, "EmailSettingsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "settings" : { "$ref" : "#/components/schemas/EmailSettings" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailSmsOrder" : { "properties" : { "email" : { "description" : "email", "type" : "string" }, "order_dts" : { "description" : "order_dts", "format" : "dateTime", "type" : "string" }, "order_id" : { "description" : "order_id", "type" : "string" }, "total" : { "$ref" : "#/components/schemas/Currency" } }, "type" : "object" }, "EmailSmsOrdersResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "orders" : { "items" : { "$ref" : "#/components/schemas/EmailSmsOrder" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailSmsStat" : { "properties" : { "click_count" : { "description" : "Count of clicked emails", "format" : "int32", "type" : "integer" }, "click_count_formatted" : { "description" : "Count of clicked emails, formatted", "type" : "string" }, "conversion_count" : { "description" : "Count of conversions", "format" : "int32", "type" : "integer" }, "conversion_count_formatted" : { "description" : "Count of conversions, formatted", "type" : "string" }, "deleted" : { "description" : "True if campaign/flow has been archived", "type" : "boolean" }, "delivered_count" : { "description" : "Count of delivered emails", "format" : "int32", "type" : "integer" }, "delivered_count_formatted" : { "description" : "Count of delivered emails, formatted", "type" : "string" }, "merchant_id" : { "description" : "Merchant ID", "type" : "string" }, "name" : { "description" : "List or segment name", "type" : "string" }, "order_count" : { "description" : "Count of orders", "format" : "int32", "type" : "integer" }, "order_count_formatted" : { "description" : "Count of orders, formatted", "type" : "string" }, "profit" : { "description" : "Profit", "type" : "number" }, "profit_formatted" : { "description" : "Profit, formatted", "type" : "string" }, "revenue" : { "description" : "Revenue", "type" : "number" }, "revenue_formatted" : { "description" : "Revenue, formatted", "type" : "string" }, "send_count" : { "description" : "Count of emails sent", "format" : "int32", "type" : "integer" }, "send_count_formatted" : { "description" : "Count of emails sent, formatted", "type" : "string" }, "skipped_count" : { "description" : "Count of skipped emails", "format" : "int32", "type" : "integer" }, "skipped_count_formatted" : { "description" : "Count of skipped emails, formatted", "type" : "string" }, "stat_type" : { "description" : "Campaign, Flow or None (for anything else)", "type" : "string" }, "status" : { "description" : "Status of campaign or flow", "type" : "string" }, "status_dts" : { "description" : "Status dts of campaign or flow", "type" : "string" }, "step_uuid" : { "description" : "Step UUID if the statistics are at the step/email level", "type" : "string" }, "steps" : { "items" : { "$ref" : "#/components/schemas/EmailSmsStat" }, "type" : "array" }, "storefront_oid" : { "description" : "Storefront oid", "format" : "int32", "type" : "integer" }, "unsubscribe_count" : { "description" : "Count of emails classified as unsubscribe", "format" : "int32", "type" : "integer" }, "unsubscribe_count_formatted" : { "description" : "Count of emails classified as unsubscribe, formatted", "type" : "string" }, "uuid" : { "description" : "List/Segment uuid, or Flow/Campaign uuid depending on level of stat aggregation.", "type" : "string" }, "view_count" : { "description" : "Count of views", "format" : "int32", "type" : "integer" }, "view_count_formatted" : { "description" : "Count of views, formatted", "type" : "string" } }, "type" : "object" }, "EmailStat" : { "properties" : { "click_count" : { "description" : "Count of clicked emails", "format" : "int32", "type" : "integer" }, "click_count_formatted" : { "description" : "Count of clicked emails, formatted", "type" : "string" }, "conversion_count" : { "description" : "Count of conversions", "format" : "int32", "type" : "integer" }, "conversion_count_formatted" : { "description" : "Count of conversions, formatted", "type" : "string" }, "deleted" : { "description" : "True if campaign/flow has been archived", "type" : "boolean" }, "delivered_count" : { "description" : "Count of delivered emails", "format" : "int32", "type" : "integer" }, "delivered_count_formatted" : { "description" : "Count of delivered emails, formatted", "type" : "string" }, "kickbox_count" : { "description" : "Count of emails kicked", "format" : "int32", "type" : "integer" }, "kickbox_count_formatted" : { "description" : "Count of emails kicked, formatted", "type" : "string" }, "merchant_id" : { "description" : "Merchant ID", "type" : "string" }, "name" : { "description" : "List or segment name", "type" : "string" }, "open_count" : { "description" : "Count of opened emails", "format" : "int32", "type" : "integer" }, "open_count_formatted" : { "description" : "Count of opened emails, formatted", "type" : "string" }, "order_count" : { "description" : "Count of orders", "format" : "int32", "type" : "integer" }, "order_count_formatted" : { "description" : "Count of orders, formatted", "type" : "string" }, "permanent_bounce_count" : { "description" : "Count of emails permanently bounced", "format" : "int32", "type" : "integer" }, "permanent_bounce_count_formatted" : { "description" : "Count of emails permanently bounced, formatted", "type" : "string" }, "profit" : { "description" : "Profit", "type" : "number" }, "profit_formatted" : { "description" : "Profit, formatted", "type" : "string" }, "revenue" : { "description" : "Revenue", "type" : "number" }, "revenue_formatted" : { "description" : "Revenue, formatted", "type" : "string" }, "send_count" : { "description" : "Count of emails sent", "format" : "int32", "type" : "integer" }, "send_count_formatted" : { "description" : "Count of emails sent, formatted", "type" : "string" }, "skipped_count" : { "description" : "Count of skipped emails", "format" : "int32", "type" : "integer" }, "skipped_count_formatted" : { "description" : "Count of skipped emails, formatted", "type" : "string" }, "spam_count" : { "description" : "Count of emails classified as spam", "format" : "int32", "type" : "integer" }, "spam_count_formatted" : { "description" : "Count of emails classified as spam, formatted", "type" : "string" }, "stat_type" : { "description" : "Campaign, Flow or None (for anything else)", "type" : "string" }, "status" : { "description" : "Status of campaign or flow", "type" : "string" }, "status_dts" : { "description" : "Status dts of campaign or flow", "type" : "string" }, "step_uuid" : { "description" : "Step UUID if the statistics are at the step/email level", "type" : "string" }, "steps" : { "items" : { "$ref" : "#/components/schemas/EmailStat" }, "type" : "array" }, "storefront_oid" : { "description" : "Storefront oid", "format" : "int32", "type" : "integer" }, "unsubscribe_count" : { "description" : "Count of emails classified as unsubscribe", "format" : "int32", "type" : "integer" }, "unsubscribe_count_formatted" : { "description" : "Count of emails classified as unsubscribe, formatted", "type" : "string" }, "uuid" : { "description" : "List/Segment uuid, or Flow/Campaign uuid depending on level of stat aggregation.", "type" : "string" }, "view_count" : { "description" : "Count of views", "format" : "int32", "type" : "integer" }, "view_count_formatted" : { "description" : "Count of views, formatted", "type" : "string" } }, "type" : "object" }, "EmailStatPostcardSummaryRequest" : { "properties" : { "commseq_postcard_uuids" : { "items" : { "type" : "string" }, "type" : "array" }, "days" : { "format" : "int32", "type" : "integer" } }, "type" : "object" }, "EmailStatPostcardSummaryResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "stats" : { "items" : { "$ref" : "#/components/schemas/EmailPostcardStat" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailStatSmsSummaryRequest" : { "properties" : { "commseq_step_uuids" : { "items" : { "type" : "string" }, "type" : "array" }, "days" : { "format" : "int32", "type" : "integer" } }, "type" : "object" }, "EmailStatSmsSummaryResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "stats" : { "items" : { "$ref" : "#/components/schemas/EmailSmsStat" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailStatSummaryRequest" : { "properties" : { "commseq_email_uuids" : { "items" : { "type" : "string" }, "type" : "array" }, "commseq_step_uuids" : { "items" : { "type" : "string" }, "type" : "array" }, "days" : { "format" : "int32", "type" : "integer" } }, "type" : "object" }, "EmailStatSummaryResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "stats" : { "items" : { "$ref" : "#/components/schemas/EmailStat" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailStepStat" : { "properties" : { "left_click_count" : { "description" : "click count (left side)", "format" : "int32", "type" : "integer" }, "left_click_count_formatted" : { "description" : "click count formatted (left side)", "type" : "string" }, "left_conversion_count" : { "description" : "conversion count (left/default side)", "format" : "int32", "type" : "integer" }, "left_conversion_count_formatted" : { "description" : "conversion count formatted (left/default side)", "type" : "string" }, "left_customer_count" : { "description" : "customer count (left/default side)", "format" : "int32", "type" : "integer" }, "left_customer_count_formatted" : { "description" : "customer count formatted (left/default side)", "type" : "string" }, "left_delivered_count" : { "description" : "delivered count (left side)", "format" : "int32", "type" : "integer" }, "left_delivered_count_formatted" : { "description" : "delivered count formatted (left side)", "type" : "string" }, "left_order_count" : { "description" : "order count (left/default side)", "format" : "int32", "type" : "integer" }, "left_order_count_formatted" : { "description" : "order count formatted (left/default side)", "type" : "string" }, "left_profit" : { "description" : "profit (left/default side)", "type" : "number" }, "left_profit_formatted" : { "description" : "profit formatted (left/default side)", "type" : "string" }, "left_revenue" : { "description" : "revenue (left/default side)", "type" : "number" }, "left_revenue_formatted" : { "description" : "revenue formatted (left/default side)", "type" : "string" }, "left_send_count" : { "description" : "send count (left side)", "format" : "int32", "type" : "integer" }, "left_send_count_formatted" : { "description" : "send count formatted (left side)", "type" : "string" }, "left_skipped_count" : { "description" : "conversion count (left side)", "format" : "int32", "type" : "integer" }, "left_skipped_count_formatted" : { "description" : "skipped count formatted (left side)", "type" : "string" }, "left_unsubscribe_count" : { "description" : "unsubscribe count (left side)", "format" : "int32", "type" : "integer" }, "left_unsubscribe_count_formatted" : { "description" : "unsubscribe count formatted (left side)", "type" : "string" }, "right_conversion_count" : { "description" : "conversion count (right side)", "format" : "int32", "type" : "integer" }, "right_conversion_count_formatted" : { "description" : "conversion count formatted (right side)", "type" : "string" }, "right_customer_count" : { "description" : "customer count (right side)", "format" : "int32", "type" : "integer" }, "right_customer_count_formatted" : { "description" : "customer count formatted (right side)", "type" : "string" }, "right_order_count" : { "description" : "order count (right side)", "format" : "int32", "type" : "integer" }, "right_order_count_formatted" : { "description" : "order count formatted (right side)", "type" : "string" }, "right_profit" : { "description" : "profit (right side)", "type" : "number" }, "right_profit_formatted" : { "description" : "profit formatted (right side)", "type" : "string" }, "right_revenue" : { "description" : "revenue (right side)", "type" : "number" }, "right_revenue_formatted" : { "description" : "revenue formatted (right side)", "type" : "string" } }, "type" : "object" }, "EmailStepStatRequest" : { "properties" : { "commseq_step_uuids" : { "items" : { "type" : "string" }, "type" : "array" }, "days" : { "format" : "int32", "type" : "integer" } }, "type" : "object" }, "EmailStepStatResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "stats" : { "items" : { "$ref" : "#/components/schemas/EmailStepStat" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailStepWaitingRequest" : { "properties" : { "commseq_step_uuids" : { "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "EmailStepWaitingResponse" : { "properties" : { "step_waitings" : { "items" : { "$ref" : "#/components/schemas/StepWaiting" }, "type" : "array" } }, "type" : "object" }, "EmailTemplate" : { "properties" : { "container_cjson" : { "description" : "Container cjson", "type" : "string" }, "description" : { "description" : "Description of email template", "type" : "string" }, "email_template_oid" : { "description" : "Email template oid", "format" : "int32", "type" : "integer" }, "email_template_vm_path" : { "description" : "Email Template VM Path", "type" : "string" }, "merchant_id" : { "description" : "Merchant ID", "type" : "string" }, "name" : { "description" : "Name of email template", "maxLength" : 250, "type" : "string" }, "preview_amazon_listing_key" : { "description" : "Amazon key for preview png image", "maxLength" : 250, "type" : "string" }, "sort_order" : { "description" : "Sort order (optional)", "format" : "int32", "type" : "integer" }, "storefront_oid" : { "description" : "StoreFront oid", "format" : "int32", "type" : "integer" }, "system" : { "description" : "True if this email template is system-wide,false if merchant specific", "type" : "boolean" }, "trigger_type" : { "description" : "Trigger type", "maxLength" : 100, "type" : "string" } }, "type" : "object" }, "EmailTemplatesResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "templates" : { "items" : { "$ref" : "#/components/schemas/EmailTemplate" }, "type" : "array" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailThirdPartyList" : { "properties" : { "id" : { "description" : "id", "type" : "string" }, "name" : { "description" : "name", "type" : "string" } }, "type" : "object" }, "EmailThirdPartyListImportRequest" : { "properties" : { "providers" : { "description" : "providers", "items" : { "$ref" : "#/components/schemas/EmailThirdPartyProvider" }, "type" : "array" } }, "type" : "object" }, "EmailThirdPartyProvider" : { "properties" : { "connect_url" : { "description" : "URL to the settings screen to connect. Null if the provider is already connected.", "type" : "string" }, "list_count" : { "description" : "list_count", "format" : "int32", "type" : "integer" }, "lists" : { "description" : "lists", "items" : { "$ref" : "#/components/schemas/EmailThirdPartyList" }, "type" : "array" }, "logo_url" : { "description" : "logo_url", "type" : "string" }, "name" : { "description" : "name", "type" : "string" }, "supports_add_tags" : { "description" : "True if this provider can support adding tags", "type" : "boolean" }, "supports_list_subscribe" : { "description" : "True if this provider can support list subscribe", "type" : "boolean" }, "supports_list_unsubscribe" : { "description" : "True if this provider can support list unsubscribe", "type" : "boolean" }, "supports_remove_tags" : { "description" : "True if this provider can support remove tags", "type" : "boolean" }, "tag_count" : { "description" : "tag_count", "format" : "int32", "type" : "integer" }, "tags" : { "description" : "tags", "items" : { "$ref" : "#/components/schemas/EmailThirdPartyTag" }, "type" : "array" } }, "type" : "object" }, "EmailThirdPartyProvidersResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "providers" : { "items" : { "$ref" : "#/components/schemas/EmailThirdPartyProvider" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailThirdPartyTag" : { "properties" : { "id" : { "description" : "id", "type" : "string" }, "name" : { "description" : "name", "type" : "string" } }, "type" : "object" }, "EmailVerifyTokenRequest" : { "properties" : { "email" : { "description" : "email", "type" : "string" }, "password" : { "description" : "password", "type" : "string" } }, "type" : "object" }, "EmailVerifyTokenResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "token" : { "description" : "token", "type" : "string" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailVerifyTokenValidateRequest" : { "properties" : { "token" : { "description" : "token", "type" : "string" } }, "type" : "object" }, "EmailVerifyTokenValidateResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "EmailWebhookEditorValuesResponse" : { "properties" : { "available_expansions" : { "items" : { "type" : "string" }, "type" : "array" }, "available_tokens" : { "items" : { "type" : "string" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "rest_object_type" : { "type" : "string" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "Error" : { "properties" : { "developer_message" : { "description" : "A technical message meant to be read by a developer", "type" : "string" }, "error_code" : { "description" : "HTTP status code", "type" : "string" }, "more_info" : { "description" : "Additional information often a link to additional documentation", "type" : "string" }, "object_id" : { "description" : "Object id that the error is associated with", "type" : "string" }, "user_message" : { "description" : "An end-user friendly message suitable for display to the customer", "type" : "string" } }, "type" : "object" }, "ErrorResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "Experiment" : { "properties" : { "container_id" : { "description" : "Contained ID where the experiment element was located", "type" : "string" }, "duration_days" : { "description" : "Duration in days", "format" : "int32", "type" : "integer" }, "end_dts" : { "description" : "End date/time", "format" : "dateTime", "type" : "string" }, "equal_weighting" : { "description" : "Whether or not traffic is equally weighted or shifts over time during the experiment", "type" : "boolean" }, "experiment_type" : { "description" : "The type of experiment", "type" : "string" }, "id" : { "description" : "Experiment id", "type" : "string" }, "name" : { "description" : "Experiment name", "type" : "string" }, "notes" : { "description" : "Notes about the experiment", "type" : "string" }, "objective" : { "description" : "Objective that is being optimized", "type" : "string" }, "objective_parameter" : { "description" : "Objective parameter (such as event name) that is being optimized", "type" : "string" }, "openai_current_iteration" : { "description" : "The current iteration of the OpenAI related experiment", "format" : "int32", "type" : "integer" }, "openai_element_type" : { "description" : "The type of OpenAI element being experimented on", "enum" : [ "headline", "text", "textblock" ], "type" : "string" }, "openai_model" : { "description" : "The type of OpenAI model used", "type" : "string" }, "openai_total_iterations" : { "description" : "The total number of iterations to perform on the experiment", "format" : "int32", "type" : "integer" }, "optimization_type" : { "description" : "Type of optimization", "type" : "string" }, "p95_sessions_needed" : { "description" : "Estimated sessions needed to achieve P95", "format" : "int32", "type" : "integer" }, "p_value" : { "description" : "Statistics p-value for the experiment", "type" : "number" }, "session_count" : { "description" : "Total number of sessions in the experiment", "format" : "int32", "type" : "integer" }, "start_dts" : { "description" : "Start date/time", "format" : "dateTime", "type" : "string" }, "status" : { "description" : "Status of the experiment", "enum" : [ "Running", "Ended", "Deleted" ], "type" : "string" }, "storefront_experiment_oid" : { "description" : "Storefront Experiment Oid", "format" : "int32", "type" : "integer" }, "storefront_oid" : { "description" : "Storefront oid", "format" : "int32", "type" : "integer" }, "uri" : { "description" : "URI the experiment was started on", "type" : "string" }, "variations" : { "description" : "Variations being tested in the experiment", "items" : { "$ref" : "#/components/schemas/ExperimentVariation" }, "type" : "array" } }, "type" : "object" }, "ExperimentResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "experiment" : { "$ref" : "#/components/schemas/Experiment" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ExperimentsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "experiments" : { "items" : { "$ref" : "#/components/schemas/Experiment" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ExperimentVariation" : { "properties" : { "add_to_cart_count" : { "description" : "Total add to cart count for this variation", "format" : "int32", "type" : "integer" }, "average_duration_seconds" : { "description" : "Average duration seconds per session for this variation", "format" : "int32", "type" : "integer" }, "average_objective_per_session" : { "description" : "Average objective value per session for this variation", "type" : "number" }, "average_order_value" : { "description" : "Average order value for this variation", "type" : "number" }, "bounce_count" : { "description" : "Total bounce count for this variation", "format" : "int32", "type" : "integer" }, "conversion_rate" : { "description" : "Conversion rate for this variation", "type" : "number" }, "daily_statistics" : { "description" : "Array of daily statistics for this variation", "items" : { "$ref" : "#/components/schemas/ExperimentVariationStat" }, "type" : "array" }, "duration_seconds_sum" : { "description" : "Total number of seconds spent on the site for this variation", "format" : "int64", "type" : "integer" }, "event_count" : { "description" : "Total event ocunt for this variation", "format" : "int32", "type" : "integer" }, "initiate_checkout_count" : { "description" : "Total initiate checkout count for this variation", "format" : "int32", "type" : "integer" }, "order_count" : { "description" : "Total order count for this variation", "format" : "int32", "type" : "integer" }, "order_item_count" : { "description" : "Total order item count for this variation", "format" : "int32", "type" : "integer" }, "original_traffic_percentage" : { "description" : "Percentage of the traffic the variation originally started out with", "type" : "number" }, "page_view_count" : { "description" : "Total page view count for this variation", "format" : "int32", "type" : "integer" }, "paused" : { "description" : "True if traffic should be paused to this variation", "type" : "boolean" }, "revenue" : { "description" : "Total revenue for this variation", "type" : "number" }, "session_count" : { "description" : "Total sessions for this variation", "format" : "int32", "type" : "integer" }, "sms_opt_ins" : { "description" : "SMS Opt Ins for this variation", "format" : "int32", "type" : "integer" }, "traffic_percentage" : { "description" : "Percentage of the traffic this variation is currently receiving", "type" : "number" }, "url" : { "description" : "Url of the variation if this experiment is a url experiment.", "type" : "string" }, "variation_name" : { "description" : "Name of the variation", "type" : "string" }, "variation_number" : { "description" : "Variation number", "format" : "int32", "type" : "integer" }, "winner" : { "description" : "True if this variation has been declared the winner", "type" : "boolean" } }, "type" : "object" }, "ExperimentVariationStat" : { "properties" : { "add_to_cart_count" : { "description" : "Total add to cart count for this variation", "format" : "int32", "type" : "integer" }, "bounce_count" : { "description" : "Total bounce count for this variation", "format" : "int32", "type" : "integer" }, "duration_seconds_sum" : { "description" : "Total number of seconds spent on the site for this variation", "format" : "int64", "type" : "integer" }, "event_count" : { "description" : "Total event count for this variation", "format" : "int32", "type" : "integer" }, "initiate_checkout_count" : { "description" : "Total initiate checkout count for this variation", "format" : "int32", "type" : "integer" }, "order_count" : { "description" : "Total order count for this variation", "format" : "int32", "type" : "integer" }, "order_ids" : { "description" : "Order ID thats converted on this variation", "items" : { "type" : "string" }, "type" : "array" }, "order_item_count" : { "description" : "Total order item count for this variation", "format" : "int32", "type" : "integer" }, "page_view_count" : { "description" : "Total page view count for this variation", "format" : "int32", "type" : "integer" }, "revenue" : { "description" : "Total revenue for this variation", "type" : "number" }, "session_count" : { "description" : "Total sessions for this variation", "format" : "int32", "type" : "integer" }, "sms_opt_in_count" : { "description" : "Total SMS opt in count for this variation", "format" : "int32", "type" : "integer" }, "stat_dts" : { "description" : "Date/time that the statistic was created", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "FileManagerDirectory" : { "properties" : { "active_theme_directory" : { "type" : "boolean" }, "favorite" : { "type" : "boolean" }, "hostname" : { "type" : "string" }, "icon" : { "type" : "string" }, "last_modified" : { "type" : "string" }, "name" : { "type" : "string" }, "parent_storefront_fs_directory_oid" : { "format" : "int32", "type" : "integer" }, "part_of_active_theme" : { "type" : "boolean" }, "selected" : { "type" : "boolean" }, "storefront_fs_directory_oid" : { "format" : "int32", "type" : "integer" }, "storefront_fs_file_oid" : { "format" : "int32", "type" : "integer" }, "storefront_oid" : { "format" : "int32", "type" : "integer" }, "type" : { "type" : "string" } }, "type" : "object" }, "FileManagerFile" : { "properties" : { "favorite" : { "type" : "boolean" }, "hostname" : { "type" : "string" }, "i18n_violation" : { "type" : "boolean" }, "icon" : { "type" : "string" }, "internal_version" : { "format" : "int32", "type" : "integer" }, "last_modified" : { "type" : "string" }, "merge_conflict" : { "type" : "boolean" }, "name" : { "type" : "string" }, "parent_storefront_fs_directory_oid" : { "format" : "int32", "type" : "integer" }, "part_of_active_theme" : { "type" : "boolean" }, "path" : { "type" : "string" }, "raw_size" : { "format" : "int32", "type" : "integer" }, "selected" : { "type" : "boolean" }, "size" : { "type" : "string" }, "storefront_fs_directory_oid" : { "format" : "int32", "type" : "integer" }, "storefront_fs_file_oid" : { "format" : "int32", "type" : "integer" }, "storefront_oid" : { "format" : "int32", "type" : "integer" }, "thumbnail_16_url" : { "description" : "CDN thumbnail 16x16 size", "type" : "string" }, "thumbnail_32_url" : { "description" : "CDN thumbnail 32x32 size", "type" : "string" }, "thumbnail_64_url" : { "description" : "CDN thumbnail 64x64 size", "type" : "string" }, "type" : { "type" : "string" }, "valid_velocity" : { "type" : "string" } }, "type" : "object" }, "FileManagerPage" : { "properties" : { "current_storefront_fs_directory_oid" : { "format" : "int32", "type" : "integer" }, "directories" : { "items" : { "$ref" : "#/components/schemas/FileManagerDirectory" }, "type" : "array" }, "files" : { "items" : { "$ref" : "#/components/schemas/FileManagerFile" }, "type" : "array" }, "hostname" : { "type" : "string" }, "parent_storefront_fs_directory_oid" : { "format" : "int32", "type" : "integer" }, "path" : { "type" : "string" }, "path_list" : { "items" : { "$ref" : "#/components/schemas/FileManagerDirectory" }, "type" : "array" }, "storefront_oid" : { "format" : "int32", "type" : "integer" } }, "type" : "object" }, "FileManagerPageResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "file_manager_page" : { "$ref" : "#/components/schemas/FileManagerPage" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "FileManagerUploadRequest" : { "properties" : { "filename" : { "type" : "string" }, "key" : { "type" : "string" }, "parent_storefront_fs_directory_oid" : { "format" : "int32", "type" : "integer" } }, "type" : "object" }, "FileManagerUploadUrlResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "key" : { "type" : "string" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "url" : { "type" : "string" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "FulfillmentInventory" : { "properties" : { "itemId" : { "type" : "string" }, "quantity" : { "type" : "number" } }, "type" : "object" }, "FulfillmentShipment" : { "properties" : { "fulfillment_fee" : { "description" : "Fees charged by the fulfillment company other than the shipping cost to process the order.", "type" : "number" }, "order_id" : { "description" : "Order ID that was shipped", "type" : "string" }, "package_cost" : { "description" : "The cost of the packaging used to sent this shipment", "type" : "number" }, "shipping_cost" : { "description" : "The actual total cost of shipping this order", "type" : "number" }, "tracking_numbers" : { "description" : "Tracking numbers associated with the shipment", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "GeocodeRequest" : { "properties" : { "address" : { "description" : "address", "type" : "string" }, "city" : { "description" : "city", "type" : "string" }, "country_code" : { "description" : "country_code", "type" : "string" }, "postal_code" : { "description" : "postal_code", "type" : "string" }, "state" : { "description" : "state", "type" : "string" } }, "type" : "object" }, "GeocodeResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "latitude" : { "type" : "number" }, "longitude" : { "type" : "number" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "GeoPoint" : { "properties" : { "lat" : { "type" : "number" }, "lon" : { "type" : "number" } }, "type" : "object" }, "GiftCertificate" : { "properties" : { "activated" : { "description" : "True if this gift certificate is activated and ready to apply to purchases.", "type" : "boolean" }, "code" : { "description" : "The code used by the customer to purchase against this gift certificate.", "type" : "string" }, "customer_profile_oid" : { "description" : "This is the customer profile oid associated with this internally managed gift certificate.", "format" : "int32", "type" : "integer" }, "deleted" : { "description" : "True if this gift certificate was deleted.", "type" : "boolean" }, "email" : { "description" : "Email of the customer associated with this gift certificate.", "maxLength" : 100, "type" : "string" }, "expiration_dts" : { "description" : "Expiration date time.", "format" : "dateTime", "type" : "string" }, "gift_certificate_oid" : { "description" : "Gift certificate oid.", "format" : "int32", "type" : "integer" }, "internal" : { "description" : "This is an internally managed gift certificate associated with the loyalty cash rewards program.", "type" : "boolean" }, "ledger_entries" : { "description" : "A list of all ledger activity for this gift certificate.", "items" : { "$ref" : "#/components/schemas/GiftCertificateLedgerEntry" }, "type" : "array" }, "merchant_id" : { "description" : "Merchant Id", "type" : "string" }, "merchant_note" : { "description" : "A list of all ledger activity for this gift certificate.", "type" : "string" }, "original_balance" : { "description" : "Original balance of the gift certificate.", "type" : "number" }, "reference_order_id" : { "description" : "The order used to purchase this gift certificate. This value is ONLY set during checkout when a certificate is purchased, not when it is used. Any usage is recorded in the ledger", "type" : "string" }, "remaining_balance" : { "description" : "The remaining balance on the gift certificate. This is never set directly, but calculated from the ledger. To change the remaining balance, add a ledger entry.", "type" : "number" } }, "type" : "object" }, "GiftCertificateCreateRequest" : { "properties" : { "amount" : { "description" : "Initial amount of this gift certificate.", "type" : "number" }, "email" : { "description" : "The email address (customer/owner) associated with this gift certificate.", "type" : "string" }, "expiration_dts" : { "description" : "Expiration date time.", "format" : "dateTime", "type" : "string" }, "initial_ledger_description" : { "description" : "A brief description of how and/or why this gift certificate was created.", "type" : "string" }, "merchant_note" : { "description" : "Any internal details you wish to record about this gift certificate.", "type" : "string" } }, "type" : "object" }, "GiftCertificateLedgerEntry" : { "properties" : { "amount" : { "description" : "The amount of the activity.", "type" : "number" }, "description" : { "description" : "Description of what this ledger entry is used.", "maxLength" : 50, "type" : "string" }, "entry_dts" : { "description" : "Date time of this ledger activity.", "format" : "dateTime", "type" : "string" }, "gift_certificate_ledger_oid" : { "description" : "Gift certificate ledger oid is a primary key for this object, used internally.", "format" : "int32", "type" : "integer" }, "gift_certificate_oid" : { "description" : "Gift certificate oid.", "format" : "int32", "type" : "integer" }, "reference_order_id" : { "description" : "The order id if this gift certificate was used as part of the payment.", "type" : "string" } }, "type" : "object" }, "GiftCertificateQuery" : { "properties" : { "code" : { "description" : "Gift certificate code", "type" : "string" }, "email" : { "description" : "Email address of this gift certificate", "type" : "string" }, "expiration_dts_end" : { "description" : "Expiration date end", "format" : "dateTime", "type" : "string" }, "expiration_dts_start" : { "description" : "Expiration date start", "format" : "dateTime", "type" : "string" }, "original_balance_end" : { "description" : "Original balance end", "type" : "number" }, "original_balance_start" : { "description" : "Original balance start", "type" : "number" }, "reference_order_id" : { "description" : "Gift certificate reference order id", "type" : "string" }, "remaining_balance_end" : { "description" : "Remaining balance end", "type" : "number" }, "remaining_balance_start" : { "description" : "Remaining balance start", "type" : "number" } }, "type" : "object" }, "GiftCertificateResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "gift_certificate" : { "$ref" : "#/components/schemas/GiftCertificate" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "GiftCertificatesResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "gift_certificates" : { "items" : { "$ref" : "#/components/schemas/GiftCertificate" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "Group" : { "properties" : { "group_oid" : { "description" : "The unique object identifier (oid for short) for this group", "format" : "int32", "type" : "integer" }, "name" : { "description" : "The name of this group.", "type" : "string" }, "notifications" : { "description" : "A list of notifications the user receives.", "items" : { "$ref" : "#/components/schemas/Notification" }, "type" : "array" }, "permissions" : { "description" : "A list of permissions the user enjoys for accessing the backend of UltraCart.", "items" : { "$ref" : "#/components/schemas/Permission" }, "type" : "array" }, "users" : { "description" : "A list of users that belong to this group.", "items" : { "$ref" : "#/components/schemas/GroupUserMembership" }, "type" : "array" } }, "type" : "object" }, "GroupResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "group" : { "$ref" : "#/components/schemas/Group" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "GroupsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "groups" : { "items" : { "$ref" : "#/components/schemas/Group" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "GroupUserMembership" : { "properties" : { "email" : { "description" : "The email for this user.", "type" : "string" }, "fullName" : { "description" : "The full name for this user.", "type" : "string" }, "login" : { "description" : "The login for this user.", "type" : "string" }, "member" : { "description" : "True if this user belongs to the parent group, false otherwise.", "type" : "boolean" }, "user_id" : { "description" : "The user id for this user.", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "HitPageView" : { "properties" : { "bounce" : { "type" : "boolean" }, "meta_data" : { "items" : { "$ref" : "#/components/schemas/HitPageViewMetaData" }, "type" : "array" }, "method" : { "type" : "string" }, "prefetch" : { "type" : "boolean" }, "query" : { "type" : "string" }, "recording" : { "type" : "boolean" }, "redirect" : { "type" : "boolean" }, "referrer" : { "type" : "string" }, "time_on_page" : { "type" : "number" }, "title" : { "type" : "string" }, "url" : { "type" : "string" } }, "type" : "object" }, "HitPageViewMetaData" : { "properties" : { "key" : { "type" : "string" }, "value" : { "type" : "string" } }, "type" : "object" }, "HitSessionStart" : { "properties" : { "bot" : { "type" : "boolean" }, "bounce" : { "type" : "boolean" }, "channel" : { "type" : "string" }, "device_switch_detected" : { "type" : "boolean" }, "fake_bot" : { "type" : "boolean" }, "geolocation_country" : { "type" : "string" }, "geolocation_latitude" : { "type" : "number" }, "geolocation_longitude" : { "type" : "number" }, "geolocation_province" : { "type" : "string" }, "no_cookie_support" : { "type" : "boolean" }, "prefetch" : { "type" : "boolean" }, "referrer" : { "type" : "string" }, "screen_height" : { "format" : "int32", "type" : "integer" }, "screen_width" : { "format" : "int32", "type" : "integer" }, "time_on_Site" : { "type" : "number" }, "user_agent" : { "type" : "string" }, "user_ip" : { "type" : "string" } }, "type" : "object" }, "HitSessionUtm" : { "properties" : { "fb_ad_id" : { "type" : "string" }, "fbclid" : { "type" : "string" }, "gbraid" : { "type" : "string" }, "gclid" : { "type" : "string" }, "msclkid" : { "type" : "string" }, "ttclid" : { "type" : "string" }, "uc_message_id" : { "type" : "string" }, "utm_campaign" : { "type" : "string" }, "utm_content" : { "type" : "string" }, "utm_id" : { "type" : "string" }, "utm_medium" : { "type" : "string" }, "utm_source" : { "type" : "string" }, "utm_term" : { "type" : "string" }, "vmcid" : { "type" : "string" }, "wbraid" : { "type" : "string" } }, "type" : "object" }, "HTTPHeader" : { "properties" : { "name" : { "description" : "Name of the HTTP header", "type" : "string" }, "value" : { "description" : "Value of the HTTP header", "type" : "string" } }, "type" : "object" }, "IntegrationLog" : { "properties" : { "action" : { "type" : "string" }, "auto_order_oids" : { "items" : { "type" : "integer" }, "type" : "array" }, "direction" : { "type" : "string" }, "email" : { "type" : "string" }, "files" : { "items" : { "$ref" : "#/components/schemas/IntegrationLogFile" }, "type" : "array" }, "integration_log_oid" : { "format" : "int32", "type" : "integer" }, "item_id" : { "type" : "string" }, "item_ipn_oid" : { "format" : "int32", "type" : "integer" }, "log_dts" : { "description" : "Date/time the integration log was created", "format" : "dateTime", "type" : "string" }, "log_type" : { "type" : "string" }, "logger_id" : { "type" : "string" }, "logger_name" : { "type" : "string" }, "logs" : { "items" : { "$ref" : "#/components/schemas/IntegrationLogLog" }, "type" : "array" }, "omit_log_map" : { "type" : "boolean" }, "order_ids" : { "items" : { "type" : "string" }, "type" : "array" }, "pk" : { "type" : "string" }, "sk" : { "type" : "string" }, "status" : { "type" : "string" }, "status_code" : { "format" : "int32", "type" : "integer" } }, "type" : "object" }, "IntegrationLogFile" : { "properties" : { "mime_type" : { "type" : "string" }, "name" : { "type" : "string" }, "size" : { "format" : "int32", "type" : "integer" }, "uuid" : { "type" : "string" } }, "type" : "object" }, "IntegrationLogLog" : { "properties" : { "contents" : { "type" : "string" }, "name" : { "type" : "string" } }, "type" : "object" }, "IntegrationLogQueryFilterValues" : { "properties" : { "actions" : { "items" : { "type" : "string" }, "type" : "array" }, "directions" : { "items" : { "type" : "string" }, "type" : "array" }, "emails" : { "items" : { "type" : "string" }, "type" : "array" }, "file_names" : { "items" : { "type" : "string" }, "type" : "array" }, "item_ids" : { "items" : { "type" : "string" }, "type" : "array" }, "item_ipn_oids" : { "items" : { "type" : "integer" }, "type" : "array" }, "log_dts_max" : { "description" : "Maximum date/time log date/time", "format" : "dateTime", "type" : "string" }, "log_dts_min" : { "description" : "Minimum date/time log date/time", "format" : "dateTime", "type" : "string" }, "log_types" : { "items" : { "type" : "string" }, "type" : "array" }, "logger_names" : { "items" : { "type" : "string" }, "type" : "array" }, "order_ids" : { "items" : { "type" : "string" }, "type" : "array" }, "statuses" : { "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "IntegrationLogQueryRequest" : { "properties" : { "action" : { "type" : "string" }, "auto_order_ids" : { "items" : { "type" : "string" }, "type" : "array" }, "auto_order_oids" : { "items" : { "type" : "integer" }, "type" : "array" }, "direction" : { "type" : "string" }, "email" : { "type" : "string" }, "file_names" : { "items" : { "type" : "string" }, "type" : "array" }, "integration_log_oid" : { "format" : "int32", "type" : "integer" }, "item_id" : { "type" : "string" }, "item_ipn_oid" : { "format" : "int32", "type" : "integer" }, "log_dts_begin" : { "description" : "Log date/time begin", "format" : "dateTime", "type" : "string" }, "log_dts_end" : { "description" : "Log date/time end", "format" : "dateTime", "type" : "string" }, "log_type" : { "type" : "string" }, "logger_id" : { "type" : "string" }, "logger_name" : { "type" : "string" }, "order_ids" : { "items" : { "type" : "string" }, "type" : "array" }, "status" : { "type" : "string" } }, "type" : "object" }, "IntegrationLogQueryResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "filter_values" : { "$ref" : "#/components/schemas/IntegrationLogQueryFilterValues" }, "integration_logs" : { "items" : { "$ref" : "#/components/schemas/IntegrationLog" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "IntegrationLogResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "integration_log" : { "$ref" : "#/components/schemas/IntegrationLog" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "IntegrationLogSummary" : { "properties" : { "critical" : { "format" : "int32", "type" : "integer" }, "error" : { "format" : "int32", "type" : "integer" }, "events" : { "format" : "int32", "type" : "integer" }, "log_type" : { "type" : "string" }, "logger_id" : { "type" : "string" }, "logger_name" : { "type" : "string" }, "success" : { "format" : "int32", "type" : "integer" }, "view_url" : { "type" : "string" }, "warning" : { "format" : "int32", "type" : "integer" } }, "type" : "object" }, "IntegrationLogSummaryQueryRequest" : { "properties" : { "log_dts_begin" : { "description" : "Log date/time begin", "format" : "dateTime", "type" : "string" }, "log_dts_end" : { "description" : "Log date/time end", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "IntegrationLogSummaryQueryResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "integration_log_summaries" : { "items" : { "$ref" : "#/components/schemas/IntegrationLogSummary" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "Item" : { "properties" : { "accounting" : { "$ref" : "#/components/schemas/ItemAccounting" }, "amember" : { "$ref" : "#/components/schemas/ItemAmember" }, "auto_order" : { "$ref" : "#/components/schemas/ItemAutoOrder" }, "ccbill" : { "$ref" : "#/components/schemas/ItemCCBill" }, "channel_partner_item_mappings" : { "description" : "Channel Partner Item Mapping", "items" : { "$ref" : "#/components/schemas/ItemChannelPartnerMapping" }, "type" : "array" }, "chargeback" : { "$ref" : "#/components/schemas/ItemChargeback" }, "checkout" : { "$ref" : "#/components/schemas/ItemCheckout" }, "content" : { "$ref" : "#/components/schemas/ItemContent" }, "creation_dts" : { "description" : "Date/time of creation", "format" : "dateTime", "type" : "string" }, "description" : { "description" : "Description of the item up to 500 characters.", "maxLength" : 512, "type" : "string" }, "description_translated_text_instance_oid" : { "description" : "Description translated text instance id", "format" : "int32", "type" : "integer" }, "digital_delivery" : { "$ref" : "#/components/schemas/ItemDigitalDelivery" }, "ebay" : { "$ref" : "#/components/schemas/ItemEbay" }, "email_notifications" : { "$ref" : "#/components/schemas/ItemEmailNotifications" }, "enrollment123" : { "$ref" : "#/components/schemas/ItemEnrollment123" }, "fulfillment_addons" : { "description" : "Fulfillment Add-ons", "items" : { "$ref" : "#/components/schemas/ItemFulfillmentAddon" }, "type" : "array" }, "gated_codes" : { "description" : "Gated access codes for this item. Read-only on this object. Use the /items/{merchant_item_oid}/gated_codes endpoints to manage.", "items" : { "$ref" : "#/components/schemas/ItemGatedCode" }, "type" : "array" }, "gift_certificate" : { "$ref" : "#/components/schemas/ItemGiftCertificate" }, "google_product_search" : { "$ref" : "#/components/schemas/ItemGoogleProductSearch" }, "identifiers" : { "$ref" : "#/components/schemas/ItemIdentifiers" }, "inactive" : { "description" : "True if this item is inactive and can not be purchased", "type" : "boolean" }, "instant_payment_notifications" : { "$ref" : "#/components/schemas/ItemInstantPaymentNotifications" }, "internal" : { "$ref" : "#/components/schemas/ItemInternal" }, "kit" : { "description" : "True if this item is a kit", "type" : "boolean" }, "kit_component_only" : { "description" : "True if this item can only be usd as a kit component", "type" : "boolean" }, "kit_definition" : { "$ref" : "#/components/schemas/ItemKitDefinition" }, "last_modified_dts" : { "description" : "Date/time of last modification", "format" : "dateTime", "type" : "string" }, "merchant_id" : { "description" : "UltraCart merchant ID owning item", "maxLength" : 5, "type" : "string" }, "merchant_item_id" : { "description" : "Unique item id assigned to this item", "maxLength" : 20, "type" : "string" }, "merchant_item_oid" : { "description" : "Unique object identifier for this item", "format" : "int32", "type" : "integer" }, "options" : { "description" : "Options", "items" : { "$ref" : "#/components/schemas/ItemOption" }, "type" : "array" }, "parent_category_id" : { "description" : "Parent category of the item. Zero indicates the root folder.", "format" : "int32", "type" : "integer" }, "parent_category_path" : { "description" : "Parent category path. / indicates the root folder. This is the folder structure within item management.", "type" : "string" }, "payment_processing" : { "$ref" : "#/components/schemas/ItemPaymentProcessing" }, "physical" : { "$ref" : "#/components/schemas/ItemPhysical" }, "pricing" : { "$ref" : "#/components/schemas/ItemPricing" }, "properties" : { "description" : "Properties", "items" : { "$ref" : "#/components/schemas/ItemProperty" }, "type" : "array" }, "realtime_pricing" : { "$ref" : "#/components/schemas/ItemRealtimePricing" }, "recommend_replenishment_days" : { "description" : "Number of days to recommend replenishment after. Null is not configured. Set to zero to disable.", "format" : "int32", "type" : "integer" }, "related" : { "$ref" : "#/components/schemas/ItemRelated" }, "reporting" : { "$ref" : "#/components/schemas/ItemReporting" }, "restriction" : { "$ref" : "#/components/schemas/ItemRestriction" }, "revguard" : { "$ref" : "#/components/schemas/ItemRevguard" }, "reviews" : { "$ref" : "#/components/schemas/ItemReviews" }, "salesforce" : { "$ref" : "#/components/schemas/ItemSalesforce" }, "shipping" : { "$ref" : "#/components/schemas/ItemShipping" }, "tags" : { "$ref" : "#/components/schemas/ItemTags" }, "tax" : { "$ref" : "#/components/schemas/ItemTax" }, "third_party_email_marketing" : { "description" : "3rd Party Email Marketing", "items" : { "$ref" : "#/components/schemas/ItemThirdPartyEmailMarketing" }, "type" : "array" }, "variant_items" : { "description" : "Variant Items", "items" : { "$ref" : "#/components/schemas/ItemVariantItem" }, "type" : "array" }, "variations" : { "description" : "Variations", "items" : { "$ref" : "#/components/schemas/ItemVariation" }, "type" : "array" }, "wishlist_member" : { "$ref" : "#/components/schemas/ItemWishlistMember" } }, "type" : "object" }, "ItemAccounting" : { "properties" : { "accounting_code" : { "description" : "QuickBooks item name if different than the item id", "maxLength" : 50, "type" : "string" }, "qb_class" : { "description" : "QuickBooks class if you are classifying items on your invoices/receipts", "maxLength" : 31, "type" : "string" } }, "type" : "object" }, "ItemAmember" : { "properties" : { "amember_payment_duration_days" : { "description" : "The number of days that the customer should be given access to the item", "format" : "int32", "type" : "integer" }, "amember_product_id" : { "description" : "A-member product id give customer access to when they purchase this item", "maxLength" : 10, "type" : "string" } }, "type" : "object" }, "ItemAutoOrder" : { "properties" : { "auth_future_amount" : { "description" : "Amount to try and authorize for the future rebill", "type" : "number" }, "auth_test_amount" : { "description" : "Amount to try and test authorize", "type" : "number" }, "auto_order_cancel_charge_minimum_balance" : { "description" : "If true, the cost of the cancel item will be the remaining balance of the minimum rebill or lifetime value", "type" : "boolean" }, "auto_order_cancel_item_id" : { "description" : "Item id to attempt charging the customer for if they cancel", "maxLength" : 20, "type" : "string" }, "auto_order_cancel_item_oid" : { "description" : "Item object identifier to attempt charging the customer for if they cancel", "format" : "int32", "type" : "integer" }, "auto_order_cancel_minimum_life_time_count" : { "description" : "The minimum life time count that must be billed in order to not be charged the cancellation item.", "format" : "int32", "type" : "integer" }, "auto_order_cancel_minimum_life_time_value" : { "description" : "The minimum life time value that must be paid in order to not be charged the cancellation item.", "type" : "number" }, "auto_order_cancel_minimum_rebill_count" : { "description" : "The minimum rebill count that must be billed in order to not be charged the cancellation item.", "format" : "int32", "type" : "integer" }, "auto_order_cancel_minimum_rebill_value" : { "description" : "The minimum rebill value that must be paid in order to not be charged the cancellation item.", "type" : "number" }, "auto_order_downgrade_items" : { "description" : "List of downgrade items presented to customer service representatives", "items" : { "type" : "string" }, "type" : "array" }, "auto_order_paused" : { "description" : "True if the rebill processing of this item is paused", "type" : "boolean" }, "auto_order_prohibit_expiring_cards" : { "description" : "Minimum number of months before expiration for the card. Overrides the account level setting if higher. Set to zero to disable.", "format" : "int32", "type" : "integer" }, "auto_order_schedules" : { "description" : "The user selectable schedules that are available", "items" : { "type" : "string" }, "type" : "array" }, "auto_order_upgrade_items" : { "description" : "List of upgrade items presented to customer service representatives", "items" : { "type" : "string" }, "type" : "array" }, "auto_order_upsell" : { "description" : "True if this item uses a fixed upsell step schedule", "type" : "boolean" }, "auto_order_upsell_no_easy_cancel" : { "description" : "Do not send the easy cancel email to the customer", "type" : "boolean" }, "auto_order_upsell_one_per_customer" : { "description" : "Limit the purchase of this item to one per customer", "type" : "boolean" }, "auto_orderable" : { "description" : "True if this item can be automatically ordered by the customer", "type" : "boolean" }, "cancel_other_auto_orders" : { "description" : "True if other auto orders for this customer should be canceled when this item is ordered", "type" : "boolean" }, "free_shipping_auto_order" : { "description" : "True if the customer should be given free shipping", "type" : "boolean" }, "refund_other_auto_orders" : { "description" : "True if other auto orders for this customer should refunded if this item is refunded.", "type" : "boolean" }, "steps" : { "description" : "The rebill steps if this auto order is an upsell", "items" : { "$ref" : "#/components/schemas/ItemAutoOrderStep" }, "type" : "array" } }, "type" : "object" }, "ItemAutoOrderStep" : { "properties" : { "arbitrary_schedule_days" : { "description" : "If the schedule is arbitrary, then this is the number of days", "format" : "int32", "type" : "integer" }, "arbitrary_unit_cost" : { "description" : "Arbitrary unit cost used to override the regular item cost", "type" : "number" }, "arbitrary_unit_cost_schedules" : { "description" : "Arbitrary unit costs schedules for more advanced discounting by rebill attempt", "items" : { "$ref" : "#/components/schemas/ItemAutoOrderStepArbitraryUnitCostSchedule" }, "type" : "array" }, "grandfather_pricing" : { "description" : "Grand-father pricing configuration if the rebill schedule has changed over time", "items" : { "$ref" : "#/components/schemas/ItemAutoOrderStepGrandfatherPricing" }, "type" : "array" }, "managed_by" : { "description" : "Managed by (defaults to UltraCart)", "type" : "string" }, "pause_days" : { "description" : "Number of days to pause", "format" : "int32", "type" : "integer" }, "pause_until_date" : { "description" : "Wait for this step to happen until the specified date", "format" : "dateTime", "type" : "string" }, "pause_until_day_of_month" : { "description" : "Pause until a specific day of the month", "format" : "int32", "type" : "integer" }, "pause_until_minimum_delay_days" : { "description" : "Pause at least this many days between the last order and the calculated next day of month", "format" : "int32", "type" : "integer" }, "preshipment_notice_days" : { "description" : "If set, a pre-shipment notice is sent to the customer this many days in advance", "format" : "int32", "type" : "integer" }, "recurring_merchant_item_id" : { "description" : "Item id to rebill", "maxLength" : 20, "type" : "string" }, "recurring_merchant_item_oid" : { "description" : "Item object identifier to rebill", "format" : "int32", "type" : "integer" }, "repeat_count" : { "description" : "Number of times to rebill. Last step can be null for infinite", "format" : "int32", "type" : "integer" }, "schedule" : { "description" : "Frequency of the rebill", "type" : "string" }, "subscribe_email_list_name" : { "description" : "Email list name to subscribe the customer to when the rebill occurs (decommissioned email engine)", "type" : "string" }, "subscribe_email_list_oid" : { "description" : "Email list identifier to subscribe the customer to when this rebill occurs (decommissioned email engine)", "format" : "int32", "type" : "integer" }, "type" : { "description" : "Type of step (item, kit only, loop or pause)", "enum" : [ "item", "pause", "loop", "kit only", "pause until" ], "type" : "string" } }, "type" : "object" }, "ItemAutoOrderStepArbitraryUnitCostSchedule" : { "properties" : { "arbitrary_unit_cost" : { "description" : "Arbitrary unit cost", "type" : "number" }, "retry_days" : { "description" : "Retry days", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ItemAutoOrderStepGrandfatherPricing" : { "properties" : { "on_or_before_date" : { "description" : "On or before date", "format" : "dateTime", "type" : "string" }, "unit_cost" : { "description" : "Unit cost", "type" : "number" } }, "type" : "object" }, "ItemCCBill" : { "properties" : { "ccbill_allowed_currencies" : { "description" : "Allowed currencies", "type" : "string" }, "ccbill_allowed_types" : { "description" : "Allowed types", "type" : "string" }, "ccbill_currency_code" : { "description" : "Currency code", "type" : "string" }, "ccbill_form_name" : { "description" : "Form name", "type" : "string" }, "ccbill_subaccount_id" : { "description" : "Sub-account id", "type" : "string" }, "ccbill_subscription_type_id" : { "description" : "Subscription type id", "type" : "string" } }, "type" : "object" }, "ItemChannelPartnerMapping" : { "properties" : { "barcode_ua" : { "description" : "Barcode UA (EDI only)", "type" : "string" }, "barcode_uc" : { "description" : "Barcode UC (EDI only)", "type" : "string" }, "barcode_ui" : { "description" : "Barcode UI (EDI only)", "type" : "string" }, "barcode_uk" : { "description" : "Barcode UK (EDI only)", "type" : "string" }, "buyer_catalog_number" : { "description" : "Buyer catalog number (EDI only)", "type" : "string" }, "buyer_dpci" : { "description" : "Buyer DPCI (EDI only)", "type" : "string" }, "buyer_item_number" : { "description" : "Buyer item number (EDI only)", "type" : "string" }, "channel_partner_code" : { "description" : "Channel partner code", "type" : "string" }, "channel_partner_oid" : { "description" : "Channel partner object identifier", "format" : "int32", "type" : "integer" }, "cost" : { "description" : "Cost given to this channel partner", "type" : "number" }, "from_item_id" : { "description" : "From Item ID", "maxLength" : 30, "type" : "string" }, "from_sku" : { "description" : "From SKU", "maxLength" : 50, "type" : "string" }, "mutually_defined_number" : { "description" : "Mutually defined number (EDI only)", "type" : "string" }, "quantity_ratio_cp" : { "description" : "Ratio (Channel Partner)", "format" : "int32", "type" : "integer" }, "quantity_ratio_uc" : { "description" : "Ratio (UltraCart)", "format" : "int32", "type" : "integer" }, "sku" : { "description" : "SKU", "maxLength" : 50, "type" : "string" }, "unit_of_measure" : { "description" : "Unit of measure", "type" : "string" }, "vendor_number" : { "description" : "Vendor number (EDI only)", "type" : "string" }, "vendor_style_number" : { "description" : "Vendor style number (EDI only)", "type" : "string" } }, "type" : "object" }, "ItemChargeback" : { "properties" : { "addendums" : { "description" : "Addendums (deprecated)", "items" : { "$ref" : "#/components/schemas/ItemChargebackAddendum" }, "type" : "array" }, "adjustment_requests" : { "description" : "Adjustment requests (deprecated)", "items" : { "$ref" : "#/components/schemas/ItemChargebackAdjustmentRequest" }, "type" : "array" } }, "type" : "object" }, "ItemChargebackAddendum" : { "properties" : { "chargeback_addendum_oid" : { "description" : "Chargeback addendum object identifier", "format" : "int32", "type" : "integer" }, "description" : { "description" : "Description", "type" : "string" }, "file_size" : { "description" : "Size of the file", "format" : "int32", "type" : "integer" }, "pages" : { "description" : "Number of pages", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ItemChargebackAdjustmentRequest" : { "properties" : { "chargeback_adjustment_request_oid" : { "description" : "Chargeback adjustment request object identifier", "format" : "int32", "type" : "integer" }, "description" : { "description" : "Description", "type" : "string" }, "reason_code" : { "description" : "Reason code", "type" : "string" } }, "type" : "object" }, "ItemCheckout" : { "properties" : { "suppress_buysafe" : { "description" : "True to suppress buySAFE (deprecated)", "type" : "boolean" }, "terms" : { "description" : "Terms for purchasing this item", "maxLength" : 10000, "type" : "string" }, "terms_if_auto_order" : { "description" : "Terms only apply if the item is on auto order", "type" : "boolean" }, "terms_translated_text_instance_oid" : { "description" : "Terms translated text instance identifier", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ItemContent" : { "properties" : { "assignments" : { "description" : "StoreFront assignments", "items" : { "$ref" : "#/components/schemas/ItemContentAssignment" }, "type" : "array" }, "attributes" : { "description" : "StoreFront attributes", "items" : { "$ref" : "#/components/schemas/ItemContentAttribute" }, "type" : "array" }, "custom_thank_you_url" : { "description" : "Custom Thank You URL", "type" : "string" }, "exclude_from_search" : { "description" : "Exclude from search", "type" : "boolean" }, "exclude_from_sitemap" : { "description" : "Exclude from the sitemap for the StoreFront", "type" : "boolean" }, "exclude_from_top_sellers" : { "description" : "Exclude from the top sellers list in the StoreFront", "type" : "boolean" }, "extended_description" : { "description" : "Extended description (max 10000 characters)", "maxLength" : 10000, "type" : "string" }, "extended_description_translated_text_instance_oid" : { "description" : "Extended description text translation instance identifier", "format" : "int32", "type" : "integer" }, "meta_description" : { "description" : "SEO meta description used by Storefronts", "type" : "string" }, "meta_keywords" : { "description" : "SEO meta keywords used by Storefronts", "type" : "string" }, "meta_title" : { "description" : "SEO meta title used by Storefronts", "type" : "string" }, "multimedia" : { "description" : "Multimedia", "items" : { "$ref" : "#/components/schemas/ItemContentMultimedia" }, "type" : "array" }, "new_item" : { "description" : "True if the item is new", "type" : "boolean" }, "new_item_end" : { "description" : "The date the item should no longer be considered new", "format" : "dateTime", "type" : "string" }, "new_item_start" : { "description" : "The date the item should start being considered new", "format" : "dateTime", "type" : "string" }, "view_url" : { "description" : "Legacy view URL (not used by StoreFronts)", "type" : "string" } }, "type" : "object" }, "ItemContentAssignment" : { "properties" : { "default_assignment" : { "description" : "True if this group is the default assignment for this item", "type" : "boolean" }, "group_oid" : { "description" : "Page (group) object identifier", "format" : "int32", "type" : "integer" }, "group_path" : { "description" : "Page (group) path", "type" : "string" }, "host" : { "description" : "StoreFront host name", "type" : "string" }, "sort_order" : { "description" : "Sort order (optional)", "format" : "int32", "type" : "integer" }, "url_part" : { "description" : "URL part if the item id is not used", "maxLength" : 150, "type" : "string" } }, "type" : "object" }, "ItemContentAttribute" : { "properties" : { "name" : { "description" : "Attribute name", "maxLength" : 400, "type" : "string" }, "translated_text_instance_oid" : { "description" : "Attribute translated text instance identifier", "format" : "int32", "type" : "integer" }, "type" : { "description" : "Attribute type", "type" : "string" }, "value" : { "description" : "Attribute value", "maxLength" : 100000, "type" : "string" } }, "type" : "object" }, "ItemContentMultimedia" : { "properties" : { "cloud_url" : { "description" : "URL where the image can be downloaded from the cloud", "type" : "string" }, "cloud_url_expiration" : { "description" : "Expiration date of the cloud URL", "format" : "dateTime", "type" : "string" }, "code" : { "description" : "Code assigned to the file", "maxLength" : 20, "type" : "string" }, "description" : { "description" : "Description", "maxLength" : 50000, "type" : "string" }, "exclude_from_gallery" : { "description" : "True to exclude from multimedia gallery", "type" : "boolean" }, "file_name" : { "description" : "File name", "maxLength" : 75, "type" : "string" }, "height" : { "description" : "Height of the image", "format" : "int32", "type" : "integer" }, "merchant_item_multimedia_oid" : { "description" : "Item multimedia object identifier", "format" : "int32", "type" : "integer" }, "orphan" : { "description" : "True if the multimedia is an orphan of the active StoreFront themes", "type" : "boolean" }, "placeholder" : { "description" : "True if the object is a place holder that can be populated", "type" : "boolean" }, "size" : { "description" : "Size of the file in bytes if known", "format" : "int32", "type" : "integer" }, "temp_multimedia_oid" : { "description" : "Temporary multimedia object identifier assigned if uploading new multimedia", "format" : "int32", "type" : "integer" }, "thumbnails" : { "description" : "Thumbnails of this image", "items" : { "$ref" : "#/components/schemas/ItemContentMultimediaThumbnail" }, "type" : "array" }, "type" : { "description" : "Type of file", "enum" : [ "Image", "PDF", "Text", "Unknown", "Video" ], "type" : "string" }, "url" : { "description" : "URL to download file (on new multimedia record this can be a URL for UltraCart to fetch)", "type" : "string" }, "width" : { "description" : "Width of the image", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ItemContentMultimediaThumbnail" : { "properties" : { "height" : { "description" : "Height of the thumbnail", "format" : "int32", "type" : "integer" }, "http_url" : { "description" : "HTTP URL to view the thumbnail", "type" : "string" }, "https_url" : { "description" : "HTTPS URL to view the thumbnail", "type" : "string" }, "png_format" : { "description" : "True if PNG, false if JPEG", "type" : "boolean" }, "square" : { "description" : "True if the thumbnail is square", "type" : "boolean" }, "width" : { "description" : "Width of the thumbnail", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ItemDigitalDelivery" : { "properties" : { "activation_code_description" : { "description" : "Description of the activation code", "maxLength" : 50, "type" : "string" }, "activation_code_low_warning" : { "description" : "The number of activation codes whcih should generate a warning email", "format" : "int32", "type" : "integer" }, "activation_code_realtime_url" : { "description" : "The URL to retrieve activation codes from in real-time", "maxLength" : 350, "type" : "string" }, "activation_code_shared_secret" : { "description" : "Shared secret used when communicating with the real-time URL", "maxLength" : 20, "type" : "string" }, "activation_code_type" : { "description" : "Type of activation code", "type" : "string" }, "digital_items" : { "description" : "Digital items that customer can download when this item is purchased", "items" : { "$ref" : "#/components/schemas/ItemDigitalItem" }, "type" : "array" } }, "type" : "object" }, "ItemDigitalItem" : { "properties" : { "click_wrap_agreement" : { "description" : "Click wrap agreement is presented to the customer before they can purchase your product.", "type" : "string" }, "creation_dts" : { "description" : "File creation date", "format" : "dateTime", "type" : "string" }, "description" : { "description" : "Description of the digital item", "maxLength" : 200, "type" : "string" }, "digital_item_oid" : { "description" : "The Digital item oid is a primary key used internally by UltraCart. You should not set or change this value. Doing so will have no effect.", "format" : "int32", "type" : "integer" }, "external_id" : { "description" : "External Id useful for syncing with a remote filesystem, this may be an MD5 hash or whatever suits your needs.", "maxLength" : 100, "type" : "string" }, "file_size" : { "description" : "File size", "format" : "int64", "type" : "integer" }, "import_from_url" : { "description" : "This url is sourced to create or update a digital file in your digital library. It is only considered during an insert or update operation.", "type" : "string" }, "mime_type" : { "description" : "Mime type associated with the file", "maxLength" : 100, "type" : "string" }, "original_filename" : { "description" : "Original filename", "maxLength" : 250, "type" : "string" }, "pdf_meta" : { "$ref" : "#/components/schemas/ItemDigitalItemPdfMeta" } }, "type" : "object" }, "ItemDigitalItemPdfMeta" : { "properties" : { "assembly_allowed" : { "description" : "Assembly allowed", "type" : "boolean" }, "copy_allowed" : { "description" : "Copy/Paste is allowed", "type" : "boolean" }, "custom_footer" : { "description" : "A custom footer for each pdf page", "maxLength" : 8000, "type" : "string" }, "custom_header" : { "description" : "A custom header for each pdf page", "maxLength" : 8000, "type" : "string" }, "degraded_printing_allowed" : { "description" : "Degraded printing allowed", "type" : "boolean" }, "fillin_allowed" : { "description" : "Fillin is allowed", "type" : "boolean" }, "modify_annotations_allowed" : { "description" : "Modifying annotations is allowed", "type" : "boolean" }, "modify_contents_allowed" : { "description" : "Modifying contents is allowed", "type" : "boolean" }, "printing_allowed" : { "description" : "Printing is allowed", "type" : "boolean" }, "screen_readers_allowed" : { "description" : "Screen readers are allowed", "type" : "boolean" }, "tagged" : { "description" : "PDF is tagged", "type" : "boolean" } }, "type" : "object" }, "ItemDigitalItemResponse" : { "properties" : { "digital_item" : { "$ref" : "#/components/schemas/ItemDigitalItem" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ItemDigitalItemsResponse" : { "properties" : { "digital_items" : { "description" : "digital_items", "items" : { "$ref" : "#/components/schemas/ItemDigitalItem" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ItemEbay" : { "properties" : { "active" : { "description" : "True if the item is active for listing", "type" : "boolean" }, "category_id" : { "description" : "e-Bay category ID", "format" : "int32", "type" : "integer" }, "category_specifics" : { "description" : "Answers to category specific questions", "items" : { "$ref" : "#/components/schemas/ItemEbayCategorySpecific" }, "type" : "array" }, "condition_description" : { "description" : "Description of the condition (e-Bay constant)", "type" : "string" }, "condition_id" : { "description" : "Numerical ID of the condition (e-Bay constant)", "format" : "int32", "type" : "integer" }, "consecutive_failures" : { "description" : "Number of consecutive failures trying to list this item", "format" : "int32", "type" : "integer" }, "custom_category1" : { "description" : "e-Bay Store category 1", "format" : "int64", "type" : "integer" }, "custom_category2" : { "description" : "e-Bay Store category 2", "format" : "int64", "type" : "integer" }, "dispatch_time_max" : { "description" : "Maximum number of days it will take to ship the item", "format" : "int32", "type" : "integer" }, "domestic_1_additional_cost" : { "description" : "Domestic 1 method additional item cost", "type" : "number" }, "domestic_1_first_cost" : { "description" : "Domestic 1 method first item cost", "type" : "number" }, "domestic_2_additional_cost" : { "description" : "Domestic 2 method additional item cost", "type" : "number" }, "domestic_2_first_cost" : { "description" : "Domestic 2 method first item cost", "type" : "number" }, "domestic_3_additional_cost" : { "description" : "Domestic 3 method additional item cost", "type" : "number" }, "domestic_3_first_cost" : { "description" : "Domestic 3 method first item cost", "type" : "number" }, "domestic_4_additional_cost" : { "description" : "Domestic 4 method additional item cost", "type" : "number" }, "domestic_4_first_cost" : { "description" : "Domestic 4 method first item cost", "type" : "number" }, "ebay_auction_id" : { "description" : "If listed, this is the e-Bay auction id", "type" : "string" }, "ebay_specific_inventory" : { "description" : "e-Bay specific inventory", "format" : "int32", "type" : "integer" }, "ebay_template_name" : { "description" : "The template name to use hwen rendering the e-Bay listing", "type" : "string" }, "ebay_template_oid" : { "description" : "The template object identifier to use when rendering the e-Bay listing", "format" : "int32", "type" : "integer" }, "end_time" : { "description" : "Date/time of the auction end", "format" : "dateTime", "type" : "string" }, "free_shipping" : { "description" : "True if item receives free shipping", "type" : "boolean" }, "free_shipping_method" : { "description" : "The method that is free for free shipping", "type" : "string" }, "international_1_additional_cost" : { "description" : "International 1 method additional item cost", "type" : "number" }, "international_1_first_cost" : { "description" : "International 1 method first item cost", "type" : "number" }, "international_2_additional_cost" : { "description" : "International 2 method additional item cost", "type" : "number" }, "international_2_first_cost" : { "description" : "International 2 method first item cost", "type" : "number" }, "international_3_additional_cost" : { "description" : "International 3 method additional item cost", "type" : "number" }, "international_3_first_cost" : { "description" : "International 3 method first item cost", "type" : "number" }, "international_4_additional_cost" : { "description" : "International 4 method additional item cost", "type" : "number" }, "international_4_first_cost" : { "description" : "International 4 method first item cost", "type" : "number" }, "last_status_dts" : { "description" : "Date/time of the last status check", "format" : "dateTime", "type" : "string" }, "listed_dispatch_time_max" : { "description" : "Current listing dispatch time maximum", "format" : "int32", "type" : "integer" }, "listed_ebay_template_oid" : { "description" : "The template object identifier used for the listing", "format" : "int32", "type" : "integer" }, "listing_dts" : { "description" : "Date/time of the listing", "format" : "dateTime", "type" : "string" }, "listing_duration" : { "description" : "The duration of the listing", "type" : "string" }, "listing_price" : { "description" : "Price to list the item at", "type" : "number" }, "listing_price_override" : { "description" : "The price to list the item at if different than the regular UltraCart item price", "type" : "number" }, "listing_type" : { "description" : "The type of e-Bay listing", "type" : "string" }, "marketplace_analysis" : { "$ref" : "#/components/schemas/ItemEbayMarketPlaceAnalysis" }, "marketplace_analysis_perform" : { "description" : "True if marketplace analysis should be performed", "type" : "boolean" }, "marketplace_final_value_fee_percentage" : { "description" : "Marketplace FVF percentage", "type" : "number" }, "marketplace_last_check_dts" : { "description" : "Date/time of the marketplace analysis last check", "format" : "dateTime", "type" : "string" }, "marketplace_lowest" : { "description" : "True if we are the lowest offer in the marketplace", "type" : "boolean" }, "marketplace_map_violation" : { "description" : "True if another seller is violating MAP", "type" : "boolean" }, "marketplace_multiplier" : { "description" : "Marketplace multiplier", "type" : "number" }, "marketplace_other_price" : { "description" : "Marketplace other price", "type" : "number" }, "marketplace_other_seller" : { "description" : "Marketplace other seller", "type" : "string" }, "marketplace_other_shipping" : { "description" : "Marketplace other shipping", "type" : "number" }, "marketplace_other_total" : { "description" : "Marketplace other total", "type" : "number" }, "marketplace_our_additional_profit_potential" : { "description" : "Marketplace our additional profit potential", "type" : "number" }, "marketplace_our_price" : { "description" : "Marketplace our price", "type" : "number" }, "marketplace_our_profit" : { "description" : "Marketplace our profit", "type" : "number" }, "marketplace_our_shipping" : { "description" : "Marketplace our shipping", "type" : "number" }, "marketplace_our_total" : { "description" : "Marketplace our total", "type" : "number" }, "marketplace_overhead" : { "description" : "Marketplace overhead", "type" : "number" }, "marketplace_profitable" : { "description" : "True if our listing is profitable to sell", "type" : "boolean" }, "next_attempt_dts" : { "description" : "Date/time for the next attempt to list", "format" : "dateTime", "type" : "string" }, "next_listing_duration" : { "description" : "The next listing duration to use when the current listing ends.", "type" : "string" }, "no_promotional_shipping" : { "description" : "True if the item should not qualify for promotional shipping", "type" : "boolean" }, "packaging_handling_costs" : { "description" : "Packaging and handling costs", "type" : "number" }, "previous_ebay_auction_id" : { "description" : "Previous e-Bay auction id", "type" : "string" }, "quantity" : { "description" : "Quantity available of the item", "format" : "int32", "type" : "integer" }, "reserve_price" : { "description" : "Reserve price", "type" : "number" }, "send_dimensions_and_weight" : { "description" : "How to send the item dimensions and weights to e-Bay", "type" : "string" }, "start_time" : { "description" : "Date/time of the auction start", "type" : "string" }, "status" : { "description" : "Status of the item's listing", "type" : "string" }, "target_dispatch_time_max" : { "description" : "Typical number of days it will take to ship the item", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ItemEbayCategorySpecific" : { "properties" : { "name" : { "description" : "Name of the category specification field", "type" : "string" }, "value" : { "description" : "Value", "type" : "string" } }, "type" : "object" }, "ItemEbayMarketListing" : { "properties" : { "auction_id" : { "description" : "Auction ID", "type" : "string" }, "price" : { "description" : "Price", "type" : "number" }, "seller" : { "description" : "Seller", "type" : "string" }, "shipping" : { "description" : "Shipping", "type" : "number" }, "total" : { "description" : "Total", "type" : "number" } }, "type" : "object" }, "ItemEbayMarketPlaceAnalysis" : { "properties" : { "adjusted_price" : { "description" : "Adjusted price", "type" : "number" }, "adjusted_shipping" : { "description" : "Adjusted shipping", "type" : "number" }, "adjusted_total" : { "description" : "Adjusted total", "type" : "number" }, "cogs" : { "description" : "Cost of goods sold", "type" : "number" }, "final_value_fee" : { "description" : "Final value fee", "type" : "number" }, "minimum_advertised_price" : { "description" : "Minimum advertised price", "type" : "number" }, "other_listings" : { "description" : "Other listings", "items" : { "$ref" : "#/components/schemas/ItemEbayMarketListing" }, "type" : "array" }, "our_listing" : { "$ref" : "#/components/schemas/ItemEbayMarketListing" }, "overhead" : { "description" : "Overhead", "type" : "number" }, "profit_potential" : { "description" : "Profit potential", "type" : "number" } }, "type" : "object" }, "ItemEmailNotifications" : { "properties" : { "skip_receipt" : { "description" : "Skip receipt email to customer", "type" : "boolean" }, "skip_shipment_notification" : { "description" : "Skip shipment notification to customer", "type" : "boolean" } }, "type" : "object" }, "ItemEnrollment123" : { "properties" : { "enrollment123_product_code" : { "description" : "Enrolment 123 product code", "type" : "string" } }, "type" : "object" }, "ItemFulfillmentAddon" : { "properties" : { "add_item_id" : { "description" : "Add Item Id", "type" : "string" }, "add_item_oid" : { "description" : "Add Item object identifier", "format" : "int32", "type" : "integer" }, "initial_order_only" : { "description" : "Initial Order Only", "type" : "boolean" }, "once_per_order" : { "description" : "Once Per Order", "type" : "boolean" }, "quantity" : { "description" : "Quantity", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ItemGatedCode" : { "properties" : { "code" : { "description" : "The access code a customer must enter at checkout.", "maxLength" : 255, "type" : "string" }, "created_dts" : { "description" : "Date/time the code was added.", "format" : "dateTime", "type" : "string" }, "merchant_item_gated_code_oid" : { "description" : "Internal identifier; populated by the server on insert.", "format" : "int32", "type" : "integer" }, "merchant_item_oid" : { "description" : "Item this code is associated with.", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ItemGatedCodeResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "gatedCode" : { "$ref" : "#/components/schemas/ItemGatedCode" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ItemGatedCodesRequest" : { "properties" : { "gatedCodes" : { "description" : "gated_codes", "items" : { "$ref" : "#/components/schemas/ItemGatedCode" }, "type" : "array" } }, "type" : "object" }, "ItemGatedCodesResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "gatedCodes" : { "description" : "gated_codes", "items" : { "$ref" : "#/components/schemas/ItemGatedCode" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ItemGenerateGatedCodesRequest" : { "properties" : { "additionalExistingCodes" : { "description" : "Optional codes to also dedupe against (e.g. an in-progress draft).", "items" : { "type" : "string" }, "type" : "array" }, "count" : { "description" : "Number of codes to generate (1-1000).", "format" : "int32", "type" : "integer" }, "length" : { "description" : "Length of each code (8-32).", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ItemGiftCertificate" : { "properties" : { "gift_certificate" : { "description" : "True if the purchase of this item generates a gift certificate", "type" : "boolean" }, "gift_certificate_expiration_days" : { "description" : "The number of days that the gift certificate is good for (optional)", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ItemGoogleProductSearch" : { "properties" : { "adwords_grouping" : { "description" : "Adwords grouping", "maxLength" : 50, "type" : "string" }, "adwords_label1" : { "description" : "Adwords label 1", "maxLength" : 50, "type" : "string" }, "adwords_label2" : { "description" : "Adwords label 2", "maxLength" : 50, "type" : "string" }, "adwords_label3" : { "description" : "Adwords label 3", "maxLength" : 50, "type" : "string" }, "adwords_label4" : { "description" : "Adwords label 4", "maxLength" : 50, "type" : "string" }, "adwords_label5" : { "description" : "Adwords label 5", "maxLength" : 50, "type" : "string" }, "age_group" : { "description" : "Age group", "maxLength" : 5, "type" : "string" }, "available_at_physical_store" : { "description" : "Available at physical store", "type" : "boolean" }, "book_author" : { "description" : "Book - author", "maxLength" : 50, "type" : "string" }, "book_format" : { "description" : "Book - format", "maxLength" : 50, "type" : "string" }, "book_isbn" : { "description" : "Bood - ISBN", "maxLength" : 20, "type" : "string" }, "book_publisher" : { "description" : "Book - publisher", "maxLength" : 50, "type" : "string" }, "category_description" : { "description" : "Category description", "maxLength" : 1000, "type" : "string" }, "color" : { "description" : "Color", "maxLength" : 100, "type" : "string" }, "condition" : { "description" : "Condition", "maxLength" : 15, "type" : "string" }, "custom_label0" : { "description" : "Custom label 0", "maxLength" : 50, "type" : "string" }, "custom_label1" : { "description" : "Custom label 1", "maxLength" : 50, "type" : "string" }, "custom_label2" : { "description" : "Custom label 2", "maxLength" : 50, "type" : "string" }, "custom_label3" : { "description" : "Custom label 3", "maxLength" : 50, "type" : "string" }, "custom_label4" : { "description" : "Custom label 4", "maxLength" : 50, "type" : "string" }, "gender" : { "description" : "Gender", "maxLength" : 6, "type" : "string" }, "google_product_category" : { "description" : "Google product category", "maxLength" : 250, "type" : "string" }, "music_artist" : { "description" : "Music - artist", "maxLength" : 50, "type" : "string" }, "music_format" : { "description" : "Music - format", "maxLength" : 5, "type" : "string" }, "music_release_date" : { "description" : "Music - release date", "format" : "dateTime", "type" : "string" }, "omit_from_feed" : { "description" : "Omit from feed", "type" : "boolean" }, "product_type" : { "description" : "Product type", "maxLength" : 10, "type" : "string" }, "promotion_id1" : { "description" : "Promotion ID 1", "maxLength" : 30, "type" : "string" }, "promotion_id10" : { "description" : "Promotion ID 10", "maxLength" : 30, "type" : "string" }, "promotion_id2" : { "description" : "Promotion ID 2", "maxLength" : 30, "type" : "string" }, "promotion_id3" : { "description" : "Promotion ID 3", "maxLength" : 30, "type" : "string" }, "promotion_id4" : { "description" : "Promotion ID 4", "maxLength" : 30, "type" : "string" }, "promotion_id5" : { "description" : "Promotion ID 5", "maxLength" : 30, "type" : "string" }, "promotion_id6" : { "description" : "Promotion ID 6", "maxLength" : 30, "type" : "string" }, "promotion_id7" : { "description" : "Promotion ID 7", "maxLength" : 30, "type" : "string" }, "promotion_id8" : { "description" : "Promotion ID 8", "maxLength" : 30, "type" : "string" }, "promotion_id9" : { "description" : "Promotion ID 9", "maxLength" : 30, "type" : "string" }, "search_dts" : { "description" : "Search date/time", "format" : "dateTime", "type" : "string" }, "search_lowest_price" : { "description" : "Search lowest price", "type" : "number" }, "search_lowest_url" : { "description" : "Search lowest URL", "maxLength" : 250, "type" : "string" }, "search_position" : { "description" : "Search position", "format" : "int32", "type" : "integer" }, "shippingLabel" : { "type" : "string" }, "size" : { "description" : "Size", "maxLength" : 20, "type" : "string" }, "video_director" : { "description" : "Video - director", "maxLength" : 50, "type" : "string" }, "video_format" : { "description" : "Video - format", "maxLength" : 5, "type" : "string" }, "video_rating" : { "description" : "Video - rating", "maxLength" : 5, "type" : "string" }, "video_release_date" : { "description" : "Video - release date", "format" : "dateTime", "type" : "string" }, "video_starring" : { "description" : "Video - starring", "maxLength" : 150, "type" : "string" } }, "type" : "object" }, "ItemIdentifiers" : { "properties" : { "barcode" : { "description" : "Barcode", "maxLength" : 30, "type" : "string" }, "barcode_gtin12" : { "description" : "Barcode - GTIN 12", "maxLength" : 12, "type" : "string" }, "barcode_gtin14" : { "description" : "Barcode - GTIN 14", "maxLength" : 14, "type" : "string" }, "barcode_upc11" : { "description" : "Barcode - UPC 11", "maxLength" : 11, "type" : "string" }, "barcode_upc12" : { "description" : "Barcode - UPC 12", "maxLength" : 12, "type" : "string" }, "manufacturer_name" : { "description" : "Manufacturer Name", "maxLength" : 50, "type" : "string" }, "manufacturer_sku" : { "description" : "Manufacturer SKU", "maxLength" : 25, "type" : "string" }, "unspsc" : { "description" : "UNSPSC", "maxLength" : 20, "type" : "string" } }, "type" : "object" }, "ItemInstantPaymentNotification" : { "properties" : { "post_operation" : { "description" : "True for HTTP POST instead of GET", "type" : "boolean" }, "successful_response_text" : { "description" : "Successful response text", "maxLength" : 1024, "type" : "string" }, "url" : { "description" : "URL", "maxLength" : 1024, "type" : "string" } }, "type" : "object" }, "ItemInstantPaymentNotifications" : { "properties" : { "notifications" : { "description" : "Notifications", "items" : { "$ref" : "#/components/schemas/ItemInstantPaymentNotification" }, "type" : "array" } }, "type" : "object" }, "ItemInternal" : { "properties" : { "memo" : { "description" : "Memo", "maxLength" : 250, "type" : "string" } }, "type" : "object" }, "ItemInventorySnapshot" : { "properties" : { "allocated_to_placed_orders" : { "format" : "int32", "type" : "integer" }, "allocated_to_shopping_carts" : { "format" : "int32", "type" : "integer" }, "available_to_allocate" : { "format" : "int32", "type" : "integer" }, "distribution_centers" : { "items" : { "$ref" : "#/components/schemas/ItemInventorySnapshotDistributionCenter" }, "type" : "array" }, "merchant_item_id" : { "type" : "string" }, "quantity" : { "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ItemInventorySnapshotDistributionCenter" : { "properties" : { "allocated_to_placed_orders" : { "format" : "int32", "type" : "integer" }, "allocated_to_shopping_carts" : { "format" : "int32", "type" : "integer" }, "available_to_allocate" : { "format" : "int32", "type" : "integer" }, "code" : { "type" : "string" }, "quantity" : { "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ItemInventorySnapshotResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "inventories" : { "description" : "inventories", "items" : { "$ref" : "#/components/schemas/ItemInventorySnapshot" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ItemKitComponent" : { "properties" : { "component_cost" : { "description" : "Component item cost", "type" : "number" }, "component_description" : { "description" : "Component item description", "type" : "string" }, "component_merchant_item_id" : { "description" : "Component item ID", "type" : "string" }, "component_merchant_item_oid" : { "description" : "Component item object identifier", "format" : "int32", "type" : "integer" }, "quantity" : { "description" : "Quantity", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ItemKitDefinition" : { "properties" : { "components" : { "description" : "Components", "items" : { "$ref" : "#/components/schemas/ItemKitComponent" }, "type" : "array" } }, "type" : "object" }, "ItemOption" : { "properties" : { "cost_if_specified" : { "description" : "Cost if specified", "type" : "number" }, "cost_per_letter" : { "description" : "Cost per letter", "type" : "number" }, "cost_per_line" : { "description" : "Cost per line", "type" : "number" }, "ignore_if_default" : { "description" : "Ignore this option on the order if the default value is selected", "type" : "boolean" }, "label" : { "description" : "Label", "maxLength" : 50, "type" : "string" }, "label_translated_text_instance_oid" : { "description" : "Label translated text instance ID", "format" : "int32", "type" : "integer" }, "name" : { "description" : "Name", "maxLength" : 50, "type" : "string" }, "name_translated_text_instance_oid" : { "description" : "Name translated text instance ID", "format" : "int32", "type" : "integer" }, "one_time_fee" : { "description" : "One time fee", "type" : "boolean" }, "option_oid" : { "description" : "Option object identifier", "format" : "int32", "type" : "integer" }, "required" : { "description" : "True if the customer is required to specify an answer", "type" : "boolean" }, "system_option" : { "description" : "True if this is a system option", "type" : "boolean" }, "type" : { "description" : "Type of option", "enum" : [ "dropdown", "file attachment", "fixed", "hidden", "multiline", "radio", "single" ], "type" : "string" }, "values" : { "description" : "Values", "items" : { "$ref" : "#/components/schemas/ItemOptionValue" }, "type" : "array" } }, "type" : "object" }, "ItemOptionValue" : { "properties" : { "additional_dimension_application" : { "description" : "Additional dimensions application", "enum" : [ "none", "set item to", "add item" ], "type" : "string" }, "additional_items" : { "description" : "Additional items to add to the order if this value is selected", "items" : { "$ref" : "#/components/schemas/ItemOptionValueAdditionalItem" }, "type" : "array" }, "cost_change" : { "description" : "Cost change", "type" : "number" }, "default_value" : { "description" : "True if default value", "type" : "boolean" }, "digital_items" : { "description" : "Digital items to allow the customer to download if this option value is selected", "items" : { "$ref" : "#/components/schemas/ItemOptionValueDigitalItem" }, "type" : "array" }, "height" : { "$ref" : "#/components/schemas/Distance" }, "length" : { "$ref" : "#/components/schemas/Distance" }, "merchant_item_multimedia_oid" : { "description" : "Multimedia object identifier associated with this option value", "format" : "int32", "type" : "integer" }, "option_value_oid" : { "description" : "Option value object identifier", "format" : "int32", "type" : "integer" }, "percent_cost_change" : { "description" : "Percentage cost change", "type" : "number" }, "translated_text_instance_oid" : { "description" : "Translated text instance id", "format" : "int32", "type" : "integer" }, "value" : { "description" : "Value", "maxLength" : 1024, "type" : "string" }, "weight_change" : { "$ref" : "#/components/schemas/Weight" }, "weight_change_percent" : { "description" : "Percentage weight change", "type" : "number" }, "width" : { "$ref" : "#/components/schemas/Distance" } }, "type" : "object" }, "ItemOptionValueAdditionalItem" : { "properties" : { "additional_merchant_item_id" : { "description" : "Additional item id", "type" : "string" }, "additional_merchant_item_oid" : { "description" : "Additional item object identifier", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ItemOptionValueDigitalItem" : { "properties" : { "digital_item_oid" : { "description" : "Digital item object identifier", "format" : "int32", "type" : "integer" }, "original_filename" : { "description" : "Original filename", "type" : "string" } }, "type" : "object" }, "ItemPaymentProcessing" : { "properties" : { "block_prepaid" : { "description" : "True if prepaid cards should be blocked from buying this item", "type" : "boolean" }, "block_refunds" : { "description" : "True if this item should block any refund attempts, set to false otherwise, null value will not update the field", "type" : "boolean" }, "credit_card_transaction_type" : { "description" : "Credit card transaction type", "type" : "string" }, "no_realtime_charge" : { "description" : "True if no real-time charge should be performed on this item.", "type" : "boolean" }, "payment_method_validity" : { "description" : "Payment method validity", "items" : { "type" : "string" }, "type" : "array" }, "rotating_transaction_gateway_codes" : { "description" : "Rotating transaction gateway codes", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "ItemPhysical" : { "properties" : { "height" : { "$ref" : "#/components/schemas/Distance" }, "length" : { "$ref" : "#/components/schemas/Distance" }, "weight" : { "$ref" : "#/components/schemas/Weight" }, "width" : { "$ref" : "#/components/schemas/Distance" } }, "type" : "object" }, "ItemPricing" : { "properties" : { "allow_arbitrary_cost" : { "description" : "Allow arbitrary cost", "type" : "boolean" }, "arbitrary_cost_velocity_code" : { "description" : "Arbitrary cost velocity code", "maxLength" : 10000, "type" : "string" }, "auto_order_cost" : { "description" : "Cost if customer selects to receive item on auto order. Set to zero to delete.", "type" : "number" }, "automatic_pricing_tier_name" : { "description" : "Automatic pricing tier name", "type" : "string" }, "automatic_pricing_tier_oid" : { "description" : "Automatic pricing tier object identifier", "format" : "int32", "type" : "integer" }, "cogs" : { "description" : "Cost of goods sold", "type" : "number" }, "cost" : { "description" : "Cost", "type" : "number" }, "currency_code" : { "description" : "Currency code", "maxLength" : 3, "type" : "string" }, "manufacturer_suggested_retail_price" : { "description" : "Manufacturer suggested retail price", "type" : "number" }, "maximum_arbitrary_cost" : { "description" : "Maximum arbitrary cost", "type" : "number" }, "minimum_advertised_price" : { "description" : "Minimum advertised price", "type" : "number" }, "minimum_arbitrary_cost" : { "description" : "Minimum arbitrary cost", "type" : "number" }, "mix_and_match_group" : { "description" : "Mix and match group", "type" : "string" }, "mix_and_match_group_oid" : { "description" : "Mix and match group object identifier", "format" : "int32", "type" : "integer" }, "sale_cost" : { "description" : "Sale cost", "type" : "number" }, "sale_end" : { "description" : "Sale end", "format" : "dateTime", "type" : "string" }, "sale_start" : { "description" : "Sale start", "format" : "dateTime", "type" : "string" }, "tiers" : { "description" : "Tiers", "items" : { "$ref" : "#/components/schemas/ItemPricingTier" }, "type" : "array" } }, "type" : "object" }, "ItemPricingTier" : { "properties" : { "default_tier" : { "description" : "True if this is the default tier", "type" : "boolean" }, "discounts" : { "description" : "Discounts", "items" : { "$ref" : "#/components/schemas/ItemPricingTierDiscount" }, "type" : "array" }, "limit" : { "$ref" : "#/components/schemas/ItemPricingTierLimit" }, "name" : { "description" : "Pricing tier name", "type" : "string" }, "pricing_tier_oid" : { "description" : "Pricing tier object identifier", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ItemPricingTierDiscount" : { "properties" : { "cost" : { "description" : "Cost", "type" : "number" }, "quantity" : { "description" : "Quantity", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ItemPricingTierLimit" : { "properties" : { "cumulative_order_limit" : { "description" : "Cumulative order limit", "format" : "int32", "type" : "integer" }, "exempt_from_minimum_item_count" : { "description" : "Exempt from Minimum Item Count", "type" : "boolean" }, "individual_order_limit" : { "description" : "Individual order limit", "format" : "int32", "type" : "integer" }, "multiple_quantity" : { "description" : "Multiple quantity", "format" : "int32", "type" : "integer" }, "payment_method_validity" : { "description" : "Payment method validity", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "ItemProperty" : { "properties" : { "expirationDts" : { "description" : "Expiration of the property", "format" : "dateTime", "type" : "string" }, "name" : { "description" : "Property name", "maxLength" : 100, "type" : "string" }, "value" : { "description" : "Property value", "maxLength" : 1000, "type" : "string" } }, "type" : "object" }, "ItemRealtimePricing" : { "properties" : { "realtime_pricing_parameter" : { "description" : "Real-time pricing provider parameters", "type" : "string" }, "realtime_pricing_provider" : { "description" : "Real-time pricing provider name", "type" : "string" }, "realtime_pricing_provider_oid" : { "description" : "Real-time pricing provide object identifier", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ItemRelated" : { "properties" : { "no_system_calculated_related_items" : { "description" : "True to suppress system calculated relationships", "type" : "boolean" }, "not_relatable" : { "description" : "Not relatable", "type" : "boolean" }, "related_items" : { "description" : "Related items", "items" : { "$ref" : "#/components/schemas/ItemRelatedItem" }, "type" : "array" } }, "type" : "object" }, "ItemRelatedItem" : { "properties" : { "related_merchant_item_id" : { "description" : "Related item id", "type" : "string" }, "related_merchant_item_oid" : { "description" : "Related item object identifier", "format" : "int32", "type" : "integer" }, "type" : { "description" : "Relationship type", "enum" : [ "System", "UserDefined", "Addon", "Complementary" ], "type" : "string" } }, "type" : "object" }, "ItemReporting" : { "properties" : { "report_as_upsell" : { "description" : "Report as an upsell", "type" : "boolean" }, "report_pickable_quantities" : { "description" : "Report pickable quantities (deprecated)", "items" : { "type" : "integer" }, "type" : "array" } }, "type" : "object" }, "ItemResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "item" : { "$ref" : "#/components/schemas/Item" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ItemRestriction" : { "properties" : { "exclude_coupon" : { "description" : "Exclude coupons", "type" : "boolean" }, "exclude_from_free_promotion" : { "description" : "Exclude from free promotion", "type" : "boolean" }, "exclude_from_loyalty" : { "description" : "Exclude from loyalty. Must be set to true or false to save. Null is ignored for backwards SDK compatibility", "type" : "boolean" }, "items" : { "description" : "Items", "items" : { "$ref" : "#/components/schemas/ItemRestrictionItem" }, "type" : "array" }, "maximum_quantity" : { "description" : "Maximum quantity", "format" : "int32", "type" : "integer" }, "minimum_quantity" : { "description" : "Minimum quantity (defaults to 1)", "format" : "int32", "type" : "integer" }, "multiple_quantity" : { "description" : "Multiple of quantity", "format" : "int32", "type" : "integer" }, "one_per_customer" : { "description" : "One per customer", "type" : "boolean" }, "purchase_separately" : { "description" : "Purchase separately", "type" : "boolean" } }, "type" : "object" }, "ItemRestrictionItem" : { "properties" : { "restrict_merchant_item_id" : { "description" : "Restrict item id", "type" : "string" }, "restrict_merchant_item_oid" : { "description" : "Restrict item object identifier", "format" : "int32", "type" : "integer" }, "type" : { "description" : "Restriction type", "enum" : [ "can not be purchased with", "can only be purchased with", "must be purchased with" ], "type" : "string" } }, "type" : "object" }, "ItemRevguard" : { "properties" : { "revguard_canceled_csr_prompt_group" : { "description" : "Canceled CSR prompt group", "format" : "int64", "type" : "integer" }, "revguard_canceled_ivr_prompt_group" : { "description" : "IVR prompt group", "format" : "int64", "type" : "integer" }, "revguard_canceled_web_prompt_group" : { "description" : "Canceled web prompt group", "format" : "int64", "type" : "integer" }, "revguard_client_brand" : { "description" : "Client brand", "format" : "int64", "type" : "integer" }, "revguard_csr_prompt_group" : { "description" : "CSR prompt group", "format" : "int64", "type" : "integer" }, "revguard_ivr_prompt_group" : { "description" : "IVR prompt group", "format" : "int64", "type" : "integer" }, "revguard_web_prompt_group" : { "description" : "Web prompt group", "format" : "int64", "type" : "integer" } }, "type" : "object" }, "ItemReview" : { "properties" : { "customer_profile_oid" : { "description" : "Customer profile object identifier", "format" : "int32", "type" : "integer" }, "featured" : { "type" : "boolean" }, "helperful_no_votes" : { "format" : "int32", "type" : "integer" }, "helpful_yes_votes" : { "format" : "int32", "type" : "integer" }, "merchant_reply" : { "description" : "Merchant Reply (set to an empty string to remove)", "maxLength" : 10000, "type" : "string" }, "order_id" : { "type" : "string" }, "overall" : { "type" : "number" }, "rating_name1" : { "description" : "Rating Name 1", "maxLength" : 100, "type" : "string" }, "rating_name10" : { "description" : "Rating Name 10", "maxLength" : 100, "type" : "string" }, "rating_name2" : { "description" : "Rating Name 2", "maxLength" : 100, "type" : "string" }, "rating_name3" : { "description" : "Rating Name 3", "maxLength" : 100, "type" : "string" }, "rating_name4" : { "description" : "Rating Name 4", "maxLength" : 100, "type" : "string" }, "rating_name5" : { "description" : "Rating Name 5", "maxLength" : 100, "type" : "string" }, "rating_name6" : { "description" : "Rating Name 6", "maxLength" : 100, "type" : "string" }, "rating_name7" : { "description" : "Rating Name 7", "maxLength" : 100, "type" : "string" }, "rating_name8" : { "description" : "Rating Name 8", "maxLength" : 100, "type" : "string" }, "rating_name9" : { "description" : "Rating Name 9", "maxLength" : 100, "type" : "string" }, "rating_score1" : { "type" : "number" }, "rating_score10" : { "type" : "number" }, "rating_score2" : { "type" : "number" }, "rating_score3" : { "type" : "number" }, "rating_score4" : { "type" : "number" }, "rating_score5" : { "type" : "number" }, "rating_score6" : { "type" : "number" }, "rating_score7" : { "type" : "number" }, "rating_score8" : { "type" : "number" }, "rating_score9" : { "type" : "number" }, "recommend_store_to_friend" : { "format" : "int32", "type" : "integer" }, "recommend_to_friend" : { "type" : "boolean" }, "review" : { "description" : "Review", "maxLength" : 10000, "type" : "string" }, "review_oid" : { "format" : "int32", "type" : "integer" }, "reviewed_nickname" : { "description" : "Nickname", "maxLength" : 25, "type" : "string" }, "reviewer_email" : { "description" : "Reviewer Email", "maxLength" : 100, "type" : "string" }, "reviewer_location" : { "description" : "Location", "maxLength" : 25, "type" : "string" }, "status" : { "description" : "Status of the review", "enum" : [ "approved", "unapproved", "rejected", "multimedia processing" ], "type" : "string" }, "store_feedback" : { "description" : "Store Feedback", "maxLength" : 10000, "type" : "string" }, "submitted_dts" : { "description" : "Date/time of review submission", "format" : "dateTime", "type" : "string" }, "title" : { "description" : "Title", "maxLength" : 250, "type" : "string" } }, "type" : "object" }, "ItemReviewResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "review" : { "$ref" : "#/components/schemas/ItemReview" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ItemReviews" : { "properties" : { "has_approved_review" : { "description" : "True if the item has an approved review", "type" : "boolean" }, "has_review" : { "description" : "True if the item has a review", "type" : "boolean" }, "individual_reviews" : { "items" : { "$ref" : "#/components/schemas/ItemReview" }, "type" : "array" }, "review_count" : { "description" : "Number of approved reviews", "format" : "int32", "type" : "integer" }, "review_overall" : { "description" : "Overall score of reviews", "type" : "number" }, "review_template_name" : { "description" : "Review template name", "type" : "string" }, "review_template_oid" : { "description" : "Review template object identifier", "format" : "int32", "type" : "integer" }, "reviewable" : { "description" : "True if the item is reviewable", "type" : "boolean" }, "share_reviews_with_merchant_item_id" : { "description" : "Share reviews with item id. To set, use the share_reviews_with_merchant_item_oid field.", "type" : "string" }, "share_reviews_with_merchant_item_oid" : { "description" : "Share reviews with item oid. To null out this field, set teh value to zero.", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ItemReviewsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "reviews" : { "description" : "reviews", "items" : { "$ref" : "#/components/schemas/ItemReview" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ItemSalesforce" : { "properties" : { "sfdc_pricebook_id" : { "description" : "Salesforce.com pricebook id", "type" : "string" }, "sfdc_product_id" : { "description" : "Salesforce.com product id", "type" : "string" } }, "type" : "object" }, "ItemShipping" : { "properties" : { "allow_back_order" : { "description" : "Allow back order", "type" : "boolean" }, "amazon_fba" : { "description" : "Fulfillment by Amazon.com", "type" : "boolean" }, "case_inner_packs" : { "description" : "Case inner packs", "format" : "int32", "type" : "integer" }, "case_units" : { "description" : "Case units", "format" : "int32", "type" : "integer" }, "cases" : { "description" : "Cases", "items" : { "$ref" : "#/components/schemas/ItemShippingCase" }, "type" : "array" }, "collect_serial_numbers" : { "description" : "This item is on pre-order", "type" : "boolean" }, "country_code_of_origin" : { "description" : "Country code of origin for customs forms. (ISO-3166 two letter code)", "maxLength" : 2, "type" : "string" }, "customs_description" : { "description" : "Customs description", "type" : "string" }, "customs_value" : { "description" : "Customs value", "type" : "number" }, "delivery_on_friday" : { "description" : "Delivery on Friday", "type" : "boolean" }, "delivery_on_monday" : { "description" : "Delivery on Monday", "type" : "boolean" }, "delivery_on_saturday" : { "description" : "Delivery on Saturday", "type" : "boolean" }, "delivery_on_sunday" : { "description" : "Delivery on Sunday", "type" : "boolean" }, "delivery_on_thursday" : { "description" : "Delivery on Thursday", "type" : "boolean" }, "delivery_on_tuesday" : { "description" : "Delivery on Tuesday", "type" : "boolean" }, "delivery_on_wednesday" : { "description" : "Delivery on Wednesday", "type" : "boolean" }, "destination_markups" : { "description" : "Destination markups", "items" : { "$ref" : "#/components/schemas/ItemShippingDestinationMarkup" }, "type" : "array" }, "destination_restrictions" : { "description" : "Destination restrictions", "items" : { "$ref" : "#/components/schemas/ItemShippingDestinationRestriction" }, "type" : "array" }, "distribution_centers" : { "description" : "Distribution centers", "items" : { "$ref" : "#/components/schemas/ItemShippingDistributionCenter" }, "type" : "array" }, "eta" : { "description" : "Estimated time of arrival", "format" : "dateTime", "type" : "string" }, "free_shipping" : { "description" : "Qualifies for free shipping", "type" : "boolean" }, "freight_class" : { "description" : "Freight class", "type" : "string" }, "hazmat" : { "description" : "Hazardous material", "type" : "boolean" }, "hold_for_transmission" : { "description" : "Hold for transmission", "type" : "boolean" }, "include_on_packing_slip" : { "description" : "Force this item onto the packing slip even if there is no weight.", "type" : "boolean" }, "made_to_order" : { "description" : "True if this item is made to order", "type" : "boolean" }, "made_to_order_lead_time" : { "description" : "Number of days lead time it takes to make the item before ite can ship", "format" : "int32", "type" : "integer" }, "max_days_time_in_transit" : { "description" : "Maximum days allowed in transit", "format" : "int32", "type" : "integer" }, "methods" : { "description" : "Methods", "items" : { "$ref" : "#/components/schemas/ItemShippingMethod" }, "type" : "array" }, "no_shipping_discount" : { "description" : "No shipping discounts", "type" : "boolean" }, "one_line_per_unit" : { "description" : "Split cart line items with quantity greater than one into individual lines of quantity one on the order", "type" : "boolean" }, "package_requirements" : { "description" : "Package requirements", "items" : { "$ref" : "#/components/schemas/ItemShippingPackageRequirement" }, "type" : "array" }, "perishable_class_name" : { "description" : "Perishable class name", "type" : "string" }, "perishable_class_oid" : { "description" : "Perishable class object identifier", "format" : "int32", "type" : "integer" }, "preorder" : { "description" : "This item is on pre-order", "type" : "boolean" }, "require_delivery_date" : { "description" : "True to require customer to select a delivery date", "type" : "boolean" }, "restrict_shipment_on_friday" : { "description" : "Restrict shipment on Friday", "type" : "boolean" }, "restrict_shipment_on_monday" : { "description" : "Restrict shipment on Monday", "type" : "boolean" }, "restrict_shipment_on_saturday" : { "description" : "Restrict shipment on Saturday", "type" : "boolean" }, "restrict_shipment_on_sunday" : { "description" : "Restrict shipment on Sunday", "type" : "boolean" }, "restrict_shipment_on_thursday" : { "description" : "Restrict shipment on Thursday", "type" : "boolean" }, "restrict_shipment_on_tuesday" : { "description" : "Restrict shipment on Tuesday", "type" : "boolean" }, "restrict_shipment_on_wednesday" : { "description" : "Restrict shipment on Wednesday", "type" : "boolean" }, "send_to_hold_before_fulfillment" : { "description" : "Send order to hold stage before fulfillment", "type" : "boolean" }, "ship_separately" : { "description" : "Ship this item in a separate box", "type" : "boolean" }, "ship_separately_additional_weight" : { "$ref" : "#/components/schemas/Weight" }, "ship_separately_height" : { "$ref" : "#/components/schemas/Distance" }, "ship_separately_length" : { "$ref" : "#/components/schemas/Distance" }, "ship_separately_package_special_type" : { "description" : "Ship separately package special type", "type" : "string" }, "ship_separately_width" : { "$ref" : "#/components/schemas/Distance" }, "special_product_type" : { "description" : "Special product type (USPS Media Mail)", "type" : "string" }, "track_inventory" : { "description" : "Track inventory", "type" : "boolean" } }, "type" : "object" }, "ItemShippingCase" : { "properties" : { "case_label" : { "description" : "Case label", "maxLength" : 20, "type" : "string" }, "case_merchant_item_id" : { "description" : "Case item id", "type" : "string" }, "case_merchant_item_oid" : { "description" : "Case item object identifier", "format" : "int32", "type" : "integer" }, "quantity" : { "description" : "Case quantity", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ItemShippingDestinationMarkup" : { "properties" : { "adult_signature_required" : { "description" : "Adult Signature Required (only updated if not-null value provided)", "type" : "boolean" }, "country_code" : { "description" : "Country code (ISO-3166 two letter)", "maxLength" : 2, "type" : "string" }, "flat_fee" : { "description" : "Flat fee", "type" : "number" }, "per_item" : { "description" : "Per item", "type" : "number" }, "postal_code" : { "description" : "Postal code", "maxLength" : 20, "type" : "string" }, "shipping_method" : { "description" : "Shipping method", "type" : "string" }, "state" : { "description" : "State", "maxLength" : 32, "type" : "string" } }, "type" : "object" }, "ItemShippingDestinationRestriction" : { "properties" : { "country_code" : { "description" : "Country code (ISO-3166 two letter)", "maxLength" : 2, "type" : "string" }, "state" : { "description" : "State", "maxLength" : 32, "type" : "string" }, "validity" : { "description" : "Validity", "enum" : [ "valid only for", "invalid for" ], "type" : "string" } }, "type" : "object" }, "ItemShippingDistributionCenter" : { "properties" : { "allocated_to_placed_orders" : { "description" : "Allocated to placed orders", "type" : "number" }, "allocated_to_shopping_carts" : { "description" : "Allocated to shopping carts", "type" : "number" }, "available_to_allocate" : { "description" : "Available to allocate", "type" : "number" }, "cogs" : { "description" : "Cost of goods sold override at the distribution center level", "type" : "number" }, "desired_inventory_level" : { "description" : "Desired inventory level", "type" : "number" }, "distribution_center_code" : { "description" : "Distribution center code", "type" : "string" }, "distribution_center_oid" : { "description" : "Distribution center object identifier", "format" : "int32", "type" : "integer" }, "eta" : { "description" : "Estimated time of arrival", "format" : "dateTime", "type" : "string" }, "handles" : { "description" : "True if this distribution center handles this item", "type" : "boolean" }, "inventory_level" : { "description" : "Inventory level", "type" : "number" }, "maximum_backorder" : { "description" : "Maximum back-order", "format" : "int32", "type" : "integer" }, "reorder_inventory_level" : { "description" : "Reorder inventory level (triggers notification)", "type" : "number" }, "sku" : { "description" : "SKU", "maxLength" : 50, "type" : "string" }, "stock_picking_location" : { "description" : "Stock picking location", "maxLength" : 20, "type" : "string" } }, "type" : "object" }, "ItemShippingMethod" : { "properties" : { "cost" : { "description" : "Cost", "type" : "number" }, "each_additional_item_markup" : { "description" : "Each additional item markup", "type" : "number" }, "filter_to_if_available" : { "description" : "Filter to this method if available", "type" : "boolean" }, "first_item_markup" : { "description" : "First item markup", "type" : "number" }, "fixed_shipping_cost" : { "description" : "Fixed shipping cost", "type" : "number" }, "flat_fee_markup" : { "description" : "Flat fee markup", "type" : "number" }, "free_shipping" : { "description" : "Free shipping", "type" : "boolean" }, "per_item_fee_markup" : { "description" : "Per item fee markup", "type" : "number" }, "percentage_markup" : { "description" : "Percentage markup", "type" : "number" }, "percentage_of_item_markup" : { "description" : "Percentage of item markup", "type" : "number" }, "relax_restrictions_on_upsell" : { "description" : "Relax restrictions on upsell", "type" : "boolean" }, "shipping_method" : { "description" : "Shipping method name", "type" : "string" }, "shipping_method_oid" : { "description" : "Shipping method object identifier", "format" : "int32", "type" : "integer" }, "shipping_method_validity" : { "description" : "Shipping method validity", "enum" : [ "invalid for", "valid for", "valid only for" ], "type" : "string" }, "ships_separately" : { "description" : "Ships separately", "type" : "boolean" }, "signature_required" : { "description" : "Signature required", "type" : "boolean" } }, "type" : "object" }, "ItemShippingPackageRequirement" : { "properties" : { "package_name" : { "description" : "Package name", "type" : "string" }, "package_oid" : { "description" : "Package object identifier", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ItemsRequest" : { "properties" : { "items" : { "description" : "items", "items" : { "$ref" : "#/components/schemas/Item" }, "type" : "array" } }, "type" : "object" }, "ItemsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "items" : { "description" : "items", "items" : { "$ref" : "#/components/schemas/Item" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ItemTag" : { "properties" : { "tagType" : { "description" : "tag_type", "enum" : [ "item", "order", "customer" ], "type" : "string" }, "tagValue" : { "description" : "tag_value", "maxLength" : 100, "type" : "string" } }, "type" : "object" }, "ItemTags" : { "properties" : { "tags" : { "description" : "tags", "items" : { "$ref" : "#/components/schemas/ItemTag" }, "type" : "array" } }, "type" : "object" }, "ItemTax" : { "properties" : { "exemptions" : { "description" : "Exemptions", "items" : { "$ref" : "#/components/schemas/ItemTaxExemption" }, "type" : "array" }, "tax_free" : { "description" : "True if tax free", "type" : "boolean" }, "tax_product_type" : { "description" : "Tax product type", "enum" : [ "", "digital", "physical", "service" ], "type" : "string" }, "taxable_cost" : { "description" : "Taxable cost if different than regular cost", "type" : "number" } }, "type" : "object" }, "ItemTaxExemption" : { "properties" : { "city" : { "description" : "City", "maxLength" : 32, "type" : "string" }, "country_code" : { "description" : "Country code (ISO-3166 two letter)", "maxLength" : 2, "type" : "string" }, "county" : { "description" : "County", "maxLength" : 32, "type" : "string" }, "postal_code" : { "description" : "Postal code", "maxLength" : 20, "type" : "string" }, "state_code" : { "description" : "State code", "maxLength" : 32, "type" : "string" } }, "type" : "object" }, "ItemThirdPartyEmailMarketing" : { "properties" : { "add_tags" : { "description" : "Add tags", "items" : { "type" : "string" }, "type" : "array" }, "provider_name" : { "description" : "Provider name", "enum" : [ "ActiveCampaign", "AWeber", "Campaign Monitor", "ConstantContact", "Emma", "GetResponse", "iContact", "Klaviyo", "Lyris", "LyrisHQ", "MailChimp", "SilverPop" ], "type" : "string" }, "remove_tags" : { "description" : "Remove tags", "items" : { "type" : "string" }, "type" : "array" }, "subscribe_lists" : { "description" : "Subscribe to lists", "items" : { "type" : "string" }, "type" : "array" }, "unsubscribe_lists" : { "description" : "Unsubscribe from lists", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "ItemVariantItem" : { "properties" : { "description" : { "description" : "Description", "maxLength" : 512, "type" : "string" }, "merchant_item_multimedia_oid" : { "description" : "Multimedia object identifier", "format" : "int32", "type" : "integer" }, "variant_default_multimedia" : { "$ref" : "#/components/schemas/ItemContentMultimedia" }, "variant_merchant_item_id" : { "description" : "Variant item id", "type" : "string" }, "variant_merchant_item_oid" : { "description" : "Variant item object identifier", "format" : "int32", "type" : "integer" }, "variant_pricing" : { "$ref" : "#/components/schemas/ItemPricing" }, "variation_options" : { "description" : "Variation options", "items" : { "type" : "string" }, "type" : "array" }, "variations" : { "description" : "Variations", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "ItemVariation" : { "properties" : { "default_text" : { "description" : "Default text", "maxLength" : 50, "type" : "string" }, "default_text_translated_text_instance_oid" : { "description" : "Default text translated text instance id", "format" : "int32", "type" : "integer" }, "name" : { "description" : "Name", "maxLength" : 50, "type" : "string" }, "name_translated_text_instance_oid" : { "description" : "Name translated text instance id", "format" : "int32", "type" : "integer" }, "options" : { "description" : "Options", "items" : { "$ref" : "#/components/schemas/ItemVariationOption" }, "type" : "array" } }, "type" : "object" }, "ItemVariationOption" : { "properties" : { "default_option" : { "description" : "True if default option", "type" : "boolean" }, "merchant_item_multimedia_oid" : { "description" : "Multimedia object identifier", "format" : "int32", "type" : "integer" }, "translated_text_instance_oid" : { "description" : "Translated text instance id", "format" : "int32", "type" : "integer" }, "value" : { "description" : "Value", "maxLength" : 50, "type" : "string" } }, "type" : "object" }, "ItemWishlistMember" : { "properties" : { "wishlist_member_instance_description" : { "description" : "WishList Member instance description", "type" : "string" }, "wishlist_member_instance_oid" : { "description" : "WishList Member instance object identifier", "format" : "int32", "type" : "integer" }, "wishlist_member_sku" : { "description" : "WishList Member SKU", "maxLength" : 25, "type" : "string" } }, "type" : "object" }, "KeyValue" : { "properties" : { "description" : { "description" : "Optional description of the lookup value", "type" : "string" }, "key" : { "description" : "The key or id of this lookup value", "type" : "string" }, "value" : { "description" : "The value of this lookup value", "type" : "string" } }, "type" : "object" }, "LibraryFilterValues" : { "properties" : { "categories" : { "items" : { "type" : "string" }, "type" : "array" }, "industries" : { "items" : { "type" : "string" }, "type" : "array" }, "styles" : { "items" : { "type" : "string" }, "type" : "array" }, "types" : { "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "LibraryFilterValuesResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "filter_values" : { "$ref" : "#/components/schemas/LibraryFilterValues" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "LibraryItem" : { "properties" : { "assets" : { "items" : { "$ref" : "#/components/schemas/LibraryItemAsset" }, "type" : "array" }, "attributes" : { "items" : { "$ref" : "#/components/schemas/LibraryItemAttribute" }, "type" : "array" }, "categories" : { "items" : { "type" : "string" }, "type" : "array" }, "content" : { "type" : "string" }, "content_type" : { "type" : "string" }, "description" : { "type" : "string" }, "industries" : { "items" : { "type" : "string" }, "type" : "array" }, "library_item_oid" : { "format" : "int32", "type" : "integer" }, "merchant_id" : { "type" : "string" }, "my_purchased_version" : { "description" : "If this is a public item and the merchant has already purchased it, this is their version. If not yet purchased, this will be zero. This value will only be populated during a searchPublicItems() call.", "format" : "int32", "type" : "integer" }, "original_object_id" : { "description" : "This id points to the original object that was added to the library. For flows and campaigns, this is a uuid string. For upsells, it is an oid integer. For transactional_emails, it is an email name.", "type" : "string" }, "price" : { "description" : "The price of the published item. Null for any private library items.", "type" : "number" }, "price_formatted" : { "description" : "The formatted price of the published item. Null for any private library items.", "type" : "string" }, "published" : { "description" : "True if this library item is a published item (not source)", "type" : "boolean" }, "published_dts" : { "description" : "The timestamp of the last published version", "type" : "object" }, "published_from_library_item_oid" : { "description" : "The source item used to publish this item. This allows for comparisons between source and published", "format" : "int32", "type" : "integer" }, "published_meta" : { "$ref" : "#/components/schemas/LibraryItemPublishedMeta" }, "published_version" : { "description" : "The source version when this item was published. This allows for out-of-date alerts to be shown when there is a difference between source and published", "format" : "int32", "type" : "integer" }, "purchased" : { "description" : "True if this library item has been purchased", "type" : "boolean" }, "purchased_from_library_item_oid" : { "description" : "The published item that was purchased to make this item. This allows for comparisons between published and purchased", "format" : "int32", "type" : "integer" }, "purchased_meta" : { "$ref" : "#/components/schemas/LibraryItemPurchasedMeta" }, "purchased_version" : { "description" : "The published version when this item was purchased. This allows for out-of-date alerts to be shown when there is a difference between published and purchased", "format" : "int32", "type" : "integer" }, "rejected" : { "description" : "Any published library reviewed by UltraCart staff for malicious or inappropriate content will have this flag set to true. This is always false for non-published items", "type" : "boolean" }, "rejected_reason" : { "description" : "Any rejected published item will have this field populated with the reason.", "type" : "string" }, "release_notes" : { "description" : "Release notes specific to each published version and only appearing on public items.", "type" : "string" }, "release_version" : { "description" : "This counter records how many times a library item has been published. This is used to show version history.", "format" : "int32", "type" : "integer" }, "reviewed" : { "description" : "Any published library items must be reviewed by UltraCart staff for malicious content. This flag shows the status of that review. This is always false for non-published items", "type" : "boolean" }, "reviewed_dts" : { "description" : "This is the timestamp for a published items formal review by UltraCart staff for malicious content.", "type" : "object" }, "screenshots" : { "items" : { "$ref" : "#/components/schemas/LibraryItemScreenshot" }, "type" : "array" }, "share_with_accounts" : { "items" : { "$ref" : "#/components/schemas/LibraryItemAccount" }, "type" : "array" }, "share_with_other_emails" : { "items" : { "$ref" : "#/components/schemas/LibraryItemEmail" }, "type" : "array" }, "shared" : { "description" : "True if this item is shared from another merchant account", "type" : "boolean" }, "source" : { "description" : "True if this library item has been published", "type" : "boolean" }, "source_to_library_item_oid" : { "description" : "This oid points to the published library item, if there is one.", "format" : "int32", "type" : "integer" }, "source_version" : { "description" : "The version of this item. Increment every time the item is saved.", "format" : "int32", "type" : "integer" }, "style" : { "type" : "string" }, "times_purchased" : { "format" : "int32", "type" : "integer" }, "title" : { "type" : "string" }, "type" : { "type" : "string" }, "under_review" : { "description" : "True if this library item was published but is awaiting review from UltraCart staff.", "type" : "boolean" } }, "type" : "object" }, "LibraryItemAccount" : { "properties" : { "library_item_account_oid" : { "format" : "int32", "type" : "integer" }, "library_item_oid" : { "format" : "int32", "type" : "integer" }, "other_merchant_id" : { "type" : "string" } }, "type" : "object" }, "LibraryItemAsset" : { "properties" : { "mime_type" : { "type" : "string" }, "url" : { "type" : "string" } }, "type" : "object" }, "LibraryItemAttribute" : { "properties" : { "name" : { "type" : "string" }, "value" : { "type" : "string" } }, "type" : "object" }, "LibraryItemEmail" : { "properties" : { "email" : { "type" : "string" }, "library_item_email_oid" : { "format" : "int32", "type" : "integer" }, "library_item_oid" : { "format" : "int32", "type" : "integer" } }, "type" : "object" }, "LibraryItemPublishedMeta" : { "properties" : { "count_of_versions" : { "description" : "The number of published versions a source item has, or zero if this item is not a source or is private", "format" : "int32", "type" : "integer" }, "library_item_published_oid" : { "description" : "The oid pointing to the most recent published version, or zero if this is not a published source item.", "format" : "int32", "type" : "integer" }, "library_item_review_oid" : { "description" : "The oid pointing to the review data if this is a source library item and currently under review", "format" : "int32", "type" : "integer" }, "rejected" : { "description" : "True if this is a source item and is under review and was rejected.", "type" : "boolean" }, "rejected_reason" : { "description" : "The reason for rejection if this item is a source item, is under review, and was rejected. For all other cases, this value will be null or missing.", "type" : "string" }, "release_version" : { "description" : "If this library item is a source item and it is published, this is the most recent release version number", "format" : "int32", "type" : "integer" }, "review_version" : { "description" : "If this library item is a source item and has a published item currently under review, this is that version number", "format" : "int32", "type" : "integer" }, "under_review" : { "description" : "True if this library item is a source item and is currently under review", "type" : "boolean" } }, "type" : "object" }, "LibraryItemPurchasedMeta" : { "properties" : { "most_recent_version" : { "description" : "The most recent version of the item purchased", "format" : "int32", "type" : "integer" }, "my_purchased_version" : { "description" : "If this is a public item and the merchant has already purchased it, this is their version. If not yet purchased, this will be zero. This value will only be populated during a searchPublicItems() call.", "format" : "int32", "type" : "integer" }, "upgrade_available" : { "description" : "True if the most recent version of this purchase it greater than what was purchased", "type" : "boolean" } }, "type" : "object" }, "LibraryItemQuery" : { "properties" : { "category" : { "description" : "Category", "type" : "string" }, "content_type" : { "description" : "Library item content type such as flow, campaign, cjson, email, or transactional_email", "type" : "string" }, "description" : { "description" : "Description of library item", "type" : "string" }, "industry" : { "description" : "Industry", "type" : "string" }, "price_high" : { "description" : "Maximum price", "type" : "number" }, "price_low" : { "description" : "Minimum price", "type" : "number" }, "published_dts_begin" : { "description" : "Minimum published date/time", "type" : "string" }, "published_dts_end" : { "description" : "Maximum published date/time", "type" : "string" }, "source_of_published" : { "description" : "Boolean, true if this library item has been published and is the master copy of that published work", "type" : "boolean" }, "style" : { "description" : "Library item style", "type" : "string" }, "title" : { "description" : "Title of the library item", "type" : "string" }, "type" : { "description" : "Library item type such as header, footer, shipping block, etc", "type" : "string" } }, "type" : "object" }, "LibraryItemResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "library_item" : { "$ref" : "#/components/schemas/LibraryItem" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "LibraryItemScreenshot" : { "properties" : { "default_url" : { "type" : "boolean" }, "screenshot_url" : { "type" : "string" } }, "type" : "object" }, "LibraryItemsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "items" : { "description" : "Library items", "items" : { "$ref" : "#/components/schemas/LibraryItem" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "LinkedAccount" : { "properties" : { "company" : { "description" : "The company name of this linked account.", "type" : "string" }, "merchant_id" : { "description" : "A merchant id that is linked to this account.", "type" : "string" }, "selected" : { "description" : "If true, this user configuration (permissions, notifications, everything) is cascaded to this linked account.", "type" : "boolean" } }, "type" : "object" }, "ListSegmentMembership" : { "properties" : { "name" : { "type" : "string" }, "type" : { "type" : "string" }, "uuid" : { "type" : "string" } }, "type" : "object" }, "LookupRequest" : { "properties" : { "category" : { "type" : "string" }, "matches" : { "type" : "string" }, "max_hits" : { "format" : "int32", "type" : "integer" }, "storefront_host_name" : { "type" : "string" }, "storefront_oid" : { "format" : "int32", "type" : "integer" }, "subcategory" : { "type" : "string" } }, "type" : "object" }, "LookupResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "values" : { "items" : { "$ref" : "#/components/schemas/KeyValue" }, "type" : "array" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "Mailgun" : { "properties" : { "api_key" : { "type" : "string" } }, "type" : "object" }, "Metric" : { "properties" : { "all_time" : { "type" : "number" }, "all_time_formatted" : { "type" : "string" }, "last_30" : { "type" : "number" }, "last_30_formatted" : { "type" : "string" }, "name" : { "type" : "string" }, "prior_30" : { "type" : "number" }, "prior_30_formatted" : { "type" : "string" }, "type" : { "type" : "string" } }, "type" : "object" }, "Notification" : { "properties" : { "can_filter_by_distribution_centers" : { "description" : "True if this notification can be filtered to only send for one or more distribution centers.", "type" : "boolean" }, "can_include_affiliate" : { "description" : "True if this notification can include an affiliate information.", "type" : "boolean" }, "can_include_order" : { "description" : "True if this notification can include an order attachment.", "type" : "boolean" }, "can_include_order_plain_text" : { "description" : "True if this notification can include a plain text rendering of an order directly within an email. Some desire this over an attachment", "type" : "boolean" }, "distribution_center_filters" : { "description" : "If this notification supports it, this list of distribution center CODES will filter the notification to just those distribution centers.", "items" : { "type" : "string" }, "type" : "array" }, "include_affiliate" : { "description" : "If true, and this notification supports it, affiliate information will be attached to all notifications of this type", "type" : "boolean" }, "include_order" : { "description" : "If true, and this notification supports it, the order will be attached to all notifications of this type", "type" : "boolean" }, "include_order_plain_text" : { "description" : "If true, and this notification supports it, a plain text order will be directly inserted into all notifications of this type", "type" : "boolean" }, "name" : { "description" : "The name of this notification.", "type" : "string" }, "notification_group" : { "description" : "A group for this notification. This name is only used for visual grouping within interfaces.", "type" : "string" }, "selected" : { "description" : "True if this user wishes to receive this email notification.", "type" : "boolean" } }, "type" : "object" }, "OauthDeviceAuthorizationResponse" : { "properties" : { "device_code" : { "description" : "The device verification code", "type" : "string" }, "expires_in" : { "description" : "The lifetime in seconds of the device_code and user_code", "format" : "int32", "type" : "integer" }, "interval" : { "description" : "The minimum amount of time in seconds the client should wait between polling requests", "format" : "int32", "type" : "integer" }, "user_code" : { "description" : "The end-user verification code", "type" : "string" }, "verification_uri" : { "description" : "The end-user verification URI on the authorization server", "type" : "string" }, "verification_uri_complete" : { "description" : "The verification URI with the user code pre-filled", "type" : "string" } }, "type" : "object" }, "OauthRevokeSuccessResponse" : { "properties" : { "message" : { "description" : "Message confirming revocation of credentials", "type" : "string" }, "successful" : { "description" : "True if revoke was successful", "type" : "boolean" } }, "type" : "object" }, "OauthTokenResponse" : { "properties" : { "access_token" : { "description" : "Access token to use in OAuth authenticated API call", "type" : "string" }, "error" : { "type" : "string" }, "error_description" : { "type" : "string" }, "error_uri" : { "type" : "string" }, "expires_in" : { "description" : "The number of seconds since issuance when the access token will expire and need to be refreshed using the refresh token", "type" : "string" }, "refresh_token" : { "description" : "The refresh token that should be used to fetch a new access token when the expiration occurs", "type" : "string" }, "scope" : { "description" : "The scope of permissions associated with teh access token", "type" : "string" }, "token_type" : { "description" : "Type of token", "enum" : [ "bearer" ], "type" : "string" } }, "type" : "object" }, "Order" : { "properties" : { "affiliates" : { "description" : "Affiliates if any were associated with the order. The first one in the array sent the order and each subsequent affiliate is the recruiter that earns a downline commission.", "items" : { "$ref" : "#/components/schemas/OrderAffiliate" }, "type" : "array" }, "auto_order" : { "$ref" : "#/components/schemas/OrderAutoOrder" }, "billing" : { "$ref" : "#/components/schemas/OrderBilling" }, "buysafe" : { "$ref" : "#/components/schemas/OrderBuysafe" }, "channel_partner" : { "$ref" : "#/components/schemas/OrderChannelPartner" }, "checkout" : { "$ref" : "#/components/schemas/OrderCheckout" }, "coupons" : { "description" : "Coupons", "items" : { "$ref" : "#/components/schemas/OrderCoupon" }, "type" : "array" }, "creation_dts" : { "description" : "Date/time that the order was created", "format" : "dateTime", "type" : "string" }, "currency_code" : { "description" : "Currency code that the customer used if different than the merchant's base currency code", "maxLength" : 3, "type" : "string" }, "current_stage" : { "description" : "Current stage that the order is in.", "enum" : [ "Accounts Receivable", "Pending Clearance", "Fraud Review", "Rejected", "Shipping Department", "Completed Order", "Quote Request", "Quote Sent", "Least Cost Routing", "Unknown", "Pre-ordered", "Advanced Order Routing", "Hold" ], "type" : "string" }, "current_stage_histories" : { "description" : "History of the changes to the current_stage field", "items" : { "$ref" : "#/components/schemas/OrderCurrentStageHistory" }, "type" : "array" }, "customer_profile" : { "$ref" : "#/components/schemas/Customer" }, "digital_order" : { "$ref" : "#/components/schemas/OrderDigitalOrder" }, "edi" : { "$ref" : "#/components/schemas/OrderEdi" }, "emails" : { "description" : "Email delivery records associated with this order.", "items" : { "$ref" : "#/components/schemas/OrderEmail" }, "type" : "array" }, "exchange_rate" : { "description" : "Exchange rate at the time the order was placed if currency code is different than the base currency", "type" : "number" }, "fraud_score" : { "$ref" : "#/components/schemas/OrderFraudScore" }, "gift" : { "$ref" : "#/components/schemas/OrderGift" }, "gift_certificate" : { "$ref" : "#/components/schemas/OrderGiftCertificate" }, "internal" : { "$ref" : "#/components/schemas/OrderInternal" }, "items" : { "description" : "Items", "items" : { "$ref" : "#/components/schemas/OrderItem" }, "type" : "array" }, "language_iso_code" : { "description" : "Three letter ISO-639 language code used by the customer during the checkout if different than the default language", "maxLength" : 3, "type" : "string" }, "linked_shipment" : { "$ref" : "#/components/schemas/OrderLinkedShipment" }, "marketing" : { "$ref" : "#/components/schemas/OrderMarketing" }, "merchant_id" : { "description" : "UltraCart merchant ID owning this order", "type" : "string" }, "order_id" : { "description" : "Order ID", "type" : "string" }, "payment" : { "$ref" : "#/components/schemas/OrderPayment" }, "point_of_sale" : { "$ref" : "#/components/schemas/OrderPointOfSale" }, "properties" : { "description" : "Properties, available only through update, not through insert due to the nature of how properties are handled internally", "items" : { "$ref" : "#/components/schemas/OrderProperty" }, "type" : "array" }, "quote" : { "$ref" : "#/components/schemas/OrderQuote" }, "refund_dts" : { "description" : "If the order was refunded, the date/time that the last refund occurred", "format" : "dateTime", "type" : "string" }, "refund_reason" : { "description" : "Refund reason code. This can only be written during a refund operation otherwise this field is read only.", "type" : "string" }, "reject_dts" : { "description" : "If the order was rejected, the date/time that the rejection occurred", "format" : "dateTime", "type" : "string" }, "reject_reason" : { "description" : "Reject reason code. This can only be written during a reject operation otherwise this field is read only.", "type" : "string" }, "salesforce" : { "$ref" : "#/components/schemas/OrderSalesforce" }, "shipping" : { "$ref" : "#/components/schemas/OrderShipping" }, "summary" : { "$ref" : "#/components/schemas/OrderSummary" }, "Tags" : { "description" : "tags, available only through update, not through insert due to the nature of how tags are handled internally", "items" : { "$ref" : "#/components/schemas/OrderTag" }, "type" : "array" }, "taxes" : { "$ref" : "#/components/schemas/OrderTaxes" }, "utms" : { "description" : "UTM clicks. The zero index is the most recent (last) UTM click", "items" : { "$ref" : "#/components/schemas/OrderUtm" }, "type" : "array" } }, "type" : "object" }, "OrderAddItemsAndReleaseRequest" : { "properties" : { "items" : { "description" : "Items to add to the order. Must have at least the item id and quantity specified. These will be FREE items on the order since we are post payment on this method.", "items" : { "$ref" : "#/components/schemas/OrderItem" }, "type" : "array" } }, "type" : "object" }, "OrderAffiliate" : { "properties" : { "affiliate_oid" : { "description" : "Affiliate ID", "format" : "int32", "type" : "integer" }, "ledger_entries" : { "description" : "Ledger entries associated with all the commissions earned on this order", "items" : { "$ref" : "#/components/schemas/OrderAffiliateLedger" }, "type" : "array" }, "sub_id" : { "description" : "Sub identifier provided by the affiliate on the click that generated this order", "type" : "string" } }, "type" : "object" }, "OrderAffiliateLedger" : { "properties" : { "assigned_by_user" : { "description" : "UltraCart user name that assigned this commission if manually assigned", "type" : "string" }, "item_id" : { "description" : "Item ID that this ledger record is associated with", "type" : "string" }, "tier_number" : { "description" : "Tier number of this affiliate in the commission calculation", "format" : "int32", "type" : "integer" }, "transaction_amount" : { "description" : "Amount of the transaction", "type" : "number" }, "transaction_amount_paid" : { "description" : "The amount that has been paid so far on the transaction", "type" : "number" }, "transaction_dts" : { "description" : "The date/time that the affiliate ledger was generated for the transaction", "format" : "dateTime", "type" : "string" }, "transaction_memo" : { "description" : "Details of the transaction suitable for display to the affiliate", "type" : "string" }, "transaction_percentage" : { "description" : "The percentage earned on the transaction", "type" : "number" }, "transaction_state" : { "description" : "The state of the transaction", "enum" : [ "Pending", "Posted", "Approved", "Paid", "Rejected", "Partially Paid" ], "type" : "string" } }, "type" : "object" }, "OrderAssignToAffiliateRequest" : { "properties" : { "affiliate_email" : { "description" : "Affiliate email to associate with the order", "type" : "string" }, "affiliate_id" : { "description" : "Affiliate id to associate with the order", "format" : "int32", "type" : "integer" }, "affiliate_sub_id" : { "description" : "Affiliate sub id to associate with the order", "maxLength" : 50, "type" : "string" } }, "type" : "object" }, "OrderAutoOrder" : { "properties" : { "auto_order_code" : { "description" : "Unique code assigned to this auto order", "type" : "string" }, "auto_order_oid" : { "description" : "Auto order object identifier", "format" : "int32", "type" : "integer" }, "cancel_after_next_x_orders" : { "description" : "Cancel this auto order after X additional rebills", "format" : "int32", "type" : "integer" }, "cancel_downgrade" : { "description" : "True if the auto order was canceled because the customer purchased a downgrade item", "type" : "boolean" }, "cancel_reason" : { "description" : "The reason this auto order was canceled by either merchant or customer", "type" : "string" }, "cancel_upgrade" : { "description" : "True if the auto order was canceled because the customer purchased an upgrade item", "type" : "boolean" }, "canceled_by_user" : { "description" : "The user that canceled the auto order", "type" : "string" }, "canceled_dts" : { "description" : "The date/time that the auto order was canceled", "format" : "dateTime", "type" : "string" }, "completed" : { "description" : "True if the auto order ran successfully to completion", "type" : "boolean" }, "credit_card_attempt" : { "description" : "The number of credit card attempts that have taken place", "format" : "int32", "type" : "integer" }, "disabled_dts" : { "description" : "The date/time the auto order was disabled due to failed rebills", "format" : "dateTime", "type" : "string" }, "enabled" : { "description" : "True if this auto order is enabled", "type" : "boolean" }, "failure_reason" : { "description" : "The reason this auto order failed during the last rebill attempt", "type" : "string" }, "items" : { "description" : "The items that are setup to rebill", "items" : { "$ref" : "#/components/schemas/AutoOrderItem" }, "type" : "array" }, "next_attempt" : { "description" : "The next time that the auto order will be attempted for processing", "format" : "dateTime", "type" : "string" }, "original_order_id" : { "description" : "The original order id that this auto order is associated with.", "type" : "string" }, "override_affiliate_id" : { "description" : "Override the affiliate id given credit for rebills of this auto order", "format" : "int32", "type" : "integer" }, "rebill_orders" : { "description" : "Rebill orders that have taken place on this auto order", "items" : { "$ref" : "#/components/schemas/Order" }, "type" : "array" }, "rotating_transaction_gateway_code" : { "description" : "The RTG code associated with this order for future rebills", "type" : "string" }, "status" : { "description" : "The status of the auto order", "enum" : [ "active", "canceled", "disabled" ], "type" : "string" } }, "type" : "object" }, "OrderBilling" : { "properties" : { "address1" : { "description" : "Address line 1", "maxLength" : 50, "type" : "string" }, "address2" : { "description" : "Address line 2", "maxLength" : 50, "type" : "string" }, "cc_emails" : { "description" : "CC emails. Multiple allowed, but total length of all emails can not exceed 100 characters.", "items" : { "type" : "string" }, "type" : "array" }, "cell_phone" : { "description" : "Cell phone", "maxLength" : 25, "type" : "string" }, "cell_phone_e164" : { "description" : "Cell phone (E164 format)", "maxLength" : 25, "type" : "string" }, "city" : { "description" : "City", "maxLength" : 32, "type" : "string" }, "company" : { "description" : "Company", "maxLength" : 50, "type" : "string" }, "country_code" : { "description" : "ISO-3166 two letter country code", "maxLength" : 2, "type" : "string" }, "day_phone" : { "description" : "Day time phone", "maxLength" : 25, "type" : "string" }, "day_phone_e164" : { "description" : "Day time phone (E164 format)", "maxLength" : 25, "type" : "string" }, "email" : { "description" : "Email", "maxLength" : 100, "type" : "string" }, "evening_phone" : { "description" : "Evening phone", "maxLength" : 25, "type" : "string" }, "evening_phone_e164" : { "description" : "Evening phone (E164 format)", "maxLength" : 25, "type" : "string" }, "first_name" : { "description" : "First name", "maxLength" : 30, "type" : "string" }, "last_name" : { "description" : "Last name", "maxLength" : 30, "type" : "string" }, "postal_code" : { "description" : "Postal code", "maxLength" : 20, "type" : "string" }, "state_region" : { "description" : "State for United States otherwise region or province for other countries", "maxLength" : 32, "type" : "string" }, "title" : { "description" : "Title", "maxLength" : 50, "type" : "string" } }, "type" : "object" }, "OrderBuysafe" : { "properties" : { "buysafe_bond_available" : { "description" : "True if a buySAFE bond was available for purchase on this order", "type" : "boolean" }, "buysafe_bond_cost" : { "$ref" : "#/components/schemas/Currency" }, "buysafe_bond_free" : { "description" : "True if the buySAFE bond was free for this order", "type" : "boolean" }, "buysafe_bond_refunded" : { "$ref" : "#/components/schemas/Currency" }, "buysafe_bond_wanted" : { "description" : "True if the buySAFE bond was wanted by the customer", "type" : "boolean" }, "buysafe_shopping_cart_id" : { "description" : "Shopping cart ID associated with the buySAFE bond", "type" : "string" } }, "type" : "object" }, "OrderByTokenQuery" : { "properties" : { "order_token" : { "description" : "Order Token", "type" : "string" } }, "type" : "object" }, "OrderChannelPartner" : { "properties" : { "auto_approve_purchase_order" : { "description" : "If true, any purchase order submitted is automatically approved", "type" : "boolean" }, "channel_partner_code" : { "description" : "The code of the channel partner", "type" : "string" }, "channel_partner_data" : { "description" : "Additional data provided by the channel partner, read-only", "type" : "string" }, "channel_partner_oid" : { "description" : "Channel partner object identifier, read-only and available on existing channel orders only.", "format" : "int32", "type" : "integer" }, "channel_partner_order_id" : { "description" : "The order ID assigned by the channel partner for this order.", "maxLength" : 50, "type" : "string" }, "ignore_invalid_shipping_method" : { "description" : "Set to true to ignore invalid shipping method being specified. Only applicable on inserting orders.", "type" : "boolean" }, "no_realtime_payment_processing" : { "description" : "Indicates this order should be placed in Account Receivable for later payment processing", "type" : "boolean" }, "skip_payment_processing" : { "description" : "Indicates this order was already paid for via a channel purchase and no payment collection should be attempted", "type" : "boolean" }, "store_completed" : { "description" : "Instructs UltraCart to skip shipping department and mark this order as fully complete. This flag defaults to true. Set this flag to false to shipped product for this order.", "type" : "boolean" }, "store_if_payment_declines" : { "description" : "If true, any failed payment will place the order in Accounts Receivable rather than rejecting it.", "type" : "boolean" }, "treat_warnings_as_errors" : { "description" : "Any warnings are raised as errors and halt the import of the order", "type" : "boolean" } }, "type" : "object" }, "OrderCheckout" : { "properties" : { "browser" : { "$ref" : "#/components/schemas/Browser" }, "comments" : { "description" : "Comments from the customer. Rarely used on the single page checkout.", "type" : "string" }, "custom_field1" : { "description" : "Custom field 1", "maxLength" : 50, "type" : "string" }, "custom_field10" : { "description" : "Custom field 10", "maxLength" : 200, "type" : "string" }, "custom_field2" : { "description" : "Custom field 2", "maxLength" : 50, "type" : "string" }, "custom_field3" : { "description" : "Custom field 3", "maxLength" : 50, "type" : "string" }, "custom_field4" : { "description" : "Custom field 4", "maxLength" : 50, "type" : "string" }, "custom_field5" : { "description" : "Custom field 5", "maxLength" : 75, "type" : "string" }, "custom_field6" : { "description" : "Custom field 6", "maxLength" : 50, "type" : "string" }, "custom_field7" : { "description" : "Custom field 7", "maxLength" : 50, "type" : "string" }, "custom_field8" : { "description" : "Custom field 8", "maxLength" : 200, "type" : "string" }, "custom_field9" : { "description" : "Custom field 9", "maxLength" : 200, "type" : "string" }, "customer_ip_address" : { "description" : "IP address of the customer when placing the order", "type" : "string" }, "screen_branding_theme_code" : { "description" : "Screen branding theme code associated with the order (legacy checkout)", "maxLength" : 10, "type" : "string" }, "screen_size" : { "description" : "Screen size small, medium or large", "type" : "string" }, "storefront_host_name" : { "description" : "StoreFront host name associated with the order", "type" : "string" }, "upsell_path_code" : { "description" : "Upsell path code assigned during the checkout that the customer went through", "type" : "string" } }, "type" : "object" }, "OrderCoupon" : { "properties" : { "accounting_code" : { "description" : "QuickBooks accounting code for this coupon", "type" : "string" }, "automatically_applied" : { "description" : "Whether or not the coupon was automatically applied to the order", "type" : "boolean" }, "base_coupon_code" : { "description" : "Coupon code configured by the merchant. Will differ if the customer used a one time coupon code generated off this base coupon", "maxLength" : 20, "type" : "string" }, "coupon_code" : { "description" : "Coupon code entered by the customer", "maxLength" : 20, "type" : "string" }, "hdie_from_customer" : { "description" : "True if this coupon is hide from the customer", "type" : "boolean" } }, "type" : "object" }, "OrderCurrentStageHistory" : { "properties" : { "after_stage" : { "description" : "New stage that the order is in.", "enum" : [ "Accounts Receivable", "Pending Clearance", "Fraud Review", "Rejected", "Shipping Department", "Completed Order", "Quote Request", "Quote Sent", "Least Cost Routing", "Unknown", "Pre-ordered", "Advanced Order Routing", "Hold" ], "type" : "string" }, "before_stage" : { "description" : "Previous stage that the order was in.", "enum" : [ "Accounts Receivable", "Pending Clearance", "Fraud Review", "Rejected", "Shipping Department", "Completed Order", "Quote Request", "Quote Sent", "Least Cost Routing", "Unknown", "Pre-ordered", "Advanced Order Routing", "Hold" ], "type" : "string" }, "transition_dts" : { "description" : "Date/time that the stage transitioned", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "OrderDigitalItem" : { "properties" : { "file_size" : { "description" : "File size", "format" : "int64", "type" : "integer" }, "last_download" : { "description" : "Last download", "format" : "dateTime", "type" : "string" }, "last_download_ip_address" : { "description" : "IP address that performed the last download", "type" : "string" }, "original_filename" : { "description" : "Original file name", "type" : "string" }, "product_code" : { "description" : "Item id associated with this item", "type" : "string" }, "product_description" : { "description" : "Item description associated with this item", "type" : "string" }, "remaining_downloads" : { "description" : "Remaining number of downloads", "format" : "int32", "type" : "integer" }, "url" : { "description" : "URL that the customer can click to download the specific digital item", "type" : "string" } }, "type" : "object" }, "OrderDigitalOrder" : { "properties" : { "creation_dts" : { "description" : "Date/time that the digital order was created", "format" : "dateTime", "type" : "string" }, "expiration_dts" : { "description" : "Expiration date/time of the digital order", "format" : "dateTime", "type" : "string" }, "items" : { "description" : "Digital items associated with the digital order", "items" : { "$ref" : "#/components/schemas/OrderDigitalItem" }, "type" : "array" }, "url" : { "description" : "URL where the customer can go to and download their digital order content", "type" : "string" }, "url_id" : { "description" : "URL ID is a unique code that is part of the URLs", "type" : "string" } }, "type" : "object" }, "OrderEdi" : { "properties" : { "bill_to_edi_code" : { "description" : "Billing address identification code from the EDI order. Typically DUNS or DUNS+4", "type" : "string" }, "edi_department" : { "description" : "Department number associated with this EDI order", "type" : "string" }, "edi_internal_vendor_number" : { "description" : "Internal vendor number associated with this EDI order", "maxLength" : 50, "type" : "string" }, "ship_to_edi_code" : { "description" : "Shipping address identification code from the EDI order. Typically DUNS or DUNS+4", "type" : "string" } }, "type" : "object" }, "OrderEdiDocument" : { "properties" : { "direction" : { "description" : "Direction the document flowed", "enum" : [ "inbound", "outbound" ], "type" : "string" }, "doc_dts" : { "description" : "Date/time the document was created/received", "format" : "dateTime", "type" : "string" }, "document" : { "type" : "string" }, "document_type_description" : { "type" : "string" }, "document_type_number" : { "format" : "int32", "type" : "integer" }, "external_id" : { "type" : "string" }, "functional_acknowledgement" : { "type" : "string" }, "functional_acknowledgement_dts" : { "type" : "string" }, "functional_acknowledgement_pending" : { "type" : "boolean" }, "group_control_number" : { "format" : "int32", "type" : "integer" }, "internal_id" : { "type" : "string" }, "merchant_id" : { "type" : "string" }, "order_id" : { "type" : "string" }, "test_mode" : { "type" : "boolean" } }, "type" : "object" }, "OrderEdiDocumentsResponse" : { "properties" : { "ediDocuments" : { "description" : "edi_documents", "items" : { "$ref" : "#/components/schemas/OrderEdiDocument" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "OrderEmail" : { "properties" : { "bounce_diagnostic_code" : { "type" : "string" }, "bounce_dts" : { "description" : "Date/time that the email was bounced", "format" : "dateTime", "type" : "string" }, "bounce_sub_type" : { "type" : "string" }, "bounce_type" : { "type" : "string" }, "clicked" : { "type" : "boolean" }, "clicked_dts" : { "description" : "Date/time that the email was clicked", "format" : "dateTime", "type" : "string" }, "delivered" : { "type" : "boolean" }, "delivery_dts" : { "description" : "Date/time that the email was delivered", "format" : "dateTime", "type" : "string" }, "email" : { "description" : "Email", "maxLength" : 100, "type" : "string" }, "internal" : { "type" : "boolean" }, "message_id" : { "type" : "string" }, "opened" : { "type" : "boolean" }, "opened_dts" : { "description" : "Date/time that the email was opened", "format" : "dateTime", "type" : "string" }, "reporting_mta" : { "type" : "string" }, "send_dts" : { "description" : "Date/time that the email was sent", "format" : "dateTime", "type" : "string" }, "skip_reason" : { "type" : "string" }, "skipped" : { "type" : "boolean" }, "smtp_response" : { "type" : "string" }, "subject" : { "type" : "string" } }, "type" : "object" }, "OrderEmailsResponse" : { "properties" : { "emails" : { "description" : "emails", "items" : { "$ref" : "#/components/schemas/OrderEmail" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "OrderFormat" : { "properties" : { "context" : { "description" : "The context to generate the order view for.", "type" : "string" }, "dont_link_email_to_search" : { "description" : "True to not link the email address to the order search", "type" : "boolean" }, "email_as_link" : { "description" : "True to make the email address a clickable mailto link", "type" : "boolean" }, "filter_distribution_center_oid" : { "description" : "Specify a distribution center oid to filter the items displayed to that particular distribution center.", "format" : "int32", "type" : "integer" }, "filter_to_items_in_container_oid" : { "description" : "The container oid to filter items to.", "format" : "int32", "type" : "integer" }, "format" : { "description" : "The desired format.", "enum" : [ "text", "div", "table", "email" ], "type" : "string" }, "hide_bill_to_address" : { "description" : "True to ide the bill to address", "type" : "boolean" }, "hide_price_information" : { "description" : "True to hide price information", "type" : "boolean" }, "link_file_attachments" : { "description" : "True to link file attachments for download", "type" : "boolean" }, "show_contact_info" : { "description" : "True to show contact information", "type" : "boolean" }, "show_in_merchant_currency" : { "description" : "True to show the order in the merchant currency", "type" : "boolean" }, "show_internal_information" : { "description" : "True to show internal information about the order", "type" : "boolean" }, "show_merchant_notes" : { "description" : "True to show merchant notes", "type" : "boolean" }, "show_non_sensitive_payment_info" : { "description" : "True to show non-sensitive payment information", "type" : "boolean" }, "show_payment_info" : { "description" : "True to show payment information", "type" : "boolean" }, "translate" : { "description" : "True to translate the order into the native language of the customer", "type" : "boolean" }, "use_phone_number_web_component" : { "description" : "True to render phone numbers as web components in the HTML output. Only honored by the div format. Default false preserves legacy scalar rendering for receipts and unauthenticated consumers.", "type" : "boolean" } }, "type" : "object" }, "OrderFormatResponse" : { "properties" : { "css_links" : { "description" : "The URLs to any stylesheets that need to be included to properly view the markup.", "items" : { "type" : "string" }, "type" : "array" }, "formatted_result" : { "description" : "The formatted result of the order. This will be HTML or text depending upon the requested format.", "type" : "string" } }, "type" : "object" }, "OrderFraudScore" : { "properties" : { "anonymous_proxy" : { "description" : "True if the IP address is a known anonymous proxy server", "type" : "boolean" }, "bin_match" : { "description" : "Whether the BIN (first six digits) matched the country", "enum" : [ "NA", "No", "NotFound", "Yes" ], "type" : "string" }, "carder_email" : { "description" : "True if the email address belongs to a known credit card fraudster", "type" : "boolean" }, "country_code" : { "description" : "Country code", "type" : "string" }, "country_match" : { "description" : "Country code matches BIN country", "type" : "boolean" }, "customer_phone_in_billing_location" : { "description" : "Whether the customer's phone number is located in the area of the billing address", "type" : "string" }, "distance_km" : { "description" : "Distance in kilometers between the IP address and the BIN", "format" : "int32", "type" : "integer" }, "free_email" : { "description" : "True if the email address is for a free service like gmail.com", "type" : "boolean" }, "high_risk_country" : { "description" : "True if the customer is in a high risk country known for internet fraud", "type" : "boolean" }, "ip_city" : { "description" : "City associated with the IP address", "type" : "string" }, "ip_isp" : { "description" : "ISP that owns the IP address", "type" : "string" }, "ip_latitude" : { "description" : "Approximate latitude associated with the IP address", "type" : "string" }, "ip_longitude" : { "description" : "Approximate longitude associated with the IP address", "type" : "string" }, "ip_org" : { "description" : "Organization that owns the IP address", "type" : "string" }, "ip_region" : { "description" : "State/region associated with the IP address", "type" : "string" }, "proxy_score" : { "description" : "Likelihood of the IP address being a proxy server", "type" : "number" }, "score" : { "description" : "Overall score. This is the score that is compared to see if the order is rejected or held for review by the fraud filter rules.", "type" : "number" }, "ship_forwarder" : { "description" : "True if the address is a known ship forwarding company", "type" : "boolean" }, "spam_score" : { "description" : "Likelihood of the email address being associated with a spammer", "type" : "number" }, "transparent_proxy" : { "description" : "True if the IP address that placed the order is a transparent proxy server", "type" : "boolean" } }, "type" : "object" }, "OrderGift" : { "properties" : { "gift" : { "description" : "True if the order is a gift", "type" : "boolean" }, "gift_charge" : { "$ref" : "#/components/schemas/Currency" }, "gift_charge_accounting_code" : { "description" : "QuickBooks code for the gift charge", "type" : "string" }, "gift_charge_refunded" : { "$ref" : "#/components/schemas/Currency" }, "gift_email" : { "description" : "Email address of the gift recipient", "maxLength" : 100, "type" : "string" }, "gift_message" : { "description" : "Message to the gift recipient", "maxLength" : 10000, "type" : "string" }, "gift_wrap_accounting_code" : { "description" : "QuickBooks code for the gift wrap charge", "type" : "string" }, "gift_wrap_cost" : { "$ref" : "#/components/schemas/Currency" }, "gift_wrap_refunded" : { "$ref" : "#/components/schemas/Currency" }, "gift_wrap_title" : { "description" : "Title of the gift wrap that the customer wants used", "maxLength" : 30, "type" : "string" } }, "type" : "object" }, "OrderGiftCertificate" : { "properties" : { "gift_certificate_amount" : { "$ref" : "#/components/schemas/Currency" }, "gift_certificate_code" : { "description" : "Gift certificate code used on the order", "type" : "string" }, "gift_certificate_oid" : { "description" : "Gift certificate object identifier", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "OrderInternal" : { "properties" : { "exported_to_accounting" : { "description" : "True if the order has been exported to QuickBooks. If QuickBooks is not configured, then this will already be true", "type" : "boolean" }, "merchant_notes" : { "description" : "Merchant notes. Full notes in non-transactional mode. Just used to write a new merchant note when transaction merchant notes enabled.", "type" : "string" }, "placed_by_user" : { "description" : "If placed via the BEOE, this is the user that placed the order", "type" : "string" }, "refund_by_user" : { "description" : "User that issued the refund", "type" : "string" }, "sales_rep_code" : { "description" : "Sales rep code associated with the order", "maxLength" : 10, "type" : "string" }, "transactional_merchant_notes" : { "description" : "Transactional merchant notes", "items" : { "$ref" : "#/components/schemas/OrderTransactionalMerchantNote" }, "type" : "array" } }, "type" : "object" }, "OrderInvoiceResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "pdfBase64" : { "description" : "pdf_base64", "type" : "string" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "OrderItem" : { "properties" : { "accounting_code" : { "description" : "QuickBooks code", "type" : "string" }, "activation_codes" : { "description" : "Activation codes assigned to this item", "items" : { "type" : "string" }, "type" : "array" }, "actual_cogs" : { "$ref" : "#/components/schemas/Currency" }, "arbitrary_unit_cost" : { "$ref" : "#/components/schemas/Currency" }, "auto_order_last_rebill_dts" : { "description" : "Date/time of the last rebill, used only during order insert to help project future rebills", "format" : "dateTime", "type" : "string" }, "auto_order_schedule" : { "description" : "Auto order schedule, used only during inserts supplying the recurring schedule", "type" : "string" }, "barcode" : { "description" : "Barcode", "type" : "string" }, "barcode_gtin12" : { "description" : "Barcode - GTIN 12", "maxLength" : 12, "type" : "string" }, "barcode_gtin14" : { "description" : "Barcode - GTIN 14", "maxLength" : 14, "type" : "string" }, "barcode_upc11" : { "description" : "Barcode - UPC 11", "maxLength" : 11, "type" : "string" }, "barcode_upc12" : { "description" : "Barcode - UPC 12", "maxLength" : 12, "type" : "string" }, "channel_partner_item_id" : { "description" : "Channel partner item id if this order came through a channel partner and the channel partner item id was mapped to an internal item id", "maxLength" : 30, "type" : "string" }, "cogs" : { "description" : "Cost of goods sold", "type" : "number" }, "component_unit_value" : { "description" : "Value of the kit component item", "type" : "number" }, "cost" : { "$ref" : "#/components/schemas/Currency" }, "country_code_of_origin" : { "description" : "Country of origin (ISO-3166 two letter code)", "maxLength" : 2, "type" : "string" }, "customs_description" : { "description" : "Customs description", "type" : "string" }, "description" : { "description" : "Description", "maxLength" : 2000, "type" : "string" }, "discount" : { "$ref" : "#/components/schemas/Currency" }, "discount_quantity" : { "description" : "Discount quantity", "type" : "number" }, "discount_shipping_weight" : { "$ref" : "#/components/schemas/Weight" }, "distribution_center_code" : { "description" : "Distribution center code responsible for shipping this item", "type" : "string" }, "edi" : { "$ref" : "#/components/schemas/OrderItemEdi" }, "exclude_coupon" : { "description" : "True if this item is excluded from coupons", "type" : "boolean" }, "free_shipping" : { "description" : "True if the item receives free shipping", "type" : "boolean" }, "hazmat" : { "description" : "Hazardous materials indicator", "type" : "boolean" }, "height" : { "$ref" : "#/components/schemas/Distance" }, "item_index" : { "description" : "Index of the item on the order (one based index)", "format" : "int32", "type" : "integer" }, "item_reference_oid" : { "description" : "Item reference object identifier used to linked to auto order item record", "format" : "int32", "type" : "integer" }, "kit" : { "description" : "True if this item is a kit", "type" : "boolean" }, "kit_component" : { "description" : "True if this item is a kit component", "type" : "boolean" }, "length" : { "$ref" : "#/components/schemas/Distance" }, "manufacturer_sku" : { "description" : "Manufacturer SKU", "type" : "string" }, "max_days_time_in_transit" : { "description" : "Maximum days that the item can be in transit before spoilage (perishable products)", "format" : "int32", "type" : "integer" }, "merchant_item_id" : { "description" : "Item ID", "maxLength" : 20, "type" : "string" }, "mix_and_match_group_name" : { "description" : "Mix and match group name", "type" : "string" }, "mix_and_match_group_oid" : { "description" : "Mix and match group object identifier", "format" : "int32", "type" : "integer" }, "no_shipping_discount" : { "description" : "True if this item is excluded from shipping discounts", "type" : "boolean" }, "options" : { "description" : "Options", "items" : { "$ref" : "#/components/schemas/OrderItemOption" }, "type" : "array" }, "packed_by_user" : { "description" : "Packed by user", "type" : "string" }, "parent_item_index" : { "description" : "If this item is a kit component, this is the item index of the parent item (kit)", "format" : "int32", "type" : "integer" }, "parent_merchant_item_id" : { "description" : "If this item is a kit component, this is the item id of the parent item (kit)", "maxLength" : 20, "type" : "string" }, "perishable_class" : { "description" : "Perishable class of the item", "maxLength" : 50, "type" : "string" }, "pricing_tier_name" : { "description" : "Pricing tier that granted the particular price for this item if the customer profile had pricing tiers assigned", "type" : "string" }, "properties" : { "description" : "Properties", "items" : { "$ref" : "#/components/schemas/OrderItemProperty" }, "type" : "array" }, "quantity" : { "description" : "Quantity", "type" : "number" }, "quantity_refunded" : { "description" : "Quantity refunded on this item (read only except refund operation)", "type" : "number" }, "quickbooks_class" : { "description" : "QuickBooks class", "maxLength" : 31, "type" : "string" }, "refund_reason" : { "description" : "Refund reason code. This can only be written during a refund operation otherwise this field is read only.", "type" : "string" }, "return_reason" : { "description" : "Return reason code. This can only be written during a refund operation otherwise this field is read only.", "type" : "string" }, "ship_separately" : { "description" : "True if this item ships in a separate box", "type" : "boolean" }, "shipped_by_user" : { "description" : "Shipped by user", "type" : "string" }, "shipped_dts" : { "description" : "Date/time that this item was marked shipped", "format" : "dateTime", "type" : "string" }, "shipping_status" : { "description" : "Shipping status for this item. This is the replacement for the old order level shipping status.", "type" : "string" }, "special_product_type" : { "description" : "Special product type (USPS Media Mail)", "type" : "string" }, "tags" : { "description" : "Tags", "items" : { "$ref" : "#/components/schemas/OrderItemTag" }, "type" : "array" }, "tax_free" : { "description" : "True if the item is tax free", "type" : "boolean" }, "tax_product_type" : { "description" : "Type of product for tax purposes (self or UltraCart Managed taxes)", "enum" : [ "", "digital", "physical", "service" ], "type" : "string" }, "taxable_cost" : { "$ref" : "#/components/schemas/Currency" }, "total_cost_with_discount" : { "$ref" : "#/components/schemas/Currency" }, "total_refunded" : { "$ref" : "#/components/schemas/Currency" }, "transmitted_to_distribution_center_dts" : { "description" : "Date/time that this item was transmitted to the distribution center", "format" : "dateTime", "type" : "string" }, "unit_cost_with_discount" : { "$ref" : "#/components/schemas/Currency" }, "upsell" : { "description" : "True if this item was added to the order as part of an upsell", "type" : "boolean" }, "weight" : { "$ref" : "#/components/schemas/Weight" }, "width" : { "$ref" : "#/components/schemas/Distance" } }, "type" : "object" }, "OrderItemEdi" : { "properties" : { "identifications" : { "description" : "Identification information receives on the EDI purchase order", "items" : { "$ref" : "#/components/schemas/OrderItemEdiIdentification" }, "type" : "array" }, "lots" : { "description" : "Lot information", "items" : { "$ref" : "#/components/schemas/OrderItemEdiLot" }, "type" : "array" } }, "type" : "object" }, "OrderItemEdiIdentification" : { "properties" : { "identification" : { "description" : "Identification value", "type" : "string" }, "quantity" : { "description" : "Quantity associated with this identifier", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "OrderItemEdiLot" : { "properties" : { "lot_expiration" : { "description" : "Log expiration", "format" : "dateTime", "type" : "string" }, "lot_number" : { "description" : "Lot number", "type" : "string" }, "lot_quantity" : { "description" : "Lot quantity", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "OrderItemOption" : { "properties" : { "additional_dimension_application" : { "description" : "How the additional dimensions are applied to the item.", "enum" : [ "none", "set item to", "add item" ], "type" : "string" }, "cost_change" : { "$ref" : "#/components/schemas/Currency" }, "file_attachment" : { "$ref" : "#/components/schemas/OrderItemOptionFileAttachment" }, "height" : { "$ref" : "#/components/schemas/Distance" }, "hidden" : { "description" : "True if this option is hidden from display on the order", "type" : "boolean" }, "label" : { "description" : "Label", "maxLength" : 50, "type" : "string" }, "length" : { "$ref" : "#/components/schemas/Distance" }, "one_time_fee" : { "description" : "True if the cost associated with this option is a one time fee or multiplied by the quantity of the item", "type" : "boolean" }, "value" : { "description" : "Value", "maxLength" : 1024, "type" : "string" }, "weight_change" : { "$ref" : "#/components/schemas/Weight" }, "width" : { "$ref" : "#/components/schemas/Distance" } }, "type" : "object" }, "OrderItemOptionFileAttachment" : { "properties" : { "expiration_dts" : { "description" : "Expiration date/time", "format" : "dateTime", "type" : "string" }, "file_name" : { "description" : "File name", "type" : "string" }, "mime_type" : { "description" : "Mime type", "type" : "string" }, "size" : { "description" : "Size", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "OrderItemProperty" : { "properties" : { "display" : { "description" : "True if this property is displayed to the customer", "type" : "boolean" }, "expiration_dts" : { "description" : "The date/time that the property expires and is deleted", "format" : "dateTime", "type" : "string" }, "name" : { "description" : "Name", "maxLength" : 100, "type" : "string" }, "value" : { "description" : "Value", "maxLength" : 3800, "type" : "string" } }, "type" : "object" }, "OrderItemTag" : { "properties" : { "tag_value" : { "description" : "Tag Value", "maxLength" : 100, "type" : "string" } }, "type" : "object" }, "OrderLinkedShipment" : { "properties" : { "has_linked_shipment" : { "description" : "True if this order has child linked shipments", "type" : "boolean" }, "linked_shipment" : { "description" : "True if this order is linked to another parent order", "type" : "boolean" }, "linked_shipment_channel_partner_order_ids" : { "description" : "The child linked shipment channel partner order ids", "items" : { "type" : "string" }, "type" : "array" }, "linked_shipment_order_ids" : { "description" : "The child linked shipment order ids", "items" : { "type" : "string" }, "type" : "array" }, "linked_shipment_to_order_id" : { "description" : "The parent order id that this one is linked to", "type" : "string" } }, "type" : "object" }, "OrderMarketing" : { "properties" : { "advertising_source" : { "description" : "Advertising source", "maxLength" : 50, "type" : "string" }, "cell_phone_opt_in" : { "description" : "True if the customer has opted into SMS marketing", "type" : "boolean" }, "mailing_list" : { "description" : "True if the customer has opted into mailing list subscription", "type" : "boolean" }, "referral_code" : { "description" : "Referral code", "maxLength" : 30, "type" : "string" } }, "type" : "object" }, "OrderPackingSlipResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "pdfBase64" : { "description" : "pdf_base64", "type" : "string" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "OrderPageView" : { "properties" : { "meta_data" : { "description" : "Meta tag name/value pairs captured on the page view", "items" : { "$ref" : "#/components/schemas/OrderPageViewMetaData" }, "type" : "array" }, "params" : { "description" : "Query string parameters captured on the page view", "items" : { "$ref" : "#/components/schemas/OrderPageViewParam" }, "type" : "array" }, "time_on_page" : { "description" : "Time spent on the page in seconds", "format" : "int32", "type" : "integer" }, "url" : { "description" : "URL of the page that was viewed", "type" : "string" }, "view_dts" : { "description" : "Date/time the page was viewed", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "OrderPageViewHistoryResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "page_views" : { "description" : "Page views captured during the session that placed this order", "items" : { "$ref" : "#/components/schemas/OrderPageView" }, "type" : "array" }, "referrer" : { "description" : "HTTP referrer captured at the start of the session that placed this order", "type" : "string" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "OrderPageViewMetaData" : { "properties" : { "name" : { "description" : "Meta tag name", "type" : "string" }, "value" : { "description" : "Meta tag value", "type" : "string" } }, "type" : "object" }, "OrderPageViewParam" : { "properties" : { "name" : { "description" : "Query string parameter name", "type" : "string" }, "value" : { "description" : "Query string parameter value", "type" : "string" } }, "type" : "object" }, "OrderPayment" : { "properties" : { "check" : { "$ref" : "#/components/schemas/OrderPaymentCheck" }, "credit_card" : { "$ref" : "#/components/schemas/OrderPaymentCreditCard" }, "echeck" : { "$ref" : "#/components/schemas/OrderPaymentECheck" }, "health_benefit_card" : { "$ref" : "#/components/schemas/OrderPaymentHealthBenefitCard" }, "hold_for_fraud_review" : { "description" : "True if order has been held for fraud review", "type" : "boolean" }, "insurance" : { "$ref" : "#/components/schemas/OrderPaymentInsurance" }, "payment_dts" : { "description" : "Date/time that the payment was successfully processed, for new orders, this field is only considered if channel_partner.skip_payment_processing is true", "format" : "dateTime", "type" : "string" }, "payment_method" : { "description" : "Payment method", "enum" : [ "Affirm", "Amazon", "Amazon Pay", "Amazon SC", "Cash", "Check", "COD", "Credit Card", "Crypto", "eBay", "eCheck", "Google Shopping", "Goldbelly", "GoHighLevel", "Insurance", "Link", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Unknown", "Wire Transfer", "Walmart", "Shop.com", "Sezzle", "Venmo", "Apple Pay", "Google Pay", "Health Benefit Card", "PayPal Fastlane", "Klarna" ], "type" : "string" }, "payment_method_accounting_code" : { "description" : "Payment method QuickBooks code", "type" : "string" }, "payment_method_deposit_to_account" : { "description" : "Payment method QuickBooks deposit account", "type" : "string" }, "payment_status" : { "description" : "Payment status", "enum" : [ "Unprocessed", "Authorized", "Capture Failed", "Processed", "Declined", "Voided", "Refunded", "Skipped" ], "type" : "string" }, "paypal" : { "$ref" : "#/components/schemas/OrderPaymentPayPal" }, "purchase_order" : { "$ref" : "#/components/schemas/OrderPaymentPurchaseOrder" }, "rotating_transaction_gateway_code" : { "description" : "Rotating transaction gateway code used to process this order", "type" : "string" }, "surcharge" : { "$ref" : "#/components/schemas/Currency" }, "surcharge_accounting_code" : { "description" : "Surcharge accounting code", "type" : "string" }, "surcharge_transaction_fee" : { "description" : "Surcharge transaction fee", "type" : "number" }, "surcharge_transaction_percentage" : { "description" : "Surcharge transaction percentage", "type" : "number" }, "test_order" : { "description" : "True if this is a test order", "type" : "boolean" }, "transactions" : { "description" : "Transactions associated with processing this payment", "items" : { "$ref" : "#/components/schemas/OrderPaymentTransaction" }, "type" : "array" } }, "type" : "object" }, "OrderPaymentCheck" : { "properties" : { "check_number" : { "description" : "Check number", "type" : "string" } }, "type" : "object" }, "OrderPaymentCreditCard" : { "properties" : { "card_auth_ticket" : { "description" : "Card authorization ticket", "type" : "string" }, "card_authorization_amount" : { "description" : "Card authorization amount", "type" : "number" }, "card_authorization_dts" : { "description" : "Card authorization date/time", "format" : "dateTime", "type" : "string" }, "card_authorization_reference_number" : { "description" : "Card authorization reference number", "type" : "string" }, "card_expiration_month" : { "description" : "Card expiration month (1-12)", "format" : "int32", "type" : "integer" }, "card_expiration_year" : { "description" : "Card expiration year (Four digit year)", "format" : "int32", "type" : "integer" }, "card_number" : { "description" : "Card number (masked to last 4)", "type" : "string" }, "card_number_token" : { "description" : "Card number token from hosted fields used to update the card number", "type" : "string" }, "card_number_truncated" : { "description" : "True if the card has been truncated", "type" : "boolean" }, "card_type" : { "description" : "Card type", "enum" : [ "AMEX", "Diners Club", "Discover", "JCB", "MasterCard", "VISA" ], "type" : "string" }, "card_verification_number_token" : { "description" : "Card verification number token from hosted fields, only for import/insert of new orders, completely ignored for updates, and always null/empty for queries", "type" : "string" }, "dual_vaulted" : { "$ref" : "#/components/schemas/OrderPaymentCreditCardDualVaulted" } }, "type" : "object" }, "OrderPaymentCreditCardDualVaulted" : { "properties" : { "gateway_name" : { "type" : "string" }, "properties" : { "items" : { "$ref" : "#/components/schemas/OrderPaymentCreditCardDualVaultedProperty" }, "type" : "array" }, "rotating_transaction_gateway_code" : { "type" : "string" } }, "type" : "object" }, "OrderPaymentCreditCardDualVaultedProperty" : { "properties" : { "name" : { "type" : "string" }, "value" : { "type" : "string" } }, "type" : "object" }, "OrderPaymentECheck" : { "properties" : { "bank_aba_code" : { "description" : "Bank routing code", "maxLength" : 9, "type" : "string" }, "bank_account_name" : { "description" : "Bank account name", "maxLength" : 50, "type" : "string" }, "bank_account_number" : { "description" : "Bank account number (masked to last 4)", "maxLength" : 50, "type" : "string" }, "bank_account_type" : { "description" : "Bank account type", "enum" : [ "Checking", "Savings" ], "type" : "string" }, "bank_name" : { "description" : "Bank name", "maxLength" : 50, "type" : "string" }, "bank_owner_type" : { "description" : "Bank owner type", "enum" : [ "Personal", "Business" ], "type" : "string" }, "customer_tax_id" : { "description" : "Customer tax id (masked to last 4)", "maxLength" : 9, "type" : "string" }, "drivers_license_dob" : { "description" : "Driver license date of birth", "maxLength" : 10, "type" : "string" }, "drivers_license_number" : { "description" : "Driver license number (masked to last 4)", "maxLength" : 50, "type" : "string" }, "drivers_license_state" : { "description" : "Driver license state", "maxLength" : 2, "type" : "string" } }, "type" : "object" }, "OrderPaymentHealthBenefitCard" : { "properties" : { "health_benefit_card_expiration_month" : { "description" : "Health benefit card expiration month (1-12)", "format" : "int32", "type" : "integer" }, "health_benefit_card_expiration_year" : { "description" : "Health benefit card expiration year (Four digit year)", "format" : "int32", "type" : "integer" }, "health_benefit_card_number" : { "description" : "Health benefit card number (masked to last 4)", "type" : "string" }, "health_benefit_card_number_token" : { "description" : "Health benefit card number token from hosted fields used to update the health benefit card number", "type" : "string" }, "health_benefit_card_number_truncated" : { "description" : "True if the health benefit card has been truncated", "type" : "boolean" }, "health_benefit_card_verification_number_token" : { "description" : "Health benefit card verification number token from hosted fields, only for import/insert of new orders, completely ignored for updates, and always null/empty for queries", "type" : "string" } }, "type" : "object" }, "OrderPaymentInsurance" : { "properties" : { "application_id" : { "description" : "application id", "type" : "string" }, "claim_id" : { "description" : "claim id", "type" : "string" }, "insurance_type" : { "description" : "insurance type", "type" : "string" }, "refund_claim_id" : { "description" : "refund claim id", "type" : "string" } }, "type" : "object" }, "OrderPaymentPayPal" : { "properties" : { "customer_id" : { "description" : "PayPal Customer ID", "type" : "string" }, "vault_id" : { "description" : "PayPal Vault ID", "type" : "string" } }, "type" : "object" }, "OrderPaymentPurchaseOrder" : { "properties" : { "purchase_order_number" : { "description" : "Purchase order number", "type" : "string" } }, "type" : "object" }, "OrderPaymentTransaction" : { "properties" : { "details" : { "description" : "Details", "items" : { "$ref" : "#/components/schemas/OrderPaymentTransactionDetail" }, "type" : "array" }, "successful" : { "description" : "True if the transaction was successful", "type" : "boolean" }, "transaction_gateway" : { "description" : "Transaction gateway", "type" : "string" }, "transaction_id" : { "description" : "Transaction ID", "format" : "int32", "type" : "integer" }, "transaction_timestamp" : { "description" : "Transaction date/time", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "OrderPaymentTransactionDetail" : { "properties" : { "name" : { "description" : "Name", "type" : "string" }, "type" : { "description" : "Type", "type" : "string" }, "value" : { "description" : "Value", "type" : "string" } }, "type" : "object" }, "OrderPointOfSale" : { "properties" : { "location" : { "$ref" : "#/components/schemas/PointOfSaleLocation" }, "reader" : { "$ref" : "#/components/schemas/PointOfSaleReader" }, "register" : { "$ref" : "#/components/schemas/PointOfSaleRegister" } }, "type" : "object" }, "OrderProcessPaymentRequest" : { "properties" : { "amount" : { "description" : "Specific amount to bill (optional). If not specified the total of the order is billed.", "type" : "number" }, "card_verification_number_token" : { "description" : "Card verification number token from hosted fields used during credit card transaction processing (optional)", "type" : "string" } }, "type" : "object" }, "OrderProcessPaymentResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "payment_transaction" : { "$ref" : "#/components/schemas/OrderPaymentTransaction" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "OrderProperty" : { "properties" : { "created_by" : { "description" : "Created by user", "maxLength" : 20, "type" : "string" }, "created_dts" : { "description" : "The date/time that the property was created by the user", "format" : "dateTime", "type" : "string" }, "display" : { "description" : "True if this property is displayed to the customer", "type" : "boolean" }, "expiration_dts" : { "description" : "The date/time that the property expires and is deleted", "format" : "dateTime", "type" : "string" }, "name" : { "description" : "Name", "maxLength" : 100, "type" : "string" }, "value" : { "description" : "Value", "maxLength" : 1500, "type" : "string" } }, "type" : "object" }, "OrderQuery" : { "properties" : { "cc_email" : { "description" : "CC Email", "maxLength" : 100, "type" : "string" }, "channel_partner_code" : { "description" : "The code of the channel partner", "type" : "string" }, "channel_partner_order_id" : { "description" : "The order ID assigned by the channel partner for this order", "type" : "string" }, "city" : { "description" : "City", "maxLength" : 32, "type" : "string" }, "company" : { "description" : "Company", "maxLength" : 50, "type" : "string" }, "country_code" : { "description" : "ISO-3166 two letter country code", "maxLength" : 2, "type" : "string" }, "creation_date_begin" : { "description" : "Date/time that the order was created", "format" : "dateTime", "type" : "string" }, "creation_date_end" : { "description" : "Date/time that the order was created", "format" : "dateTime", "type" : "string" }, "current_stage" : { "description" : "Current stage that the order is in.", "enum" : [ "Accounts Receivable", "Pending Clearance", "Fraud Review", "Rejected", "Shipping Department", "Completed Order", "Quote Request", "Quote Sent", "Least Cost Routing", "Unknown", "Hold" ], "type" : "string" }, "custom_field_1" : { "description" : "Custom field 1", "type" : "string" }, "custom_field_10" : { "description" : "Custom field 10", "type" : "string" }, "custom_field_2" : { "description" : "Custom field 2", "type" : "string" }, "custom_field_3" : { "description" : "Custom field 3", "type" : "string" }, "custom_field_4" : { "description" : "Custom field 4", "type" : "string" }, "custom_field_5" : { "description" : "Custom field 5", "type" : "string" }, "custom_field_6" : { "description" : "Custom field 6", "type" : "string" }, "custom_field_7" : { "description" : "Custom field 7", "type" : "string" }, "custom_field_8" : { "description" : "Custom field 8", "type" : "string" }, "custom_field_9" : { "description" : "Custom field 9", "type" : "string" }, "customer_profile_oid" : { "description" : "The customer profile to find associated orders for", "format" : "int32", "type" : "integer" }, "email" : { "description" : "Email", "maxLength" : 100, "type" : "string" }, "first_name" : { "description" : "First name", "maxLength" : 30, "type" : "string" }, "item_id" : { "description" : "Item ID", "type" : "string" }, "last_name" : { "description" : "Last name", "maxLength" : 30, "type" : "string" }, "order_id" : { "description" : "Order ID", "type" : "string" }, "payment_date_begin" : { "description" : "Date/time that the order was successfully processed", "format" : "dateTime", "type" : "string" }, "payment_date_end" : { "description" : "Date/time that the order was successfully processed", "format" : "dateTime", "type" : "string" }, "payment_method" : { "description" : "Payment method", "enum" : [ "Affirm", "Amazon", "Amazon SC", "Cash", "Check", "COD", "Credit Card", "eCheck", "LoanHero", "Money Order", "PayPal", "Purchase Order", "Quote Request", "Unknown", "Wire Transfer", "Venmo", "Apple Pay", " Google Pay", "PayPal Fastlane" ], "type" : "string" }, "phone" : { "description" : "Phone", "maxLength" : 25, "type" : "string" }, "postal_code" : { "description" : "Postal code", "maxLength" : 20, "type" : "string" }, "purchase_order_number" : { "description" : "Purchase order number", "type" : "string" }, "query_target" : { "description" : "Query Target", "enum" : [ "origin", "cache" ], "type" : "string" }, "refund_date_begin" : { "description" : "Date/time that the order was refunded", "format" : "dateTime", "type" : "string" }, "refund_date_end" : { "description" : "Date/time that the order was refunded", "format" : "dateTime", "type" : "string" }, "rma" : { "description" : "RMA number", "maxLength" : 30, "type" : "string" }, "screen_branding_theme_code" : { "description" : "Screen branding theme code associated with the order (legacy checkout)", "maxLength" : 10, "type" : "string" }, "shipment_date_begin" : { "description" : "Date/time that the order was shipped", "format" : "dateTime", "type" : "string" }, "shipment_date_end" : { "description" : "Date/time that the order was shipped", "format" : "dateTime", "type" : "string" }, "shipped_on_date_begin" : { "description" : "Date/time that the order should ship on", "format" : "dateTime", "type" : "string" }, "shipped_on_date_end" : { "description" : "Date/time that the order should ship on", "format" : "dateTime", "type" : "string" }, "state_region" : { "description" : "State for United States otherwise region or province for other countries", "maxLength" : 32, "type" : "string" }, "storefront_host_name" : { "description" : "StoreFront host name associated with the order", "type" : "string" }, "total" : { "description" : "Total", "type" : "number" } }, "type" : "object" }, "OrderQueryBatch" : { "properties" : { "order_ids" : { "description" : "Order IDs", "items" : { "type" : "string" }, "type" : "array" }, "query_target" : { "description" : "Query Target", "enum" : [ "origin", "cache" ], "type" : "string" } }, "type" : "object" }, "OrderQuote" : { "properties" : { "quote_expiration_dts" : { "description" : "Expiration of quote at date/time", "format" : "dateTime", "type" : "string" }, "quoted_by" : { "description" : "Quoted by user", "type" : "string" }, "quoted_dts" : { "description" : "Quoted on date/time", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "OrderReason" : { "properties" : { "default_reason" : { "description" : "Default reason", "type" : "boolean" }, "description" : { "description" : "Reason description. This is the friendly description of the reason that should be displayed to the user.", "type" : "string" }, "value" : { "description" : "Reason value. This is what should be submitted with a refund operation.", "type" : "string" } }, "type" : "object" }, "OrderRefundableResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "item_level_refund_reason_required" : { "description" : "True if the item level refund reason is required", "type" : "boolean" }, "item_level_refund_reasons" : { "description" : "Reason codes available at the item level.", "items" : { "$ref" : "#/components/schemas/OrderReason" }, "type" : "array" }, "item_level_return_reasons" : { "description" : "Return codes available at the item level.", "items" : { "$ref" : "#/components/schemas/OrderReason" }, "type" : "array" }, "manual_because_multiple_charges" : { "description" : "If true, this refund will have to be manually done because of additional charges with the virtual terminal were made", "type" : "boolean" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "order_level_refund_reason_required" : { "description" : "True if the order level refund reason is required", "type" : "boolean" }, "order_level_refund_reasons" : { "description" : "Reason codes available at the order level.", "items" : { "$ref" : "#/components/schemas/OrderReason" }, "type" : "array" }, "order_level_reject_reason_required" : { "description" : "True if the order level reject reason is required", "type" : "boolean" }, "order_level_reject_reasons" : { "description" : "Reject codes available at the order level.", "items" : { "$ref" : "#/components/schemas/OrderReason" }, "type" : "array" }, "refundable" : { "description" : "Whether the order is refundable or not. Null should be interpreted as false.", "type" : "boolean" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "OrderReplacement" : { "properties" : { "additional_merchant_notes_new_order" : { "description" : "Additional merchant notes to append to the new order", "type" : "string" }, "additional_merchant_notes_original_order" : { "description" : "Additional merchant notes to append to the original order", "type" : "string" }, "custom_field1" : { "description" : "Custom field 1", "maxLength" : 50, "type" : "string" }, "custom_field2" : { "description" : "Custom field 2", "maxLength" : 50, "type" : "string" }, "custom_field3" : { "description" : "Custom field 3", "maxLength" : 50, "type" : "string" }, "custom_field4" : { "description" : "Custom field 4", "maxLength" : 50, "type" : "string" }, "custom_field5" : { "description" : "Custom field 5", "maxLength" : 75, "type" : "string" }, "custom_field6" : { "description" : "Custom field 6", "maxLength" : 50, "type" : "string" }, "custom_field7" : { "description" : "Custom field 7", "maxLength" : 50, "type" : "string" }, "free" : { "description" : "Set to true if this replacement shipment should be free for the customer.", "type" : "boolean" }, "immediate_charge" : { "description" : "Set to true if you want to immediately charge the payment on this order, otherwise it will go to Accounts Receivable.", "type" : "boolean" }, "items" : { "description" : "Items to include in the replacement order", "items" : { "$ref" : "#/components/schemas/OrderReplacementItem" }, "type" : "array" }, "original_order_id" : { "description" : "Original order id", "type" : "string" }, "shipping_method" : { "description" : "Shipping method to use. If not specified or invalid then least cost shipping will take place.", "type" : "string" }, "skip_payment" : { "description" : "Set to true if you want to skip the payment as if it was successful.", "type" : "boolean" } }, "type" : "object" }, "OrderReplacementItem" : { "properties" : { "arbitrary_unit_cost" : { "description" : "Cost to charge the customer if specified. If not specified then the default item cost is used.", "type" : "number" }, "merchant_item_id" : { "description" : "Item ID", "maxLength" : 20, "type" : "string" }, "quantity" : { "description" : "Quantity", "type" : "number" } }, "type" : "object" }, "OrderReplacementResponse" : { "properties" : { "chargeSuccessful" : { "type" : "boolean" }, "errorMessage" : { "type" : "string" }, "feedback" : { "type" : "string" }, "free" : { "type" : "boolean" }, "orderId" : { "type" : "string" }, "successful" : { "type" : "boolean" } }, "type" : "object" }, "OrderResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "order" : { "$ref" : "#/components/schemas/Order" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "OrderSalesforce" : { "properties" : { "salesforce_opportunity_id" : { "description" : "Salesforce.com opportunity id", "type" : "string" } }, "type" : "object" }, "OrderShipping" : { "properties" : { "address1" : { "description" : "Address line 1", "maxLength" : 50, "type" : "string" }, "address2" : { "description" : "Address line 2", "maxLength" : 50, "type" : "string" }, "city" : { "description" : "City", "maxLength" : 32, "type" : "string" }, "company" : { "description" : "Company", "maxLength" : 50, "type" : "string" }, "country_code" : { "description" : "ISO-3166 two letter country code", "maxLength" : 2, "type" : "string" }, "day_phone" : { "description" : "Day time phone", "maxLength" : 25, "type" : "string" }, "day_phone_e164" : { "description" : "Day time phone (E164 format)", "maxLength" : 25, "type" : "string" }, "delivery_date" : { "description" : "Date the customer is requesting delivery on. Typically used for perishable product delivery.", "format" : "dateTime", "type" : "string" }, "evening_phone" : { "description" : "Evening phone", "maxLength" : 25, "type" : "string" }, "evening_phone_e164" : { "description" : "Evening phone (E164 format)", "maxLength" : 25, "type" : "string" }, "first_name" : { "description" : "First name", "maxLength" : 30, "type" : "string" }, "last_name" : { "description" : "Last name", "maxLength" : 30, "type" : "string" }, "least_cost_route" : { "description" : "If true, instructs UltraCart to apply the cheapest shipping method to this order. Used only for channel partner order inserts.", "type" : "boolean" }, "least_cost_route_shipping_methods" : { "description" : "List of shipping methods to consider if least_code_route is true. Used only for channel parter order inserts.", "items" : { "type" : "string" }, "type" : "array" }, "lift_gate" : { "description" : "Lift gate requested (LTL shipping methods only)", "type" : "boolean" }, "pickup_dts" : { "description" : "Date/time the order should be picked up locally.", "format" : "dateTime", "type" : "string" }, "postal_code" : { "description" : "Postal code", "maxLength" : 20, "type" : "string" }, "rma" : { "description" : "RMA number", "maxLength" : 30, "type" : "string" }, "ship_on_date" : { "description" : "Date the customer is requesting that the order ship on. Typically used for perishable product delivery.", "format" : "dateTime", "type" : "string" }, "ship_to_residential" : { "description" : "True if the shipping address is residential. Effects the methods that are available to the customer as well as the price of the shipping method.", "type" : "boolean" }, "shipping_3rd_party_account_number" : { "description" : "Shipping 3rd party account number", "maxLength" : 20, "type" : "string" }, "shipping_date" : { "description" : "Date/time the order shipped on. This date is set once the first shipment is sent to the customer.", "format" : "dateTime", "type" : "string" }, "shipping_department_status" : { "description" : "Shipping department status", "maxLength" : 30, "type" : "string" }, "shipping_method" : { "description" : "Shipping method", "type" : "string" }, "shipping_method_accounting_code" : { "description" : "Shipping method accounting code", "type" : "string" }, "special_instructions" : { "description" : "Special instructions from the customer regarding shipping", "type" : "string" }, "state_region" : { "description" : "State", "maxLength" : 32, "type" : "string" }, "title" : { "description" : "Title", "maxLength" : 50, "type" : "string" }, "tracking_number_details" : { "description" : "Tracking number details", "items" : { "$ref" : "#/components/schemas/OrderTrackingNumberDetails" }, "type" : "array" }, "tracking_numbers" : { "description" : "Tracking numbers", "items" : { "type" : "string" }, "type" : "array" }, "weight" : { "$ref" : "#/components/schemas/Weight" } }, "type" : "object" }, "OrdersResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "orders" : { "description" : "orders", "items" : { "$ref" : "#/components/schemas/Order" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "OrderSummary" : { "properties" : { "actual_fulfillment" : { "$ref" : "#/components/schemas/Currency" }, "actual_other_cost" : { "$ref" : "#/components/schemas/Currency" }, "actual_payment_processing" : { "$ref" : "#/components/schemas/Currency" }, "actual_profit" : { "$ref" : "#/components/schemas/Currency" }, "actual_profit_analyzed" : { "description" : "Actual profit has been analyzed", "type" : "boolean" }, "actual_profit_review" : { "description" : "Actual profit needs review", "type" : "boolean" }, "actual_shipping" : { "$ref" : "#/components/schemas/Currency" }, "arbitrary_shipping_handling_total" : { "$ref" : "#/components/schemas/Currency" }, "health_benefit_card_amount" : { "$ref" : "#/components/schemas/Currency" }, "health_benefit_card_refunded" : { "$ref" : "#/components/schemas/Currency" }, "internal_gift_certificate_amount" : { "$ref" : "#/components/schemas/Currency" }, "internal_gift_certificate_refunded" : { "$ref" : "#/components/schemas/Currency" }, "other_refunded" : { "$ref" : "#/components/schemas/Currency" }, "shipping_handling_refunded" : { "$ref" : "#/components/schemas/Currency" }, "shipping_handling_total" : { "$ref" : "#/components/schemas/Currency" }, "shipping_handling_total_discount" : { "$ref" : "#/components/schemas/Currency" }, "subtotal" : { "$ref" : "#/components/schemas/Currency" }, "subtotal_discount" : { "$ref" : "#/components/schemas/Currency" }, "subtotal_discount_refunded" : { "$ref" : "#/components/schemas/Currency" }, "subtotal_refunded" : { "$ref" : "#/components/schemas/Currency" }, "tax" : { "$ref" : "#/components/schemas/Currency" }, "tax_refunded" : { "$ref" : "#/components/schemas/Currency" }, "taxable_subtotal" : { "$ref" : "#/components/schemas/Currency" }, "taxable_subtotal_discount" : { "$ref" : "#/components/schemas/Currency" }, "total" : { "$ref" : "#/components/schemas/Currency" }, "total_refunded" : { "$ref" : "#/components/schemas/Currency" } }, "type" : "object" }, "OrderTag" : { "properties" : { "tag_value" : { "description" : "Tag Value", "maxLength" : 100, "type" : "string" } }, "type" : "object" }, "OrderTaxes" : { "properties" : { "arbitrary_tax" : { "description" : "Arbitrary Tax, this is meaningless for updating an order. For inserting a new order, this will override any internal tax calculations and should only be used for orders completed outside the system.", "type" : "number" }, "arbitrary_tax_rate" : { "description" : "Arbitrary tax rate, this is meaningless for updating an order. For inserting a new order, this will override any internal tax calculations and should only be used for orders completed outside the system.", "type" : "number" }, "arbitrary_taxable_subtotal" : { "description" : "Arbitrary taxable subtotal, this is meaningless for updating an order. For inserting a new order, this will override any internal tax calculations and should only be used for orders completed outside the system.", "type" : "number" }, "tax_city_accounting_code" : { "description" : "QuickBooks tax city code", "type" : "string" }, "tax_country_accounting_code" : { "description" : "QuickBooks tax country code", "type" : "string" }, "tax_county" : { "description" : "County used for tax calculation purposes (only in the United States)", "maxLength" : 32, "type" : "string" }, "tax_county_accounting_code" : { "description" : "QuickBooks tax county code", "type" : "string" }, "tax_gift_charge" : { "description" : "True if gift charge is taxed", "type" : "boolean" }, "tax_postal_code_accounting_code" : { "description" : "QuickBooks tax postal code code", "type" : "string" }, "tax_rate" : { "description" : "Tax rate, this is meaningless for updating an order. For inserting a new order, if you need to override internal tax calculations, use the arbitrary fields.", "type" : "number" }, "tax_rate_city" : { "description" : "Tax rate at the city level", "type" : "number" }, "tax_rate_country" : { "description" : "Tax rate at the country level", "type" : "number" }, "tax_rate_county" : { "description" : "Tax rate at the county level", "type" : "number" }, "tax_rate_postal_code" : { "description" : "Tax rate at the postal code level", "type" : "number" }, "tax_rate_state" : { "description" : "Tax rate at the state level", "type" : "number" }, "tax_shipping" : { "description" : "True if shipping is taxed", "type" : "boolean" }, "tax_state_accounting_code" : { "description" : "QuickBooks tax state code", "type" : "string" } }, "type" : "object" }, "OrderTokenResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "order_token" : { "description" : "An order token that securely represents an order id", "type" : "string" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "OrderTrackingNumberDetail" : { "properties" : { "city" : { "type" : "string" }, "event_dts" : { "description" : "ISO 8601 timestamp that the event occurred", "format" : "dateTime", "type" : "string" }, "event_local_date" : { "type" : "string" }, "event_local_time" : { "type" : "string" }, "event_timezone_id" : { "description" : "Timezone the event occurred in. Use this in conjunction with event_dts to format a local date/time.", "type" : "string" }, "state" : { "type" : "string" }, "subtag" : { "type" : "string" }, "subtag_message" : { "type" : "string" }, "tag" : { "type" : "string" }, "tag_description" : { "type" : "string" }, "tag_icon" : { "type" : "string" }, "zip" : { "type" : "string" } }, "type" : "object" }, "OrderTrackingNumberDetails" : { "properties" : { "actual_delivery_date" : { "type" : "string" }, "actual_delivery_date_formatted" : { "type" : "string" }, "details" : { "items" : { "$ref" : "#/components/schemas/OrderTrackingNumberDetail" }, "type" : "array" }, "easypost_tracker_id" : { "type" : "string" }, "expected_delivery_date" : { "type" : "string" }, "expected_delivery_date_formatted" : { "type" : "string" }, "map_url" : { "type" : "string" }, "order_placed_date" : { "type" : "string" }, "order_placed_date_formatted" : { "type" : "string" }, "payment_processed_date" : { "type" : "string" }, "payment_processed_date_formatted" : { "type" : "string" }, "shipped_date" : { "type" : "string" }, "shipped_date_formatted" : { "type" : "string" }, "shipping_method" : { "type" : "string" }, "status" : { "type" : "string" }, "status_description" : { "type" : "string" }, "tracking_number" : { "type" : "string" }, "tracking_url" : { "type" : "string" } }, "type" : "object" }, "OrderTransactionalMerchantNote" : { "properties" : { "ip_address" : { "description" : "IP Address", "type" : "string" }, "note" : { "description" : "note", "type" : "string" }, "note_dts" : { "description" : "Timestamp when the note was added", "format" : "dateTime", "type" : "string" }, "user" : { "description" : "User that wrote the merchant note", "type" : "string" } }, "type" : "object" }, "OrderUpsellCartRequest" : { "properties" : { "checkout_url" : { "type" : "string" }, "coupon_codes" : { "items" : { "type" : "string" }, "type" : "array" }, "items" : { "items" : { "$ref" : "#/components/schemas/CartItem" }, "type" : "array" } }, "type" : "object" }, "OrderUtm" : { "properties" : { "attribution_first_click_subtotal" : { "type" : "number" }, "attribution_first_click_total" : { "type" : "number" }, "attribution_last_click_subtotal" : { "type" : "number" }, "attribution_last_click_total" : { "type" : "number" }, "attribution_linear_subtotal" : { "type" : "number" }, "attribution_linear_total" : { "type" : "number" }, "attribution_position_based_subtotal" : { "type" : "number" }, "attribution_position_based_total" : { "type" : "number" }, "click_dts" : { "description" : "Date/time that the click happened", "format" : "dateTime", "type" : "string" }, "facebook_ad_id" : { "type" : "string" }, "fbclid" : { "type" : "string" }, "gbraid" : { "type" : "string" }, "glcid" : { "type" : "string" }, "itm_campaign" : { "type" : "string" }, "itm_content" : { "type" : "string" }, "itm_id" : { "type" : "string" }, "itm_medium" : { "type" : "string" }, "itm_source" : { "type" : "string" }, "itm_term" : { "type" : "string" }, "msclkid" : { "type" : "string" }, "short_code" : { "type" : "string" }, "short_code_backup" : { "type" : "boolean" }, "ttclid" : { "type" : "string" }, "uc_message_id" : { "type" : "string" }, "utm_campaign" : { "type" : "string" }, "utm_content" : { "type" : "string" }, "utm_id" : { "type" : "string" }, "utm_medium" : { "type" : "string" }, "utm_source" : { "type" : "string" }, "utm_term" : { "type" : "string" }, "vmcid" : { "type" : "string" }, "wbraid" : { "type" : "string" } }, "type" : "object" }, "OrderValidationRequest" : { "properties" : { "checks" : { "description" : "Checks to perform", "items" : { "type" : "string" }, "type" : "array" }, "order" : { "$ref" : "#/components/schemas/Order" } }, "type" : "object" }, "OrderValidationResponse" : { "properties" : { "errors" : { "description" : "Errors to display to the merchant if they failed any of the validations checked", "items" : { "type" : "string" }, "type" : "array" }, "messages" : { "description" : "Informational messages", "items" : { "type" : "string" }, "type" : "array" }, "order_was_updated" : { "description" : "If true, this order was updated during the validation call. This may happen during address standardization fixes.", "type" : "boolean" } }, "type" : "object" }, "Permission" : { "properties" : { "permission_group" : { "description" : "A group for this permission. This name is only used for visual grouping within interfaces.", "type" : "string" }, "permission_Name" : { "description" : "The name of this permission.", "type" : "string" }, "selected" : { "description" : "True if this user has this permission.", "type" : "boolean" } }, "type" : "object" }, "PointOfSaleLocation" : { "properties" : { "adddress2" : { "description" : "Address line 2", "type" : "string" }, "address1" : { "description" : "Address line 1", "type" : "string" }, "city" : { "description" : "City", "type" : "string" }, "country" : { "description" : "Country", "type" : "string" }, "distribution_center_code" : { "description" : "The distribution center code where inventory is reduced from for this sale.", "type" : "string" }, "external_id" : { "description" : "External Id useful for syncing with a remote filesystem, this may be an MD5 hash or whatever suits your needs.", "maxLength" : 100, "type" : "string" }, "merchant_id" : { "description" : "Merchant ID that owns this location", "type" : "string" }, "pos_location_oid" : { "description" : "Object identifier of the point of sale location.", "format" : "int32", "type" : "integer" }, "postal_code" : { "description" : "Postal code", "type" : "string" }, "state_province" : { "description" : "State/province", "type" : "string" }, "tax_county" : { "description" : "Tax county associated with this address. Need when a self managed tax configuration is being used.", "maxLength" : 32, "type" : "string" } }, "type" : "object" }, "PointOfSaleReader" : { "properties" : { "device_type" : { "description" : "The device type of the reader.", "type" : "string" }, "label" : { "description" : "The label of the reader.", "type" : "string" }, "merchant_id" : { "description" : "The merchant id that owns this point of sale reader.", "type" : "string" }, "payment_provider" : { "description" : "The payment provider for the card reader.", "enum" : [ "stripe" ], "type" : "string" }, "pos_reader_id" : { "description" : "Object identifier of the point of sale reader.", "format" : "int32", "type" : "integer" }, "pos_register_oid" : { "description" : "Object identifier of the point of sale register this reader is assigned to.", "format" : "int32", "type" : "integer" }, "serial_number" : { "description" : "The serial number of the reader.", "type" : "string" }, "stripe_account_id" : { "description" : "If the payment provider is Stripe, this is the Stripe account id", "type" : "string" }, "stripe_reader_id" : { "description" : "If the payment provide is Stripe, this is the Stripe terminal reader id", "type" : "string" } }, "type" : "object" }, "PointOfSaleRegister" : { "properties" : { "merchant_id" : { "description" : "The merchant id that owns this point of sale register.", "type" : "string" }, "name" : { "description" : "Name of the register.", "type" : "string" }, "pos_location_oid" : { "description" : "Object identifier of the point of sale location where this register is located.", "format" : "int32", "type" : "integer" }, "pos_register_oid" : { "description" : "Object identifier of the point of sale register.", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "PricingTier" : { "properties" : { "allow_3rd_party_billing" : { "description" : "Allow 3rd party billing", "type" : "boolean" }, "allow_cod" : { "description" : "Allow COD", "type" : "boolean" }, "allow_purchase_order" : { "description" : "Allow purchase order", "type" : "boolean" }, "allow_quote_request" : { "description" : "Allow quote request", "type" : "boolean" }, "approval_notification" : { "$ref" : "#/components/schemas/PricingTierNotification" }, "auto_approve_cod" : { "description" : "Auto approve COD", "type" : "boolean" }, "auto_approve_purchase_order" : { "description" : "Auto approve purchase order", "type" : "boolean" }, "currency_code" : { "description" : "Any currency code specified on this pricing tier will force a shopping cart into that currency", "type" : "string" }, "default_on_wholesale_signup" : { "description" : "Default on wholesale signup", "type" : "boolean" }, "default_percentage_discount" : { "description" : "Default percentage discount", "type" : "number" }, "default_shipping_method_oid" : { "description" : "Default shipping method oid", "format" : "int32", "type" : "integer" }, "default_tier" : { "description" : "Default tier", "type" : "boolean" }, "display_on_wholesale_signup" : { "description" : "Display on wholesale signup", "type" : "boolean" }, "exclude_from_free_promotion" : { "description" : "Exclude from free promotion", "type" : "boolean" }, "exempt_loyalty_rewards" : { "description" : "Exempt from Loyalty Rewards", "type" : "boolean" }, "exempt_shipping_handling_charge" : { "description" : "Exempt shipping handling charge", "type" : "boolean" }, "free_shipping" : { "description" : "Free shipping", "type" : "boolean" }, "free_shipping_minimum" : { "description" : "Free shipping minimum", "type" : "number" }, "maximum_item_count" : { "description" : "Maximum item count", "format" : "int32", "type" : "integer" }, "minimum_item_count" : { "description" : "Minimum item count", "format" : "int32", "type" : "integer" }, "minimum_subtotal" : { "description" : "Minimum subtotal", "type" : "number" }, "name" : { "description" : "Name", "maxLength" : 50, "type" : "string" }, "no_coupons" : { "description" : "No coupons", "type" : "boolean" }, "no_free_shipping" : { "description" : "No free shipping", "type" : "boolean" }, "no_realtime_charge" : { "description" : "No realtime charge", "type" : "boolean" }, "not_valid_when_coupon_present" : { "description" : "Not valid when coupon present", "type" : "boolean" }, "pricing_tier_oid" : { "description" : "Pricing Tier Oid", "format" : "int32", "type" : "integer" }, "realtime_percentage_discount" : { "description" : "Realtime percentage discount", "type" : "number" }, "restrict_to_distribution_center_oid" : { "description" : "Restrict inventory to this distribution center oid", "format" : "int32", "type" : "integer" }, "signup_notification" : { "$ref" : "#/components/schemas/PricingTierNotification" }, "suppress_buysafe" : { "description" : "Suppress buySAFE (deprecated)", "type" : "boolean" }, "suppress_mailing_list" : { "description" : "Suppress mailing list", "type" : "boolean" }, "tax_exempt" : { "description" : "Tax Exempt", "type" : "boolean" }, "track_separately" : { "description" : "Track separately", "type" : "boolean" } }, "type" : "object" }, "PricingTierNotification" : { "properties" : { "format" : { "description" : "Notification format", "maxLength" : 16, "type" : "string" }, "subject" : { "description" : "Notification subject", "maxLength" : 100, "type" : "string" }, "text" : { "description" : "Notification text", "type" : "string" } }, "type" : "object" }, "PricingTiersResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "pricingTiers" : { "description" : "pricing_tiers", "items" : { "$ref" : "#/components/schemas/PricingTier" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "Property" : { "properties" : { "name" : { "type" : "string" }, "value" : { "type" : "string" } }, "type" : "object" }, "PublishLibraryItemRequest" : { "properties" : { "release_notes" : { "description" : "Release notes for this release version.", "type" : "string" } }, "type" : "object" }, "RegisterAffiliateClickRequest" : { "properties" : { "affid" : { "description" : "Affiliate Id (must be specified if landing_page_url is not)", "format" : "int32", "type" : "integer" }, "ip_address" : { "description" : "IP Address (must be specified for non-browser key authenticated)", "type" : "string" }, "landing_page_url" : { "description" : "Landing Page URL", "type" : "string" }, "referrer_url" : { "description" : "Referrer URL (used for detecting invisible linking)", "type" : "string" }, "subid" : { "description" : "Sub Id (optional value if affid is specified.", "type" : "string" }, "user_agent" : { "description" : "User agent of the browser (must be specified for non-browser key authenticated)", "type" : "string" } }, "type" : "object" }, "RegisterAffiliateClickResponse" : { "properties" : { "cookie_max_age" : { "description" : "The cookie max age to use", "format" : "int32", "type" : "integer" }, "cookie_names" : { "description" : "The names of all the cookies to set on the browser", "items" : { "type" : "string" }, "type" : "array" }, "cookie_values" : { "description" : "The values of all the cookies to set on the browser", "items" : { "type" : "string" }, "type" : "array" }, "registered" : { "description" : "True if a click was registered", "type" : "boolean" } }, "type" : "object" }, "ReplaceOrderItemIdRequest" : { "properties" : { "item_index" : { "description" : "Index of the item on the order. Must match order.items[].item_index", "format" : "int32", "type" : "integer" }, "merchant_item_id" : { "description" : "Item ID", "maxLength" : 20, "type" : "string" }, "order_id" : { "description" : "Order ID", "type" : "string" }, "replacement_merchant_item_id" : { "description" : "Replacement Item ID", "maxLength" : 20, "type" : "string" } }, "type" : "object" }, "Report" : { "properties" : { "active" : { "type" : "boolean" }, "data_sources" : { "items" : { "$ref" : "#/components/schemas/ReportDataSource" }, "type" : "array" }, "default_dataset_id" : { "type" : "string" }, "default_project_id" : { "type" : "string" }, "filters" : { "items" : { "$ref" : "#/components/schemas/ReportFilter" }, "type" : "array" }, "merchant_id" : { "type" : "string" }, "name" : { "type" : "string" }, "pages" : { "items" : { "$ref" : "#/components/schemas/ReportPage" }, "type" : "array" }, "report_oid" : { "description" : "Object identifier for this report.", "format" : "int32", "type" : "integer" }, "security_level" : { "description" : "Security level to execute report under", "enum" : [ "standard", "low", "medium", "high" ], "type" : "string" }, "settings" : { "description" : "A JSON representation of the settings for this report", "type" : "string" } }, "type" : "object" }, "ReportAuth" : { "properties" : { "client_uuid" : { "description" : "Unique UUID assigned to this client", "type" : "string" }, "jwt" : { "type" : "string" }, "merchant_id" : { "type" : "string" }, "websocket_url" : { "type" : "string" } }, "type" : "object" }, "ReportAuthResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "report_auth" : { "$ref" : "#/components/schemas/ReportAuth" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ReportDataSet" : { "properties" : { "data_set_query_uuid" : { "description" : "A unique identifier assigned to the data set query that is returned.", "type" : "string" }, "data_set_uuid" : { "description" : "A unique identifier assigned to the data set that is returned.", "type" : "string" }, "destination_table_id" : { "description" : "The BigQuery destination table id that contains the result.", "type" : "string" }, "error_message" : { "description" : "Error message if the query failed.", "type" : "string" }, "executed_sql" : { "type" : "string" }, "for_object_id" : { "description" : "An identifier that can be used to help match up the returned data set", "type" : "string" }, "for_object_type" : { "description" : "The type of object this data set is for", "enum" : [ "schema", "filter", "visualization" ], "type" : "string" }, "initial_pages" : { "description" : "Initial pages returned in the dataset", "items" : { "$ref" : "#/components/schemas/ReportDataSetPage" }, "type" : "array" }, "max_results" : { "description" : "The total number of results", "format" : "int64", "type" : "integer" }, "merchant_id" : { "description" : "Merchant that owns this data set", "type" : "string" }, "page_count" : { "description" : "The total number of pages in the result set", "format" : "int32", "type" : "integer" }, "page_size" : { "description" : "The size of the pages", "format" : "int32", "type" : "integer" }, "request_dts" : { "description" : "Date/Time of the client submitted the request. Can be used to resolve out of order query completion results", "format" : "dateTime", "type" : "string" }, "schema" : { "description" : "The schema associated with the data set.", "items" : { "$ref" : "#/components/schemas/ReportDataSetSchema" }, "type" : "array" }, "security_level" : { "description" : "Security level this dataset was read from.", "type" : "string" }, "timezone" : { "type" : "string" }, "user_data" : { "description" : "Any other data that needs to be returned with the response to help the UI", "type" : "string" } }, "type" : "object" }, "ReportDataSetColumn" : { "properties" : { "in" : { "type" : "boolean" }, "n" : { "type" : "string" }, "vd" : { "type" : "string" }, "vdt" : { "type" : "string" }, "vn" : { "type" : "number" }, "vs" : { "type" : "string" } }, "type" : "object" }, "ReportDataSetPage" : { "properties" : { "data_set_uuid" : { "description" : "A unique identifier assigned to the data set that is returned.", "type" : "string" }, "merchant_id" : { "description" : "Merchant that owns this data set", "type" : "string" }, "next_page_token" : { "type" : "string" }, "next_start_index" : { "format" : "int32", "type" : "integer" }, "page_number" : { "format" : "int32", "type" : "integer" }, "row_count" : { "format" : "int32", "type" : "integer" }, "rows" : { "description" : "Rows returned for the data set", "items" : { "$ref" : "#/components/schemas/ReportDataSetRow" }, "type" : "array" }, "rows_s3_url" : { "description" : "Signed S3 URL where the page rows can be downloaded from", "type" : "string" }, "start_index" : { "description" : "Zero based index of the starting row", "format" : "int32", "type" : "integer" }, "table_id" : { "description" : "The BigQuery destination table id that contains the result.", "type" : "string" } }, "type" : "object" }, "ReportDataSetPageResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "page" : { "$ref" : "#/components/schemas/ReportDataSetPage" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ReportDataSetQuery" : { "properties" : { "comparison_results" : { "description" : "True if a date range filter is provided with comparison date ranges and two results should be returned for the query.", "type" : "boolean" }, "data_set_query_uuid" : { "description" : "A unique identifier assigned to the data set query that is returned.", "type" : "string" }, "data_source" : { "$ref" : "#/components/schemas/ReportDataSource" }, "dimensions" : { "items" : { "$ref" : "#/components/schemas/ReportPageVisualizationDimension" }, "type" : "array" }, "filter" : { "$ref" : "#/components/schemas/ReportFilter" }, "for_object_id" : { "description" : "An identifier that can be used to help match up the returned data set", "type" : "string" }, "for_object_type" : { "description" : "The type of object this data set is for", "enum" : [ "schema", "filter", "visualization" ], "type" : "string" }, "metrics" : { "items" : { "$ref" : "#/components/schemas/ReportPageVisualizationMetric" }, "type" : "array" }, "order_by_columns" : { "description" : "The columns to order by in the final result. If not specified the dimensions will be used", "items" : { "$ref" : "#/components/schemas/ReportDataSetQueryOrderByColumn" }, "type" : "array" }, "page_size" : { "description" : "Result set page size. The default value is 200 records. Max is 10000.", "format" : "int32", "type" : "integer" }, "selected_filters" : { "items" : { "$ref" : "#/components/schemas/ReportFilter" }, "type" : "array" }, "skip_cache" : { "description" : "True if the 15 minute cache should be skipped.", "type" : "boolean" }, "user_data" : { "description" : "Any other data that needs to be returned with the response to help the UI", "type" : "string" } }, "type" : "object" }, "ReportDataSetQueryOrderByColumn" : { "properties" : { "ascending" : { "type" : "boolean" }, "column_name" : { "type" : "string" } }, "type" : "object" }, "ReportDataSetResponse" : { "properties" : { "data_set" : { "$ref" : "#/components/schemas/ReportDataSet" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ReportDataSetRow" : { "properties" : { "c" : { "items" : { "$ref" : "#/components/schemas/ReportDataSetColumn" }, "type" : "array" } }, "type" : "object" }, "ReportDataSetSchema" : { "properties" : { "config" : { "description" : "A JSON representation of the configuration for this visualization", "type" : "string" }, "name" : { "type" : "string" }, "type" : { "description" : "Type of the column.", "enum" : [ "BIGNUMERIC", "BOOL", "DATE", "DATETIME", "FLOAT64", "INT64", "JSON", "NUMERIC", "STRING", "TIME", "TIMESTAMP" ], "type" : "string" } }, "type" : "object" }, "ReportDataSource" : { "properties" : { "data_source_uuid" : { "description" : "A unique identifier assigned to the data source.", "type" : "string" }, "name" : { "type" : "string" }, "partition_date_column" : { "type" : "string" }, "partition_date_safety_days" : { "format" : "int32", "type" : "integer" }, "partition_date_strategy" : { "description" : "The partition date strategy, defaults to weekly sunday", "type" : "string" }, "schema" : { "items" : { "$ref" : "#/components/schemas/ReportDataSourceSchema" }, "type" : "array" }, "sql" : { "type" : "string" } }, "type" : "object" }, "ReportDataSourceSchema" : { "properties" : { "config" : { "description" : "A JSON representation of the configuration for this visualization", "type" : "string" }, "dimension" : { "description" : "Whether or not this column can be used as a dimension within a visualization", "type" : "boolean" }, "name" : { "type" : "string" }, "type" : { "description" : "Type of the column. Only supporting the allowed values. Any other types will be ignored.", "enum" : [ "BIGNUMERIC", "BOOL", "DATE", "DATETIME", "FLOAT64", "INT64", "JSON", "NUMERIC", "STRING", "TIME", "TIMESTAMP" ], "type" : "string" } }, "type" : "object" }, "ReportDryRunQueriesRequest" : { "properties" : { "connection_id" : { "type" : "string" }, "default_dataset_id" : { "type" : "string" }, "default_project_id" : { "type" : "string" }, "merchant_id" : { "type" : "string" }, "queries" : { "items" : { "$ref" : "#/components/schemas/ReportDataSetQuery" }, "type" : "array" }, "security_level" : { "type" : "string" } }, "type" : "object" }, "ReportDryRunQueriesResponse" : { "properties" : { "dry_run_query_results" : { "items" : { "$ref" : "#/components/schemas/ReportDryRunQueryResult" }, "type" : "array" } }, "type" : "object" }, "ReportDryRunQueryResult" : { "properties" : { "error_message" : { "type" : "string" }, "total_bytes_processed" : { "format" : "int64", "type" : "integer" } }, "type" : "object" }, "ReportExecuteQueriesRequest" : { "properties" : { "client_uuid" : { "description" : "Unique UUID assigned to this client during the auth. This will be used to locate the websocket connect id.", "type" : "string" }, "connection_id" : { "description" : "The websocket connection id that should receive back notices of query completion.", "type" : "string" }, "default_dataset_id" : { "type" : "string" }, "default_project_id" : { "type" : "string" }, "merchant_id" : { "type" : "string" }, "queries" : { "description" : "An array of queries that we want the lambda function to execute.", "items" : { "$ref" : "#/components/schemas/ReportDataSetQuery" }, "type" : "array" }, "request_dts" : { "description" : "Date/Time of the client submitted the request. Can be used to resolve out of order query completion results", "format" : "dateTime", "type" : "string" }, "security_level" : { "description" : "Security level to execute report under", "enum" : [ "standard", "low", "medium", "high" ], "type" : "string" } }, "type" : "object" }, "ReportFilter" : { "properties" : { "connections" : { "description" : "How this filter connects to the data sources and columns", "items" : { "$ref" : "#/components/schemas/ReportFilterConnection" }, "type" : "array" }, "name" : { "type" : "string" }, "timezone" : { "description" : "The timezone that the date range is querying on.", "type" : "string" }, "type" : { "description" : "Type of filter", "enum" : [ "date range", "date comparison", "single value", "multiple values" ], "type" : "string" }, "uuid" : { "description" : "Unique UUID assigned to the filter. Assists when returning values that the filter can use.", "type" : "string" }, "values" : { "description" : "The selected values for the filter. When used, some type conversion will need to occur.", "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "ReportFilterConnection" : { "properties" : { "column" : { "type" : "string" }, "data_source_name" : { "type" : "string" }, "data_source_uuid" : { "description" : "A unique identifier assigned to the data source.", "type" : "string" } }, "type" : "object" }, "ReportPage" : { "properties" : { "filters" : { "items" : { "$ref" : "#/components/schemas/ReportPageFilter" }, "type" : "array" }, "height" : { "description" : "Height of the report page in inches", "type" : "number" }, "settings" : { "description" : "A JSON representation of the settings for this report", "type" : "string" }, "title" : { "type" : "string" }, "visualizations" : { "description" : "Visualizations on the report page.", "items" : { "$ref" : "#/components/schemas/ReportPageVisualization" }, "type" : "array" }, "width" : { "description" : "Width of the report page in inches", "type" : "number" } }, "type" : "object" }, "ReportPageFilter" : { "properties" : { "config" : { "description" : "A JSON representation of the configuration for this visualization", "type" : "string" }, "name" : { "type" : "string" }, "styles" : { "description" : "A JSON representation of the style configuration for this visualization", "type" : "string" }, "uuid" : { "description" : "Unique UUID assigned to the filter. Assists when returning values that the filter can use.", "type" : "string" } }, "type" : "object" }, "ReportPageVisualization" : { "properties" : { "config" : { "description" : "A JSON representation of the configuration for this visualization", "type" : "string" }, "data_source_name" : { "type" : "string" }, "data_source_uuid" : { "description" : "A unique identifier assigned to the data source.", "type" : "string" }, "dimensions" : { "items" : { "$ref" : "#/components/schemas/ReportPageVisualizationDimension" }, "type" : "array" }, "metrics" : { "items" : { "$ref" : "#/components/schemas/ReportPageVisualizationMetric" }, "type" : "array" }, "name" : { "type" : "string" }, "show_comparison" : { "description" : "True if the visualization should show a comparison based upon the date range", "type" : "boolean" }, "styles" : { "description" : "A JSON representation of the style configuration for this visualization", "type" : "string" }, "type" : { "description" : "Type of visualization", "enum" : [ "score card", "line chart", "bar chart", "text", "table", "gauge", "pie chart" ], "type" : "string" }, "visualization_uuid" : { "description" : "A UUID for the visualization", "type" : "string" } }, "type" : "object" }, "ReportPageVisualizationDimension" : { "properties" : { "as" : { "description" : "Return the column as a different name", "type" : "string" }, "cast" : { "description" : "Cast the column to a different data type such as DATETIME -> DATE", "type" : "string" }, "column" : { "type" : "string" }, "datetime_timezone" : { "description" : "The timezone to shift the date to", "type" : "string" }, "datetime_trunc" : { "description" : "The type of truncation to perform on the date, DAY, WEEK(MONDAY), etc.", "type" : "string" }, "extract" : { "description" : "Part of a datetime to extract", "type" : "string" }, "function" : { "description" : "The function to perform around the column such as DATE_TRUNC(@column, day)", "type" : "string" } }, "type" : "object" }, "ReportPageVisualizationMetric" : { "properties" : { "aggregation" : { "description" : "Aggregation to perform", "enum" : [ "sum", "count", "min", "max", "avg", "none" ], "type" : "string" }, "as" : { "description" : "Return the column as a different name", "type" : "string" }, "column" : { "type" : "string" }, "round" : { "description" : "Number of places after the decimal point to round the number to.", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ReportResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "report" : { "$ref" : "#/components/schemas/Report" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ReportsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "reports" : { "items" : { "$ref" : "#/components/schemas/Report" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ReportWebsocketEvent" : { "properties" : { "event_type" : { "description" : "Event type", "enum" : [ "ping", "query completion" ], "type" : "string" }, "query_completion" : { "$ref" : "#/components/schemas/ReportDataSet" } }, "type" : "object" }, "ResponseMetadata" : { "properties" : { "payload_name" : { "description" : "Payload name", "type" : "string" }, "result_set" : { "$ref" : "#/components/schemas/ResultSet" } }, "type" : "object" }, "ResultSet" : { "properties" : { "count" : { "description" : "Number of results in this set", "format" : "int32", "type" : "integer" }, "limit" : { "description" : "Maximum number of results that can be returned in a set", "format" : "int32", "type" : "integer" }, "more" : { "description" : "True if there are more results to query", "type" : "boolean" }, "next_offset" : { "description" : "The next offset that you should query to retrieve more results", "format" : "int32", "type" : "integer" }, "offset" : { "description" : "Offset of this result set (zero based)", "format" : "int32", "type" : "integer" }, "total_records" : { "description" : "The total number of records in the result set. May be null if the number is not known and the client should continue iterating as long as more is true.", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "RulerValidationRequest" : { "properties" : { "ruler" : { "type" : "string" } }, "type" : "object" }, "RulerValidationResponse" : { "properties" : { "error_message" : { "type" : "string" }, "valid" : { "type" : "boolean" } }, "type" : "object" }, "ScreenRecording" : { "properties" : { "ad_platform" : { "$ref" : "#/components/schemas/ScreenRecordingAdPlatform" }, "analytics_client_oid" : { "format" : "int64", "type" : "integer" }, "analytics_session_dts" : { "format" : "int64", "type" : "integer" }, "analytics_session_oid" : { "format" : "int64", "type" : "integer" }, "communications_campaign_name" : { "description" : "Campaign Name", "type" : "string" }, "communications_campaign_uuid" : { "description" : "Campaign UUID", "type" : "string" }, "communications_email_subject" : { "description" : "Email subject", "type" : "string" }, "communications_email_uuid" : { "description" : "Email UUID", "type" : "string" }, "communications_flow_name" : { "description" : "Flow Name", "type" : "string" }, "communications_flow_uuid" : { "description" : "Flow UUID", "type" : "string" }, "email" : { "type" : "string" }, "email_domain" : { "type" : "string" }, "end_timestamp" : { "description" : "Ending timestamp", "format" : "dateTime", "type" : "string" }, "esp_customer_uuid" : { "type" : "string" }, "events_gz_size" : { "format" : "int32", "type" : "integer" }, "events_json_key" : { "type" : "string" }, "favorite" : { "description" : "True if the user calling the API has favorited this particular screen recording.", "type" : "boolean" }, "favorites" : { "description" : "Array of user ids that favorited this particular screen recording.", "items" : { "type" : "integer" }, "type" : "array" }, "geolocation" : { "$ref" : "#/components/schemas/GeoPoint" }, "geolocation_country" : { "type" : "string" }, "geolocation_state" : { "type" : "string" }, "language_iso_code" : { "description" : "Language ISO code", "type" : "string" }, "merchant_id" : { "type" : "string" }, "merchant_notes" : { "type" : "string" }, "missing_external_tracking" : { "description" : "True if external page view was not tracked", "type" : "boolean" }, "order_id" : { "type" : "string" }, "page_view_count" : { "format" : "int32", "type" : "integer" }, "page_views" : { "items" : { "$ref" : "#/components/schemas/ScreenRecordingPageView" }, "type" : "array" }, "preferred_language" : { "description" : "ISO 3 Letter language code that the customer would prefer", "type" : "string" }, "referrer_domain" : { "type" : "string" }, "rrweb_version" : { "type" : "string" }, "screen_recording_uuid" : { "type" : "string" }, "signed_download_url" : { "type" : "string" }, "start_timestamp" : { "description" : "Starting timestamp", "format" : "dateTime", "type" : "string" }, "storefront_oids" : { "items" : { "type" : "integer" }, "type" : "array" }, "storefronts" : { "items" : { "$ref" : "#/components/schemas/ScreenRecordingStoreFront" }, "type" : "array" }, "tags" : { "items" : { "type" : "string" }, "type" : "array" }, "time_on_site" : { "format" : "int32", "type" : "integer" }, "ucacid" : { "type" : "string" }, "user_agent" : { "$ref" : "#/components/schemas/ScreenRecordingUserAgent" }, "user_agent_raw" : { "type" : "string" }, "user_ip" : { "type" : "string" }, "user_properties" : { "items" : { "$ref" : "#/components/schemas/ScreenRecordingUserProperty" }, "type" : "array" }, "utm_campaign" : { "description" : "UTM Campaign", "type" : "string" }, "utm_source" : { "description" : "UTM Source", "type" : "string" }, "visitor_first_seen" : { "description" : "Timestamp this visitor was first seen", "format" : "dateTime", "type" : "string" }, "visitor_number" : { "format" : "int32", "type" : "integer" }, "watched" : { "type" : "boolean" }, "window_height" : { "format" : "int32", "type" : "integer" }, "window_width" : { "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ScreenRecordingAdPlatform" : { "properties" : { "fbc" : { "description" : "Facebook Click Id (Cookie)", "type" : "string" }, "fbclid" : { "description" : "Facebook Click Id Parameter (Parameter)", "type" : "string" }, "fbp" : { "description" : "Facebook Browser Id (Cookie)", "type" : "string" }, "gacid" : { "description" : "Google Analytics CID (Cookie)", "type" : "string" }, "glcid" : { "description" : "Google Adwords Click Id (Parameter)", "type" : "string" }, "msclkid" : { "description" : "Bing Click Id (Parameter", "type" : "string" }, "ttclid" : { "description" : "TikTok Click Id (Parameter", "type" : "string" } }, "type" : "object" }, "ScreenRecordingFilter" : { "properties" : { "affiliate_email" : { "type" : "string" }, "affiliate_id" : { "format" : "int32", "type" : "integer" }, "communications_campaign_name" : { "type" : "string" }, "communications_campaign_name_filter" : { "type" : "boolean" }, "communications_email_subject" : { "type" : "string" }, "communications_email_subject_filter" : { "type" : "boolean" }, "communications_flow_name" : { "type" : "string" }, "communications_flow_name_filter" : { "type" : "boolean" }, "email" : { "$ref" : "#/components/schemas/ScreenRecordingFilterStringSearch" }, "email_domain" : { "type" : "string" }, "email_domain_filter" : { "type" : "boolean" }, "email_identified" : { "type" : "boolean" }, "end_timestamp" : { "$ref" : "#/components/schemas/ScreenRecordingFilterRangeDate" }, "esp_customer_uuid" : { "type" : "string" }, "favorite" : { "type" : "boolean" }, "geolocation" : { "$ref" : "#/components/schemas/ScreenRecordingFilterGeoDistance" }, "geolocation_country" : { "$ref" : "#/components/schemas/ScreenRecordingFilterStringSearch" }, "geolocation_country_filter" : { "type" : "boolean" }, "geolocation_state" : { "$ref" : "#/components/schemas/ScreenRecordingFilterStringSearch" }, "geolocation_state_filter" : { "type" : "boolean" }, "language_iso_code" : { "$ref" : "#/components/schemas/ScreenRecordingFilterStringSearch" }, "language_iso_code_filter" : { "type" : "boolean" }, "last_x_days" : { "format" : "int32", "type" : "integer" }, "max_filter_values" : { "format" : "int32", "type" : "integer" }, "order_id" : { "$ref" : "#/components/schemas/ScreenRecordingFilterStringSearch" }, "page_view_count" : { "$ref" : "#/components/schemas/ScreenRecordingFilterRangeInteger" }, "page_views" : { "items" : { "$ref" : "#/components/schemas/ScreenRecordingFilterPageView" }, "type" : "array" }, "placed_order" : { "type" : "boolean" }, "preferred_language" : { "$ref" : "#/components/schemas/ScreenRecordingFilterStringSearch" }, "preferred_language_filter" : { "type" : "boolean" }, "referrer_domain" : { "type" : "string" }, "referrer_domain_filter" : { "type" : "boolean" }, "screen_recording_uuids" : { "items" : { "type" : "string" }, "type" : "array" }, "screen_sizes" : { "items" : { "type" : "string" }, "type" : "array" }, "skip_filter_values" : { "type" : "boolean" }, "skip_histogram" : { "type" : "boolean" }, "skip_hits" : { "type" : "boolean" }, "start_timestamp" : { "$ref" : "#/components/schemas/ScreenRecordingFilterRangeDate" }, "tags" : { "items" : { "type" : "string" }, "type" : "array" }, "time_on_site" : { "$ref" : "#/components/schemas/ScreenRecordingFilterRangeInteger" }, "time_on_site_max_filter" : { "type" : "boolean" }, "time_on_site_min_filter" : { "type" : "boolean" }, "url_filter" : { "type" : "boolean" }, "user_agent_device_name" : { "type" : "string" }, "user_agent_device_name_filter" : { "type" : "boolean" }, "user_agent_device_os_name_filter" : { "type" : "boolean" }, "user_agent_device_os_version_filter" : { "type" : "boolean" }, "user_agent_name" : { "type" : "string" }, "user_agent_name_filter" : { "type" : "boolean" }, "user_agent_original" : { "$ref" : "#/components/schemas/ScreenRecordingFilterStringSearch" }, "user_agent_original_filter" : { "type" : "boolean" }, "user_agent_os_name" : { "type" : "string" }, "user_agent_os_version" : { "type" : "string" }, "user_ip" : { "$ref" : "#/components/schemas/ScreenRecordingFilterIpSearch" }, "utm_campaign" : { "type" : "string" }, "utm_campaign_filter" : { "type" : "boolean" }, "utm_source" : { "type" : "string" }, "utm_source_filter" : { "type" : "boolean" }, "visitor_number" : { "format" : "int32", "type" : "integer" }, "watched" : { "type" : "boolean" } }, "type" : "object" }, "ScreenRecordingFilterGeoDistance" : { "properties" : { "distance" : { "format" : "int32", "type" : "integer" }, "distance_uom" : { "type" : "string" }, "from_address" : { "type" : "string" }, "lat" : { "type" : "number" }, "lon" : { "type" : "number" } }, "type" : "object" }, "ScreenRecordingFilterIpSearch" : { "properties" : { "does_not_exist" : { "type" : "boolean" }, "exists" : { "type" : "boolean" }, "is" : { "type" : "string" }, "is_not" : { "type" : "string" } }, "type" : "object" }, "ScreenRecordingFilterPageView" : { "properties" : { "domain" : { "$ref" : "#/components/schemas/ScreenRecordingFilterStringSearch" }, "domain_filter" : { "type" : "boolean" }, "event_name_filter" : { "type" : "boolean" }, "event_param_name_filter" : { "type" : "boolean" }, "event_param_value_filter" : { "type" : "boolean" }, "events" : { "items" : { "$ref" : "#/components/schemas/ScreenRecordingFilterPageViewEvent" }, "type" : "array" }, "param_name_filter" : { "type" : "boolean" }, "param_value_filter" : { "type" : "boolean" }, "params" : { "items" : { "$ref" : "#/components/schemas/ScreenRecordingFilterPageViewParam" }, "type" : "array" }, "referrer" : { "$ref" : "#/components/schemas/ScreenRecordingFilterStringSearch" }, "referrer_params" : { "items" : { "$ref" : "#/components/schemas/ScreenRecordingFilterPageViewReferrerParam" }, "type" : "array" }, "referrer_raw" : { "$ref" : "#/components/schemas/ScreenRecordingFilterStringSearch" }, "time_on_page" : { "$ref" : "#/components/schemas/ScreenRecordingFilterRangeInteger" }, "time_on_page_max_filter" : { "type" : "boolean" }, "time_on_page_min_filter" : { "type" : "boolean" }, "url" : { "$ref" : "#/components/schemas/ScreenRecordingFilterStringSearch" }, "url_filter" : { "type" : "boolean" } }, "type" : "object" }, "ScreenRecordingFilterPageViewEvent" : { "properties" : { "event_name" : { "type" : "string" }, "event_params" : { "items" : { "$ref" : "#/components/schemas/ScreenRecordingFilterPageViewEventParam" }, "type" : "array" } }, "type" : "object" }, "ScreenRecordingFilterPageViewEventParam" : { "properties" : { "name" : { "type" : "string" }, "value_bd" : { "$ref" : "#/components/schemas/ScreenRecordingFilterRangeBigDecimal" }, "value_bool" : { "type" : "boolean" }, "value_num" : { "$ref" : "#/components/schemas/ScreenRecordingFilterRangeInteger" }, "value_text" : { "$ref" : "#/components/schemas/ScreenRecordingFilterStringSearch" } }, "type" : "object" }, "ScreenRecordingFilterPageViewParam" : { "properties" : { "name" : { "type" : "string" }, "value" : { "$ref" : "#/components/schemas/ScreenRecordingFilterStringSearch" } }, "type" : "object" }, "ScreenRecordingFilterPageViewReferrerParam" : { "properties" : { "name" : { "type" : "string" }, "value" : { "$ref" : "#/components/schemas/ScreenRecordingFilterStringSearch" } }, "type" : "object" }, "ScreenRecordingFilterRangeBigDecimal" : { "properties" : { "eq" : { "type" : "number" }, "gt" : { "type" : "number" }, "gte" : { "type" : "number" }, "lt" : { "type" : "number" }, "lte" : { "type" : "number" } }, "type" : "object" }, "ScreenRecordingFilterRangeDate" : { "properties" : { "end" : { "description" : "End of the range", "format" : "dateTime", "type" : "string" }, "start" : { "description" : "Start of the range", "format" : "dateTime", "type" : "string" } }, "type" : "object" }, "ScreenRecordingFilterRangeInteger" : { "properties" : { "eq" : { "format" : "int32", "type" : "integer" }, "gt" : { "format" : "int32", "type" : "integer" }, "gte" : { "format" : "int32", "type" : "integer" }, "lt" : { "format" : "int32", "type" : "integer" }, "lte" : { "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ScreenRecordingFilterStringSearch" : { "properties" : { "does_not_exist" : { "type" : "boolean" }, "exists" : { "type" : "boolean" }, "is" : { "type" : "string" }, "is_not" : { "type" : "string" }, "starts_with" : { "type" : "string" } }, "type" : "object" }, "ScreenRecordingFilterValues" : { "properties" : { "communications_campaign_names" : { "items" : { "type" : "string" }, "type" : "array" }, "communications_email_subjects" : { "items" : { "type" : "string" }, "type" : "array" }, "communications_flow_names" : { "items" : { "type" : "string" }, "type" : "array" }, "email_domains" : { "items" : { "type" : "string" }, "type" : "array" }, "geolocation_countries" : { "items" : { "type" : "string" }, "type" : "array" }, "geolocation_states" : { "items" : { "type" : "string" }, "type" : "array" }, "language_iso_codes" : { "items" : { "type" : "string" }, "type" : "array" }, "max_values" : { "format" : "int32", "type" : "integer" }, "page_views" : { "items" : { "$ref" : "#/components/schemas/ScreenRecordingFilterValuesPageView" }, "type" : "array" }, "preferred_languages" : { "items" : { "type" : "string" }, "type" : "array" }, "referrer_domains" : { "items" : { "type" : "string" }, "type" : "array" }, "time_on_site_max" : { "format" : "int32", "type" : "integer" }, "time_on_site_min" : { "format" : "int32", "type" : "integer" }, "urls" : { "items" : { "type" : "string" }, "type" : "array" }, "user_agent_device_names" : { "items" : { "type" : "string" }, "type" : "array" }, "user_agent_device_os_names" : { "items" : { "type" : "string" }, "type" : "array" }, "user_agent_device_os_versions" : { "items" : { "type" : "string" }, "type" : "array" }, "user_agent_names" : { "items" : { "type" : "string" }, "type" : "array" }, "user_agent_originals" : { "items" : { "type" : "string" }, "type" : "array" }, "utm_campaigns" : { "items" : { "type" : "string" }, "type" : "array" }, "utm_sources" : { "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "ScreenRecordingFilterValuesEvent" : { "properties" : { "name" : { "type" : "string" }, "params" : { "items" : { "$ref" : "#/components/schemas/ScreenRecordingFilterValuesEventParams" }, "type" : "array" } }, "type" : "object" }, "ScreenRecordingFilterValuesEventParams" : { "properties" : { "name" : { "type" : "string" }, "values_bd" : { "items" : { "type" : "number" }, "type" : "array" }, "values_bool" : { "items" : { "type" : "boolean" }, "type" : "array" }, "values_num" : { "items" : { "type" : "integer" }, "type" : "array" }, "values_text" : { "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "ScreenRecordingFilterValuesPageParam" : { "properties" : { "name" : { "type" : "string" }, "values" : { "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "ScreenRecordingFilterValuesPageView" : { "properties" : { "domains" : { "items" : { "type" : "string" }, "type" : "array" }, "events" : { "items" : { "$ref" : "#/components/schemas/ScreenRecordingFilterValuesEvent" }, "type" : "array" }, "page_params" : { "items" : { "$ref" : "#/components/schemas/ScreenRecordingFilterValuesPageParam" }, "type" : "array" }, "time_on_page_max" : { "format" : "int32", "type" : "integer" }, "time_on_page_min" : { "format" : "int32", "type" : "integer" }, "urls" : { "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "ScreenRecordingHeatmap" : { "properties" : { "large_click_thumbnail_url" : { "type" : "string" }, "large_click_url" : { "type" : "string" }, "large_movement_thumbnail_url" : { "type" : "string" }, "large_movement_url" : { "type" : "string" }, "large_regular_thumbnail_url" : { "type" : "string" }, "large_regular_url" : { "type" : "string" }, "large_scroll_thumbnail_url" : { "type" : "string" }, "large_scroll_url" : { "type" : "string" }, "medium_click_thumbnail_url" : { "type" : "string" }, "medium_click_url" : { "type" : "string" }, "medium_movement_thumbnail_url" : { "type" : "string" }, "medium_movement_url" : { "type" : "string" }, "medium_regular_thumbnail_url" : { "type" : "string" }, "medium_regular_url" : { "type" : "string" }, "medium_scroll_thumbnail_url" : { "type" : "string" }, "medium_scroll_url" : { "type" : "string" }, "small_click_thumbnail_url" : { "type" : "string" }, "small_click_url" : { "type" : "string" }, "small_movement_thumbnail_url" : { "type" : "string" }, "small_movement_url" : { "type" : "string" }, "small_regular_thumbnail_url" : { "type" : "string" }, "small_regular_url" : { "type" : "string" }, "small_scroll_thumbnail_url" : { "type" : "string" }, "small_scroll_url" : { "type" : "string" } }, "type" : "object" }, "ScreenRecordingHeatmapIndexRequest" : { "properties" : { "url_contains" : { "type" : "string" } }, "type" : "object" }, "ScreenRecordingHeatmapIndexResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "heatmap_urls" : { "items" : { "$ref" : "#/components/schemas/ScreenRecordingHeatmapUrl" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ScreenRecordingHeatmapRequest" : { "properties" : { "range" : { "$ref" : "#/components/schemas/ScreenRecordingFilterRangeDate" }, "screen_sizes" : { "items" : { "type" : "string" }, "type" : "array" }, "url" : { "type" : "string" } }, "type" : "object" }, "ScreenRecordingHeatmapReset" : { "properties" : { "url" : { "type" : "string" } }, "type" : "object" }, "ScreenRecordingHeatmapResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "heatmap" : { "$ref" : "#/components/schemas/ScreenRecordingHeatmap" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ScreenRecordingHeatmapUrl" : { "properties" : { "histogram_data" : { "items" : { "type" : "integer" }, "type" : "array" }, "histogram_interval" : { "type" : "string" }, "histogram_start_dts" : { "type" : "string" }, "page_rank" : { "format" : "int32", "type" : "integer" }, "session_count" : { "format" : "int32", "type" : "integer" }, "url" : { "type" : "string" } }, "type" : "object" }, "ScreenRecordingMerchantNotesRequest" : { "properties" : { "merchant_notes" : { "type" : "string" } }, "type" : "object" }, "ScreenRecordingMultifield" : { "properties" : { "bd" : { "type" : "number" }, "bool" : { "type" : "boolean" }, "json" : { "type" : "string" }, "num" : { "format" : "int64", "type" : "integer" }, "text" : { "type" : "string" } }, "type" : "object" }, "ScreenRecordingPageView" : { "properties" : { "domain" : { "type" : "string" }, "events" : { "items" : { "$ref" : "#/components/schemas/ScreenRecordingPageViewEvent" }, "type" : "array" }, "first_event_timestamp" : { "description" : "First event timestamp", "format" : "dateTime", "type" : "string" }, "http_post" : { "type" : "boolean" }, "last_event_timestamp" : { "description" : "Last event timestamp", "format" : "dateTime", "type" : "string" }, "missing_events" : { "type" : "boolean" }, "params" : { "items" : { "$ref" : "#/components/schemas/ScreenRecordingPageViewParameter" }, "type" : "array" }, "range_end" : { "format" : "int32", "type" : "integer" }, "range_start" : { "format" : "int32", "type" : "integer" }, "referrer" : { "type" : "string" }, "referrer_params" : { "items" : { "$ref" : "#/components/schemas/ScreenRecordingPageViewParameter" }, "type" : "array" }, "referrer_raw" : { "type" : "string" }, "screen_recording_page_view_uuid" : { "type" : "string" }, "time_on_page" : { "format" : "int32", "type" : "integer" }, "timing_dom_content_loaded" : { "description" : "Amount of time for DOMContentLoaded event to fire (milliseconds)", "format" : "int32", "type" : "integer" }, "timing_loaded" : { "description" : "Amount of time for loaded event to fire (milliseconds)", "format" : "int32", "type" : "integer" }, "truncated_events" : { "type" : "boolean" }, "ucapv" : { "type" : "string" }, "url" : { "type" : "string" } }, "type" : "object" }, "ScreenRecordingPageViewDataResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "events_json" : { "type" : "string" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ScreenRecordingPageViewEvent" : { "properties" : { "name" : { "type" : "string" }, "params" : { "items" : { "$ref" : "#/components/schemas/ScreenRecordingPageViewEventParameter" }, "type" : "array" }, "prior_page_view" : { "type" : "boolean" }, "sub_text" : { "type" : "string" }, "timestamp" : { "description" : "Timestamp of the event", "format" : "dateTime", "type" : "string" }, "ts" : { "format" : "int64", "type" : "integer" } }, "type" : "object" }, "ScreenRecordingPageViewEventParameter" : { "properties" : { "name" : { "type" : "string" }, "value" : { "$ref" : "#/components/schemas/ScreenRecordingMultifield" } }, "type" : "object" }, "ScreenRecordingPageViewParameter" : { "properties" : { "name" : { "type" : "string" }, "value" : { "type" : "string" } }, "type" : "object" }, "ScreenRecordingQueryRequest" : { "properties" : { "filter" : { "$ref" : "#/components/schemas/ScreenRecordingFilter" } }, "type" : "object" }, "ScreenRecordingQueryResponse" : { "properties" : { "checkout_only" : { "type" : "boolean" }, "error" : { "$ref" : "#/components/schemas/Error" }, "filter" : { "$ref" : "#/components/schemas/ScreenRecordingFilter" }, "filter_values" : { "$ref" : "#/components/schemas/ScreenRecordingFilterValues" }, "histogram_data" : { "items" : { "type" : "integer" }, "type" : "array" }, "histogram_interval" : { "type" : "string" }, "histogram_start_dts" : { "type" : "string" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "screen_recordings" : { "items" : { "$ref" : "#/components/schemas/ScreenRecording" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ScreenRecordingResponse" : { "properties" : { "checkout_only" : { "type" : "boolean" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "screen_recording" : { "$ref" : "#/components/schemas/ScreenRecording" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ScreenRecordingSegment" : { "properties" : { "create_dts" : { "type" : "string" }, "description" : { "type" : "string" }, "filter" : { "$ref" : "#/components/schemas/ScreenRecordingFilter" }, "histogram_data" : { "items" : { "type" : "integer" }, "type" : "array" }, "histogram_interval" : { "type" : "string" }, "histogram_start_dts" : { "type" : "string" }, "name" : { "type" : "string" }, "screen_recording_segment_oid" : { "format" : "int32", "type" : "integer" }, "session_count" : { "format" : "int32", "type" : "integer" }, "session_count_last_update_dts" : { "type" : "string" } }, "type" : "object" }, "ScreenRecordingSegmentResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "segment" : { "$ref" : "#/components/schemas/ScreenRecordingSegment" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ScreenRecordingSegmentsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "segments" : { "items" : { "$ref" : "#/components/schemas/ScreenRecordingSegment" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ScreenRecordingSettings" : { "properties" : { "cost_per_thousand" : { "description" : "Cost per one thousand sessions", "type" : "number" }, "enabled" : { "type" : "boolean" }, "retention_interval" : { "description" : "How long screen recording data is retained", "type" : "string" }, "sessions_current_billing_period" : { "format" : "int32", "type" : "integer" }, "sessions_last_billing_period" : { "format" : "int32", "type" : "integer" }, "sessions_trial_billing_period" : { "format" : "int32", "type" : "integer" }, "trial_expiration" : { "type" : "string" }, "trial_expired" : { "type" : "boolean" } }, "type" : "object" }, "ScreenRecordingSettingsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "settings" : { "$ref" : "#/components/schemas/ScreenRecordingSettings" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ScreenRecordingStoreFront" : { "properties" : { "storefront_host_name" : { "type" : "string" }, "storefront_oid" : { "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ScreenRecordingTagsRequest" : { "properties" : { "tags" : { "items" : { "type" : "string" }, "type" : "array" } }, "type" : "object" }, "ScreenRecordingTagsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "tags" : { "items" : { "type" : "string" }, "type" : "array" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ScreenRecordingUserAgent" : { "properties" : { "device" : { "$ref" : "#/components/schemas/ScreenRecordingUserAgentDevice" }, "name" : { "type" : "string" }, "original" : { "type" : "string" }, "os" : { "$ref" : "#/components/schemas/ScreenRecordingUserAgentOS" }, "version" : { "type" : "string" } }, "type" : "object" }, "ScreenRecordingUserAgentDevice" : { "properties" : { "name" : { "type" : "string" } }, "type" : "object" }, "ScreenRecordingUserAgentOS" : { "properties" : { "full" : { "type" : "string" }, "name" : { "type" : "string" }, "version" : { "type" : "string" } }, "type" : "object" }, "ScreenRecordingUserProperty" : { "properties" : { "name" : { "type" : "string" }, "value" : { "$ref" : "#/components/schemas/ScreenRecordingMultifield" } }, "type" : "object" }, "ScreenshotsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "screenshots" : { "description" : "List of screenshot urls related to the object (depends on which method was called).", "items" : { "type" : "string" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "SelfConfig" : { "properties" : { "exempt_from_colorado_retail_delivery_fee" : { "description" : "True if the Colorado Retail Delivery Fee should not be collected", "type" : "boolean" }, "exempt_from_minnesota_retail_delivery_fee" : { "description" : "True if the Minnesota Retail Delivery Fee should not be collected", "type" : "boolean" }, "tax_billing" : { "description" : "True if sales tax should be collected based on billing address instead of shipping address", "type" : "boolean" } }, "type" : "object" }, "SimpleValue" : { "properties" : { "display" : { "description" : "A friendly display of this value suitable for human reading", "type" : "string" }, "value" : { "description" : "The actual value", "type" : "string" } }, "type" : "object" }, "SingleSignOnAuthorizeRequest" : { "properties" : { "redirect_uri" : { "description" : "The URL that the customer should be redirected to after they have approved a single sign on session.", "type" : "string" }, "state" : { "description" : "An optional state variable that you provide. It will be returned to you on the redirect. You can inspect the state to validate the request is legitimate. We recommend using this field.", "type" : "string" } }, "type" : "object" }, "SingleSignOnAuthorizeResponse" : { "properties" : { "expiration_dts" : { "description" : "Expiration date/time after which the single sign-on login operation will have timed out", "format" : "dateTime", "type" : "string" }, "login_url" : { "description" : "The URL that you should redirect the customer's browser to. This URL will begin the login process.", "type" : "string" } }, "type" : "object" }, "SingleSignOnTokenRequest" : { "properties" : { "code" : { "description" : "The code received on the redirect URI after the customer approved the single sign on request.", "type" : "string" }, "grant_type" : { "description" : "Grant type. The value should be simple_key.", "type" : "string" } }, "type" : "object" }, "SingleSignOnTokenResponse" : { "properties" : { "expiration_dts" : { "description" : "Expiration date/time after which time the key is no longer valid", "format" : "dateTime", "type" : "string" }, "ip_address" : { "description" : "IP address of the user which we recommend you lock the simple key's usage to.", "type" : "string" }, "simple_key" : { "description" : "The simple key that can then be used to make SDK calls on the users behalf.", "type" : "string" } }, "type" : "object" }, "SovosConfig" : { "properties" : { "access_key" : { "description" : "Sovos access key", "type" : "string" }, "estimate_only" : { "description" : "True if this Sovos configuration is to estimate taxes only and not report placed orders to Sovos", "type" : "boolean" }, "last_test_dts" : { "description" : "Date/time of the connection test to Sovos", "format" : "dateTime", "type" : "string" }, "secret_key" : { "description" : "Sovos secret key", "type" : "string" }, "send_test_orders" : { "description" : "Send test orders through to Sovos. The default is to not transmit test orders to Sovos.", "type" : "boolean" }, "test_results" : { "description" : "Test results of the last connection test to Sovos", "type" : "string" }, "uat" : { "description" : "True if this Sovos configuration is currently undergoing user acceptance testing", "type" : "boolean" } }, "type" : "object" }, "StateProvince" : { "properties" : { "abbreviation" : { "description" : "abbreviation", "type" : "string" }, "name" : { "description" : "name", "maxLength" : 50, "type" : "string" } }, "type" : "object" }, "StepWaiting" : { "properties" : { "commseq_step_uuid" : { "type" : "string" }, "number_waiting" : { "format" : "int32", "type" : "integer" } }, "type" : "object" }, "StoreFront" : { "properties" : { "host_alias1" : { "type" : "string" }, "host_alias2" : { "type" : "string" }, "host_alias3" : { "type" : "string" }, "host_alias4" : { "type" : "string" }, "host_alias5" : { "type" : "string" }, "host_name" : { "type" : "string" }, "locked" : { "type" : "boolean" }, "merchant_id" : { "type" : "string" }, "redirect_aliases" : { "type" : "boolean" }, "storefront_oid" : { "format" : "int32", "type" : "integer" }, "unlock_password" : { "type" : "string" } }, "type" : "object" }, "StoreFrontPageContentAttribute" : { "properties" : { "name" : { "description" : "Attribute name", "maxLength" : 100000, "type" : "string" }, "translated_text_instance_oid" : { "description" : "Attribute translated text instance identifier", "format" : "int32", "type" : "integer" }, "type" : { "description" : "Attribute type", "type" : "string" }, "value" : { "description" : "Attribute value", "maxLength" : 100000, "type" : "string" } }, "type" : "object" }, "StoreFrontsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "storeFronts" : { "items" : { "$ref" : "#/components/schemas/StoreFront" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "TaxCity" : { "properties" : { "accounting_code" : { "description" : "Accounting code for programs such as QuickBooks", "type" : "string" }, "city" : { "description" : "City", "type" : "string" }, "city_oid" : { "description" : "Tax record object identifier used internally by database", "format" : "int32", "type" : "integer" }, "county_oid" : { "description" : "Tax record object identifier used internally by database", "format" : "int32", "type" : "integer" }, "dont_collect_city" : { "description" : "Flag instructing engine to not collect city tax for this city", "type" : "boolean" }, "dont_collect_postal_code" : { "description" : "Flag instructing engine to not collect postal code tax for this city", "type" : "boolean" }, "postal_codes" : { "description" : "Postal Codes within this city", "items" : { "$ref" : "#/components/schemas/TaxPostalCode" }, "type" : "array" }, "tax_rate" : { "description" : "Tax Rate", "type" : "number" }, "tax_rate_formatted" : { "description" : "Tax rate formatted", "type" : "string" } }, "type" : "object" }, "TaxCountry" : { "properties" : { "accounting_code" : { "description" : "Accounting code for programs such as QuickBooks", "type" : "string" }, "country_code" : { "description" : "Country code (2 characters", "type" : "string" }, "country_oid" : { "description" : "Tax record object identifier used internally by database", "format" : "int32", "type" : "integer" }, "states" : { "description" : "States (or regions or territories) within this country", "items" : { "$ref" : "#/components/schemas/TaxState" }, "type" : "array" }, "tax_gift_charge" : { "description" : "True if taxation within this jurisdiction should charge tax on gift charge", "type" : "boolean" }, "tax_gift_wrap" : { "description" : "True if taxation within this jurisdiction should charge tax on gift wrap", "type" : "boolean" }, "tax_rate" : { "description" : "Tax Rate", "type" : "number" }, "tax_rate_formatted" : { "description" : "Tax rate formatted", "type" : "string" }, "tax_shipping" : { "description" : "True if taxation within this jurisdiction should charge tax on shipping", "type" : "boolean" } }, "type" : "object" }, "TaxCountryCode" : { "properties" : { "accounting_code" : { "description" : "Accounting code for programs such as QuickBooks", "type" : "string" }, "country_code" : { "description" : "Country code (2 characters", "type" : "string" }, "country_name" : { "description" : "Country name", "type" : "string" }, "tax_rate" : { "description" : "Tax Rate", "type" : "number" }, "tax_rate_formatted" : { "description" : "Tax rate formatted", "type" : "string" } }, "type" : "object" }, "TaxCounty" : { "properties" : { "accounting_code" : { "description" : "Accounting code for programs such as QuickBooks", "type" : "string" }, "cities" : { "description" : "Cities within this city", "items" : { "$ref" : "#/components/schemas/TaxCity" }, "type" : "array" }, "county" : { "description" : "County", "type" : "string" }, "county_oid" : { "description" : "Tax record object identifier used internally by database", "format" : "int32", "type" : "integer" }, "dont_collect_city" : { "description" : "Flag instructing engine to not collect city tax for this county", "type" : "boolean" }, "dont_collect_county" : { "description" : "Flag instructing engine to not collect county tax for this county", "type" : "boolean" }, "dont_collect_postal_code" : { "description" : "Flag instructing engine to not collect postal code tax for this county", "type" : "boolean" }, "state_oid" : { "description" : "Tax record object identifier used internally by database", "format" : "int32", "type" : "integer" }, "tax_rate" : { "description" : "Tax Rate", "type" : "number" }, "tax_rate_formatted" : { "description" : "Tax rate formatted", "type" : "string" } }, "type" : "object" }, "TaxJarConfig" : { "properties" : { "active" : { "description" : "True if TaxJar is active for this merchant", "type" : "boolean" }, "api_key" : { "description" : "TaxJar API key", "type" : "string" }, "estimate_only" : { "description" : "True if this TaxJar configuration is to estimate taxes only and not report placed orders to TaxJar", "type" : "boolean" }, "send_outside_nexus" : { "description" : "Send orders outside your nexus TaxJar. The default is to not transmit outside orders to TaxJar to reduce API calls. However, this will prevent TaxJar from dynamically creating new Nexus when thresholds are exceeded for a state.", "type" : "boolean" }, "send_test_orders" : { "description" : "Send test orders through to TaxJar. The default is to not transmit test orders to TaxJar.", "type" : "boolean" }, "skip_channel_orders" : { "description" : "Do not send channel partner orders to TaxJar. Set this to true if your channel partner reports tax on their own.", "type" : "boolean" }, "use_distribution_center_from" : { "description" : "Use distribution center from address", "type" : "boolean" } }, "type" : "object" }, "TaxPostalCode" : { "properties" : { "accounting_code" : { "description" : "Accounting code for programs such as QuickBooks", "type" : "string" }, "city_oid" : { "description" : "Tax record object identifier used internally by database", "format" : "int32", "type" : "integer" }, "dont_collect_postal_code" : { "description" : "Flag instructing engine to not collect postal code tax for this postal code", "type" : "boolean" }, "postal_code" : { "description" : "Postal Code (5 digits)", "type" : "string" }, "postal_code_oid" : { "description" : "Tax record object identifier used internally by database", "format" : "int32", "type" : "integer" }, "tax_rate" : { "description" : "Tax Rate", "type" : "number" }, "tax_rate_formatted" : { "description" : "Tax rate formatted", "type" : "string" } }, "type" : "object" }, "TaxProviderActivateResult" : { "properties" : { "details" : { "type" : "string" }, "success" : { "description" : "True if the connection was successful", "type" : "boolean" } }, "type" : "object" }, "TaxProviderAvalara" : { "properties" : { "configuration" : { "$ref" : "#/components/schemas/AvalaraConfig" }, "description" : { "description" : "Description", "type" : "string" }, "selected" : { "description" : "Selected", "type" : "boolean" }, "title" : { "description" : "Title", "type" : "string" } }, "type" : "object" }, "TaxProviderAvalaraCompaniesResult" : { "properties" : { "companies" : { "description" : "Tax companies configured by the merchant", "items" : { "$ref" : "#/components/schemas/TaxProviderAvalaraCompany" }, "type" : "array" } }, "type" : "object" }, "TaxProviderAvalaraCompany" : { "properties" : { "company_code" : { "description" : "Company code", "type" : "string" }, "company_name" : { "description" : "Company name", "type" : "string" }, "description" : { "description" : "Description", "type" : "string" }, "selected" : { "description" : "Selected", "type" : "boolean" }, "title" : { "description" : "Title", "type" : "string" } }, "type" : "object" }, "TaxProviderSelf" : { "properties" : { "configuration" : { "$ref" : "#/components/schemas/SelfConfig" }, "countries" : { "description" : "Countries that collect sales tax", "items" : { "$ref" : "#/components/schemas/TaxCountry" }, "type" : "array" }, "description" : { "description" : "Description", "type" : "string" }, "selected" : { "description" : "Selected", "type" : "boolean" }, "title" : { "description" : "Title", "type" : "string" } }, "type" : "object" }, "TaxProviderSelfCountriesResponse" : { "properties" : { "countries" : { "description" : "countries", "items" : { "$ref" : "#/components/schemas/TaxCountryCode" }, "type" : "array" } }, "type" : "object" }, "TaxProviderSelfRegionsResponse" : { "properties" : { "regions" : { "description" : "regions", "items" : { "$ref" : "#/components/schemas/TaxStateCode" }, "type" : "array" } }, "type" : "object" }, "TaxProviderSovos" : { "properties" : { "configuration" : { "$ref" : "#/components/schemas/SovosConfig" }, "description" : { "description" : "Description", "type" : "string" }, "selected" : { "description" : "Selected", "type" : "boolean" }, "title" : { "description" : "Title", "type" : "string" } }, "type" : "object" }, "TaxProvidersResponse" : { "properties" : { "avalara" : { "$ref" : "#/components/schemas/TaxProviderAvalara" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "self" : { "$ref" : "#/components/schemas/TaxProviderSelf" }, "sovos" : { "$ref" : "#/components/schemas/TaxProviderSovos" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "taxjar" : { "$ref" : "#/components/schemas/TaxProviderTaxJar" }, "ultracart" : { "$ref" : "#/components/schemas/TaxProviderUltraCart" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "TaxProviderTaxJar" : { "properties" : { "configuration" : { "$ref" : "#/components/schemas/TaxJarConfig" }, "description" : { "description" : "Description", "type" : "string" }, "selected" : { "description" : "Selected", "type" : "boolean" }, "title" : { "description" : "Title", "type" : "string" } }, "type" : "object" }, "TaxProviderTestResult" : { "properties" : { "details" : { "type" : "string" }, "success" : { "description" : "True if the connection was successful", "type" : "boolean" } }, "type" : "object" }, "TaxProviderUltraCart" : { "properties" : { "configuration" : { "$ref" : "#/components/schemas/UltraCartConfig" }, "description" : { "description" : "Description", "type" : "string" }, "selected" : { "description" : "Selected", "type" : "boolean" }, "states" : { "description" : "States in the union showing their management status", "items" : { "$ref" : "#/components/schemas/TaxProviderUltraCartState" }, "type" : "array" }, "title" : { "description" : "Title", "type" : "string" } }, "type" : "object" }, "TaxProviderUltraCartState" : { "properties" : { "enabled" : { "description" : "True if this state taxes are managed by UltraCart", "type" : "boolean" }, "exempt_digital_items" : { "description" : "True if digital items are exempt from sales tax in this state.", "type" : "boolean" }, "exempt_physical_items" : { "description" : "True if physical items are exempt from sales tax in this state.", "type" : "boolean" }, "exempt_service_items" : { "description" : "True if service items are exempt from sales tax in this state.", "type" : "boolean" }, "state_code" : { "description" : "State Code (2 digits)", "type" : "string" }, "state_name" : { "description" : "Fully spelled out state name", "type" : "string" }, "tax_gift_charge" : { "description" : "True if gift charges should be taxed in this state.", "type" : "boolean" }, "tax_gift_wrap" : { "description" : "True if gift wrap should be taxed in this state.", "type" : "boolean" }, "tax_rate_formatted" : { "description" : "State tax rate formatted for display", "type" : "string" }, "tax_shipping" : { "description" : "True if shipping should be taxed in this state.", "type" : "boolean" } }, "type" : "object" }, "TaxState" : { "properties" : { "accounting_code" : { "description" : "Accounting code for programs such as QuickBooks", "type" : "string" }, "counties" : { "description" : "Counties within this state", "items" : { "$ref" : "#/components/schemas/TaxCounty" }, "type" : "array" }, "country_oid" : { "description" : "Tax record object identifier used internally by database", "format" : "int32", "type" : "integer" }, "dont_collect_city" : { "description" : "Flag instructing engine to not collect city tax for this state", "type" : "boolean" }, "dont_collect_county" : { "description" : "Flag instructing engine to not collect county tax for this state", "type" : "boolean" }, "dont_collect_postal_code" : { "description" : "Flag instructing engine to not collect postal code tax for this state", "type" : "boolean" }, "dont_collect_state" : { "description" : "Flag instructing engine to not collect state tax for this state", "type" : "boolean" }, "exempt_digital_items" : { "description" : "True if digital items are exempt from sales tax in this state.", "type" : "boolean" }, "exempt_physical_items" : { "description" : "True if physical items are exempt from sales tax in this state.", "type" : "boolean" }, "exempt_service_items" : { "description" : "True if service items are exempt from sales tax in this state.", "type" : "boolean" }, "state_code" : { "description" : "State code", "type" : "string" }, "state_oid" : { "description" : "Tax record object identifier used internally by database", "format" : "int32", "type" : "integer" }, "tax_gift_charge" : { "description" : "True if taxation within this jurisdiction should charge tax on gift charge", "type" : "boolean" }, "tax_gift_wrap" : { "description" : "True if taxation within this jurisdiction should charge tax on gift wrap", "type" : "boolean" }, "tax_rate" : { "description" : "Tax Rate", "type" : "number" }, "tax_rate_formatted" : { "description" : "Tax rate formatted", "type" : "string" }, "tax_shipping" : { "description" : "True if taxation within this jurisdiction should charge tax on shipping", "type" : "boolean" }, "use_ultracart_managed_rates" : { "description" : "If true, use UltraCart managed rates for this state", "type" : "boolean" } }, "type" : "object" }, "TaxStateCode" : { "properties" : { "accounting_code" : { "description" : "Accounting code for programs such as QuickBooks", "type" : "string" }, "state_code" : { "description" : "State code (2 characters", "type" : "string" }, "state_name" : { "description" : "State name", "type" : "string" }, "tax_rate" : { "description" : "Tax Rate", "type" : "number" }, "tax_rate_formatted" : { "description" : "Tax rate formatted", "type" : "string" } }, "type" : "object" }, "TempMultimedia" : { "properties" : { "filename" : { "description" : "Filename", "maxLength" : 75, "type" : "string" }, "height" : { "description" : "Height", "format" : "int32", "type" : "integer" }, "multimedia_type" : { "description" : "Multimedia type", "enum" : [ "Image", "PDF", "Text", "Video" ], "type" : "string" }, "size" : { "description" : "Size", "format" : "int64", "type" : "integer" }, "temp_multimedia_oid" : { "description" : "Temporary multimedia object identifier", "format" : "int32", "type" : "integer" }, "url" : { "description" : "URL", "type" : "string" }, "width" : { "description" : "Width", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "TempMultimediaResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "temp_multimedia" : { "$ref" : "#/components/schemas/TempMultimedia" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "ThumbnailParametersRequest" : { "properties" : { "height" : { "format" : "int32", "type" : "integer" }, "pngFormat" : { "type" : "boolean" }, "squareThumbnail" : { "type" : "boolean" }, "webp" : { "type" : "boolean" }, "width" : { "format" : "int32", "type" : "integer" } }, "type" : "object" }, "ThumbnailParametersResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "thumbnail_url_suffix" : { "description" : "Suffix to append to the larger image URL to obtain the thumbnail", "type" : "string" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "TimelineSummary" : { "properties" : { "available_seconds" : { "description" : "Seconds the agent was Available (incl. Busy)", "format" : "int64", "type" : "integer" }, "avg_handle_time_seconds" : { "description" : "Average handle time across calls and chats, in seconds", "format" : "int64", "type" : "integer" }, "calls_missed" : { "description" : "Calls the agent missed (inbound, disposition=missed)", "format" : "int32", "type" : "integer" }, "calls_taken" : { "description" : "Calls the agent took", "format" : "int32", "type" : "integer" }, "chats_handled" : { "description" : "Chats the agent handled", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "TransactionEmail" : { "properties" : { "content" : { "description" : "Actual template contents", "type" : "string" }, "esp_domain_uuid" : { "description" : "The uuid of the sending domain", "type" : "string" }, "esp_friendly_name" : { "description" : "Friendly from that will appear in customer email clients.", "type" : "string" }, "esp_user" : { "description" : "The username of the sending email. This is not the full email. Only the username which is everything before the @ sign.", "type" : "string" }, "file_exists" : { "description" : "An internal identifier used to aid in retrieving templates from the filesystem.", "type" : "boolean" }, "file_name" : { "description" : "File name", "type" : "string" }, "group" : { "description" : "Group", "type" : "string" }, "handlebar_variables" : { "description" : "Handlebar Variables available for email template", "items" : { "type" : "string" }, "type" : "array" }, "invalid" : { "description" : "Invalid will be true if the template cannot compile", "type" : "boolean" }, "last_modified" : { "description" : "Last modified timestamp", "format" : "dateTime", "type" : "string" }, "library_item_oid" : { "description" : "If this item was ever added to the Code Library, this is the oid for that library item, or 0 if never added before. This value is used to determine if a library item should be inserted or updated.", "format" : "int32", "type" : "integer" }, "options" : { "description" : "Options that help govern how and when this template is used", "items" : { "$ref" : "#/components/schemas/TransactionEmailOption" }, "type" : "array" }, "path" : { "description" : "directory path where template is stored in file system", "type" : "string" }, "size" : { "description" : "Size of file in friendly description", "type" : "string" }, "store_front_fs_directory_oid" : { "description" : "Internal identifier used to store and retrieve template from filesystem", "format" : "int32", "type" : "integer" }, "store_front_fs_file_oid" : { "description" : "Internal identifier used to store and retrieve template from filesystem", "format" : "int32", "type" : "integer" }, "subject" : { "description" : "Subject", "type" : "string" }, "syntax_errors" : { "description" : "Any syntax errors contained within the tempalate", "type" : "string" }, "template_path_relative_path" : { "description" : "Internal value used to locate the template in the filesystem", "type" : "string" }, "theme_relative_path" : { "description" : "Theme relative path in the filesystem.", "type" : "string" } }, "type" : "object" }, "TransactionEmailListResponse" : { "properties" : { "email_names" : { "items" : { "type" : "string" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "TransactionEmailOption" : { "properties" : { "description" : { "type" : "string" }, "merchantEmailDeliveryOptionOid" : { "format" : "int32", "type" : "integer" }, "merchantId" : { "type" : "string" }, "name" : { "type" : "string" }, "selected" : { "type" : "boolean" }, "storeFrontOid" : { "format" : "int32", "type" : "integer" }, "templateDisplay" : { "type" : "string" }, "templateType" : { "type" : "string" } }, "type" : "object" }, "TransactionEmailResponse" : { "properties" : { "email" : { "$ref" : "#/components/schemas/TransactionEmail" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "Twilio" : { "properties" : { "account_sid" : { "type" : "string" }, "ai_twiml_app_sid" : { "type" : "string" }, "api_key_id" : { "type" : "string" }, "api_key_name" : { "type" : "string" }, "auth_token" : { "type" : "string" }, "esp_twilio_uuid" : { "type" : "string" }, "inbound_twiml_app_sid" : { "type" : "string" }, "outbound_twiml_app_sid" : { "type" : "string" }, "phone_numbers" : { "items" : { "type" : "string" }, "type" : "array" }, "twilio_workspace_sid" : { "type" : "string" } }, "type" : "object" }, "TwilioResponse" : { "properties" : { "diagnostics" : { "type" : "string" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "twilio" : { "$ref" : "#/components/schemas/Twilio" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "TwiliosResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "twilios" : { "items" : { "$ref" : "#/components/schemas/Twilio" }, "type" : "array" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "UltraCartConfig" : { "properties" : { "exempt_from_colorado_retail_delivery_fee" : { "description" : "True if the Colorado Retail Delivery Fee should not be collected", "type" : "boolean" }, "exempt_from_minnesota_retail_delivery_fee" : { "description" : "True if the Minnesota Retail Delivery Fee should not be collected", "type" : "boolean" }, "tax_billing" : { "description" : "True if sales tax should be collected based on billing address instead of shipping address", "type" : "boolean" } }, "type" : "object" }, "UploadCouponCodesRequest" : { "properties" : { "coupon_codes" : { "description" : "Coupon codes", "items" : { "type" : "string" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "UploadCouponCodesResponse" : { "properties" : { "duplicate_codes" : { "description" : "Duplicate codes", "items" : { "type" : "string" }, "type" : "array" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "rejected_codes" : { "description" : "Rejected codes", "items" : { "type" : "string" }, "type" : "array" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "uploaded_codes" : { "description" : "Uploaded codes", "items" : { "type" : "string" }, "type" : "array" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "User" : { "properties" : { "api_ip_address_masks" : { "description" : "A list of IP addresses whitelisted for any user with API Access permission. Without this list, each ip address must be authenticated by a user, which can be a pain for some servers.", "items" : { "type" : "string" }, "type" : "array" }, "change_ftp_password_to" : { "description" : "Supply a new FTP password using this field. Password are stored using one-way encryption, so they are never available anywhere in the system. The FTP password cannot be the same as the normal password.", "type" : "string" }, "change_password_to" : { "description" : "Supply a new password using this field. Password are stored using one-way encryption, so they are never available anywhere in the system.", "type" : "string" }, "email" : { "description" : "Email address of user", "maxLength" : 150, "type" : "string" }, "full_name" : { "description" : "Full name of user. This is used solely for human assistance and so the UltraCart staff knows who they are calling when there is a problem.", "type" : "string" }, "groups" : { "description" : "A list of groups for this merchant and whether or not this user is a member of those groups.", "items" : { "$ref" : "#/components/schemas/UserGroupMembership" }, "type" : "array" }, "linked_accounts" : { "description" : "A list of linked accounts and whether or not this user is mirrored to any of those accounts.", "items" : { "$ref" : "#/components/schemas/LinkedAccount" }, "type" : "array" }, "login" : { "description" : "User name of user. Must be unique across a merchant account.", "type" : "string" }, "login_histories" : { "description" : "A list of user logins over the past 90 days", "items" : { "$ref" : "#/components/schemas/UserLogin" }, "type" : "array" }, "notifications" : { "description" : "A list of notifications the user receives.", "items" : { "$ref" : "#/components/schemas/Notification" }, "type" : "array" }, "otp_serial_number" : { "description" : "OTP Serial Number such as Google Authenticator or Crypto Card.", "type" : "string" }, "permissions" : { "description" : "A list of permissions the user enjoys for accessing the backend of UltraCart.", "items" : { "$ref" : "#/components/schemas/Permission" }, "type" : "array" }, "phone" : { "description" : "Phone number of user. Please supply a valid phone number. When something breaks on your account, we need to be able to reach you.", "type" : "string" }, "user_id" : { "description" : "User id is a unique identifier for this user", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "UserGroupMembership" : { "properties" : { "group_oid" : { "description" : "The unique object identifier (oid for short) for this group", "format" : "int32", "type" : "integer" }, "member" : { "description" : "True if this user is a member of the group.", "type" : "boolean" }, "name" : { "description" : "The name of this group.", "type" : "string" } }, "type" : "object" }, "UserLogin" : { "properties" : { "ip_address" : { "description" : "IP Address", "type" : "string" }, "login" : { "description" : "login", "type" : "string" }, "login_dts" : { "description" : "Login date/time", "format" : "dateTime", "type" : "string" }, "user_agent" : { "description" : "User Agent", "type" : "string" } }, "type" : "object" }, "UserLoginsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "logins" : { "description" : "Logins", "items" : { "$ref" : "#/components/schemas/UserLogin" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "UserResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "user" : { "$ref" : "#/components/schemas/User" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "UsersResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "users" : { "items" : { "$ref" : "#/components/schemas/User" }, "type" : "array" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "VerificationRecord" : { "properties" : { "name" : { "type" : "string" }, "type" : { "type" : "string" }, "value" : { "type" : "string" } }, "type" : "object" }, "Warning" : { "properties" : { "more_info" : { "description" : "Additional information often a link to additional documentation", "type" : "string" }, "warning_code" : { "description" : "A stable machine-readable code identifying the warning. See API docs for known values.", "type" : "string" }, "warning_message" : { "description" : "A technical message meant to be read by a developer", "type" : "string" } }, "type" : "object" }, "Webhook" : { "properties" : { "api_user_oid" : { "description" : "Populated if webhook associated with an API user", "format" : "int32", "type" : "integer" }, "api_version" : { "description" : "Version of the API objects that are sent in notifications", "enum" : [ "2017-03-01" ], "type" : "string" }, "application_profile" : { "$ref" : "#/components/schemas/ApiUserApplicationProfile" }, "authentication_type" : { "description" : "The type of authentication this webhook will use when communicating with your server", "enum" : [ "none", "basic", "api user", "aws iam" ], "type" : "string" }, "basic_password" : { "description" : "Basic authentication password", "type" : "string" }, "basic_username" : { "description" : "Basic authentication user name", "type" : "string" }, "compress_events" : { "description" : "Compress events with GZIP then base 64 encode them as a string", "type" : "boolean" }, "consecutive_failures" : { "description" : "The number of consecutive failures that have occurred trying to deliver notifications to the target server", "format" : "int32", "type" : "integer" }, "disabled" : { "description" : "True if the webhook has been disabled", "type" : "boolean" }, "event_categories" : { "description" : "The categories of events. Individual events and subscriptions are handled in the child objects. _placeholders parameter effects the population of this on a retrieval.", "items" : { "$ref" : "#/components/schemas/WebhookEventCategory" }, "type" : "array" }, "iam_access_key" : { "description" : "IAM Access Key for AWS SQS Delivery", "type" : "string" }, "iam_secret_key" : { "description" : "IAM Secret Key for AWS SQS Delivery", "type" : "string" }, "maximum_events" : { "description" : "The maximum number of events in the payload that UltraCart will deliver", "format" : "int32", "type" : "integer" }, "maximum_size" : { "description" : "The maximum size of the payload that UltraCart will deliver", "format" : "int32", "type" : "integer" }, "merchant_id" : { "description" : "The UltraCart merchant ID that owns this webhook", "type" : "string" }, "next_retry_after" : { "description" : "The next time UltraCart will attempt delivery if failures have been occurring", "format" : "dateTime", "type" : "string" }, "pending" : { "description" : "The number of pending events for this webhook", "format" : "int32", "type" : "integer" }, "webhook_oid" : { "description" : "The object identifier for this webhook", "format" : "int32", "type" : "integer" }, "webhook_url" : { "description" : "The URL to deliver events to. Must be HTTPS for customer related information.", "type" : "string" } }, "type" : "object" }, "WebhookEventCategoriesResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "event_categories" : { "items" : { "$ref" : "#/components/schemas/WebhookEventCategory" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "WebhookEventCategory" : { "properties" : { "any_subscribed" : { "description" : "True if any events are subscribed to.", "type" : "boolean" }, "available_expansions" : { "description" : "Array of available expansion constants", "items" : { "type" : "string" }, "type" : "array" }, "event_category" : { "description" : "Name of the event category", "type" : "string" }, "events" : { "description" : "The events within the category. Individual subscription flags contained within the child object.", "items" : { "$ref" : "#/components/schemas/WebhookEventSubscription" }, "type" : "array" }, "subscribed" : { "description" : "True if all the events within this category are subscribed. This is a convenience flag to make user interfaces easier.", "type" : "boolean" } }, "type" : "object" }, "WebhookEventSubscription" : { "properties" : { "comments" : { "description" : "Comment about the event to provide further clarification to the end user", "type" : "string" }, "deprecated_flag" : { "description" : "True if the event is deprecated. See the API change log for details on when it will be discontinued.", "type" : "boolean" }, "discontinued_flag" : { "description" : "True if the event is discontinued. See the API change log for details on migration details.", "type" : "boolean" }, "event_description" : { "description" : "Description of the event", "type" : "string" }, "event_name" : { "description" : "Event name", "type" : "string" }, "event_ruler" : { "description" : "Optional - Event ruler expression to filter events to. Only events that match this Ruler expression will be transmitted to the webhook.", "type" : "string" }, "expansion" : { "description" : "The expand string for the notification object. See the individual resource _expand documentation for valid values.", "type" : "string" }, "subscribed" : { "description" : "True if this is event is subscribed to", "type" : "boolean" }, "supports_reflow" : { "description" : "True if the event can be triggered to reflow existing records", "type" : "boolean" }, "webhook_event_oid" : { "description" : "The webhook event object identifier", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "WebhookLog" : { "properties" : { "delivery_dts" : { "description" : "Date/time of delivery", "format" : "dateTime", "type" : "string" }, "duration" : { "description" : "Number of milliseconds to process the notification", "format" : "int32", "type" : "integer" }, "queue_delay" : { "description" : "Number of milliseconds of delay caused by queuing", "format" : "int64", "type" : "integer" }, "request" : { "description" : "Request payload (first 100,000 characters)", "type" : "string" }, "request_headers" : { "description" : "Request headers sent to the server", "items" : { "$ref" : "#/components/schemas/HTTPHeader" }, "type" : "array" }, "request_id" : { "description" : "Request id is a unique string that you can look up in the logs", "type" : "string" }, "response" : { "description" : "Response payload (first 100,000 characters)", "type" : "string" }, "response_headers" : { "description" : "Response headers received from the server", "items" : { "$ref" : "#/components/schemas/HTTPHeader" }, "type" : "array" }, "status_code" : { "description" : "HTTP status code received from the server", "format" : "int32", "type" : "integer" }, "success" : { "description" : "True if the delivery was successful", "type" : "boolean" }, "uri" : { "description" : "URI of the webhook delivered to", "type" : "string" }, "webhook_oid" : { "description" : "webhook oid", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "WebhookLogResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" }, "webhook_log" : { "$ref" : "#/components/schemas/WebhookLog" } }, "type" : "object" }, "WebhookLogSummariesResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" }, "webhook_log_summaries" : { "description" : "Webhook log summaries", "items" : { "$ref" : "#/components/schemas/WebhookLogSummary" }, "type" : "array" } }, "type" : "object" }, "WebhookLogSummary" : { "properties" : { "delivery_dts" : { "description" : "Date/time of the delivery", "format" : "dateTime", "type" : "string" }, "request_id" : { "description" : "Request id", "type" : "string" }, "success" : { "description" : "True if the notification was successful", "type" : "boolean" } }, "type" : "object" }, "WebhookReflow" : { "properties" : { "event_name" : { "type" : "string" }, "queued" : { "type" : "boolean" } }, "type" : "object" }, "WebhookReflowResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "reflow" : { "$ref" : "#/components/schemas/WebhookReflow" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "WebhookResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" }, "webhook" : { "$ref" : "#/components/schemas/Webhook" } }, "type" : "object" }, "WebhooksResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" }, "webhooks" : { "items" : { "$ref" : "#/components/schemas/Webhook" }, "type" : "array" } }, "type" : "object" }, "Weight" : { "properties" : { "uom" : { "description" : "Unit of measure", "enum" : [ "KG", "G", "LB", "OZ" ], "type" : "string" }, "value" : { "description" : "Weight", "type" : "number" } }, "type" : "object" }, "WorkflowAgentAuth" : { "properties" : { "jwt" : { "type" : "string" }, "merchant_id" : { "type" : "string" }, "websocket_url" : { "type" : "string" } }, "type" : "object" }, "WorkflowAgentAuthResponse" : { "properties" : { "agent_auth" : { "$ref" : "#/components/schemas/WorkflowAgentAuth" }, "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "WorkflowAttachment" : { "properties" : { "download_key" : { "description" : "Temporary download URL", "type" : "string" }, "file_name" : { "description" : "File name", "type" : "string" }, "file_uuid" : { "description" : "File UUID", "type" : "string" }, "mime_type" : { "description" : "Mime Type", "type" : "string" }, "upload_key" : { "description" : "Temporary upload key", "type" : "string" } }, "type" : "object" }, "WorkflowAttachmentUploadUrl" : { "properties" : { "key" : { "type" : "string" }, "url" : { "type" : "string" } }, "type" : "object" }, "WorkflowAttachmentUploadUrlResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" }, "workflow_attachment_upload_url" : { "$ref" : "#/components/schemas/WorkflowAttachmentUploadUrl" } }, "type" : "object" }, "WorkflowGroup" : { "properties" : { "group" : { "description" : "The group", "type" : "string" }, "group_id" : { "description" : "Group ID", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "WorkflowGroupsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "groups" : { "description" : "groups", "items" : { "$ref" : "#/components/schemas/WorkflowGroup" }, "type" : "array" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "WorkflowNote" : { "properties" : { "attachments" : { "description" : "Attachments to the Workflow Task", "items" : { "$ref" : "#/components/schemas/WorkflowAttachment" }, "type" : "array" }, "edit_dts" : { "description" : "Date/time that the note was edited", "format" : "dateTime", "type" : "string" }, "note" : { "description" : "Note", "type" : "string" }, "note_dts" : { "description" : "Date/time that the note was written", "format" : "dateTime", "type" : "string" }, "original_note" : { "description" : "Note originally written before any edits", "type" : "string" }, "user" : { "$ref" : "#/components/schemas/WorkflowUser" } }, "type" : "object" }, "WorkflowTask" : { "properties" : { "assigned_to_group" : { "description" : "Assigned to group", "type" : "string" }, "assigned_to_group_id" : { "description" : "Assigned to group ID", "format" : "int32", "type" : "integer" }, "assigned_to_user" : { "description" : "Assigned to user", "type" : "string" }, "assigned_to_user_id" : { "description" : "Assigned to user ID", "format" : "int32", "type" : "integer" }, "assigned_to_user_or_group" : { "description" : "Assigned to user or group (used for sorting)", "type" : "string" }, "attachments" : { "description" : "Attachments to the Workflow Task", "items" : { "$ref" : "#/components/schemas/WorkflowAttachment" }, "type" : "array" }, "created_by" : { "$ref" : "#/components/schemas/WorkflowUser" }, "created_dts" : { "description" : "Date/time that the workflow task was created", "format" : "dateTime", "type" : "string" }, "delay_until_dts" : { "description" : "Date/time that the workflow task should delay until", "format" : "dateTime", "type" : "string" }, "dependant_workflow_task_uuid" : { "description" : "Dependant Workflow Task UUID (must be completed before this task can be completed)", "type" : "string" }, "due_dts" : { "description" : "Date/time that the workflow task is due", "format" : "dateTime", "type" : "string" }, "expiration_dts" : { "description" : "Date/time that the workflow task will expire and be closed. This is set by system generated tasks.", "format" : "dateTime", "type" : "string" }, "global_task_number" : { "description" : "Global task number", "format" : "int32", "type" : "integer" }, "histories" : { "description" : "Array of history records for the task", "items" : { "$ref" : "#/components/schemas/WorkflowTaskHistory" }, "type" : "array" }, "last_update_dts" : { "description" : "Date/time that the workflow task was last updated", "format" : "dateTime", "type" : "string" }, "merchant_id" : { "description" : "Merchant ID", "type" : "string" }, "notes" : { "description" : "Notes on the Workflow Task", "items" : { "$ref" : "#/components/schemas/WorkflowNote" }, "type" : "array" }, "object_email" : { "description" : "Object is associated with customer email", "type" : "string" }, "object_id" : { "description" : "Object ID", "type" : "string" }, "object_task_number" : { "description" : "Object specific task number", "format" : "int32", "type" : "integer" }, "object_type" : { "description" : "Object Type", "enum" : [ "order", "auto order", "item", "customer profile", "storefront" ], "type" : "string" }, "object_url" : { "description" : "Object URL", "type" : "string" }, "priority" : { "description" : "Priority", "enum" : [ "1 - low", "2 - medium", "3 - high", "4 - critical" ], "type" : "string" }, "properties" : { "description" : "Properties", "items" : { "$ref" : "#/components/schemas/Property" }, "type" : "array" }, "related_workflow_task_uuid" : { "description" : "Related Workflow Task UUID", "type" : "string" }, "status" : { "description" : "Status of the workflow task", "enum" : [ "open", "closed", "delayed", "awaiting customer feedback", "closed - system", "closed - customer", "closed - expiration" ], "type" : "string" }, "system_task_type" : { "description" : "Constant for the type of system generated task", "enum" : [ "order_accounts_receivable", "order_fraud_review", "auto_order_card_update_issue", "auto_order_canceled_payment", "item_low_stock", "item_out_of_stock" ], "type" : "string" }, "tags" : { "description" : "Tags", "items" : { "type" : "string" }, "type" : "array" }, "task_context" : { "description" : "User friendly string of the task context", "type" : "string" }, "task_details" : { "description" : "Task Details", "type" : "string" }, "task_name" : { "description" : "Task Name", "type" : "string" }, "workflow_task_uuid" : { "description" : "Workflow Task UUID", "type" : "string" } }, "type" : "object" }, "WorkflowTaskHistory" : { "properties" : { "activity_dts" : { "description" : "Date/time that the workflow task history record was created", "format" : "dateTime", "type" : "string" }, "description" : { "description" : "Description of the activity", "type" : "string" }, "ip_address" : { "description" : "IP Address that originated the activity", "type" : "string" }, "user" : { "$ref" : "#/components/schemas/WorkflowUser" } }, "type" : "object" }, "WorkflowTaskOpenCountResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "open_count" : { "description" : "Open Task Count", "format" : "int32", "type" : "integer" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "WorkflowTaskResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "task" : { "$ref" : "#/components/schemas/WorkflowTask" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "WorkflowTasksRequest" : { "properties" : { "assigned_to_group" : { "description" : "Assigned to group", "type" : "string" }, "assigned_to_group_id" : { "description" : "Assigned to group ID", "format" : "int32", "type" : "integer" }, "assigned_to_me" : { "description" : "Tasks are assigned to me either by direct user id or a group that the user is a member of", "type" : "boolean" }, "assigned_to_user" : { "description" : "Assigned to user", "type" : "string" }, "assigned_to_user_id" : { "description" : "Assigned to user ID", "format" : "int32", "type" : "integer" }, "created_by" : { "$ref" : "#/components/schemas/WorkflowUser" }, "created_dts_begin" : { "description" : "Date/time that the workflow task was created", "format" : "dateTime", "type" : "string" }, "created_dts_end" : { "description" : "Date/time that the workflow task was created", "format" : "dateTime", "type" : "string" }, "delay_until_dts_begin" : { "description" : "Date/time that the workflow task should delay until", "format" : "dateTime", "type" : "string" }, "delay_until_dts_end" : { "description" : "Date/time that the workflow task should delay until", "format" : "dateTime", "type" : "string" }, "due_dts_begin" : { "description" : "Date/time that the workflow task is due", "format" : "dateTime", "type" : "string" }, "due_dts_end" : { "description" : "Date/time that the workflow task is due", "format" : "dateTime", "type" : "string" }, "last_update_dts_begin" : { "description" : "Date/time that the workflow task was last updated", "format" : "dateTime", "type" : "string" }, "last_update_dts_end" : { "description" : "Date/time that the workflow task was last updated", "format" : "dateTime", "type" : "string" }, "object_email" : { "description" : "Object is associated with customer email", "type" : "string" }, "object_type" : { "description" : "Object Type", "enum" : [ "order", "auto order", "item", "customer profile" ], "type" : "string" }, "priority" : { "description" : "Priority", "enum" : [ "1 - low", "2 - medium", "3 - high", "4 - critical" ], "type" : "string" }, "status" : { "description" : "Status of the workflow task", "enum" : [ "open", "closed", "delayed", "awaiting customer feedback" ], "type" : "string" }, "tags" : { "description" : "Tasks that are tagged with the specified tags", "items" : { "type" : "string" }, "type" : "array" }, "unassigned" : { "description" : "Tasks that are unassigned to a user or group", "type" : "boolean" } }, "type" : "object" }, "WorkflowTasksResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "task_context" : { "description" : "User friendly string of the task context if querying for a specific object type/id", "type" : "string" }, "tasks" : { "description" : "tasks", "items" : { "$ref" : "#/components/schemas/WorkflowTask" }, "type" : "array" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "WorkflowTaskTagsResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "tags" : { "description" : "Tags", "items" : { "type" : "string" }, "type" : "array" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "WorkflowUser" : { "properties" : { "user" : { "description" : "The user", "type" : "string" }, "user_icon_url" : { "description" : "The user icon URL if available", "type" : "string" }, "user_id" : { "description" : "User ID", "format" : "int32", "type" : "integer" } }, "type" : "object" }, "WorkflowUserResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "user" : { "$ref" : "#/components/schemas/WorkflowUser" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "WorkflowUsersResponse" : { "properties" : { "error" : { "$ref" : "#/components/schemas/Error" }, "metadata" : { "$ref" : "#/components/schemas/ResponseMetadata" }, "my_user_id" : { "description" : "User ID of myself", "format" : "int32", "type" : "integer" }, "success" : { "description" : "Indicates if API call was successful", "type" : "boolean" }, "users" : { "description" : "users", "items" : { "$ref" : "#/components/schemas/WorkflowUser" }, "type" : "array" }, "warning" : { "$ref" : "#/components/schemas/Warning" } }, "type" : "object" }, "oauthDeviceAuthorize_request" : { "properties" : { "client_id" : { "description" : "The OAuth application client_id.", "type" : "string" }, "scope" : { "description" : "The application-level scope (e.g., crm, ultraship).", "type" : "string" } }, "required" : [ "client_id", "scope" ] }, "oauthRevoke_request" : { "properties" : { "client_id" : { "description" : "The OAuth application client_id.", "type" : "string" }, "token" : { "description" : "The OAuth access token that is to be revoked..", "type" : "string" } }, "required" : [ "client_id", "token" ] }, "oauthAccessToken_request" : { "properties" : { "client_id" : { "description" : "The OAuth application client_id.", "type" : "string" }, "grant_type" : { "description" : "Type of grant", "type" : "string" }, "code" : { "description" : "Authorization code received back from the browser redirect", "type" : "string" }, "redirect_uri" : { "description" : "The URI that you redirect the browser to start the authorization process", "type" : "string" }, "refresh_token" : { "description" : "The refresh token received during the original grant_type=authorization_code that can be used to return a new access token", "type" : "string" }, "device_code" : { "description" : "The device code received from /oauth/device/authorize", "type" : "string" } }, "required" : [ "client_id", "grant_type" ] }, "uploadTemporaryMultimedia_request" : { "properties" : { "file" : { "description" : "File to upload", "format" : "binary", "type" : "string" } }, "required" : [ "file" ] }, "embedOauthDeviceAuthorize_request" : { "properties" : { "client_id" : { "description" : "The embed widget OAuth client_id.", "type" : "string" }, "scope" : { "description" : "The application-level scope (must be 'crm_embed').", "type" : "string" } }, "required" : [ "client_id", "scope" ] }, "embedOauthRevoke_request" : { "properties" : { "client_id" : { "description" : "The embed widget OAuth client_id.", "type" : "string" }, "token" : { "description" : "The token to revoke (access token or refresh token).", "type" : "string" } }, "required" : [ "client_id", "token" ] }, "embedOauthToken_request" : { "properties" : { "client_id" : { "description" : "The embed widget OAuth client_id.", "type" : "string" }, "grant_type" : { "description" : "Grant type.", "type" : "string" }, "device_code" : { "description" : "The device code received from /oauth/device/authorize (required for device_code grant).", "type" : "string" }, "refresh_token" : { "description" : "The refresh token (required for refresh_token grant).", "type" : "string" } }, "required" : [ "client_id", "grant_type" ] } }, "securitySchemes" : { "ultraCartOauth" : { "flows" : { "authorizationCode" : { "authorizationUrl" : "https://secure.ultracart.com/rest/v2/oauth/authorize", "scopes" : { "affiliate_read" : "Allows you to read affiliate information.", "affiliate_write" : "Allows you to write affiliate information.", "auto_order_read" : "Allows you to read auto order information.", "auto_order_write" : "Allows you to write auto order information.", "channel_partner_read" : "Allows you to read channel partner information.", "channel_partner_write" : "Allows you to write channel partner information.", "chargeback_read" : "Allows you to read chargeback information.", "chargeback_write" : "Allows you to write chargeback information.", "checkout_read" : "Allows you to read checkout information.", "checkout_write" : "Allows you to write checkout information.", "configuration_read" : "Allows you to read configuration information.", "configuration_write" : "Allows you to write configuration information.", "conversation_read" : "Allows you to read conversation information.", "conversation_write" : "Allows you to write conversation information.", "coupon_read" : "Allows you to read coupon information.", "coupon_write" : "Allows you to write coupon information.", "customer_read" : "Allows you to read customer information.", "customer_write" : "Allows you to write customer information.", "fulfillment_read" : "Allows you to read fulfillment information.", "fulfillment_write" : "Allows you to write fulfillment information.", "gift_certificate_read" : "Allows you to read gift certificate information.", "gift_certificate_write" : "Allows you to write gift certificate information.", "integration_log_read" : "Allows you to read integration log information.", "integration_log_write" : "Allows you to write integration log information.", "order_read" : "Allows you to read order information.", "order_write" : "Allows you to write order information.", "item_read" : "Allows you to read item information.", "item_write" : "Allows you to write item information.", "storefront_read" : "Allows you to read storefront information.", "storefront_write" : "Allows you to write storefront information.", "tax_read" : "Allows you to read tax configuration information.", "tax_write" : "Allows you to write tax configuration information.", "webhook_read" : "Allows you to read webhook information.", "webhook_write" : "Allows you to write webhook information.", "ultrabooks_read" : "1 of 2 required to use UltraBooks", "ultrabooks_write" : "2 of 2 required to use UltraBooks", "user_read" : "Allows you to read user information.", "user_write" : "Allows you to write user information.", "workflow_read" : "Allows you to read workflow information.", "workflow_write" : "Allows you to write workflow information." }, "tokenUrl" : "https://secure.ultracart.com/rest/v2/oauth/token" } }, "type" : "oauth2" }, "ultraCartSimpleApiKey" : { "in" : "header", "name" : "x-ultracart-simple-key", "type" : "apiKey" }, "ultraCartBrowserApiKey" : { "in" : "header", "name" : "x-ultracart-browser-key", "type" : "apiKey" } } }, "x-original-swagger-version" : "2.0" }