Stores
/
Get shop information

Mirakl Marketplace APIs (latest-release)

Languages
Servers
URL to be replaced by your Mirakl instance URL
https://your-instance.mirakl.net/

Stores

Operations

Get shop information

Request

Query
shop_idinteger(int64)

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'

Responses

OK

Bodyapplication/json
applicable_taxesArray of objects(A01_Response_200_ApplicableTaxes)

List of the shop's applicable taxes

approval_delayinteger(int64)

Average time for a shop to accept or refuse an order (in seconds)

approval_ratenumber

Rate of accepted orders

bannerstring

Url of the shop's banner image

channelsArray of strings

List of the channel codes associated to the shop

closed_fromstring(date-time)

The start date of the closing of the shop

closed_tostring(date-time)

The end date of the closing of the shop

contact_informationsobject(A01_Response_200_ContactInformations)
currency_iso_codestring

The currency of the shop (iso format)

date_createdstring(date-time)

Creation date of the shop

default_billing_informationobject(A01_Response_200_DefaultBillingInformation)
descriptionstring

The description of the shop, max length: 3000 characters.

domainsArray of strings

Shop domains

evaluations_countinteger(int64)

Number of evaluations for the shop

free_shippingboolean

Whether or not this shop offers free shipping to customers

gradenumber

Global grade of the shop

is_professionalboolean

Whether or not the shop is professional

kycobject(A01_Response_200_Kyc)
last_updated_datestring(date-time)

The date of the last modification of the shop. Note: The following statistics fields do not update the last_updated date:

  • orders_count
  • offers_count
  • evaluations_count
  • grade
  • approval_rate
  • approval_delay
  • order_messages_response_delay
logostring

Url of the shop's logo image

modelstring

Shop platform model, current possible values :

  • MARKETPLACE
  • DROPSHIP
  • ONE_CREDITOR
offers_countinteger(int64)

Total count of active offers of the shop

order_messages_response_delayinteger(int64)

Average time for a shop to answer to an order message (in seconds)

orders_countinteger(int64)

Total count of debited orders (or if Pay on Delivery, accepted) of the shop

payment_detailsobject(A01_Response_200_PaymentDetails)
payment_infoobject(A01_Response_200_PaymentInfo)
payment_method_mandatoryboolean

Payment method mandatory

premiumboolean

Whether or not the shop is premium

producer_identifiersArray of objects(A01_Response_200_ProducerIdentifiers)

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_policystring<= 5000 characters

Recycling policy - only available if the operator setting Activate data collection related to circular economy regulations has been enabled.

return_policystring

Terms of restitution, max length: 60000 characters.

shippingobject(A01_Response_200_Shipping)
shipping_countrystring

Code ISO 3166-1 alpha-3 of the shipping country

shippingsArray of objects(A01_Response_200_Shippings)

All the pair shipping zone / shipping type accepted by the shop

shop_additional_fieldsArray of objects(A01_Response_200_ShopAdditionalFields)

List of additional fields

shop_idinteger(int64)

The identifier of the shop

shop_namestring

The name of the shop

shop_statestring

The state of the shop

specific_billing_informationsArray of objects(A01_Response_200_SpecificBillingInformations)

The list of specific billing information of the shop, used for invoicing and reporting purposes
Applies only when the shop is professional

suspension_typestring

Shop suspension type, current possible values:

  • MANUAL: Shop account has been manually suspended in the back-office
  • PENDING_APPROVAL: Shop account has been suspended at creation
  • AUTOMATIC_SUSPENSION: Shop account has been suspended by Mirakl Quality Control
  • INCOMPLETE_PROFILE: Shop account is suspended because some mandatory fields are missing in its profile

billing_infoobject(A01_Response_200_BillingInfo)Deprecated
pro_detailsobject(A01_Response_200_ProDetails)Deprecated
shipping_typesArray of stringsDeprecated

List of shipping types of the shop

shipping_zonesArray of stringsDeprecated

List of shipping zones of the shop

Response
application/json
{
  "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"
}

Update shop information

Request

Depending on the operator's configuration, some fields might not be editable.

Query
shop_idinteger(int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

Bodyapplication/json
addressobject(A02_Request_Address)

The address of the shop. Cannot be null.

channelsArray of strings

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.

closed_fromstring(date-time)

Date: if defined, this shop will be closed on this date. Nullable.

closed_tostring(date-time)

Date: if defined, this shop will be reopened on this date. Nullable.

descriptionstring

Description of the shop. Nullable.

emailstring

Email of the shop. Cannot be null.

faxstring

Fax of the shop. Nullable.

is_professionalboolean

Whether or not the shop is professional. Cannot be null.

payment_infoobject(A02_Request_PaymentInfo)

Payment information of the shop. Nullable.

pro_detailsobject(A02_Request_ProDetails)

Professional details of the shop. Updated and not nullable if shop is declared as professional.

producer_identifiersArray of objects(A02_Request_ProducerIdentifiers)[ 0 .. 50 ] items

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_policystring<= 5000 characters

Recycling policy - only available if the operator setting Activate data collection related to circular economy regulations has been enabled.

return_policystring

Return policy of the shop. Nullable.

shipping_countrystring

Shipping country of the shop. Nullable.

shop_additional_fieldsArray of objects(A02_Request_ShopAdditionalFields)

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.

shop_namestring

The name of the shop. Cannot be null.

web_sitestring

Website of the 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"
  }'

Responses

OK

Bodyapplication/json
errorsArray of objects(A02_Response_200_Errors)

List of errors encountered when updating the shop

updatedobject(A02_Response_200_Updated)
Response
application/json
{
  "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"
  }
}

List shop's documents

Request

You must specify at least one of the following parameters: shop_ids, updated_since

Query
shop_idinteger(int64)

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/shops/documents?shop_id=0'

Responses

OK

Bodyapplication/json
shop_documentsArray of objects(S30_Response_200_ShopDocuments)

Document details

Response
application/json
{
  "shop_documents": [
    { … }
  ]
}

Download documents for one or multiple shops

Request

  • It is mandatory to specify either the shop_ids or the document_ids.
  • If a list of document identifiers is specified only these documents are downloaded.
    • If more than one document id is specified, the documents will be wrapped in a ZIP archive
    • If only one document id is specified the document will not be zipped
  • If no document identifiers is specified, all the shop documents will be downloaded.
    Use a list of shop document type codes to retrieve specific types from your shop.
    In this case, the output of the API will always be a ZIP archive even if there is only one document to retrieve.

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

Query
document_idsstring

A list of document identifiers (separated by a comma). It is mandatory to specify either the shop_ids or the document_ids

type_codesstring

A list of document type codes (separated by a comma)

shop_idinteger(int64)

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/shops/documents/download?document_ids=string&shop_id=0&type_codes=string'

Responses

OK

Bodyapplication/octet-stream
string(binary)

Delete a shop document

Request

Path
document_idinteger(int64)required

Document identifier to delete

Query
shop_idinteger(int64)

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 DELETE \
  'https://your-instance.mirakl.net/api/shops/documents/{document_id}?shop_id=0'

Responses

No Content

Platform Settings

Operations

Invoicing and Accounting

Operations

Products

Operations

Messages

Operations

Offers

Operations

Orders

Operations

Incidents

Operations

Picklists

Operations

Promotions

Operations

Returns

Operations

Multiple shipments

Operations