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. This API is replacing all data at once. Developer have to provide the complete state every time.
Input to update business information of a store
Currency tag, expected in ISO 4217 format. Cannot be changed later.
KYC (Know Your Customer) status of the configuration. If KYC is not required, the status will be set to NOT_REQUIRED.
Enum: "PENDING_SUBMISSION", "PENDING_APPROVAL", "REFUSED", "APPROVED", "NOT_REQUIRED"
Reason of a problem with the KYC configuration. This information can be displayed to the seller if needed in Mirakl Connect
Indicates if the store is missing configuration to be properly functioning. This can be either required information not filled or documents not sent. False indicates that there is no missing configuration for the store. True will raise a warning to the seller stating that they need to configure their store.
Reason of a problem with the payment configuration. A null value indicates no problems encountered, payment configuration is valid. Any content will raise a warning in Mirakl Connect for the seller stating that there might be a problem with how their payment method is configured in the Marketplace where their store is located.
List of reasons for the suspension of the store related to quality standard defined by the Marketplace. A null or empty value indicates no problems encountered, store is not suspended. Any content will raise a warning in Mirakl Connect for the seller stating that there might be quality issues with their store.
Reason of a problem with the shipping configuration. A null value indicates no problems encountered, shipping configuration is valid.
List of sales channels inside the Marketplace where the store is located. This is useful for marketplaces where sellers have a global product catalog with multiple sales channels. One store can be provided per seller with as many sub channels as the sales channels the store operates in. By doing so, the store will receive offers, prices and stock updates per sub channel. Product events will come once for the store.
Sub channels are a critical part, it can impact the business of a seller. By deleting one the seller participates in, all offers synchronization will stop for the marketplace sales channel it relates to. Orders should also not be sent anymore to Connect.
Behavior for the sub channel field:
- Can be null if it was never filled before.
- Can be an empty array if it was never filled before.
- Cannot be emptied if there was at least one item before. How to:
- Add a new sub channel: add it to the list.
- Update an existing sub channel: update the item in the list with the same id.
- Delete an existing sub channel: remove it from the list.
- Connect Channel Platform APIhttps://miraklconnect.com/api/channel-platform/v1/channels/{channel_id}/stores/{channel_store_id}
curl -i -X PUT \
'https://miraklconnect.com/api/channel-platform/v1/channels/{channel_id}/stores/{channel_store_id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"currency": "USD",
"kyc_status": "PENDING_SUBMISSION",
"kyc_status_reason": "string",
"shipping_warning": "string",
"payment_information_warning": "string",
"payment_information_configured": true,
"quality_suspension_reasons": [
{
"rule": "Evaluation Grade last month was lower than 3.5 expected to never be lower than 4.0",
"period": "Last month",
"rule_comparison_method": "lower than",
"rule_type": "DECIMAL",
"stat_value": 3.5,
"threshold": 0
}
],
"sub_channels": [
{
"id": "12345",
"name": "Premium Sellers",
"currency": "USD"
}
],
"missing_configuration": true,
"updated_at": "2023-03-28T09:34:42Z"
}'