{ "openapi": "3.0.3", "info": { "title": "Catalog Products", "description": "Merchants can use the Catalog Products API to create products, which are goods and services.", "version": "1.0", "contact": {} }, "servers": [ { "url": "https://api-m.sandbox.paypal.com", "description": "PayPal Sandbox Environment" }, { "url": "https://api-m.paypal.com", "description": "PayPal Live Environment" } ], "tags": [ { "name": "products", "description": "Use `/products` resource to create and manage products." } ], "externalDocs": { "url": "https://developer.paypal.com/docs/api/catalog-products/v1/" }, "paths": { "/v1/catalogs/products": { "post": { "summary": "Create product", "description": "Creates a product.", "operationId": "products.create", "responses": { "200": { "description": "A successful request returns the HTTP `200 OK` status code and a JSON response body that shows product details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } }, "201": { "description": "A successful request returns the HTTP `201 Created` status code and a JSON response body that shows product details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } }, "400": { "description": "Bad Request. Request is not well-formed, syntactically incorrect, or violates schema.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/error_400" }, { "$ref": "#/components/schemas/products.create-400" } ] } } } }, "401": { "description": "Authentication failed due to missing authorization header, or invalid authentication credentials.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/error_401" }, { "$ref": "#/components/schemas/401" } ] } } } }, "403": { "description": "Authorization failed due to insufficient permissions.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/error_403" }, { "$ref": "#/components/schemas/403" } ] } } } }, "422": { "description": "The requested action could not be performed, semantically incorrect, or failed business validation.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/error_422" }, { "$ref": "#/components/schemas/422" } ] } } } }, "500": { "description": "An internal server error has occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_500" } } } }, "default": { "$ref": "#/components/responses/default" } }, "parameters": [ { "$ref": "#/components/parameters/prefer" }, { "$ref": "#/components/parameters/paypal_request_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_request_POST" }, "examples": { "product_request_POST": { "value": { "name": "Video Streaming Service", "description": "Video streaming service", "type": "SERVICE", "category": "SOFTWARE", "image_url": "https://example.com/streaming.jpg", "home_url": "https://example.com/home" } } } } } }, "security": [ { "Oauth2": [ "https://uri.paypal.com/services/subscriptions" ] } ], "tags": [ "products" ] }, "get": { "summary": "List products", "description": "Lists products.", "operationId": "products.list", "responses": { "200": { "description": "A successful request returns the HTTP `200 OK` status code and a JSON response body that lists products with details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product_collection" } } } }, "400": { "description": "Bad Request. Request is not well-formed, syntactically incorrect, or violates schema.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/error_400" }, { "$ref": "#/components/schemas/400" } ] } } } }, "401": { "description": "Authentication failed due to missing authorization header, or invalid authentication credentials.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/error_401" }, { "$ref": "#/components/schemas/401" } ] } } } }, "403": { "description": "Authorization failed due to insufficient permissions.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/error_403" }, { "$ref": "#/components/schemas/403" } ] } } } }, "500": { "description": "An internal server error has occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_500" } } } }, "default": { "$ref": "#/components/responses/default" } }, "parameters": [ { "$ref": "#/components/parameters/page_size" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/total_required" } ], "security": [ { "Oauth2": [ "https://uri.paypal.com/services/subscriptions" ] } ], "tags": [ "products" ] } }, "/v1/catalogs/products/{product_id}": { "get": { "summary": "Show product details", "description": "Shows details for a product, by ID.", "operationId": "products.get", "responses": { "200": { "description": "A successful request returns the HTTP `200 OK` status code and a JSON response body that shows product details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/product" } } } }, "401": { "description": "Authentication failed due to missing authorization header, or invalid authentication credentials.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/error_401" }, { "$ref": "#/components/schemas/401" } ] } } } }, "403": { "description": "Authorization failed due to insufficient permissions.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/error_403" }, { "$ref": "#/components/schemas/403" } ] } } } }, "404": { "description": "The specified resource does not exist.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/error_404" }, { "$ref": "#/components/schemas/404" } ] } } } }, "500": { "description": "An internal server error has occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_500" } } } }, "default": { "$ref": "#/components/responses/default" } }, "parameters": [ { "$ref": "#/components/parameters/product_id" } ], "security": [ { "Oauth2": [ "https://uri.paypal.com/services/subscriptions" ] } ], "tags": [ "products" ] }, "patch": { "summary": "Update product", "description": "Updates a product, by ID. You can patch these attributes and objects:
Attribute or objectOperations
descriptionadd, replace, remove
categoryadd, replace, remove
image_urladd, replace, remove
home_urladd, replace, remove
", "operationId": "products.patch", "responses": { "204": { "description": "A successful request returns the HTTP `204 No Content` status code with no JSON response body." }, "400": { "description": "Bad Request. Request is not well-formed, syntactically incorrect, or violates schema.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/error_400" }, { "$ref": "#/components/schemas/products.patch-400" } ] } } } }, "401": { "description": "Authentication failed due to missing authorization header, or invalid authentication credentials.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/error_401" }, { "$ref": "#/components/schemas/401" } ] } } } }, "403": { "description": "Authorization failed due to insufficient permissions.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/error_403" }, { "$ref": "#/components/schemas/403" } ] } } } }, "404": { "description": "The specified resource does not exist.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/error_404" }, { "$ref": "#/components/schemas/404" } ] } } } }, "422": { "description": "The requested action could not be performed, semantically incorrect, or failed business validation.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/error_422" }, { "$ref": "#/components/schemas/products.patch-422" } ] } } } }, "500": { "description": "An internal server error has occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_500" } } } }, "default": { "$ref": "#/components/responses/default" } }, "parameters": [ { "$ref": "#/components/parameters/product_id" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/patch_request" }, "examples": { "patch_request": { "value": [ { "op": "replace", "path": "/description", "value": "Premium video streaming service" } ] } } } } }, "security": [ { "Oauth2": [ "https://uri.paypal.com/services/subscriptions" ] } ], "tags": [ "products" ] } } }, "components": { "securitySchemes": { "Oauth2": { "type": "oauth2", "description": "Oauth 2.0 authentication", "flows": { "clientCredentials": { "tokenUrl": "/v1/oauth2/token", "scopes": { "https://uri.paypal.com/services/subscriptions": "Create and manage products" } } } } }, "responses": { "default": { "description": "The default response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error_default" } } } } }, "schemas": { "400": { "properties": { "details": { "type": "array", "items": { "anyOf": [ { "title": "INVALID_PARAMETER_VALUE", "properties": { "issue": { "type": "string", "enum": [ "INVALID_PARAMETER_VALUE" ] }, "description": { "type": "string", "enum": [ "The value of a field is invalid." ] } } } ] } } } }, "401": { "properties": { "details": { "type": "array", "items": { "anyOf": [ { "title": "INVALID_ACCOUNT_STATUS", "properties": { "issue": { "type": "string", "enum": [ "INVALID_ACCOUNT_STATUS" ] }, "description": { "type": "string", "enum": [ "Account validations failed for the user." ] } } } ] } } } }, "403": { "properties": { "details": { "type": "array", "items": { "anyOf": [ { "title": "PERMISSION_DENIED", "properties": { "issue": { "type": "string", "enum": [ "PERMISSION_DENIED" ] }, "description": { "type": "string", "enum": [ "You do not have permission to access or perform operations on this resource." ] } } } ] } } } }, "404": { "properties": { "details": { "type": "array", "items": { "anyOf": [ { "title": "INVALID_RESOURCE_ID", "properties": { "issue": { "type": "string", "enum": [ "INVALID_RESOURCE_ID" ] }, "description": { "type": "string", "enum": [ "Specified resource ID does not exist. Please check the resource ID and try again." ] } } } ] } } } }, "422": { "properties": { "details": { "type": "array", "items": { "anyOf": [ { "title": "USER_ACCOUNT_CLOSED", "properties": { "issue": { "type": "string", "enum": [ "USER_ACCOUNT_CLOSED" ] }, "description": { "type": "string", "enum": [ "User account locked or closed." ] } } }, { "title": "DUPLICATE_RESOURCE_IDENTIFIER", "properties": { "issue": { "type": "string", "enum": [ "DUPLICATE_RESOURCE_IDENTIFIER" ] }, "description": { "type": "string", "enum": [ "Identifier must be unique." ] } } }, { "title": "COUNTRY_NOT_SUPPORTED", "properties": { "issue": { "type": "string", "enum": [ "COUNTRY_NOT_SUPPORTED" ] }, "description": { "type": "string", "enum": [ "This merchant country is not currently supported." ] } } } ] } } } }, "error_details": { "title": "Error Details", "type": "object", "description": "The error details. Required for client-side `4XX` errors.", "properties": { "field": { "type": "string", "description": "The field that caused the error. If this field is in the body, set this value to the field's JSON pointer value. Required for client-side errors." }, "value": { "type": "string", "description": "The value of the field that caused the error." }, "location": { "$ref": "#/components/schemas/error_location" }, "issue": { "type": "string", "description": "The unique, fine-grained application-level error code." }, "description": { "type": "string", "description": "The human-readable description for an issue. The description can change over the lifetime of an API, so clients must not depend on this value." } }, "required": [ "issue" ] }, "error_location": { "type": "string", "description": "The location of the field that caused the error. Value is `body`, `path`, or `query`.", "enum": [ "body", "path", "query" ], "default": "body" }, "error_default": { "description": "The default error response.", "oneOf": [ { "$ref": "#/components/schemas/error_400" }, { "$ref": "#/components/schemas/error_401" }, { "$ref": "#/components/schemas/error_403" }, { "$ref": "#/components/schemas/error_404" }, { "$ref": "#/components/schemas/error_409" }, { "$ref": "#/components/schemas/error_415" }, { "$ref": "#/components/schemas/error_422" }, { "$ref": "#/components/schemas/error_500" }, { "$ref": "#/components/schemas/error_503" } ] }, "error_link_description": { "title": "Link Description", "description": "The request-related [HATEOAS link](/api/rest/responses/#hateoas-links) information.", "type": "object", "required": [ "href", "rel" ], "properties": { "href": { "description": "The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call.", "type": "string", "minLength": 0, "maxLength": 20000, "pattern": "^.*$" }, "rel": { "description": "The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml).", "type": "string", "minLength": 0, "maxLength": 100, "pattern": "^.*$" }, "method": { "description": "The HTTP method required to make the related call.", "type": "string", "minLength": 3, "maxLength": 6, "pattern": "^[A-Z]*$", "enum": [ "GET", "POST", "PUT", "DELETE", "PATCH" ] } } }, "error_400": { "type": "object", "title": "Bad Request Error", "description": "Request is not well-formed, syntactically incorrect, or violates schema.", "properties": { "name": { "type": "string", "enum": [ "INVALID_REQUEST" ] }, "message": { "type": "string", "enum": [ "Request is not well-formed, syntactically incorrect, or violates schema." ] }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/error_details" } }, "debug_id": { "type": "string", "description": "The PayPal internal ID. Used for correlation purposes." }, "links": { "description": "An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).", "type": "array", "minItems": 0, "maxItems": 10000, "items": { "$ref": "#/components/schemas/error_link_description" } } } }, "error_401": { "type": "object", "title": "Unauthorized Error", "description": "Authentication failed due to missing Authorization header, or invalid authentication credentials.", "properties": { "name": { "type": "string", "enum": [ "AUTHENTICATION_FAILURE" ] }, "message": { "type": "string", "enum": [ "Authentication failed due to missing authorization header, or invalid authentication credentials." ] }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/error_details" } }, "debug_id": { "type": "string", "description": "The PayPal internal ID. Used for correlation purposes." }, "links": { "description": "An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).", "type": "array", "minItems": 0, "maxItems": 10000, "items": { "$ref": "#/components/schemas/error_link_description" } } } }, "error_403": { "type": "object", "title": "Not Authorized Error", "description": "The client is not authorized to access this resource, although it may have valid credentials. ", "properties": { "name": { "type": "string", "enum": [ "NOT_AUTHORIZED" ] }, "message": { "type": "string", "enum": [ "Authorization failed due to insufficient permissions." ] }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/error_details" } }, "debug_id": { "type": "string", "description": "The PayPal internal ID. Used for correlation purposes." }, "links": { "description": "An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).", "type": "array", "minItems": 0, "maxItems": 10000, "items": { "$ref": "#/components/schemas/error_link_description" } } } }, "error_404": { "type": "object", "title": "Not found Error", "description": "The server has not found anything matching the request URI. This either means that the URI is incorrect or the resource is not available.", "properties": { "name": { "type": "string", "enum": [ "RESOURCE_NOT_FOUND" ] }, "message": { "type": "string", "enum": [ "The specified resource does not exist." ] }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/error_details" } }, "debug_id": { "type": "string", "description": "The PayPal internal ID. Used for correlation purposes." }, "links": { "description": "An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).", "type": "array", "minItems": 0, "maxItems": 10000, "items": { "$ref": "#/components/schemas/error_link_description" } } } }, "error_409": { "type": "object", "title": "Resource Conflict Error", "description": "The server has detected a conflict while processing this request.", "properties": { "name": { "type": "string", "enum": [ "RESOURCE_CONFLICT" ] }, "message": { "type": "string", "enum": [ "The server has detected a conflict while processing this request." ] }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/error_details" } }, "debug_id": { "type": "string", "description": "The PayPal internal ID. Used for correlation purposes." }, "links": { "description": "An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).", "type": "array", "minItems": 0, "maxItems": 10000, "items": { "$ref": "#/components/schemas/error_link_description" } } } }, "error_415": { "type": "object", "title": "Unsupported Media Type Error", "description": "The server does not support the request payload's media type.", "properties": { "name": { "type": "string", "enum": [ "UNSUPPORTED_MEDIA_TYPE" ] }, "message": { "type": "string", "enum": [ "The server does not support the request payload's media type." ] }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/error_details" } }, "debug_id": { "type": "string", "description": "The PayPal internal ID. Used for correlation purposes." }, "links": { "description": "An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).", "type": "array", "minItems": 0, "maxItems": 10000, "items": { "$ref": "#/components/schemas/error_link_description" } } } }, "error_422": { "type": "object", "title": "Unprocessable Entity Error", "description": "The requested action cannot be performed and may require interaction with APIs or processes outside of the current request. This is distinct from a 500 response in that there are no systemic problems limiting the API from performing the request.", "properties": { "name": { "type": "string", "enum": [ "UNPROCESSABLE_ENTITY" ] }, "message": { "type": "string", "enum": [ "The requested action could not be performed, semantically incorrect, or failed business validation." ] }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/error_details" } }, "debug_id": { "type": "string", "description": "The PayPal internal ID. Used for correlation purposes." }, "links": { "description": "An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).", "type": "array", "minItems": 0, "maxItems": 10000, "items": { "$ref": "#/components/schemas/error_link_description" } } } }, "error_500": { "type": "object", "title": "Internal Server Error", "description": "This is either a system or application error, and generally indicates that although the client appeared to provide a correct request, something unexpected has gone wrong on the server.", "properties": { "name": { "type": "string", "enum": [ "INTERNAL_SERVER_ERROR" ] }, "message": { "type": "string", "enum": [ "An internal server error occurred." ] }, "debug_id": { "type": "string", "description": "The PayPal internal ID. Used for correlation purposes." }, "links": { "description": "An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).", "type": "array", "minItems": 0, "maxItems": 10000, "items": { "$ref": "#/components/schemas/error_link_description" } } }, "example": { "name": "INTERNAL_SERVER_ERROR", "message": "An internal server error occurred.", "debug_id": "90957fca61718", "links": [ { "href": "https://developer.paypal.com/api/orders/v2/#error-INTERNAL_SERVER_ERROR", "rel": "information_link" } ] } }, "error_503": { "type": "object", "title": "Service Unavailable Error", "description": "The server is temporarily unable to handle the request, for example, because of planned maintenance or downtime.", "properties": { "name": { "type": "string", "enum": [ "SERVICE_UNAVAILABLE" ] }, "message": { "type": "string", "enum": [ "Service Unavailable." ] }, "debug_id": { "type": "string", "description": "The PayPal internal ID. Used for correlation purposes." }, "links": { "description": "An array of request-related [HATEOAS links](https://en.wikipedia.org/wiki/HATEOAS).", "type": "array", "minItems": 0, "maxItems": 10000, "items": { "$ref": "#/components/schemas/error_link_description" } } }, "example": { "name": "SERVICE_UNAVAILABLE", "message": "Service Unavailable.", "debug_id": "90957fca61718", "information_link": "https://developer.paypal.com/docs/api/orders/v2/#error-SERVICE_UNAVAILABLE" } }, "date_time": { "type": "string", "description": "The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.
Note: The regular expression provides guidance but does not reject all invalid dates.
", "format": "ppaas_date_time_v3", "minLength": 20, "maxLength": 64, "pattern": "^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$" }, "link_description": { "type": "object", "title": "Link Description", "description": "The request-related [HATEOAS link](/docs/api/reference/api-responses/#hateoas-links) information.", "required": [ "href", "rel" ], "properties": { "href": { "type": "string", "description": "The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call." }, "rel": { "type": "string", "description": "The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml)." }, "method": { "type": "string", "description": "The HTTP method required to make the related call.", "enum": [ "GET", "POST", "PUT", "DELETE", "HEAD", "CONNECT", "OPTIONS", "PATCH" ] } } }, "product_collection_element": { "title": "Product Element", "description": "The details for a product in the collection response.", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the product.", "minLength": 6, "maxLength": 50, "readOnly": true }, "name": { "type": "string", "description": "The product name.", "minLength": 1, "maxLength": 127 }, "description": { "type": "string", "description": "The product description.", "minLength": 1, "maxLength": 256 }, "create_time": { "description": "The date and time when the product was created, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).", "readOnly": true, "$ref": "#/components/schemas/date_time" }, "links": { "type": "array", "description": "An array of request-related [HATEOAS links](/docs/api/overview/#hateoas-links).", "readOnly": true, "items": { "$ref": "#/components/schemas/link_description", "readOnly": true } } } }, "product_collection": { "title": "Product Collection", "description": "The list of products, with details.", "type": "object", "properties": { "products": { "type": "array", "description": "An array of products.", "minItems": 1, "maxItems": 32767, "items": { "$ref": "#/components/schemas/product_collection_element" } }, "total_items": { "type": "integer", "description": "The total number of items.", "minimum": 0, "maximum": 500000000 }, "total_pages": { "type": "integer", "description": "The total number of pages.", "minimum": 0, "maximum": 100000000 }, "links": { "type": "array", "description": "An array of request-related [HATEOAS links](/docs/api/overview/#hateoas-links).", "readOnly": true, "items": { "$ref": "#/components/schemas/link_description", "readOnly": true } } } }, "product_category": { "type": "string", "description": "The product category.", "title": "Product Category", "minLength": 4, "maxLength": 256, "pattern": "^[A-Z_]+$", "enum": [ "AC_REFRIGERATION_REPAIR", "ACADEMIC_SOFTWARE", "ACCESSORIES", "ACCOUNTING", "ADULT", "ADVERTISING", "AFFILIATED_AUTO_RENTAL", "AGENCIES", "AGGREGATORS", "AGRICULTURAL_COOPERATIVE_FOR_MAIL_ORDER", "AIR_CARRIERS_AIRLINES", "AIRLINES", "AIRPORTS_FLYING_FIELDS", "ALCOHOLIC_BEVERAGES", "AMUSEMENT_PARKS_CARNIVALS", "ANIMATION", "ANTIQUES", "APPLIANCES", "AQUARIAMS_SEAQUARIUMS_DOLPHINARIUMS", "ARCHITECTURAL_ENGINEERING_AND_SURVEYING_SERVICES", "ART_AND_CRAFT_SUPPLIES", "ART_DEALERS_AND_GALLERIES", "ARTIFACTS_GRAVE_RELATED_AND_NATIVE_AMERICAN_CRAFTS", "ARTS_AND_CRAFTS", "ARTS_CRAFTS_AND_COLLECTIBLES", "AUDIO_BOOKS", "AUTO_ASSOCIATIONS_CLUBS", "AUTO_DEALER_USED_ONLY", "AUTO_RENTALS", "AUTO_SERVICE", "AUTOMATED_FUEL_DISPENSERS", "AUTOMOBILE_ASSOCIATIONS", "AUTOMOTIVE", "AUTOMOTIVE_REPAIR_SHOPS_NON_DEALER", "AUTOMOTIVE_TOP_AND_BODY_SHOPS", "AVIATION", "BABIES_CLOTHING_AND_SUPPLIES", "BABY", "BANDS_ORCHESTRAS_ENTERTAINERS", "BARBIES", "BATH_AND_BODY", "BATTERIES", "BEAN_BABIES", "BEAUTY", "BEAUTY_AND_FRAGRANCES", "BED_AND_BATH", "BICYCLE_SHOPS_SALES_AND_SERVICE", "BICYCLES_AND_ACCESSORIES", "BILLIARD_POOL_ESTABLISHMENTS", "BOAT_DEALERS", "BOAT_RENTALS_AND_LEASING", "BOATING_SAILING_AND_ACCESSORIES", "BOOKS", "BOOKS_AND_MAGAZINES", "BOOKS_MANUSCRIPTS", "BOOKS_PERIODICALS_AND_NEWSPAPERS", "BOWLING_ALLEYS", "BULLETIN_BOARD", "BUS_LINE", "BUS_LINES_CHARTERS_TOUR_BUSES", "BUSINESS", "BUSINESS_AND_SECRETARIAL_SCHOOLS", "BUYING_AND_SHOPPING_SERVICES_AND_CLUBS", "CABLE_SATELLITE_AND_OTHER_PAY_TELEVISION_AND_RADIO_SERVICES", "CABLE_SATELLITE_AND_OTHER_PAY_TV_AND_RADIO", "CAMERA_AND_PHOTOGRAPHIC_SUPPLIES", "CAMERAS", "CAMERAS_AND_PHOTOGRAPHY", "CAMPER_RECREATIONAL_AND_UTILITY_TRAILER_DEALERS", "CAMPING_AND_OUTDOORS", "CAMPING_AND_SURVIVAL", "CAR_AND_TRUCK_DEALERS", "CAR_AND_TRUCK_DEALERS_USED_ONLY", "CAR_AUDIO_AND_ELECTRONICS", "CAR_RENTAL_AGENCY", "CATALOG_MERCHANT", "CATALOG_RETAIL_MERCHANT", "CATERING_SERVICES", "CHARITY", "CHECK_CASHIER", "CHILD_CARE_SERVICES", "CHILDREN_BOOKS", "CHIROPODISTS_PODIATRISTS", "CHIROPRACTORS", "CIGAR_STORES_AND_STANDS", "CIVIC_SOCIAL_FRATERNAL_ASSOCIATIONS", "CIVIL_SOCIAL_FRAT_ASSOCIATIONS", "CLOTHING", "CLOTHING_ACCESSORIES_AND_SHOES", "CLOTHING_RENTAL", "COFFEE_AND_TEA", "COIN_OPERATED_BANKS_AND_CASINOS", "COLLECTIBLES", "COLLECTION_AGENCY", "COLLEGES_AND_UNIVERSITIES", "COMMERCIAL_EQUIPMENT", "COMMERCIAL_FOOTWEAR", "COMMERCIAL_PHOTOGRAPHY", "COMMERCIAL_PHOTOGRAPHY_ART_AND_GRAPHICS", "COMMERCIAL_SPORTS_PROFESSIONA", "COMMODITIES_AND_FUTURES_EXCHANGE", "COMPUTER_AND_DATA_PROCESSING_SERVICES", "COMPUTER_HARDWARE_AND_SOFTWARE", "COMPUTER_MAINTENANCE_REPAIR_AND_SERVICES_NOT_ELSEWHERE_CLAS", "CONSTRUCTION", "CONSTRUCTION_MATERIALS_NOT_ELSEWHERE_CLASSIFIED", "CONSULTING_SERVICES", "CONSUMER_CREDIT_REPORTING_AGENCIES", "CONVALESCENT_HOMES", "COSMETIC_STORES", "COUNSELING_SERVICES_DEBT_MARRIAGE_PERSONAL", "COUNTERFEIT_CURRENCY_AND_STAMPS", "COUNTERFEIT_ITEMS", "COUNTRY_CLUBS", "COURIER_SERVICES", "COURIER_SERVICES_AIR_AND_GROUND_AND_FREIGHT_FORWARDERS", "COURT_COSTS_ALIMNY_CHILD_SUPT", "COURT_COSTS_INCLUDING_ALIMONY_AND_CHILD_SUPPORT_COURTS_OF_LAW", "CREDIT_CARDS", "CREDIT_UNION", "CULTURE_AND_RELIGION", "DAIRY_PRODUCTS_STORES", "DANCE_HALLS_STUDIOS_AND_SCHOOLS", "DECORATIVE", "DENTAL", "DENTISTS_AND_ORTHODONTISTS", "DEPARTMENT_STORES", "DESKTOP_PCS", "DEVICES", "DIECAST_TOYS_VEHICLES", "DIGITAL_GAMES", "DIGITAL_MEDIA_BOOKS_MOVIES_MUSIC", "DIRECT_MARKETING", "DIRECT_MARKETING_CATALOG_MERCHANT", "DIRECT_MARKETING_INBOUND_TELE", "DIRECT_MARKETING_OUTBOUND_TELE", "DIRECT_MARKETING_SUBSCRIPTION", "DISCOUNT_STORES", "DOOR_TO_DOOR_SALES", "DRAPERY_WINDOW_COVERING_AND_UPHOLSTERY", "DRINKING_PLACES", "DRUGSTORE", "DURABLE_GOODS", "ECOMMERCE_DEVELOPMENT", "ECOMMERCE_SERVICES", "EDUCATIONAL_AND_TEXTBOOKS", "ELECTRIC_RAZOR_STORES", "ELECTRICAL_AND_SMALL_APPLIANCE_REPAIR", "ELECTRICAL_CONTRACTORS", "ELECTRICAL_PARTS_AND_EQUIPMENT", "ELECTRONIC_CASH", "ELEMENTARY_AND_SECONDARY_SCHOOLS", "EMPLOYMENT", "ENTERTAINERS", "ENTERTAINMENT_AND_MEDIA", "EQUIP_TOOL_FURNITURE_AND_APPLIANCE_RENTAL_AND_LEASING", "ESCROW", "EVENT_AND_WEDDING_PLANNING", "EXERCISE_AND_FITNESS", "EXERCISE_EQUIPMENT", "EXTERMINATING_AND_DISINFECTING_SERVICES", "FABRICS_AND_SEWING", "FAMILY_CLOTHING_STORES", "FASHION_JEWELRY", "FAST_FOOD_RESTAURANTS", "FICTION_AND_NONFICTION", "FINANCE_COMPANY", "FINANCIAL_AND_INVESTMENT_ADVICE", "FINANCIAL_INSTITUTIONS_MERCHANDISE_AND_SERVICES", "FIREARM_ACCESSORIES", "FIREARMS_WEAPONS_AND_KNIVES", "FIREPLACE_AND_FIREPLACE_SCREENS", "FIREWORKS", "FISHING", "FLORISTS", "FLOWERS", "FOOD_DRINK_AND_NUTRITION", "FOOD_PRODUCTS", "FOOD_RETAIL_AND_SERVICE", "FRAGRANCES_AND_PERFUMES", "FREEZER_AND_LOCKER_MEAT_PROVISIONERS", "FUEL_DEALERS_FUEL_OIL_WOOD_AND_COAL", "FUEL_DEALERS_NON_AUTOMOTIVE", "FUNERAL_SERVICES_AND_CREMATORIES", "FURNISHING_AND_DECORATING", "FURNITURE", "FURRIERS_AND_FUR_SHOPS", "GADGETS_AND_OTHER_ELECTRONICS", "GAMBLING", "GAME_SOFTWARE", "GAMES", "GARDEN_SUPPLIES", "GENERAL", "GENERAL_CONTRACTORS", "GENERAL_GOVERNMENT", "GENERAL_SOFTWARE", "GENERAL_TELECOM", "GIFTS_AND_FLOWERS", "GLASS_PAINT_AND_WALLPAPER_STORES", "GLASSWARE_CRYSTAL_STORES", "GOVERNMENT", "GOVERNMENT_IDS_AND_LICENSES", "GOVERNMENT_LICENSED_ON_LINE_CASINOS_ON_LINE_GAMBLING", "GOVERNMENT_OWNED_LOTTERIES", "GOVERNMENT_SERVICES", "GRAPHIC_AND_COMMERCIAL_DESIGN", "GREETING_CARDS", "GROCERY_STORES_AND_SUPERMARKETS", "HARDWARE_AND_TOOLS", "HARDWARE_EQUIPMENT_AND_SUPPLIES", "HAZARDOUS_RESTRICTED_AND_PERISHABLE_ITEMS", "HEALTH_AND_BEAUTY_SPAS", "HEALTH_AND_NUTRITION", "HEALTH_AND_PERSONAL_CARE", "HEARING_AIDS_SALES_AND_SUPPLIES", "HEATING_PLUMBING_AC", "HIGH_RISK_MERCHANT", "HIRING_SERVICES", "HOBBIES_TOYS_AND_GAMES", "HOME_AND_GARDEN", "HOME_AUDIO", "HOME_DECOR", "HOME_ELECTRONICS", "HOSPITALS", "HOTELS_MOTELS_INNS_RESORTS", "HOUSEWARES", "HUMAN_PARTS_AND_REMAINS", "HUMOROUS_GIFTS_AND_NOVELTIES", "HUNTING", "IDS_LICENSES_AND_PASSPORTS", "ILLEGAL_DRUGS_AND_PARAPHERNALIA", "INDUSTRIAL", "INDUSTRIAL_AND_MANUFACTURING_SUPPLIES", "INSURANCE_AUTO_AND_HOME", "INSURANCE_DIRECT", "INSURANCE_LIFE_AND_ANNUITY", "INSURANCE_SALES_UNDERWRITING", "INSURANCE_UNDERWRITING_PREMIUMS", "INTERNET_AND_NETWORK_SERVICES", "INTRA_COMPANY_PURCHASES", "LABORATORIES_DENTAL_MEDICAL", "LANDSCAPING", "LANDSCAPING_AND_HORTICULTURAL_SERVICES", "LAUNDRY_CLEANING_SERVICES", "LEGAL", "LEGAL_SERVICES_AND_ATTORNEYS", "LOCAL_DELIVERY_SERVICE", "LOCKSMITH", "LODGING_AND_ACCOMMODATIONS", "LOTTERY_AND_CONTESTS", "LUGGAGE_AND_LEATHER_GOODS", "LUMBER_AND_BUILDING_MATERIALS", "MAGAZINES", "MAINTENANCE_AND_REPAIR_SERVICES", "MAKEUP_AND_COSMETICS", "MANUAL_CASH_DISBURSEMENTS", "MASSAGE_PARLORS", "MEDICAL", "MEDICAL_AND_PHARMACEUTICAL", "MEDICAL_CARE", "MEDICAL_EQUIPMENT_AND_SUPPLIES", "MEDICAL_SERVICES", "MEETING_PLANNERS", "MEMBERSHIP_CLUBS_AND_ORGANIZATIONS", "MEMBERSHIP_COUNTRY_CLUBS_GOLF", "MEMORABILIA", "MEN_AND_BOY_CLOTHING_AND_ACCESSORY_STORES", "MEN_CLOTHING", "MERCHANDISE", "METAPHYSICAL", "MILITARIA", "MILITARY_AND_CIVIL_SERVICE_UNIFORMS", "MISC._AUTOMOTIVE_AIRCRAFT_AND_FARM_EQUIPMENT_DEALERS", "MISC._GENERAL_MERCHANDISE", "MISCELLANEOUS_GENERAL_SERVICES", "MISCELLANEOUS_REPAIR_SHOPS_AND_RELATED_SERVICES", "MODEL_KITS", "MONEY_TRANSFER_MEMBER_FINANCIAL_INSTITUTION", "MONEY_TRANSFER_MERCHANT", "MOTION_PICTURE_THEATERS", "MOTOR_FREIGHT_CARRIERS_AND_TRUCKING", "MOTOR_HOME_AND_RECREATIONAL_VEHICLE_RENTAL", "MOTOR_HOMES_DEALERS", "MOTOR_VEHICLE_SUPPLIES_AND_NEW_PARTS", "MOTORCYCLE_DEALERS", "MOTORCYCLES", "MOVIE", "MOVIE_TICKETS", "MOVING_AND_STORAGE", "MULTI_LEVEL_MARKETING", "MUSIC_CDS_CASSETTES_AND_ALBUMS", "MUSIC_STORE_INSTRUMENTS_AND_SHEET_MUSIC", "NETWORKING", "NEW_AGE", "NEW_PARTS_AND_SUPPLIES_MOTOR_VEHICLE", "NEWS_DEALERS_AND_NEWSTANDS", "NON_DURABLE_GOODS", "NON_FICTION", "NON_PROFIT_POLITICAL_AND_RELIGION", "NONPROFIT", "NOVELTIES", "OEM_SOFTWARE", "OFFICE_SUPPLIES_AND_EQUIPMENT", "ONLINE_DATING", "ONLINE_GAMING", "ONLINE_GAMING_CURRENCY", "ONLINE_SERVICES", "OOUTBOUND_TELEMARKETING_MERCH", "OPHTHALMOLOGISTS_OPTOMETRIST", "OPTICIANS_AND_DISPENSING", "ORTHOPEDIC_GOODS_PROSTHETICS", "OSTEOPATHS", "OTHER", "PACKAGE_TOUR_OPERATORS", "PAINTBALL", "PAINTS_VARNISHES_AND_SUPPLIES", "PARKING_LOTS_AND_GARAGES", "PARTS_AND_ACCESSORIES", "PAWN_SHOPS", "PAYCHECK_LENDER_OR_CASH_ADVANCE", "PERIPHERALS", "PERSONALIZED_GIFTS", "PET_SHOPS_PET_FOOD_AND_SUPPLIES", "PETROLEUM_AND_PETROLEUM_PRODUCTS", "PETS_AND_ANIMALS", "PHOTOFINISHING_LABORATORIES_PHOTO_DEVELOPING", "PHOTOGRAPHIC_STUDIOS_PORTRAITS", "PHOTOGRAPHY", "PHYSICAL_GOOD", "PICTURE_VIDEO_PRODUCTION", "PIECE_GOODS_NOTIONS_AND_OTHER_DRY_GOODS", "PLANTS_AND_SEEDS", "PLUMBING_AND_HEATING_EQUIPMENTS_AND_SUPPLIES", "POLICE_RELATED_ITEMS", "POLITICAL_ORGANIZATIONS", "POSTAL_SERVICES_GOVERNMENT_ONLY", "POSTERS", "PREPAID_AND_STORED_VALUE_CARDS", "PRESCRIPTION_DRUGS", "PROMOTIONAL_ITEMS", "PUBLIC_WAREHOUSING_AND_STORAGE", "PUBLISHING_AND_PRINTING", "PUBLISHING_SERVICES", "RADAR_DECTORS", "RADIO_TELEVISION_AND_STEREO_REPAIR", "REAL_ESTATE", "REAL_ESTATE_AGENT", "REAL_ESTATE_AGENTS_AND_MANAGERS_RENTALS", "RELIGION_AND_SPIRITUALITY_FOR_PROFIT", "RELIGIOUS", "RELIGIOUS_ORGANIZATIONS", "REMITTANCE", "RENTAL_PROPERTY_MANAGEMENT", "RESIDENTIAL", "RETAIL", "RETAIL_FINE_JEWELRY_AND_WATCHES", "REUPHOLSTERY_AND_FURNITURE_REPAIR", "RINGS", "ROOFING_SIDING_SHEET_METAL", "RUGS_AND_CARPETS", "SCHOOLS_AND_COLLEGES", "SCIENCE_FICTION", "SCRAPBOOKING", "SCULPTURES", "SECURITIES_BROKERS_AND_DEALERS", "SECURITY_AND_SURVEILLANCE", "SECURITY_AND_SURVEILLANCE_EQUIPMENT", "SECURITY_BROKERS_AND_DEALERS", "SEMINARS", "SERVICE_STATIONS", "SERVICES", "SEWING_NEEDLEWORK_FABRIC_AND_PIECE_GOODS_STORES", "SHIPPING_AND_PACKING", "SHOE_REPAIR_HAT_CLEANING", "SHOE_STORES", "SHOES", "SNOWMOBILE_DEALERS", "SOFTWARE", "SPECIALTY_AND_MISC._FOOD_STORES", "SPECIALTY_CLEANING_POLISHING_AND_SANITATION_PREPARATIONS", "SPECIALTY_OR_RARE_PETS", "SPORT_GAMES_AND_TOYS", "SPORTING_AND_RECREATIONAL_CAMPS", "SPORTING_GOODS", "SPORTS_AND_OUTDOORS", "SPORTS_AND_RECREATION", "STAMP_AND_COIN", "STATIONARY_PRINTING_AND_WRITING_PAPER", "STENOGRAPHIC_AND_SECRETARIAL_SUPPORT_SERVICES", "STOCKS_BONDS_SECURITIES_AND_RELATED_CERTIFICATES", "STORED_VALUE_CARDS", "SUPPLIES", "SUPPLIES_AND_TOYS", "SURVEILLANCE_EQUIPMENT", "SWIMMING_POOLS_AND_SPAS", "SWIMMING_POOLS_SALES_SUPPLIES_SERVICES", "TAILORS_AND_ALTERATIONS", "TAX_PAYMENTS", "TAX_PAYMENTS_GOVERNMENT_AGENCIES", "TAXICABS_AND_LIMOUSINES", "TELECOMMUNICATION_SERVICES", "TELEPHONE_CARDS", "TELEPHONE_EQUIPMENT", "TELEPHONE_SERVICES", "THEATER", "TIRE_RETREADING_AND_REPAIR", "TOLL_OR_BRIDGE_FEES", "TOOLS_AND_EQUIPMENT", "TOURIST_ATTRACTIONS_AND_EXHIBITS", "TOWING_SERVICE", "TOYS_AND_GAMES", "TRADE_AND_VOCATIONAL_SCHOOLS", "TRADEMARK_INFRINGEMENT", "TRAILER_PARKS_AND_CAMPGROUNDS", "TRAINING_SERVICES", "TRANSPORTATION_SERVICES", "TRAVEL", "TRUCK_AND_UTILITY_TRAILER_RENTALS", "TRUCK_STOP", "TYPESETTING_PLATE_MAKING_AND_RELATED_SERVICES", "USED_MERCHANDISE_AND_SECONDHAND_STORES", "USED_PARTS_MOTOR_VEHICLE", "UTILITIES", "UTILITIES_ELECTRIC_GAS_WATER_SANITARY", "VARIETY_STORES", "VEHICLE_SALES", "VEHICLE_SERVICE_AND_ACCESSORIES", "VIDEO_EQUIPMENT", "VIDEO_GAME_ARCADES_ESTABLISH", "VIDEO_GAMES_AND_SYSTEMS", "VIDEO_TAPE_RENTAL_STORES", "VINTAGE_AND_COLLECTIBLE_VEHICLES", "VINTAGE_AND_COLLECTIBLES", "VITAMINS_AND_SUPPLEMENTS", "VOCATIONAL_AND_TRADE_SCHOOLS", "WATCH_CLOCK_AND_JEWELRY_REPAIR", "WEB_HOSTING_AND_DESIGN", "WELDING_REPAIR", "WHOLESALE_CLUBS", "WHOLESALE_FLORIST_SUPPLIERS", "WHOLESALE_PRESCRIPTION_DRUGS", "WILDLIFE_PRODUCTS", "WIRE_TRANSFER", "WIRE_TRANSFER_AND_MONEY_ORDER", "WOMEN_ACCESSORY_SPECIALITY", "WOMEN_CLOTHING" ] }, "product_request_POST": { "title": "Create Product Request", "description": "The create product request details.", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the product. You can specify the SKU for the product. If you omit the ID, the system generates it. System-generated IDs have the `PROD-` prefix.", "minLength": 6, "maxLength": 50 }, "name": { "type": "string", "description": "The product name.", "minLength": 1, "maxLength": 127 }, "description": { "type": "string", "description": "The product description.", "minLength": 1, "maxLength": 256 }, "type": { "type": "string", "description": "The product type. Indicates whether the product is physical or digital goods, or a service.", "minLength": 1, "maxLength": 24, "pattern": "^[A-Z_]+$", "default": "PHYSICAL", "enum": [ "PHYSICAL", "DIGITAL", "SERVICE" ] }, "category": { "$ref": "#/components/schemas/product_category" }, "image_url": { "type": "string", "format": "uri", "minLength": 1, "maxLength": 2000, "description": "The image URL for the product." }, "home_url": { "type": "string", "format": "uri", "minLength": 1, "maxLength": 2000, "description": "The home page URL for the product." } }, "required": [ "name", "type" ] }, "product": { "title": "Product Details", "description": "The product details.", "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the product.", "minLength": 6, "maxLength": 50 }, "name": { "type": "string", "description": "The product name.", "minLength": 1, "maxLength": 127 }, "description": { "type": "string", "description": "The product description.", "minLength": 1, "maxLength": 256 }, "type": { "type": "string", "description": "The product type. Indicates whether the product is physical or digital goods, or a service.", "minLength": 1, "maxLength": 24, "pattern": "^[A-Z_]+$", "default": "PHYSICAL", "enum": [ "PHYSICAL", "DIGITAL", "SERVICE" ] }, "category": { "$ref": "#/components/schemas/product_category" }, "image_url": { "type": "string", "format": "uri", "minLength": 1, "maxLength": 2000, "description": "The image URL for the product." }, "home_url": { "type": "string", "format": "uri", "minLength": 1, "maxLength": 2000, "description": "The home page URL for the product." }, "create_time": { "description": "The date and time when the product was created, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).", "readOnly": true, "$ref": "#/components/schemas/date_time" }, "update_time": { "description": "The date and time when the product was last updated, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6).", "readOnly": true, "$ref": "#/components/schemas/date_time" }, "links": { "type": "array", "description": "An array of request-related [HATEOAS links](/docs/api/overview/#hateoas-links).", "readOnly": true, "items": { "$ref": "#/components/schemas/link_description", "readOnly": true } } } }, "products.create-400": { "properties": { "details": { "type": "array", "items": { "anyOf": [ { "title": "INVALID_PARAMETER_SYNTAX", "properties": { "issue": { "type": "string", "enum": [ "INVALID_PARAMETER_SYNTAX" ] }, "description": { "type": "string", "enum": [ "Input identifier must not use system prefix(PROD-)." ] } } }, { "title": "INVALID_PARAMETER_SYNTAX", "properties": { "issue": { "type": "string", "enum": [ "INVALID_PARAMETER_SYNTAX" ] }, "description": { "type": "string", "enum": [ "The value of a field does not conform to the expected format." ] } } }, { "title": "INVALID_PARAMETER_VALUE", "properties": { "issue": { "type": "string", "enum": [ "INVALID_PARAMETER_VALUE" ] }, "description": { "type": "string", "enum": [ "The value of a field is invalid." ] } } }, { "title": "MISSING_REQUIRED_PARAMETER", "properties": { "issue": { "type": "string", "enum": [ "MISSING_REQUIRED_PARAMETER" ] }, "description": { "type": "string", "enum": [ "A required field is missing." ] } } }, { "title": "INVALID_STRING_MIN_LENGTH", "properties": { "issue": { "type": "string", "enum": [ "INVALID_STRING_MIN_LENGTH" ] }, "description": { "type": "string", "enum": [ "The value of a field is too short." ] } } }, { "title": "INVALID_STRING_MAX_LENGTH", "properties": { "issue": { "type": "string", "enum": [ "INVALID_STRING_MAX_LENGTH" ] }, "description": { "type": "string", "enum": [ "The value of a field is too long." ] } } } ] } } } }, "patch": { "type": "object", "title": "Patch", "description": "The JSON patch object to apply partial updates to resources.", "properties": { "op": { "type": "string", "description": "The operation.", "enum": [ "add", "remove", "replace", "move", "copy", "test" ] }, "path": { "type": "string", "description": "The JSON Pointer to the target document location at which to complete the operation." }, "value": { "title": "Patch Value", "description": "The value to apply. The remove operation does not require a value." }, "from": { "type": "string", "description": "The JSON Pointer to the target document location from which to move the value. Required for the move operation." } }, "required": [ "op" ] }, "patch_request": { "type": "array", "title": "Patch Request", "description": "An array of JSON patch objects to apply partial updates to resources.", "items": { "$ref": "#/components/schemas/patch" } }, "products.patch-400": { "properties": { "details": { "type": "array", "items": { "anyOf": [ { "title": "MISSING_REQUIRED_PARAMETER", "properties": { "issue": { "type": "string", "enum": [ "MISSING_REQUIRED_PARAMETER" ] }, "description": { "type": "string", "enum": [ "A required field is missing." ] } } }, { "title": "UNSUPPORTED_PATCH_OPERATION", "properties": { "issue": { "type": "string", "enum": [ "UNSUPPORTED_PATCH_OPERATION" ] }, "description": { "type": "string", "enum": [ "The specified patch operation not supported for this field." ] } } }, { "title": "INVALID_PATCH_PATH", "properties": { "issue": { "type": "string", "enum": [ "INVALID_PATCH_PATH" ] }, "description": { "type": "string", "enum": [ "The specified field cannot be patched." ] } } }, { "title": "INVALID_PARAMETER_SYNTAX", "properties": { "issue": { "type": "string", "enum": [ "INVALID_PARAMETER_SYNTAX" ] }, "description": { "type": "string", "enum": [ "The value of a field does not conform to the expected format." ] } } }, { "title": "INVALID_PARAMETER_VALUE", "properties": { "issue": { "type": "string", "enum": [ "INVALID_PARAMETER_VALUE" ] }, "description": { "type": "string", "enum": [ "The value of a field is invalid." ] } } } ] } } } }, "products.patch-422": { "properties": { "details": { "type": "array", "items": { "anyOf": [ { "title": "USER_ACCOUNT_CLOSED", "properties": { "issue": { "type": "string", "enum": [ "USER_ACCOUNT_CLOSED" ] }, "description": { "type": "string", "enum": [ "User account locked or closed." ] } } }, { "title": "DUPLICATE_RESOURCE_IDENTIFIER", "properties": { "issue": { "type": "string", "enum": [ "DUPLICATE_RESOURCE_IDENTIFIER" ] }, "description": { "type": "string", "enum": [ "Identifier must be unique." ] } } } ] } } } } }, "parameters": { "prefer": { "name": "Prefer", "in": "header", "description": "The preferred server response upon successful completion of the request. Value is:", "required": false, "schema": { "type": "string", "default": "return=minimal" } }, "paypal_request_id": { "name": "PayPal-Request-Id", "in": "header", "description": "The server stores keys for 72 hours.", "required": false, "schema": { "type": "string" } }, "page_size": { "name": "page_size", "in": "query", "description": "The number of items to return in the response.", "schema": { "type": "integer", "minimum": 1, "maximum": 20, "default": 10 } }, "page": { "name": "page", "in": "query", "description": "A non-zero integer which is the start index of the entire list of items that are returned in the response. So, the combination of `page=1` and `page_size=20` returns the first 20 items. The combination of `page=2` and `page_size=20` returns the next 20 items.", "schema": { "type": "integer", "minimum": 1, "maximum": 100000, "default": 1 } }, "total_required": { "name": "total_required", "in": "query", "description": "Indicates whether to show the total items and total pages in the response.", "schema": { "type": "boolean", "default": false } }, "product_id": { "name": "product_id", "in": "path", "required": true, "description": "The product ID.", "schema": { "type": "string" } } } } }