Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.
curl -i -X GET \
'https://your-instance.mirakl.net/api/account?shop_id=0'OK
List of the shop's applicable taxes
The date of the last modification of the shop. Note: The following statistics fields do not update the last_updated date:
orders_countoffers_countevaluations_countgradeapproval_rateapproval_delayorder_messages_response_delayAverage time for a shop to answer to an order message (in seconds)
Total count of debited orders (or if Pay on Delivery, accepted) of the shop
List of shop’s producer identifiers per Extended Producer Responsibility (EPR) categories. Only available if the operator setting Activate data collection related to circular economy regulations is enabled.
Recycling policy - only available if the operator setting Activate data collection related to circular economy regulations has been enabled.
All the pair shipping zone / shipping type accepted by the shop
List of additional fields
The list of specific billing information of the shop, used for invoicing and reporting purposes
Applies only when the shop is professional
Shop suspension type, current possible values:
MANUAL: Shop account has been manually suspended in the back-officePENDING_APPROVAL: Shop account has been suspended at creationAUTOMATIC_SUSPENSION: Shop account has been suspended by Mirakl Quality ControlINCOMPLETE_PROFILE: Shop account is suspended because some mandatory fields are missing in its profile{ "applicable_taxes": [ { … } ], "approval_delay": 0, "approval_rate": 0, "banner": "string", "billing_info": { "bank_city": "string", "bank_name": "string", "bank_street": "string", "bic": "string", "iban": "string", "owner": "string", "zip_code": "string" }, "channels": [ "string" ], "closed_from": "2019-08-24T14:15:22Z", "closed_to": "2019-08-24T14:15:22Z", "contact_informations": { "city": "string", "civility": "string", "country": "string", "email": "string", "fax": "string", "firstname": "string", "lastname": "string", "phone": "string", "phone_secondary": "string", "state": "string", "street1": "string", "street2": "string", "web_site": "string", "zip_code": "string" }, "currency_iso_code": "string", "date_created": "2019-08-24T14:15:22Z", "default_billing_information": { "corporate_information": { … }, "default_language": "string", "fiscal_information": { … }, "fiscal_representative": { … }, "id": "string", "personal_information": { … }, "registration_address": { … } }, "description": "string", "domains": [ "string" ], "evaluations_count": 0, "free_shipping": true, "grade": 0, "is_professional": true, "kyc": { "reason": "string", "status": "string" }, "last_updated_date": "2019-08-24T14:15:22Z", "logo": "string", "model": "string", "offers_count": 0, "order_messages_response_delay": 0, "orders_count": 0, "payment_details": { "paid_balance": 0, "payable_balance": 0, "pending_balance": 0, "reserve_balance": 0, "sub_balances": [ … ] }, "payment_info": { "@type": "string", "owner": "string" }, "payment_method_mandatory": true, "premium": true, "pro_details": { "VAT_number": "string", "corporate_name": "string", "identification_number": "string", "tax_identification_number": "string" }, "producer_identifiers": [ { … } ], "recycling_policy": "string", "return_policy": "string", "shipping": { "lead_time_to_ship": 0 }, "shipping_country": "string", "shipping_types": [ "string" ], "shipping_zones": [ "string" ], "shippings": [ { … } ], "shop_additional_fields": [ { … } ], "shop_id": 0, "shop_name": "string", "shop_state": "string", "specific_billing_informations": [ { … } ], "suspension_type": "string" }
List of the channel codes associated to the shop. If new channel is associated without providing values for the required shop_additional_fields, default values will be set.
Professional details of the shop. Updated and not nullable if shop is declared as professional.
List of shop’s producer identifiers per Extended Producer Responsibility (EPR) categories. Only available if the operator setting Activate data collection related to circular economy regulations is enabled.
Recycling policy - only available if the operator setting Activate data collection related to circular economy regulations has been enabled.
Additional fields of the shop. Note that if the 'value' field in the child structure is absent, the corresponding additional field value will be removed for this shop. Nullable.
curl -i -X PUT \
'https://your-instance.mirakl.net/api/account?shop_id=0' \
-H 'Content-Type: application/json' \
-d '{
"address": {
"city": "string",
"civility": "string",
"country": "string",
"firstname": "string",
"lastname": "string",
"phone": "string",
"phone_secondary": "string",
"state": "string",
"street1": "string",
"street2": "string",
"zip_code": "string"
},
"channels": [
"string"
],
"closed_from": "2019-08-24T14:15:22Z",
"closed_to": "2019-08-24T14:15:22Z",
"description": "string",
"email": "string",
"fax": "string",
"is_professional": true,
"payment_info": {
"@type": "string",
"owner": "string"
},
"pro_details": {
"corporate_name": "string",
"identification_number": "string",
"tax_identification_number": "string"
},
"producer_identifiers": [
{
"epr_category_code": "string",
"producer_id": "string"
}
],
"recycling_policy": "string",
"return_policy": "string",
"shipping_country": "string",
"shop_additional_fields": [
{
"code": "string",
"type": "string"
}
],
"shop_name": "string",
"web_site": "string"
}'{ "errors": [ { … } ], "updated": { "address": { … }, "channels": [ … ], "closed_from": "2019-08-24T14:15:22Z", "closed_to": "2019-08-24T14:15:22Z", "default_billing_information": { … }, "description": "string", "email": "string", "fax": "string", "is_professional": true, "model": "string", "payment_info": { … }, "payment_method_mandatory": true, "pro_details": { … }, "producer_identifiers": [ … ], "recycling_policy": "string", "return_policy": "string", "shipping": { … }, "shipping_country": "string", "shop_additional_fields": [ … ], "shop_name": "string", "specific_billing_informations": [ … ], "web_site": "string" } }
curl -i -X GET \
'https://your-instance.mirakl.net/api/shops/documents?shop_id=0'{ "shop_documents": [ { … } ] }
shop_ids or the document_ids.When documents are retrieved, they're wrapped into a ZIP archive except when only one document id is specified. The tree structure of this archive is as follow:
documents-timestamp.zip |__ shop_id/ | |__ image.png | |__ image(1).png | |__ foo.txt
Returns a 404 if at least one document id or one document type code is invalid
curl -i -X GET \
'https://your-instance.mirakl.net/api/shops/documents/download?document_ids=string&shop_id=0&type_codes=string'curl -i -X DELETE \
'https://your-instance.mirakl.net/api/shops/documents/{document_id}?shop_id=0'