# 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/_spec/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)

## Orders

### 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): 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  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 FrequencyRecommended usage: Send update as soon as the action is completedMaximum 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): 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 FrequencyRecommended usage: Once per order when the anonymization date is setMaximum usage: Every time the anonymization date needs to be changed

### upsertOrders - Upsert orders

 - [POST /v1/orders](https://developer.mirakl.com/content/product/connect-channel-platform/rest/connect/openapi3/orders/upsertorders.md): 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): Updates the store catalog items for a specific channel with the provided product IDs

## 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): 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.


## Taxonomy

### 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)

## Returns

### upsertReturns - Upsert returns

 - [POST /v1/orders/returns](https://developer.mirakl.com/content/product/connect-channel-platform/rest/connect/openapi3/returns/upsertreturns.md): Use this API to synchronize returns 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 return data.Call FrequencyRecommended usage: Every 5 minutesMaximum usage: Once per minute