PC01 - List platform configurations

Request

Description

List platform configurations such as general information, modules and features activated.

Note: This configuration represents modules and major features enabled during platform setup. This differs from the PC02 API which export the platform business settings configurable by the operator in the back office.

Security

Shop-API-Key(Required scopes: ROLE_SHOP_ADMIN)

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/platform/configuration?shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

featuresobjectrequired

Features activated on the platform

modulesobjectrequired

Modules activated on the platform

platform_configurationobjectrequired

High level platform configurations

platform_namestringrequired

Operator platform name

tenant_namestringrequired

Tenant platform name

timezonestringrequired

Platform timezone

Response

{
  "features": {
    "catalog": { … },
    "circular_economy_data_collection": false,
    "competitive_pricing_tool": false,
    "direct_payment_customer_store": { … },
    "disable_seller_alternative_carrier": false,
    "lead_time_to_ship_by_sellers_enabled": "YES",
    "multi_currency": true,
    "no_reply_needed": true,
    "offer_prices_decimals": "2",
    "operator_csv_delimiter": "SEMICOLON",
    "order_conditions": { … },
    "order_tax_mode": "TAX_EXCLUDED",
    "order_workflows": { … },
    "pricing": { … },
    "product_data_validation_by_channel": true,
    "shipment": { … },
    "shop_tax_options": { … },
    "tax_collection": { … },
    "tax_id_number": { … },
    "warehouses": { … }
  },
  "modules": {
    "mirakl_catalog_integrator": true,
    "mirakl_catalog_manager": false,
    "mirakl_catalog_transformer": true,
    "mirakl_platform_services": false,
    "offer_management": true,
    "order_management": true,
    "promotions": true,
    "quotes": true,
    "tax_manager": { … }
  },
  "platform_configuration": {
    "customer_model": { … },
    "platform_model": { … }
  },
  "platform_name": "",
  "tenant_name": "tenantname-prod",
  "timezone": "Europe/Paris"
}