SM11 - List service models

Products

SM11 - List service models

Request

Call Frequency

Recommended usage: Once per hour

Maximum usage: Once per hour

Pagination

This resource supports seek pagination (see documentation)

Sort fields

sort field can have the following values:

title - Sort by title (asc by default)
code (Default) - Sort by code (asc by default)

Query

category_codeArray of strings

Category codes to include in result. (default: include all)

model_codeArray of strings

Model codes to include in result. (default: include all)

location_typeArray of strings

Location types to include in result. (default: include all)

Items Enum:"NO_LOCATION""AT_CUSTOMER_LOCATION""AT_SHOP_LOCATION"

booking_typeArray of strings

Booking types to include in result. (default: include all)

Items Enum:"NO_BOOKING""DATETIME_REQUEST""SCHEDULED_EVENTS"

consumption_typeArray of strings

Consumption types to include in result. (default: include all)

Items Enum:"VOUCHER""CONFIRMATION_BY_SHOP"

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/mms/models?category_code=string&model_code=string&location_type=NO_LOCATION&booking_type=NO_BOOKING&consumption_type=VOUCHER&shop_id=0'

Responses

Bodyapplication/json

dataArray of objectsrequired

Page of data

next_page_tokenstring

Token to access the next page. Absent if the current page is the last one.

previous_page_tokenstring

Token to access the previous page. Absent if the current page is the first one.

Response

{
  "data": [
    { … },
    { … }
  ],
  "next_page_token": "bGltaXQ9MiZhZnRlcj1PVEhFUl9SRVBBSVImc29ydD1jb2RlLEFTQw==.xbaxi4cZXKhHIqhuSR6Afp3xoKiW-RBAUEiSVQ3B9C0="
}