{"info":{"description":"The Kevel Catalog Manager API is a RESTful API that allows you to manage your product catalog and associated items.\n   \nSome useful links:\n\n- [Catalog Documentation](https://dev.kevel.com/docs/catalog)","title":"Catalog Management API","version":"1.0.0"},"openapi":"3.1.0","security":[{"APIKeyAuthentication":[]}],"servers":[{"url":"https://api.kevel.co","description":"Production"}],"components":{"securitySchemes":{"APIKeyAuthentication":{"type":"apiKey","in":"header","name":"X-Kevel-ApiKey","description":"The API key for the Kevel Catalog Manager API generated for you."}},"schemas":{"CatalogBoundaryId":{"type":"number","minimum":100,"description":"The unique identifier of the boundary item used for paginating results."},"CatalogItemBoundaryId":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"The unique identifier of the boundary item used for paginating results."},"Comparison":{"type":"string","enum":[">",">=","<","<="]},"Limit":{"type":"number"},"Order":{"type":"string","enum":["asc"]},"SearchQuery":{"type":"string"},"KeyIdName":{"type":"object","properties":{"Id":{"type":"string","maxLength":50,"description":"The unique identifier."},"Name":{"type":"string","maxLength":50,"description":"The name."}},"description":"Brand alias configuration, which allows mapping of the standard brand id and brand name keys to the corresponding keys stored in the catalog item."},"CatalogSearchableAttribute":{"oneOf":[{"type":"object","properties":{"Attribute":{"type":"string","maxLength":50,"description":"The name of the searchable attribute."},"ReferenceId":{"type":"number","minimum":100},"Type":{"type":"string","enum":["Referenced"],"description":"Referenced type of searchable attribute."},"Cardinality":{"anyOf":[{"type":"string","enum":["One"],"description":"One cardinality."},{"type":"string","enum":["Many"],"description":"Many cardinality."}],"description":"The cardinality of the searchable attribute."}},"required":["Attribute","ReferenceId","Type","Cardinality"]},{"type":"object","properties":{"Attribute":{"type":"string","maxLength":50,"description":"The name of the searchable attribute."},"Type":{"type":"string","enum":["Text"],"description":"Text type of searchable attribute."},"Cardinality":{"type":"string","enum":["One"],"description":"One cardinality."}},"required":["Attribute","Type","Cardinality"]},{"type":"object","properties":{"Attribute":{"type":"string","maxLength":50,"description":"The name of the searchable attribute."},"Type":{"type":"string","enum":["Array","Boolean","Number","Object","String"],"description":"The type of searchable attribute."},"Cardinality":{"anyOf":[{"type":"string","enum":["One"],"description":"One cardinality."},{"type":"string","enum":["Many"],"description":"Many cardinality."}],"description":"The cardinality of the searchable attribute."}},"required":["Attribute","Type","Cardinality"]}]},"UIConfiguration":{"type":"object","properties":{"Key":{"type":"string","maxLength":50,"description":"The key of the column to display."},"AllowedValues":{"anyOf":[{"type":"array","items":{"type":"number"}},{"type":"array","items":{"type":"string"}}],"description":"When a filter has a dropdown of items, the list of values will be limited to this list of IDs."},"AncestorsKey":{"type":"string","description":"Reference to the attribute name which represents the ancestors of a given item. Used in the display of filters where the items are of a hierarchical nature."},"DisplayColumn":{"type":"boolean","description":"Whether or not to display the attribute when viewing the record."},"DisplayFilter":{"type":"boolean","description":"Whether or not to display the filter for the attribute."},"FilterByOne":{"type":"boolean","description":"Whether or not to restrict filtering to a single value."},"FilterByRange":{"type":"boolean","description":"Whether or not to display the distinct values for the attribute in the filter dropdown."},"HideReferenceIds":{"type":"boolean","description":"Whether or not to hide the reference IDs so that only the label is shown."},"Label":{"type":"string","description":"Human readable label for the UI. If not provided, the attribute name will be used."},"Order":{"type":"number","description":"Order the component appears in the UI."},"Typeahead":{"type":"boolean","description":"Whether or not to display the distinct values for the attribute in the filter dropdown."}},"description":"Catalog UI configuration."},"CatalogInConfigurationItemFieldsType":{"type":"object","properties":{"Source":{"type":"string","enum":["ItemFields"]}},"required":["Source"],"description":"The data is stored within the item as fields on the item object."},"CatalogOutConfigurationReferencedType":{"type":"object","properties":{"Source":{"type":"string","enum":["Referenced"]},"ReferenceId":{"type":"number","minimum":100}},"required":["Source","ReferenceId"]},"CatalogOutConfigurationTypes":{"oneOf":[{"$ref":"#/components/schemas/CatalogInConfigurationItemFieldsType"},{"$ref":"#/components/schemas/CatalogOutConfigurationReferencedType"}],"discriminator":{"propertyName":"Source","mapping":{"ItemFields":"#/components/schemas/CatalogInConfigurationItemFieldsType","Referenced":"#/components/schemas/CatalogOutConfigurationReferencedType"}},"description":"The category configuration."},"CatalogOutConfiguration":{"type":"object","properties":{"Categories":{"$ref":"#/components/schemas/CatalogOutConfigurationTypes"},"Brands":{"allOf":[{"$ref":"#/components/schemas/CatalogOutConfigurationTypes"},{"description":"The brand configuration."}]},"Merchants":{"allOf":[{"$ref":"#/components/schemas/CatalogOutConfigurationTypes"},{"description":"The merchant configuration."}]}},"description":"The configuration for the catalog."},"CatalogOut":{"type":"object","properties":{"Aliases":{"type":"object","properties":{"Id":{"type":"string","maxLength":50,"description":"The unique identifier."},"Brand":{"$ref":"#/components/schemas/KeyIdName"},"Category":{"allOf":[{"$ref":"#/components/schemas/KeyIdName"},{"type":"object","properties":{"Categories":{"type":"string","maxLength":50,"description":"Array of categories that signify a category hierarchy."}}}],"description":"Category alias configuration, which allows mapping of the standard category id, name, and hierarchy array keys to the corresponding keys stored in the catalog item."},"Image":{"type":"string","maxLength":50,"description":"Image alias configuration, which allows mapping of the standard image url to the corresponding key stored in the catalog item."},"Merchant":{"allOf":[{"$ref":"#/components/schemas/KeyIdName"},{"description":"Merchant alias configuration, which allows mapping of the standard merchant id and merchant name keys to the corresponding keys stored in the catalog item."}]},"Name":{"type":"string","maxLength":50,"description":"Name alias configuration, which allows mapping of the standard name to the corresponding key stored in the catalog item."},"Product":{"allOf":[{"$ref":"#/components/schemas/KeyIdName"},{"description":"Product alias configuration, which allows mapping of the standard product id and product name keys to the corresponding keys stored in the catalog item."}]}},"required":["Id"],"description":"The alias configuration for the catalog. The alias configuration is used to map the raw data into kevel standardized keys, so for example if your unique identifier is **catalog_id** and your name is **catalog_name**, you can set the alias configuration to **{ \"Id\": \"catalog_id\", \"Name\": \"catalog_name\" }** to map your values to the standardized keys."},"SearchableAttributes":{"type":"array","items":{"$ref":"#/components/schemas/CatalogSearchableAttribute"},"description":"Declaration of extra attributes that will be present on items of the catalog that should be searchable."},"Name":{"type":"string","maxLength":100,"description":"The name of the catalog."},"UIConfiguration":{"type":"array","items":{"$ref":"#/components/schemas/UIConfiguration"},"description":"The UI configuration for the catalog."},"Type":{"type":"string","enum":["Product"],"description":"The type of the catalog."},"Id":{"type":"number","minimum":100},"Configuration":{"$ref":"#/components/schemas/CatalogOutConfiguration"}},"required":["Aliases","Name","Type","Id"]},"ResponseMessage":{"type":"object","properties":{"message":{"type":"string","description":"Message that was provided."}},"required":["message"]},"Error":{"type":"object","properties":{"Errors":{"type":"array","items":{"$ref":"#/components/schemas/ResponseMessage"},"description":"Collection of errors."}},"required":["Errors"]},"PaginationComparisonOperator":{"type":"string","enum":[">",">=","<","<="],"description":"The comparison operator to use for the boundary item."},"PaginationOrder":{"type":"string","enum":["asc"],"description":"The order of the items."},"CatalogOutListedScope":{"type":"object","properties":{"comparison":{"$ref":"#/components/schemas/PaginationComparisonOperator"},"limit":{"type":"number","minimum":1,"maximum":1000,"description":"The maximum number of items to return."},"order":{"$ref":"#/components/schemas/PaginationOrder"},"boundary-id":{"type":"number","minimum":100,"description":"The unique identifier of the boundary item used for paginating results."}}},"CatalogOutListed":{"type":"object","properties":{"Id":{"type":"number","minimum":100},"Name":{"type":"string","maxLength":100,"description":"The name of the catalog."},"Type":{"type":"string","enum":["Product"],"description":"The type of the catalog."}},"required":["Id","Name","Type"]},"Pagination":{"type":"object","properties":{"Metadata":{"type":"object","properties":{"Scope":{"$ref":"#/components/schemas/CatalogOutListedScope"}},"required":["Scope"],"description":"Information regarding the pagination."},"NextQuery":{"allOf":[{"$ref":"#/components/schemas/CatalogOutListedScope"},{"description":"Query to retrieve the next page of items. The absence of this field indicates that there are no more items to retrieve in that direction at the time of the request."}]},"PrevQuery":{"allOf":[{"$ref":"#/components/schemas/CatalogOutListedScope"},{"description":"Query to retrieve the previous page of items. The absence of this field indicates that there are no more items to retrieve in that direction at the time of the request."}]},"Items":{"type":"array","items":{"$ref":"#/components/schemas/CatalogOutListed"},"description":"Array of items retreived by the query. This is the main content of the response and should be used to display the items."}},"required":["Metadata","NextQuery","PrevQuery","Items"],"description":"Pagination response."},"ItemUri":{"type":"string","pattern":"^itemdb:\\/\\/(?<NetworkId>\\d+)\\/(?<TableId>\\d+)\\/(?<Id>.+)$","description":"The uri of the item."},"ItemFieldOut":{"type":"object","properties":{"Id":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"The unique identifier of the item."},"Name":{"type":"string","maxLength":100,"description":"The name of the item."},"Uri":{"$ref":"#/components/schemas/ItemUri"},"Type":{"type":"string","enum":["ItemFields"],"description":"The type of the item."}},"required":["Id","Name","Uri","Type"]},"CatalogItemIn":{"type":"object","additionalProperties":{},"description":"Item raw data."},"CatalogItemOut":{"type":"object","properties":{"Id":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"The unique identifier of the item."},"Name":{"type":"string","maxLength":100,"description":"The name of the item."},"Uri":{"$ref":"#/components/schemas/ItemUri"},"Brand":{"type":"object","properties":{"Id":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"The unique identifier."},"Name":{"type":"string","maxLength":100,"description":"The name."}},"description":"The brand information"},"Category":{"type":"object","properties":{"Id":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"The unique identifier."},"Name":{"type":"string","maxLength":100,"description":"The name."},"Categories":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]},"description":"Categories array."}},"description":"The category information"},"Image":{"type":"string","description":"The image url of the product."},"Merchant":{"type":"object","properties":{"Id":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"The unique identifier."},"Name":{"type":"string","maxLength":100,"description":"The name."}},"description":"The merchant information"},"Product":{"type":"object","properties":{"Id":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"The unique identifier."},"Name":{"type":"string","maxLength":100,"description":"The name."}},"description":"The product information"},"Data":{"$ref":"#/components/schemas/CatalogItemIn"},"Type":{"type":"string","enum":["Primary","Referenced"],"description":"The type of the item."}},"required":["Id","Name","Uri","Data","Type"]},"ItemOut":{"oneOf":[{"$ref":"#/components/schemas/ItemFieldOut"},{"$ref":"#/components/schemas/CatalogItemOut"}],"discriminator":{"propertyName":"Type","mapping":{"ItemFields":"#/components/schemas/ItemFieldOut","Primary":"#/components/schemas/CatalogItemOut","Referenced":"#/components/schemas/CatalogItemOut"}},"description":"Output item of the catalog, where we can support simple items, with a view of the future supporting items that have also been enriched with aliases and further parameters."},"ItemOutListedScope":{"type":"object","properties":{"comparison":{"$ref":"#/components/schemas/PaginationComparisonOperator"},"limit":{"type":"number","minimum":1,"maximum":1000,"description":"The maximum number of items to return."},"order":{"$ref":"#/components/schemas/PaginationOrder"},"q":{"type":["string","null"],"description":"The kevelog query to filter the items."},"boundary-id":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"The unique identifier of the boundary item used for paginating results."}}},"ItemFieldItemOutListed":{"type":"object","properties":{"Id":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"The unique identifier of the item."},"Type":{"type":"string","enum":["ItemFields"],"description":"The type of the item."},"Uri":{"$ref":"#/components/schemas/ItemUri"}},"required":["Id","Type","Uri"]},"CatalogItemOutListed":{"type":"object","properties":{"Id":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"The unique identifier of the item."},"Brand":{"type":"object","properties":{"Id":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"The unique identifier."},"Name":{"type":"string","maxLength":100,"description":"The name."}},"description":"The brand information"},"Category":{"type":"object","properties":{"Id":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"The unique identifier."},"Name":{"type":"string","maxLength":100,"description":"The name."},"Categories":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"}]},"description":"Categories array."}},"description":"The category information"},"Image":{"type":"string","description":"The image url of the product."},"Merchant":{"type":"object","properties":{"Id":{"anyOf":[{"type":"string"},{"type":"number"}],"description":"The unique identifier."},"Name":{"type":"string","maxLength":100,"description":"The name."}},"description":"The merchant information"},"Name":{"type":"string","maxLength":100,"description":"The name of the item."},"Type":{"type":"string","enum":["Primary","Referenced"],"description":"The type of the item."},"Uri":{"$ref":"#/components/schemas/ItemUri"}},"required":["Id","Name","Type","Uri"]},"ItemOutListed":{"oneOf":[{"$ref":"#/components/schemas/ItemFieldItemOutListed"},{"$ref":"#/components/schemas/CatalogItemOutListed"}],"discriminator":{"propertyName":"Type","mapping":{"ItemFields":"#/components/schemas/ItemFieldItemOutListed","Primary":"#/components/schemas/CatalogItemOutListed","Referenced":"#/components/schemas/CatalogItemOutListed"}}},"JobSubmission":{"type":"object","properties":{"Warnings":{"type":"array","items":{"$ref":"#/components/schemas/ResponseMessage"},"description":"Collection of warnings if any were provided."}}},"CatalogItemInBatchInput":{"type":"object","properties":{"Items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/CatalogItemIn"},{"description":"Catalog item data."}]},"minItems":1,"maxItems":1000,"description":"The items to be processed in the batch."}},"required":["Items"]},"CatalogItemInBatchUpdateInput":{"type":"object","properties":{"Items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/CatalogItemIn"},{"description":"Catalog item data."}]},"minItems":1,"maxItems":100,"description":"The items to be processed in the batch."}},"required":["Items"]},"CatalogItemInBatchDeleteInput":{"type":"object","properties":{"Items":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/CatalogItemIn"},{"description":"Catalog item data."}]},"minItems":1,"maxItems":1000,"description":"The items to be processed in the batch."}},"required":["Items"]}},"parameters":{"CatalogBoundaryId":{"schema":{"$ref":"#/components/schemas/CatalogBoundaryId"},"required":false,"description":"The boundary id to use for pagination.","name":"boundary-id","in":"query","examples":{"example1":{"value":null,"summary":"No Boundary"},"example2":{"value":101,"summary":"Id 101"},"example3":{"value":102,"summary":"Id 102"},"example4":{"value":103,"summary":"Id 103"}}},"CatalogItemBoundaryId":{"schema":{"$ref":"#/components/schemas/CatalogItemBoundaryId"},"required":false,"description":"The boundary id to use for pagination.","name":"boundary-id","in":"query","examples":{"example1":{"value":null,"summary":"No Boundary"},"example2":{"value":1,"summary":"Id 1 (Number)"},"example3":{"value":2,"summary":"Id 2 (Number)"},"example4":{"value":3,"summary":"Id 3 (Number)"},"example5":{"value":"531ed48c-f418-4452-86d6-91380c4574bb","summary":"Id 531ed48c-f418-4452-86d6-91380c4574bb (String)"},"example6":{"value":"item-id-123","summary":"Id item-id-123 (String)"},"example7":{"value":"product_1","summary":"Id product_1 (String)"}}},"Comparison":{"schema":{"$ref":"#/components/schemas/Comparison"},"required":false,"name":"comparison","in":"query","description":"The comparison operator to use, this requires the presence of the **boundary-id** parameter.","examples":{"example1":{"value":null,"summary":"No Comparison"},"example2":{"value":">","summary":"Greater Than"},"example3":{"value":">=","summary":"Greater Than or Equal To"},"example4":{"value":"<","summary":"Less Than"},"example5":{"value":"<=","summary":"Less Than or Equal To"}}},"Limit":{"schema":{"$ref":"#/components/schemas/Limit"},"required":false,"name":"limit","in":"query","description":"The number of items to return.","examples":{"example1":{"value":null,"summary":"No Limit"},"example2":{"value":10,"summary":"Limit 10"},"example3":{"value":20,"summary":"Limit 20"},"example4":{"value":30,"summary":"Limit 30"}}},"Order":{"schema":{"$ref":"#/components/schemas/Order"},"required":false,"name":"order","in":"query","description":"The sort order to return items in.","examples":{"example1":{"value":null,"summary":"No Order"},"example2":{"value":"asc","summary":"Ascending"}}},"SearchQuery":{"schema":{"$ref":"#/components/schemas/SearchQuery"},"required":false,"name":"q","in":"query","description":"\nURI encoded Kevelog ProductQuery syntax to search for items in the catalog. Kevelog queries consist of an array of clauses, where each clause contains a field/operator pair and a value: **[ [operator, field], value ]**. As shorthand, you can use just the field name for equality: **[ field, value ]**. Multiple clauses are combined with AND logic. Supported operators include **=**, **<**, **>**, **<=**, **>=**, **one-of**, **present?**, **matches**, and **matches-phrase** (text fields only). Fields must be defined within the parent catalog's **SearchableAttributes** array.\n\nThis same syntax is used by the *create-ads-from-product-query* task that is submitted to the Kevel jobs **/v1/jobs** endpoint. This search parameter enables you to test the query before submitting your job. More information on Kevelog can be found [here](https://dev.kevel.com/docs/creating-ads-from-products-via-api#product-ad-creation-details).","examples":{"example1":{"value":null,"summary":"No Search"},"example2":{"value":"%5B%20%5B%20%22brandName%22%2C%20%22cashewco%22%20%5D%20%5D","summary":"Search for 'brandName = \"cashewco\"'","description":"Kevelog = [ [ \"brandName\", \"cashewco\" ] ]"},"example3":{"value":"%5B%20%5B%20%5B%20%22one-of%22%2C%20%22merchantName%22%20%5D%20%5B%20%22merchant1%22%2C%20%22merchant2%22%2C%20%22merchant3%22%20%5D%20%5D%20%5D","summary":"Search for 'merchantName is one of \"merchant1\", \"merchant2\", \"merchant3\"'","description":"Kevelog = [ [ [ \"one-of\", \"merchantName\" ] [ \"merchant1\", \"merchant2\", \"merchant3\" ] ] ]"},"example4":{"value":"%5B%20%5B%20%5B%20%22one-of%22%2C%20%22merchantName%22%20%5D%20%5B%20%22merchant1%22%2C%20%22merchant2%22%2C%20%22merchant3%22%20%5D%20%5D%2C%20%5B%20%22brandName%22%2C%20%22cashewco%22%20%5D%20%5D","summary":"Search for 'merchantName is one of \"merchant1\", \"merchant2\", \"merchant3\" and brandName = \"cashewco\"'","description":"Kevelog = [ [ [ \"one-of\", \"merchantName\" ] [ \"merchant1\", \"merchant2\", \"merchant3\" ] ], [ \"brandName\", \"cashewco\" ] ]"},"example5":{"value":"%5B%20%5B%20%5B%20%22%3E%22%2C%20%22price%22%20%5D%2C%2050.00%20%5D%20%5D","summary":"Search for 'price > 50.00'","description":"Kevelog = [ [ [ \">\", \"price\" ], 50.00 ] ]"},"example6":{"value":"%5B%20%5B%20%5B%20%22%3C%3D%22%2C%20%22price%22%20%5D%2C%20100.00%20%5D%20%5D","summary":"Search for 'price <= 100.00'","description":"Kevelog = [ [ [ \"<=\", \"price\" ], 100.00 ] ]"},"example7":{"value":"%5B%20%5B%20%5B%20%22%3E%3D%22%2C%20%22price%22%20%5D%2C%2025.00%20%5D%2C%20%5B%20%5B%20%22%3C%3D%22%2C%20%22price%22%20%5D%2C%2075.00%20%5D%20%5D","summary":"Search for 'price between 25.00 and 75.00'","description":"Kevelog = [ [ [ \">=\", \"price\" ], 25.00 ], [ [ \"<=\", \"price\" ], 75.00 ] ]"},"example8":{"value":"%5B%20%5B%20%5B%20%22present%3F%22%2C%20%22description%22%20%5D%2C%20true%20%5D%20%5D","summary":"Search for items that have a description","description":"Kevelog = [ [ [ \"present?\", \"description\" ], true ] ]"},"example9":{"value":"%5B%20%5B%20%5B%20%22present%3F%22%2C%20%22onSale%22%20%5D%2C%20false%20%5D%20%5D","summary":"Search for items without an onSale field","description":"Kevelog = [ [ [ \"present?\", \"onSale\" ], false ] ]"},"example10":{"value":"%5B%20%5B%20%5B%20%22matches%22%2C%20%22description%22%20%5D%2C%20%22comfortable%26durable%22%20%5D%20%5D","summary":"Full-text search for \"comfortable AND durable\" in description","description":"Kevelog = [ [ [ \"matches\", \"description\" ], \"comfortable&durable\" ] ]"},"example11":{"value":"%5B%20%5B%20%5B%20%22matches-phrase%22%2C%20%22description%22%20%5D%2C%20%22high%20quality%20materials%22%20%5D%20%5D","summary":"Phrase search for \"high quality materials\" in description","description":"Kevelog = [ [ [ \"matches-phrase\", \"description\" ], \"high quality materials\" ] ]"},"example12":{"value":"%5B%20%5B%20%5B%20%22one-of%22%2C%20%22brandName%22%20%5D%2C%20%5B%20%22nike%22%2C%20%22adidas%22%20%5D%20%5D%2C%20%5B%20%5B%20%22%3E%22%2C%20%22price%22%20%5D%2C%2030.00%20%5D%2C%20%5B%20%5B%20%22present%3F%22%2C%20%22description%22%20%5D%2C%20true%20%5D%20%5D","summary":"Complex: Nike or Adidas products over $30 with descriptions","description":"Kevelog = [ [ [ \"one-of\", \"brandName\" ], [ \"nike\", \"adidas\" ] ], [ [ \">\", \"price\" ], 30.00 ], [ [ \"present?\", \"description\" ], true ] ]"}}}}},"paths":{"/v1/catalog/{catalogId}":{"get":{"operationId":"getCatalog","tags":["Catalogs"],"summary":"Get Catalog","description":"Retrieve the specified catalog. This will include the alias configuration, how the item parameters should be represented in a GUI, as well as read-only information about how brands, categories and merchants have been setup in the catalog system.","parameters":[{"schema":{"type":"number","minimum":100},"required":true,"name":"catalogId","in":"path"}],"responses":{"200":{"description":"Catalog retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogOut"},"examples":{"example1":{"summary":"Retrieved Catalog Example 1","value":{"Type":"Product","Id":101,"Name":"Product Catalog 1","Aliases":{"Id":"item_id","Name":"item_name","Image":"item_image","Brand":{"Id":"brand_id","Name":"brand_name"},"Category":{"Id":"category_id","Name":"category_name","Categories":"category_ids"},"Merchant":{"Id":"merchant_id","Name":"merchant_name"},"Product":{"Id":"product_id","Name":"product_name"}},"Configuration":{"Brands":{"Source":"ItemFields"},"Categories":{"Source":"ItemFields"},"Merchants":{"Source":"ItemFields"}}}},"example2":{"summary":"Retrieved Catalog Example 2","value":{"Type":"Product","Id":102,"Name":"Product Catalog 2","Aliases":{"Id":"item_id","Name":"item_name","Image":"item_image","Brand":{"Id":"brand_id","Name":"brand_name"},"Category":{"Id":"category_id","Name":"category_name","Categories":"category_ids"},"Merchant":{"Id":"merchant_id","Name":"merchant_name"},"Product":{"Id":"product_id","Name":"product_name"}},"Configuration":{"Brands":{"Source":"ItemFields"},"Categories":{"Source":"ItemFields"},"Merchants":{"Source":"ItemFields"}}}},"example3":{"summary":"Retrieved Catalog Example 3","value":{"Type":"Product","Id":103,"Name":"Product Catalog 3","Aliases":{"Id":"item_id","Name":"item_name","Image":"item_image","Brand":{"Id":"brand_id","Name":"brand_name"},"Category":{"Id":"category_id","Name":"category_name","Categories":"category_ids"},"Merchant":{"Id":"merchant_id","Name":"merchant_name"},"Product":{"Id":"product_id","Name":"product_name"}},"Configuration":{"Brands":{"Source":"ItemFields"},"Categories":{"Source":"ItemFields"},"Merchants":{"Source":"ItemFields"}}}}}}}},"400":{"description":"Bad request with errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"summary":{"summary":"Single Error Response","value":{"Errors":[{"message":"Error message 1."}]}},"multiple":{"summary":"Multiple Errors Response","value":{"Errors":[{"message":"Something went wrong."},{"message":"Something else went wrong."},{"message":"Another error."}]}}}}}}}}},"/v1/catalog":{"get":{"operationId":"listCatalogs","tags":["Catalogs"],"summary":"List Catalogs","description":"Retrieve a summarized list of catalogs.","parameters":[{"$ref":"#/components/parameters/CatalogBoundaryId"},{"$ref":"#/components/parameters/Comparison"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Order"}],"responses":{"200":{"description":"List of catalogs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pagination"},"examples":{"example1":{"summary":"List Catalogs Example 1","value":{"Items":[{"Id":100,"Name":"Product Catalog 0","Type":"Product"},{"Id":101,"Name":"Product Catalog 1","Type":"Product"},{"Id":102,"Name":"Product Catalog 2","Type":"Product"},{"Id":103,"Name":"Product Catalog 3","Type":"Product"},{"Id":104,"Name":"Product Catalog 4","Type":"Product"},{"Id":105,"Name":"Product Catalog 5","Type":"Product"},{"Id":106,"Name":"Product Catalog 6","Type":"Product"},{"Id":107,"Name":"Product Catalog 7","Type":"Product"},{"Id":108,"Name":"Product Catalog 8","Type":"Product"},{"Id":109,"Name":"Product Catalog 9","Type":"Product"}],"Metadata":{"Scope":{"comparison":">=","limit":10,"order":"asc"}},"NextQuery":{"comparison":">=","limit":10,"order":"asc","boundary-id":10},"PrevQuery":{"comparison":"<","limit":10,"order":"asc","boundary-id":1}}}}}}},"400":{"description":"Bad request with errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"summary":{"summary":"Single Error Response","value":{"Errors":[{"message":"Error message 1."}]}},"multiple":{"summary":"Multiple Errors Response","value":{"Errors":[{"message":"Something went wrong."},{"message":"Something else went wrong."},{"message":"Another error."}]}}}}}}}}},"/v1/catalog/{catalogId}/{item}/{id}":{"get":{"operationId":"getItem","tags":["Catalog Items"],"summary":"Get Catalog Item","description":"Retrieve the specified Item from the given catalog.","parameters":[{"schema":{"type":"number","minimum":100},"required":true,"name":"catalogId","in":"path"},{"schema":{"type":"string","enum":["product","brand","category","merchant"],"description":"Permitted item types."},"required":true,"description":"Permitted item types.","name":"item","in":"path"},{"schema":{"type":"string","description":"Unique identifier of Item."},"required":true,"description":"Unique identifier of Item.","name":"id","in":"path"}],"responses":{"200":{"description":"Item retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemOut"},"examples":{"example1":{"summary":"Primary Item Catalog Example 1","value":{"Type":"Primary","Id":"1","Name":"Item Name 1","Image":"https://example.com/image1.jpg","Data":{"item_id":"1","item_name":"Item Name 1","item_description":"Item Description 1 Taken from a Primary Catalog","item_image":"https://example.com/image1.jpg","item_url":"https://example.com/item/1"},"Uri":"itemdb://10055/107/1"}},"example2":{"summary":"Primary Item Catalog Example 2","value":{"Type":"Primary","Id":"2","Name":"Item Name 2","Image":"https://example.com/image1.jpg","Data":{"item_id":"2","item_name":"Item Name 2","item_description":"Item Description 2 Taken from a Primary Catalog","item_image":"https://example.com/image1.jpg","item_url":"https://example.com/item/2"},"Uri":"itemdb://10100/101/2"}},"example3":{"summary":"Referenced Item Catalog Example 1","value":{"Type":"Referenced","Id":"3","Name":"Item Name 3","Image":"https://example.com/image1.jpg","Data":{"item_id":"3","item_name":"Item Name 3","item_description":"Item Description 3 Taken from a Primary Catalog","item_image":"https://example.com/image1.jpg","item_url":"https://example.com/item/3"},"Uri":"itemdb://15000/102/3"}}}}}},"400":{"description":"Bad request with errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"summary":{"summary":"Single Error Response","value":{"Errors":[{"message":"Error message 1."}]}},"multiple":{"summary":"Multiple Errors Response","value":{"Errors":[{"message":"Something went wrong."},{"message":"Something else went wrong."},{"message":"Another error."}]}}}}}}}}},"/v1/catalog/{catalogId}/{item}":{"get":{"operationId":"listItem","tags":["Catalog Items"],"summary":"List Catalog Items","description":"Retrieve list of Items from specified catalog.","parameters":[{"schema":{"type":"number","minimum":100},"required":true,"name":"catalogId","in":"path"},{"schema":{"type":"string","enum":["product","brand","category","merchant"],"description":"Permitted item types."},"required":true,"description":"Permitted item types.","name":"item","in":"path"},{"$ref":"#/components/parameters/CatalogItemBoundaryId"},{"$ref":"#/components/parameters/Comparison"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/Order"},{"$ref":"#/components/parameters/SearchQuery"}],"responses":{"200":{"description":"List of Items.","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Pagination"},{"properties":{"Metadata":{"type":"object","properties":{"Scope":{"$ref":"#/components/schemas/ItemOutListedScope"}},"required":["Scope"],"description":"Information regarding the pagination."},"NextQuery":{"allOf":[{"$ref":"#/components/schemas/ItemOutListedScope"},{"description":"Query to retrieve the next page of items. The absence of this field indicates that there are no more items to retrieve in that direction at the time of the request."}]},"PrevQuery":{"allOf":[{"$ref":"#/components/schemas/ItemOutListedScope"},{"description":"Query to retrieve the previous page of items. The absence of this field indicates that there are no more items to retrieve in that direction at the time of the request."}]},"Items":{"type":"array","items":{"$ref":"#/components/schemas/ItemOutListed"},"description":"Array of items retreived by the query. This is the main content of the response and should be used to display the items."}}}]},"examples":{"example1":{"summary":"List of Items Example [ItemFields]","value":{"Items":[{"Id":"0","Type":"ItemFields","Uri":"itemdb://10055/107/0"},{"Id":"1","Type":"ItemFields","Uri":"itemdb://10055/107/1"},{"Id":"2","Type":"ItemFields","Uri":"itemdb://10055/107/2"},{"Id":"3","Type":"ItemFields","Uri":"itemdb://10055/107/3"},{"Id":"4","Type":"ItemFields","Uri":"itemdb://10055/107/4"},{"Id":"5","Type":"ItemFields","Uri":"itemdb://10055/107/5"},{"Id":"6","Type":"ItemFields","Uri":"itemdb://10055/107/6"},{"Id":"7","Type":"ItemFields","Uri":"itemdb://10055/107/7"},{"Id":"8","Type":"ItemFields","Uri":"itemdb://10055/107/8"},{"Id":"9","Type":"ItemFields","Uri":"itemdb://10055/107/9"}],"Metadata":{"Scope":{"comparison":">=","limit":10,"order":"asc"}},"NextQuery":{"comparison":">=","limit":10,"order":"asc","boundary-id":10},"PrevQuery":{"comparison":"<","limit":10,"order":"asc","boundary-id":1}}},"example2":{"summary":"List of Items Example [Catalog No References]","value":{"Items":[{"Id":"0","Image":"https://example.com/image1.jpg","Name":"Item Name 0","Type":"Primary","Uri":"itemdb://10055/107/0"},{"Id":"1","Image":"https://example.com/image1.jpg","Name":"Item Name 1","Type":"Primary","Uri":"itemdb://10055/107/1"},{"Id":"2","Image":"https://example.com/image1.jpg","Name":"Item Name 2","Type":"Primary","Uri":"itemdb://10055/107/2"},{"Id":"3","Image":"https://example.com/image1.jpg","Name":"Item Name 3","Type":"Primary","Uri":"itemdb://10055/107/3"},{"Id":"4","Image":"https://example.com/image1.jpg","Name":"Item Name 4","Type":"Primary","Uri":"itemdb://10055/107/4"},{"Id":"5","Image":"https://example.com/image1.jpg","Name":"Item Name 5","Type":"Primary","Uri":"itemdb://10055/107/5"},{"Id":"6","Image":"https://example.com/image1.jpg","Name":"Item Name 6","Type":"Primary","Uri":"itemdb://10055/107/6"},{"Id":"7","Image":"https://example.com/image1.jpg","Name":"Item Name 7","Type":"Primary","Uri":"itemdb://10055/107/7"},{"Id":"8","Image":"https://example.com/image1.jpg","Name":"Item Name 8","Type":"Primary","Uri":"itemdb://10055/107/8"},{"Id":"9","Image":"https://example.com/image1.jpg","Name":"Item Name 9","Type":"Primary","Uri":"itemdb://10055/107/9"}],"Metadata":{"Scope":{"comparison":">=","limit":10,"order":"asc"}},"NextQuery":{"comparison":">=","limit":10,"order":"asc","boundary-id":10},"PrevQuery":{"comparison":"<","limit":10,"order":"asc","boundary-id":1}}},"example3":{"summary":"List of Items Example [Catalog With References]","value":{"Items":[{"Id":"0","Brand":{"Id":"Item Brand 0","Name":"Item Brand 0"},"Category":{"Id":"Item Category 0","Name":"Item Category 0"},"Image":"https://example.com/image1.jpg","Merchant":{"Id":"Item Merchant 0","Name":"Item Merchant 0"},"Name":"Item Name 0","Type":"Primary","Uri":"itemdb://10055/107/0"},{"Id":"1","Brand":{"Id":"Item Brand 1","Name":"Item Brand 1"},"Category":{"Id":"Item Category 1","Name":"Item Category 1"},"Image":"https://example.com/image1.jpg","Merchant":{"Id":"Item Merchant 1","Name":"Item Merchant 1"},"Name":"Item Name 1","Type":"Primary","Uri":"itemdb://10055/107/1"},{"Id":"2","Brand":{"Id":"Item Brand 2","Name":"Item Brand 2"},"Category":{"Id":"Item Category 2","Name":"Item Category 2"},"Image":"https://example.com/image1.jpg","Merchant":{"Id":"Item Merchant 2","Name":"Item Merchant 2"},"Name":"Item Name 2","Type":"Primary","Uri":"itemdb://10055/107/2"},{"Id":"3","Brand":{"Id":"Item Brand 3","Name":"Item Brand 3"},"Category":{"Id":"Item Category 3","Name":"Item Category 3"},"Image":"https://example.com/image1.jpg","Merchant":{"Id":"Item Merchant 3","Name":"Item Merchant 3"},"Name":"Item Name 3","Type":"Primary","Uri":"itemdb://10055/107/3"},{"Id":"4","Brand":{"Id":"Item Brand 4","Name":"Item Brand 4"},"Category":{"Id":"Item Category 4","Name":"Item Category 4"},"Image":"https://example.com/image1.jpg","Merchant":{"Id":"Item Merchant 4","Name":"Item Merchant 4"},"Name":"Item Name 4","Type":"Primary","Uri":"itemdb://10055/107/4"},{"Id":"5","Brand":{"Id":"Item Brand 5","Name":"Item Brand 5"},"Category":{"Id":"Item Category 5","Name":"Item Category 5"},"Image":"https://example.com/image1.jpg","Merchant":{"Id":"Item Merchant 5","Name":"Item Merchant 5"},"Name":"Item Name 5","Type":"Primary","Uri":"itemdb://10055/107/5"},{"Id":"6","Brand":{"Id":"Item Brand 6","Name":"Item Brand 6"},"Category":{"Id":"Item Category 6","Name":"Item Category 6"},"Image":"https://example.com/image1.jpg","Merchant":{"Id":"Item Merchant 6","Name":"Item Merchant 6"},"Name":"Item Name 6","Type":"Primary","Uri":"itemdb://10055/107/6"},{"Id":"7","Brand":{"Id":"Item Brand 7","Name":"Item Brand 7"},"Category":{"Id":"Item Category 7","Name":"Item Category 7"},"Image":"https://example.com/image1.jpg","Merchant":{"Id":"Item Merchant 7","Name":"Item Merchant 7"},"Name":"Item Name 7","Type":"Primary","Uri":"itemdb://10055/107/7"},{"Id":"8","Brand":{"Id":"Item Brand 8","Name":"Item Brand 8"},"Category":{"Id":"Item Category 8","Name":"Item Category 8"},"Image":"https://example.com/image1.jpg","Merchant":{"Id":"Item Merchant 8","Name":"Item Merchant 8"},"Name":"Item Name 8","Type":"Primary","Uri":"itemdb://10055/107/8"},{"Id":"9","Brand":{"Id":"Item Brand 9","Name":"Item Brand 9"},"Category":{"Id":"Item Category 9","Name":"Item Category 9"},"Image":"https://example.com/image1.jpg","Merchant":{"Id":"Item Merchant 9","Name":"Item Merchant 9"},"Name":"Item Name 9","Type":"Primary","Uri":"itemdb://10055/107/9"}],"Metadata":{"Scope":{"comparison":">=","limit":10,"order":"asc"}},"NextQuery":{"comparison":">=","limit":10,"order":"asc","boundary-id":10},"PrevQuery":{"comparison":"<","limit":10,"order":"asc","boundary-id":1}}}}}}},"400":{"description":"Bad request with errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"summary":{"summary":"Single Error Response","value":{"Errors":[{"message":"Error message 1."}]}},"multiple":{"summary":"Multiple Errors Response","value":{"Errors":[{"message":"Something went wrong."},{"message":"Something else went wrong."},{"message":"Another error."}]}}}}}}}}},"/v1/catalog/{catalogId}/{item}/batch/upsert":{"post":{"operationId":"upsertItemBatch","tags":["Catalog Items"],"summary":"Upsert Multiple Catalog Items","description":"Upsert a batch of Items to the specified catalog, where if the Item id(s) don't exist they will be created and if they exist the Item will be updated.","parameters":[{"schema":{"type":"number","minimum":100},"required":true,"name":"catalogId","in":"path"},{"schema":{"type":"string","enum":["product","brand","category","merchant"],"description":"Permitted item types."},"required":true,"description":"Permitted item types.","name":"item","in":"path"}],"requestBody":{"description":"The Items to upsert.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogItemInBatchInput"},"examples":{"example1":{"summary":"Upsert Items in Batch Example 1","value":{"Items":[{"item_id":"0","item_name":"Item Name 0","item_description":"Item Description 0 Taken from a Primary Catalog","item_image":"https://example.com/image1.jpg","item_url":"https://example.com/item/0"},{"item_id":"1","item_name":"Item Name 1","item_description":"Item Description 1 Taken from a Primary Catalog","item_image":"https://example.com/image1.jpg","item_url":"https://example.com/item/1"},{"item_id":"2","item_name":"Item Name 2","item_description":"Item Description 2 Taken from a Primary Catalog","item_image":"https://example.com/image1.jpg","item_url":"https://example.com/item/2"},{"item_id":"3","item_name":"Item Name 3","item_description":"Item Description 3 Taken from a Primary Catalog","item_image":"https://example.com/image1.jpg","item_url":"https://example.com/item/3"},{"item_id":"4","item_name":"Item Name 4","item_description":"Item Description 4 Taken from a Primary Catalog","item_image":"https://example.com/image1.jpg","item_url":"https://example.com/item/4"},{"item_id":"5","item_name":"Item Name 5","item_description":"Item Description 5 Taken from a Primary Catalog","item_image":"https://example.com/image1.jpg","item_url":"https://example.com/item/5"},{"item_id":"6","item_name":"Item Name 6","item_description":"Item Description 6 Taken from a Primary Catalog","item_image":"https://example.com/image1.jpg","item_url":"https://example.com/item/6"},{"item_id":"7","item_name":"Item Name 7","item_description":"Item Description 7 Taken from a Primary Catalog","item_image":"https://example.com/image1.jpg","item_url":"https://example.com/item/7"},{"item_id":"8","item_name":"Item Name 8","item_description":"Item Description 8 Taken from a Primary Catalog","item_image":"https://example.com/image1.jpg","item_url":"https://example.com/item/8"},{"item_id":"9","item_name":"Item Name 9","item_description":"Item Description 9 Taken from a Primary Catalog","item_image":"https://example.com/image1.jpg","item_url":"https://example.com/item/9"}]}}}}}},"responses":{"200":{"description":"Items upsert request successfully submitted to Kevel.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobSubmission"},"examples":{"example1":{"summary":"Upserted Items Example 1 (No Warnings)","value":{}},"example2":{"summary":"Upserted Items Example 2 (With Warnings)","value":{"Warnings":[{"message":"Warning message 1."},{"message":"Warning message 2."},{"message":"Warning message 3."}]}}}}}},"400":{"description":"Bad request with errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"summary":{"summary":"Single Error Response","value":{"Errors":[{"message":"Error message 1."}]}},"multiple":{"summary":"Multiple Errors Response","value":{"Errors":[{"message":"Something went wrong."},{"message":"Something else went wrong."},{"message":"Another error."}]}}}}}}}}},"/v1/catalog/{catalogId}/{item}/batch/update":{"patch":{"operationId":"partialUpdateItemBatch","tags":["Catalog Items"],"summary":"Partially Update Multiple Catalog Items","description":"Partially updates a batch of Items in the specified catalog. This will update only the given parameters for any Item ids that exist in the catalog.","parameters":[{"schema":{"type":"number","minimum":100},"required":true,"name":"catalogId","in":"path"},{"schema":{"type":"string","enum":["product","brand","category","merchant"],"description":"Permitted item types."},"required":true,"description":"Permitted item types.","name":"item","in":"path"}],"requestBody":{"description":"The Items to partially update.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogItemInBatchUpdateInput"},"examples":{"example1":{"summary":"Partially Update Items in Batch Example 1","value":{"Items":[{"item_id":"0","item_name":"Item Name 0","item_description":"Item Description 0 Taken from a Primary Catalog","item_image":"https://example.com/image1.jpg","item_url":"https://example.com/item/0"},{"item_id":"1","item_name":"Item Name 1","item_description":"Item Description 1 Taken from a Primary Catalog","item_image":"https://example.com/image1.jpg","item_url":"https://example.com/item/1"},{"item_id":"2","item_name":"Item Name 2","item_description":"Item Description 2 Taken from a Primary Catalog","item_image":"https://example.com/image1.jpg","item_url":"https://example.com/item/2"},{"item_id":"3","item_name":"Item Name 3","item_description":"Item Description 3 Taken from a Primary Catalog","item_image":"https://example.com/image1.jpg","item_url":"https://example.com/item/3"},{"item_id":"4","item_name":"Item Name 4","item_description":"Item Description 4 Taken from a Primary Catalog","item_image":"https://example.com/image1.jpg","item_url":"https://example.com/item/4"},{"item_id":"5","item_name":"Item Name 5","item_description":"Item Description 5 Taken from a Primary Catalog","item_image":"https://example.com/image1.jpg","item_url":"https://example.com/item/5"},{"item_id":"6","item_name":"Item Name 6","item_description":"Item Description 6 Taken from a Primary Catalog","item_image":"https://example.com/image1.jpg","item_url":"https://example.com/item/6"},{"item_id":"7","item_name":"Item Name 7","item_description":"Item Description 7 Taken from a Primary Catalog","item_image":"https://example.com/image1.jpg","item_url":"https://example.com/item/7"},{"item_id":"8","item_name":"Item Name 8","item_description":"Item Description 8 Taken from a Primary Catalog","item_image":"https://example.com/image1.jpg","item_url":"https://example.com/item/8"},{"item_id":"9","item_name":"Item Name 9","item_description":"Item Description 9 Taken from a Primary Catalog","item_image":"https://example.com/image1.jpg","item_url":"https://example.com/item/9"}]}}}}}},"responses":{"200":{"description":"Items update request successfully submitted to Kevel.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobSubmission"},"examples":{"example1":{"summary":"Updated Items Example 1 (No Warnings)","value":{}},"example2":{"summary":"Updated Items Example 2 (With Warnings)","value":{"Warnings":[{"message":"Warning message 1."},{"message":"Warning message 2."},{"message":"Warning message 3."}]}}}}}},"400":{"description":"Bad request with errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"summary":{"summary":"Single Error Response","value":{"Errors":[{"message":"Error message 1."}]}},"multiple":{"summary":"Multiple Errors Response","value":{"Errors":[{"message":"Something went wrong."},{"message":"Something else went wrong."},{"message":"Another error."}]}}}}}}}}},"/v1/catalog/{catalogId}/{item}/batch/delete":{"post":{"operationId":"deleteItemBatch","tags":["Catalog Items"],"summary":"Delete Multiple Catalog Items","description":"Delete a batch of Items from the specified catalog, where any Item ids that don't exist will be silently ignored.","parameters":[{"schema":{"type":"number","minimum":100},"required":true,"name":"catalogId","in":"path"},{"schema":{"type":"string","enum":["product","brand","category","merchant"],"description":"Permitted item types."},"required":true,"description":"Permitted item types.","name":"item","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogItemInBatchDeleteInput"},"examples":{"example1":{"summary":"Delete Items in Batch Example 1","value":{"Items":[{"item_id":"0"},{"item_id":"1"},{"item_id":"2"},{"item_id":"3"},{"item_id":"4"},{"item_id":"5"},{"item_id":"6"},{"item_id":"7"},{"item_id":"8"},{"item_id":"9"}]}}}}}},"responses":{"200":{"description":"Items deletion request successfully submitted to Kevel.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobSubmission"},"examples":{"example1":{"summary":"Deleted Items Example 1 (No Warnings)","value":{}},"example2":{"summary":"Deleted Items Example 2 (With Warnings)","value":{"Warnings":[{"message":"Warning message 1."},{"message":"Warning message 2."},{"message":"Warning message 3."}]}}}}}},"400":{"description":"Bad request with errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"},"examples":{"summary":{"summary":"Single Error Response","value":{"Errors":[{"message":"Error message 1."}]}},"multiple":{"summary":"Multiple Errors Response","value":{"Errors":[{"message":"Something went wrong."},{"message":"Something else went wrong."},{"message":"Another error."}]}}}}}}}}}},"webhooks":{}}