# Mirakl Connect Channel Platform APIs {% partial file="/partial-content/product/connect-channel-platform/rest/connect/openapi-description.md" /%} ## Servers Connect Channel Platform API ``` https://miraklconnect.com/api/channel-platform ``` ## Security ### Bearer Type: http Scheme: bearer Bearer Format: JWT ## Download OpenAPI description [Mirakl Connect Channel Platform APIs](https://developer.mirakl.com/_bundle/content/product/connect-channel-platform/rest/connect/openapi3.yaml) ## Catalog Configuration ### configureChannelCatalog - Configure Catalog capabilities for a channel - [POST /v1/catalog-configuration/channels/{channel_id}](https://developer.mirakl.com/content/product/connect-channel-platform/rest/connect/openapi3/catalog-configuration/configurechannelcatalog.md) ## Taxonomy ### createTaxonomyRule - Create a Taxonomy Rule - [PUT /v1/taxonomy/channels/{channel_id}/rules](https://developer.mirakl.com/content/product/connect-channel-platform/rest/connect/openapi3/taxonomy/createtaxonomyrule.md) ### upsertProductType - Create or Update a Product Type - [PUT /v1/taxonomy/channels/{channel_id}/product-types](https://developer.mirakl.com/content/product/connect-channel-platform/rest/connect/openapi3/taxonomy/upsertproducttype.md) ## Orders ### deleteOrderDocument - Delete order document - [DELETE /v1/orders/documents/{channel_document_id}](https://developer.mirakl.com/content/product/connect-channel-platform/rest/connect/openapi3/orders/deleteorderdocument.md): Description Use this API to delete a document. Call Frequency Recommended usage: On each document deletion on the order Maximum usage: On each document deletion on the order ### updateActionStatus - Update asynchronous action status - [PUT /v1/orders/actions/{action_id}](https://developer.mirakl.com/content/product/connect-channel-platform/rest/connect/openapi3/orders/updateactionstatus.md): Description Updates the final status of an asynchronous action previously initiated through a command event. ## Overview - When an asynchronous action is requested via command event, an action_id is provided to track the action - Use this endpoint to report the final outcome (SUCCESS or FAILURE) of the action - For failed actions, detailed error information must be provided ## Usage Notes - Update should be sent once the action is fully completed - Multiple errors can be provided for failed actions - The action ID must match the one provided in the original command event Call Frequency Recommended usage: Send update as soon as the action is completed Maximum usage: Once per action completion ### updateAnonymizeAfterDate - Update anonymization date for orders - [PUT /v1/orders/anonymize-after](https://developer.mirakl.com/content/product/connect-channel-platform/rest/connect/openapi3/orders/updateanonymizeafterdate.md): Description Updates the anonymization date for orders in the Mirakl Connect platform. Use this API to indicated after which date orders should be anonymized by Connect. The anonymization process is irreversible and should be used with caution. Call Frequency Recommended usage: Once per order when the anonymization date is set Maximum usage: Every time the anonymization date needs to be changed ### uploadOrderDocument - Upload order document - [POST /v1/orders/{channel_order_id}/documents](https://developer.mirakl.com/content/product/connect-channel-platform/rest/connect/openapi3/orders/uploadorderdocument.md): Description Use this API to upload a document for an order or its related entities (e.g. returns). Call Frequency Recommended usage: On each new document on the order Maximum usage: On each new document on the order ### upsertOrders - Upsert orders - [POST /v1/orders](https://developer.mirakl.com/content/product/connect-channel-platform/rest/connect/openapi3/orders/upsertorders.md): Description Use this API to synchronize orders with Mirakl Connect. This API does not support PATCH operations. All fields must be sent with each upsert request to ensure the complete update of the order data. ## Product Feedback ### updateStoreCatalogItems - Update Store Catalog Items for a given channel - [POST /v1/channel-catalog/{channel_id}/store-catalog-items/{store_id}](https://developer.mirakl.com/content/product/connect-channel-platform/rest/connect/openapi3/product-feedback/updatestorecatalogitems.md): Description Updates the store catalog items for a specific channel with the provided product IDs. Behavior: - If the specified store does not exist in Mirakl Connect, a 404 error is returned. - This is an asynchronous operation - the request is accepted and processed in the background. - Products that do not exist in Mirakl Connect are silently ignored (no error returned when the request is accepted). - Successfully matched products will be updated regardless of unmatched products in the same request. ## Store ### upsertBusinessInformation - Update business information of a store - [PUT /v1/channels/{channel_id}/stores/{channel_store_id}](https://developer.mirakl.com/content/product/connect-channel-platform/rest/connect/openapi3/store/upsertbusinessinformation.md): Description Update business information of a store. Those information will be displayed to the seller in Mirakl Connect. They are mandatory to consider a store as usable in Mirakl Connect. ## Returns ### upsertReturns - Upsert returns - [POST /v1/orders/returns](https://developer.mirakl.com/content/product/connect-channel-platform/rest/connect/openapi3/returns/upsertreturns.md): Description Use this API to synchronize returns with Mirakl Connect. ## Overview - Returns are always associated to an order already known by Mirakl Connect - Each return line must reference an order line already known by Mirakl Connect - The API performs an upsert: existing returns are updated, new ones are created - The operation is partially successful: some returns in the payload can succeed while others fail ## Usage Notes - The channel_order_id must reference an order previously synchronized through the orders API - Each channel_order_line_id in return_lines must reference an order line previously synchronized through the orders API - This API does not support PATCH operations. Always send all fields for each return. - When the request is syntactically valid, HTTP status is 200 even if some or all returns failed - Global failures are reported with standard HTTP errors: 400 for invalid payloads and 404 for unknown global resources (such as channel or store). Call Frequency Recommended usage: Every 5 minutes Maximum usage: Once per minute