Skip to content

A01 - Get shop information

Request

Call Frequency
Maximum usage: Once per day
Security
Shop-API-Key(Required scopes: ROLE_SHOP_ADMINROLE_PARTNER_SHOP_READ)
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' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
applicable_taxesArray of objects

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, (with decimals)

Rate of accepted orders

bannerstring

Url of the shop's banner image

channelsArray of strings, uniquerequired

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_informationsobjectrequired

Contact information

currency_iso_codestringrequired

The currency of the shop (iso format)

Enum: "AED", "ARS", "AUD", "BAM", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CZK", "DKK", "EGP", "EUR", "GBP", "GEL", "GTQ", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "IQD", "JOD", "JPY", "KES", "KRW", "KWD", "LKR", "MAD", "MGA", "MXN", "MYR", "NGN", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "TND", "TRY", "THB", "TWD", "UAH", "USD", "UYU", "UZS", "VND", "ZAR"

date_createdstring, (date-time)required

Creation date of the shop

default_billing_informationobjectrequired

The default billing information of the shop, used for invoicing and reporting purposes

descriptionstring

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

domainsArray of strings, uniquerequired

Shop domains

dropshipobject

Dropship configuration

evaluations_countinteger, (int64)required

Number of evaluations for the shop

free_shippingbooleanrequired

Whether or not this shop offers free shipping to customers

gradenumber, (with decimals)

Global grade of the shop

is_professionalbooleanrequired

Whether or not the shop is professional

kycobject

KYC information (only supported when KYC feature is enabled)

last_updated_datestring, (date-time)required

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
modelstring

Shop platform model, current possible values :

  • MARKETPLACE
  • DROPSHIP
  • ONE_CREDITOR

Enum: "MARKETPLACE", "DROPSHIP", "ONE_CREDITOR"

offers_countinteger, (int64)required

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

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

payment_detailsobjectrequired

Payment details

payment_infoobject
payment_method_mandatorybooleanrequired

Payment method mandatory

premiumbooleanrequired

Whether or not the shop is premium

producer_identifiersArray of objects, unique

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.

shippingobjectrequired

Shop shipping configuration

shipping_countrystring

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

shippingsArray of objects

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

shop_additional_fieldsArray of objectsrequired

List of additional fields

shop_idinteger, (int64)required

The identifier of the shop

shop_namestringrequired

The name of the shop

shop_statestringrequired

The state of the shop

Enum: "OPEN", "CLOSE", "SUSPENDED", "TERMINATED"

specific_billing_informationsArray of objects

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

Enum: "MANUAL", "PENDING_APPROVAL", "INCOMPLETE_PROFILE", "AUTOMATIC_SUSPENSION"

billing_infoobjectrequireddeprecated

Banking information

Use “payment_info” attribute instead

pro_detailsobjectrequireddeprecated

Professional details

Use "default_billing_information" instead

shipping_typesArray of stringsrequireddeprecated

List of shipping types of the shop

Use “shippings” attributes instead

shipping_zonesArray of stringsrequireddeprecated

List of shipping zones of the shop

Use “shippings” attributes instead

Response
{ "applicable_taxes": [ { … } ], "approval_delay": 33, "approval_rate": 1, "banner": "https://url.mirakl.net/mmp/media/shop-banner/2000", "channels": [ "US" ], "closed_from": "2019-07-31T22:00:00Z", "closed_to": "2019-08-31T21:59:59Z", "contact_informations": { "city": "New York", "civility": "Mr", "country": "USA", "email": "shop@mail.com", "fax": "213-509-6997", "firstname": "John", "lastname": "Doe", "phone": "213-509-6995", "phone_secondary": "213-509-6996", "state": "Manhattan", "street1": "30, Prince Street", "street2": "1st floor", "web_site": "https://www.mirakl.com", "zip_code": "NY 10012" }, "currency_iso_code": "USD", "date_created": "2019-03-25T14:34:03Z", "default_billing_information": { "corporate_information": { … }, "default_language": "en_US", "fiscal_information": { … }, "id": "a83c1170-f8cb-45a1-aa4a-affe809d6c64", "registration_address": { … } }, "description": "Games seller", "domains": [ "PRODUCT" ], "evaluations_count": 3, "free_shipping": false, "grade": 4, "is_professional": true, "kyc": { "reason": "Missing information", "status": "REFUSED" }, "last_updated_date": "2019-03-28T09:28:59Z", "logo": "https://url.mirakl.net/mmp/media/shop-logo/2000", "model": "MARKETPLACE", "offers_count": 234, "order_messages_response_delay": 76, "orders_count": 7, "payment_details": { "paid_balance": -170.06, "payable_balance": -259.2, "pending_balance": 512.84, "reserve_balance": 0, "reserve_target": 0, "sub_balances": [ … ] }, "payment_info": { "@type": "ABA", "bank_account_number": "000123456789123", "bank_city": "New York", "bank_name": "Bank of America", "bank_street": "115 W 42nd St", "bank_zip": "NY 10036 US", "bic": "BOFAUS3NXXX", "owner": "John Doe", "routing_number": "789456124" }, "payment_method_mandatory": true, "premium": true, "pro_details": { "corporate_name": "ACME SHOP", "identification_number": "01234567", "tax_identification_number": "XXX-XX-XXXX" }, "producer_identifiers": [ { … }, { … } ], "recycling_policy": "When we deliver your new item, we’ll take your old one away for you. Appliance recycling: this service is available through our home delivery service. Recycling electronic items in-store: if you have an old electronic item, we can safely recycle these items in-store, for free", "return_policy": "Any product return must be the subject of a formal agreement between the Seller and Purchaser. Any product returned without this agreement shall be held on behalf of the Purchaser and shall not give rise to the granting of any credit note. Claims must be received by shop within 8 days of the delivery of the goods. Subsequently to this delay, no claims shall be accepted. Once this delay has expired, should the client not have addressed their claim in writing to shop, the client is deemed to have accepted the product.\r\nWarranties that cover the delivered goods only apply within the framework of their intended use. Defects and damage resulting from natural wear, faulty assembly or maintenance, as well as modification of the products that was not intended or specified by the Seller are excluded from the warranty. Goods must be returned in their original packaging and as new, the cost and risks of returning the goods being borne by the Purchaser. Once the returned goods have been received a…" , "shipping": { "lead_time_to_ship": 2 }, "shipping_country": "USA", "shippings": [ { … }, { … }, { … } ], "shop_additional_fields": [ { … }, { … }, { … } ], "shop_id": 2000, "shop_name": "ACME SHOP", "shop_state": "OPEN", "suspension_type": null }