Skip to content
Products
/
/
/
A02 - Update shop informa...

A02 - Update shop information

Request

Description

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

Call Frequency
Recommended usage: At each information update
Maximum usage: Once per day
Security
Shop-API-Key(Required scopes: ROLE_SHOP_ADMINROLE_PARTNER_SHOP_UPDATE)
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

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
pro_detailsobject

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

producer_identifiersArray of objects, [ 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.

Enum: "AFG", "ALA", "ALB", "DZA", "ASM", "AND", "AGO", "AIA", "ATA", "ATG", "ARG", "ARM", "ABW", "AUS", "AUT", "AZE", "BHS", "BHR", "BGD", "BRB", "BLR", "BEL", "BLZ", "BEN", "BMU", "BTN", "BOL", "BES", "BIH", "BWA", "BVT", "BRA", "IOT", "BRN", "BGR", "BFA", "BDI", "KHM", "CMR", "CAN", "CPV", "CYM", "CAF", "TCD", "CHL", "CHN", "CXR", "CCK", "COL", "COM", "COG", "COD", "COK", "CRI", "CIV", "HRV", "CUB", "CUW", "CYP", "CZE", "DNK", "DJI", "DMA", "DOM", "ECU", "EGY", "SLV", "GNQ", "ERI", "EST", "ETH", "FLK", "FRO", "FJI", "FIN", "FRA", "GUF", "PYF", "ATF", "GAB", "GMB", "GEO", "DEU", "GHA", "GIB", "GRC", "GRL", "GRD", "GLP", "GUM", "GTM", "GGY", "GIN", "GNB", "GUY", "HTI", "HMD", "VAT", "HND", "HKG", "HUN", "ISL", "IND", "IDN", "IRQ", "IRL", "IMN", "ISR", "ITA", "JAM", "JPN", "JEY", "JOR", "KAZ", "KEN", "KIR", "KOR", "KWT", "KGZ", "LAO", "LVA", "LBN", "LSO", "LBR", "LBY", "LIE", "LTU", "LUX", "MAC", "MKD", "MDG", "MWI", "MYS", "MDV", "MLI", "MLT", "MHL", "MTQ", "MRT", "MUS", "MYT", "MEX", "FSM", "MDA", "MCO", "MNG", "MNE", "MSR", "MAR", "MOZ", "MMR", "NAM", "NRU", "NPL", "NLD", "NCL", "NZL", "NIC", "NER", "NGA", "NIU", "NFK", "MNP", "NOR", "OMN", "PAK", "PLW", "PSE", "PAN", "PNG", "PRY", "PER", "PHL", "PCN", "POL", "PRT", "PRI", "QAT", "REU", "ROU", "RUS", "RWA", "BLM", "SHN", "KNA", "LCA", "MAF", "SPM", "VCT", "WSM", "SMR", "STP", "SAU", "SEN", "SRB", "SYC", "SLE", "SGP", "SXM", "SVK", "SVN", "SLB", "SOM", "ZAF", "SGS", "SSD", "ESP", "LKA", "SUR", "SJM", "SWZ", "SWE", "CHE", "TWN", "TJK", "TZA", "THA", "TLS", "TGO", "TKL", "TON", "TTO", "TUN", "TUR", "TKM", "TCA", "TUV", "UGA", "UKR", "ARE", "GBR", "USA", "UMI", "URY", "UZB", "VUT", "VEN", "VNM", "VGB", "VIR", "WLF", "YEM", "ZMB", "ZWE"

shop_additional_fieldsArray of objects

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 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "address": {
      "city": "New York",
      "civility": "Mr",
      "country": "USA",
      "firstname": "Doe",
      "lastname": "John",
      "phone": "213-509-6996",
      "phone_secondary": "213-509-6995",
      "state": "Manhattan",
      "street1": "30, Prince Street",
      "street2": "1st floor",
      "zip_code": "NY 10012"
    },
    "channels": [
      "US"
    ],
    "closed_from": "2025-03-20T16:42:21Z",
    "closed_to": "2026-03-20T16:42:21Z",
    "description": "This is the description of this seller",
    "email": "my-store@example.com",
    "fax": "0245875499",
    "is_professional": true,
    "payment_info": {
      "@type": "IBAN",
      "bank_name": "CACE",
      "bic": "AGRIFRPPXX2",
      "iban": "FR6031047696713027315572590",
      "owner": "John Doe"
    },
    "pro_details": {
      "corporate_name": "Mirakl Inc.",
      "identification_number": "44268625900078",
      "tax_identification_number": "FR939383"
    },
    "producer_identifiers": [
      {
        "epr_category_code": "FR-DEA",
        "producer_id": "FR123456_89ABCD"
      },
      {
        "epr_category_code": "DE-WEEE",
        "producer_id": "PRODUCERID1"
      }
    ],
    "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": "3 days return policy",
    "shipping_country": "ITA",
    "shop_additional_fields": [
      {
        "code": "segment",
        "value": "1"
      },
      {
        "code": "prio-level",
        "value": "High"
      }
    ],
    "shop_name": "My Super Seller",
    "web_site": "https://example.fr"
  }'

Responses

OK

Bodyapplication/json
errorsArray of objects

List of errors encountered when updating the shop

updatedobject

Details of the modified shop

Response
{
  "errors": [],
  "updated": {
    "address": { … },
    "channels": [ … ],
    "closed_from": "2022-03-20T16:42:21Z",
    "closed_to": "2025-03-20T16:42:21Z",
    "default_billing_information": { … },
    "description": "This is the description of this seller",
    "email": "my-store@example.com",
    "fax": "0245875499",
    "is_professional": true,
    "model": "MARKETPLACE",
    "payment_info": { … },
    "payment_method_mandatory": true,
    "pro_details": { … },
    "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": "3 days return policy",
    "shipping": { … },
    "shipping_country": "ITA",
    "shop_additional_fields": [ … ],
    "shop_name": "My Super Seller",
    "web_site": "https://example.fr"
  }
}