Mirakl Services API
The Services API from Mirakl — 5 operation(s) for services.
OpenAPI Specification
openapi: 3.1.0
info:
description: '{% partial file="/partial-content/product/connect-channel-platform/rest/connect/openapi-description.md" /%}'
title: Mirakl Connect Channel Platform APIs Carriers Services API
version: ''
servers:
- description: Connect Channel Platform API
url: https://miraklconnect.com/api/channel-platform
tags:
- name: Services
paths:
/api/mms/locations:
post:
description: '<div class="api-description-extension">
<div class="extension-title">Call Frequency</div>
<div class="recommended-call-frequency">Recommended usage: 30 per minute</div>
<div class="max-call-frequency">Maximum usage: 30 per minute</div>
</div>'
operationId: SL01
parameters: []
requestBody:
content:
application/json:
examples:
application/json-0:
summary: Example with business values (application/json)
value:
contact_info:
email: urna@elit.edu
phone: 1-919-506-3035
description: Open every day except on monday
geography:
address:
formatted_address: 2466 White Ave, Chico, CA 95973, États-Unis
radius: 2000
type: CIRCLE
label: 2466 White Avenue
opening_hours:
friday:
- closing_time: '12:00'
opening_time: 09:00
- closing_time: '18:00'
opening_time: '14:00'
monday: []
saturday:
- closing_time: '12:00'
opening_time: 08:00
- closing_time: '19:00'
opening_time: '14:00'
sunday:
- closing_time: '12:00'
opening_time: 08:00
- closing_time: '18:00'
opening_time: '14:00'
thursday:
- closing_time: '12:00'
opening_time: 08:00
- closing_time: '18:00'
opening_time: '14:00'
tuesday:
- closing_time: '12:00'
opening_time: 09:00
- closing_time: '18:00'
opening_time: '14:00'
wednesday:
- closing_time: '12:00'
opening_time: 08:00
- closing_time: '19:00'
opening_time: '14:00'
shop:
id: 152
application/json-auto:
summary: Complete example with value types (application/json)
value:
contact_info:
email: string
phone: string
description: string
geography:
type: POINT
label: string
opening_hours:
friday:
- closing_time: string
opening_time: string
monday:
- closing_time: string
opening_time: string
saturday:
- closing_time: string
opening_time: string
sunday:
- closing_time: string
opening_time: string
thursday:
- closing_time: string
opening_time: string
tuesday:
- closing_time: string
opening_time: string
wednesday:
- closing_time: string
opening_time: string
shop:
id: 0
schema:
$ref: '#/components/schemas/SL01_Request'
responses:
'201':
content:
application/json:
examples:
application/json-0:
summary: Example with business values (application/json)
value:
contact_info:
email: urna@elit.edu
phone: 1-919-506-3035
description: Open every day except on monday
geography:
address:
city: Chico
company: 2466 White Avenue
country_code: US
formatted_address: 2466 White Ave, Chico, CA 95973, États-Unis
state: CA
street1: 2466 White Avenue
zip_code: '95973'
center:
latitude: 39.7613779
longitude: -121.8500737
radius: 2000
type: CIRCLE
id: 30ef2a4c-0ee1-4afe-ac0a-3ef30df43c70
label: 2466 White Avenue
opening_hours:
friday:
- closing_time: '12:00'
opening_time: 09:00
- closing_time: '18:00'
opening_time: '14:00'
monday: []
saturday:
- closing_time: '12:00'
opening_time: 08:00
- closing_time: '19:00'
opening_time: '14:00'
sunday:
- closing_time: '12:00'
opening_time: 08:00
- closing_time: '18:00'
opening_time: '14:00'
thursday:
- closing_time: '12:00'
opening_time: 08:00
- closing_time: '18:00'
opening_time: '14:00'
tuesday:
- closing_time: '12:00'
opening_time: 09:00
- closing_time: '18:00'
opening_time: '14:00'
wednesday:
- closing_time: '12:00'
opening_time: 08:00
- closing_time: '19:00'
opening_time: '14:00'
application/json-auto:
summary: Complete example with value types (application/json)
value:
contact_info:
email: string
phone: string
description: string
geography:
type: POINT
id: string
label: string
medias:
- mime_type: string
url: string
opening_hours:
friday:
- closing_time: string
opening_time: string
monday:
- closing_time: string
opening_time: string
saturday:
- closing_time: string
opening_time: string
sunday:
- closing_time: string
opening_time: string
thursday:
- closing_time: string
opening_time: string
tuesday:
- closing_time: string
opening_time: string
wednesday:
- closing_time: string
opening_time: string
shop:
id: 0
shop_overridden_opening_hours:
- friday:
availability: string
opening_hours:
- closing_time: string
opening_time: string
monday:
availability: string
opening_hours:
- closing_time: string
opening_time: string
saturday:
availability: string
opening_hours:
- closing_time: string
opening_time: string
shop_id: 0
sunday:
availability: string
opening_hours:
- closing_time: string
opening_time: string
thursday:
availability: string
opening_hours:
- closing_time: string
opening_time: string
tuesday:
availability: string
opening_hours:
- closing_time: string
opening_time: string
wednesday:
availability: string
opening_hours:
- closing_time: string
opening_time: string
schema:
type: object
$ref: '#/components/schemas/SL01_Response_201'
description: Created
summary: SL01 - Create a location
tags:
- Services
get:
description: '<div class="api-description-extension">
<div class="extension-title">Call Frequency</div>
<div class="recommended-call-frequency">Recommended usage: <br/>- Asynchronous: once per day <br/>- Synchronous: each time you need to create a service</div>
<div class="max-call-frequency">Maximum usage: <br/>- Asynchronous: every hour <br/>- Synchronous: each time you need to create a service</div>
<div class="extension-title">Pagination</div>
<p>This resource supports seek pagination (<a href="#section/Seek-pagination-and-sort">see documentation</a>)</p>
</div>'
operationId: SL12
parameters:
- description: 'Shop id to include in result. (default: include all)'
explode: true
in: query
name: shop
required: false
schema:
type: integer
format: int64
style: form
- description: 'Service Location IDs to include in result. (default: include all)'
explode: true
in: query
name: location_id
required: false
schema:
type: array
items:
type: string
style: form
- description: 'Service Location type to include in result. (default: include all)'
explode: true
in: query
name: location_type
required: false
schema:
type: string
enum:
- AT_CUSTOMER_LOCATION
- AT_SHOP_LOCATION
style: form
responses:
'200':
content:
application/json:
examples:
application/json-0:
summary: Example with business values (application/json)
value:
data:
- contact_info:
email: urna@elit.edu
phone: 1-919-506-3035
geography:
address:
city: Chico
company: 2466 White Avenue
country_code: US
formatted_address: 2466 White Ave, Chico, CA 95973, États-Unis
state: CA
street1: 2466 White Avenue
zip_code: '95973'
center:
latitude: 39.7613779
longitude: -121.8500737
radius: 2000
type: CIRCLE
id: 30ef2a4c-0ee1-4afe-ac0a-3ef30df43c70
label: 2466 White Avenue
medias:
- mime_type: image/jpeg
url: /api/mms/location-medias/b2b321a7-c5ea-4694-bac3-2cc74de9e2e0
opening_hours:
friday:
- closing_time: '12:00'
opening_time: 09:00
- closing_time: '18:00'
opening_time: '14:00'
monday: []
saturday:
- closing_time: '12:00'
opening_time: 08:00
- closing_time: '19:00'
opening_time: '14:00'
sunday:
- closing_time: '12:00'
opening_time: 08:00
- closing_time: '18:00'
opening_time: '14:00'
thursday:
- closing_time: '12:00'
opening_time: 08:00
- closing_time: '18:00'
opening_time: '14:00'
tuesday:
- closing_time: '12:00'
opening_time: 09:00
- closing_time: '18:00'
opening_time: '14:00'
wednesday:
- closing_time: '12:00'
opening_time: 08:00
- closing_time: '19:00'
opening_time: '14:00'
shop:
id: 152
shop_overridden_opening_hours:
- friday:
availability: OVERRIDDEN_HOURS
opening_hours:
- closing_time: '12:00'
opening_time: 09:00
- closing_time: '18:00'
opening_time: '14:00'
monday:
availability: NOT_AVAILABLE
saturday:
availability: OVERRIDDEN_HOURS
opening_hours:
- closing_time: '12:00'
opening_time: 08:00
- closing_time: '19:00'
opening_time: '14:00'
shop_id: 42
sunday:
availability: OVERRIDDEN_HOURS
opening_hours:
- closing_time: '12:00'
opening_time: 08:00
- closing_time: '18:00'
opening_time: '14:00'
thursday:
availability: OVERRIDDEN_HOURS
opening_hours:
- closing_time: '12:00'
opening_time: 08:00
- closing_time: '18:00'
opening_time: '14:00'
tuesday:
availability: OVERRIDDEN_HOURS
opening_hours:
- closing_time: '12:00'
opening_time: 09:00
- closing_time: '18:00'
opening_time: '14:00'
wednesday:
availability: OVERRIDDEN_HOURS
opening_hours:
- closing_time: '12:00'
opening_time: 08:00
- closing_time: '19:00'
opening_time: '14:00'
- contact_info:
email: nonummy@vulputatelacusCras.co.uk
phone: 1-919-656-6541
geography:
address:
city: Roscoe
company: 2467 Bend River Road
country_code: US
formatted_address: Bend River Rd, Roscoe, IL 61073, États-Unis
state: IL
street1: 2467 Bend River Road
zip_code: '61073'
geocode:
latitude: 42.431015
longitude: -89.0403527
type: POINT
id: 87ac4bd2-48d6-4afe-a1bf-4a82b663aed4
label: 2467 Bend River Road
opening_hours:
friday: []
monday:
- closing_time: '12:00'
opening_time: 09:00
- closing_time: '18:00'
opening_time: '14:00'
saturday:
- closing_time: '12:00'
opening_time: 08:00
- closing_time: '19:00'
opening_time: '14:00'
sunday:
- closing_time: '12:00'
opening_time: 09:00
- closing_time: '18:00'
opening_time: '14:00'
thursday: []
tuesday: []
wednesday:
- closing_time: '12:00'
opening_time: 08:00
- closing_time: '19:00'
opening_time: '14:00'
shop:
id: 153
shop_overridden_opening_hours:
- friday:
availability: NOT_AVAILABLE
monday:
availability: OVERRIDDEN_HOURS
opening_hours:
- closing_time: '12:00'
opening_time: 09:00
- closing_time: '18:00'
opening_time: '14:00'
saturday:
availability: OVERRIDDEN_HOURS
opening_hours:
- closing_time: '12:00'
opening_time: 08:00
- closing_time: '19:00'
opening_time: '14:00'
shop_id: 42
sunday:
availability: OVERRIDDEN_HOURS
opening_hours:
- closing_time: '12:00'
opening_time: 09:00
- closing_time: '18:00'
opening_time: '14:00'
thursday:
availability: NOT_AVAILABLE
tuesday:
availability: NOT_AVAILABLE
wednesday:
availability: OVERRIDDEN_HOURS
opening_hours:
- closing_time: '12:00'
opening_time: 08:00
- closing_time: '19:00'
opening_time: '14:00'
next_page_token: bGltaXQ9MiZhZnRlcj04N2FjNGJkMi00OGQ2LTRhZmUtYTFiZi00YTgyYjY2M2FlZDQmc29ydD1sYWJlbCxBU0M=.CFpfMq4SqojszIok6kfjG9yjnHAjku5bbfX4AXqRC3s=
application/json-auto:
summary: Complete example with value types (application/json)
value:
data:
- contact_info:
email: string
phone: string
description: string
geography:
type: POINT
id: string
label: string
medias:
- mime_type: string
url: string
opening_hours:
friday:
- closing_time: string
opening_time: string
monday:
- closing_time: string
opening_time: string
saturday:
- closing_time: string
opening_time: string
sunday:
- closing_time: string
opening_time: string
thursday:
- closing_time: string
opening_time: string
tuesday:
- closing_time: string
opening_time: string
wednesday:
- closing_time: string
opening_time: string
shop:
id: 0
shop_overridden_opening_hours:
- friday:
availability: string
opening_hours:
- closing_time: string
opening_time: string
monday:
availability: string
opening_hours:
- closing_time: string
opening_time: string
saturday:
availability: string
opening_hours:
- closing_time: string
opening_time: string
shop_id: 0
sunday:
availability: string
opening_hours:
- closing_time: string
opening_time: string
thursday:
availability: string
opening_hours:
- closing_time: string
opening_time: string
tuesday:
availability: string
opening_hours:
- closing_time: string
opening_time: string
wednesday:
availability: string
opening_hours:
- closing_time: string
opening_time: string
next_page_token: string
previous_page_token: string
schema:
type: object
$ref: '#/components/schemas/SL12_Response_200'
description: OK
summary: SL12 - List locations
tags:
- Services
/api/mms/locations/{location_id}:
delete:
description: '<div class="api-description-extension">
<div class="extension-title">Call Frequency</div>
<div class="recommended-call-frequency">Recommended usage: 20 per second</div>
<div class="max-call-frequency">Maximum usage: 60 per second</div>
</div>'
operationId: SL06
parameters:
- description: Id of the location to delete.
explode: false
in: path
name: location_id
required: true
schema:
type: string
style: simple
responses:
'204':
description: No Content
summary: SL06 - Delete a location
tags:
- Services
/api/mms/models:
get:
description: '<div class="api-description-extension">
<div class="extension-title">Call Frequency</div>
<div class="recommended-call-frequency">Recommended usage: <br/>- Asynchronous: once per day <br/>- Synchronous: at each faceting display</div>
<div class="max-call-frequency">Maximum usage: <br/>- Asynchronous: every hour <br/>- Synchronous: at each faceting display</div>
<div class="extension-title">Read More</div>
<ul><li><a href="https://help.mirakl.com/bundle/customers/page/topics/Mirakl/service_features/integrating_services/displaying_services.htm">More context</a></li></ul><div class="extension-title">Pagination</div>
<p>This resource supports seek pagination (<a href="#section/Seek-pagination-and-sort">see documentation</a>)</p>
<div class="extension-title">Sort fields</div>
<code>sort</code> field can have the following values:<ul><li><b>title</b> - Sort by title (asc by default)</li><li><b>code</b> (Default) - Sort by code (asc by default)</li></ul>
</div>'
operationId: SM11
parameters:
- description: 'Category codes to include in result. (default: include all)'
explode: true
in: query
name: category_code
required: false
schema:
type: array
items:
type: string
style: form
- description: 'Model codes to include in result. (default: include all)'
explode: true
in: query
name: model_code
required: false
schema:
type: array
items:
type: string
style: form
- description: 'Location types to include in result. (default: include all)'
explode: true
in: query
name: location_type
required: false
schema:
type: array
items:
type: string
enum:
- NO_LOCATION
- AT_CUSTOMER_LOCATION
- AT_SHOP_LOCATION
style: form
- description: 'Booking types to include in result. (default: include all)'
explode: true
in: query
name: booking_type
required: false
schema:
type: array
items:
type: string
enum:
- NO_BOOKING
- DATETIME_REQUEST
- SCHEDULED_EVENTS
style: form
- description: 'Consumption types to include in result. (default: include all)'
explode: true
in: query
name: consumption_type
required: false
schema:
type: array
items:
type: string
enum:
- VOUCHER
- CONFIRMATION_BY_SHOP
style: form
responses:
'200':
content:
application/json:
examples:
application/json-0:
summary: Example with business values
value:
data:
- booking:
type: DATETIME_REQUEST
categories:
- code: LOGO_DESIGN
label: Logo Design
code: LOGO
consumption:
type: VOUCHER
custom_attributes:
- code: DISABLED_ACCESSIBILITY
label: Accessible to disabled
service_configuration:
minimum_number_of_elements: 1
type: BOOLEAN
- code: HEIGHT_DIFF
label: Height difference
precision: 2
service_configuration:
minimum_number_of_elements: 0
type: DECIMAL
- code: AGE_MIN
label: Age minimum
service_configuration:
minimum_number_of_elements: 1
type: INTEGER
- available_values:
- code: HIKING_STICKS
label: hiking sticks
- code: ADAPTED_OUTFIT
label: adapted outfit
- code: BOOTS
label: boots
code: EQUIPT_TO_BRING
label: Equipment & gear to bring
service_configuration:
minimum_number_of_elements: 0
type: VALUE_LIST
- code: PREMIUM_PACKAGE
label: Premium package
order_configuration:
maximum_number_of_elements: 1
shop_permission: READ_WRITE
service_configuration:
minimum_number_of_elements: 0
type: BOOLEAN
location:
type: NO_LOCATION
pricing:
options:
- code: BRING_YOUR_OWN_MATERIAL
label: Bring your own material
service_configuration:
minimum_number_of_elements: 1
type: BOOLEAN
- available_values:
- code: ONE_HOUR
label: 1 hour
- code: TWO_HOURS
label: 2 hours
- code: THREE_HOURS
label: 3 hours
code: WORK_DURATION
label: Work duration
order_configuration:
maximum_number_of_elements: 1
service_configuration:
description_allowed: true
maximum_number_of_elements: 1
minimum_number_of_elements: 0
type: VALUE_LIST
type: FIXED_PRICE
quantity:
on_marketplace:
- ALLOW_UNLIMITED
per_order:
- ALLOW_FIXED
title: What do you need to ask for a logo design ?
- booking:
type: NO_BOOKING
categories:
- code: ATM_REPAIR
label: ATM Repair
- code: DISHWASHER
label: Dishwasher
- code: COPIER_REPAIR
label: Copier Repair
code: OTHER_REPAIR
consumption:
type: VOUCHER
custom_attributes: []
location:
type: AT_CUSTOMER_LOCATION
pricing:
type: FIXED_PRICE
quantity:
on_marketplace:
- ALLOW_FIXED
per_order:
- ALLOW_UNLIMITED
title: Other reparation services
next_page_token: bGltaXQ9MiZhZnRlcj1PVEhFUl9SRVBBSVImc29ydD1jb2RlLEFTQw==.xbaxi4cZXKhHIqhuSR6Afp3xoKiW-RBAUEiSVQ3B9C0=
application/json-1:
summary: Example with scheduled events
value:
data:
- booking:
type: SCHEDULED_EVENTS
categories:
- code: CHILDREN_ANIMATIONS
label: Children animations
code: CLOWN_SHOW
consumption:
type: VOUCHER
custom_attributes: []
description: Model regrouping clown shows.
location:
type: AT_SHOP_LOCATION
pricing:
type: FIXED_PRICE
quantity:
on_marketplace:
- NO_QUANTITY
per_order:
- NO_QUANTITY
title: Clown show
# --- truncated at 32 KB (180 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mirakl/refs/heads/main/openapi/mirakl-services-api-openapi.yml