Skip to content

SOF11 - List services

Request

Call Frequency
Maximum usage: Once per hour
Pagination

This resource supports seek pagination (see documentation)

Sort fields

sort field can have the following values:

  • date_created - Sort by last created date (asc by default)
  • date_updated - Sort by last updated date (asc by default)
  • title (Default) - Sort by title (asc by default)

Query
category_codeArray of strings

Category codes to include in result. Children categories of the specified codes are also included. (default: include all)

service_codeArray of strings

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

model_codeArray of strings

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

statestring

Service state to include in result. (default: include all)

Enum:"ACTIVE""INACTIVE"
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/services?category_code=string&service_code=string&model_code=string&state=ACTIVE&shop_id=0'

Responses

OK

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": [ { … } ], "previous_page_token": "YmVmb3JlPVVFVlQ0NFZKWEQmbGltaXQ9MSZzb3J0PXByb3ZpZGVyX3JhdGluZyxERVND.SB48uOZTJdHkoM-ebma4VxB7SUtpwmswT-tbw-lnkJw=" }