{"info":{"_postman_id":"d063ea3c-b285-4f88-afad-e88852f7e6b3","name":"MarketMate Public API","description":"

API MarketMate помогает продавцам управлять ассортиментом и ценами, обрабатывать заказы, обновлять остатки и решать множество других задач.

Для авторизации используется ключ стандарта JWT

Получение ключа авторизации

Чтобы система магазина получила доступ к данным на Яндексе, нужно:

Авторизоваться на портале и перейти на страницу создания API ключей
\n
Нажать на \"+\" и открыть меню добавления ключей.
\n
Ввести наименование ключа и нажать \"Создать\"
\n
Скопировать созданный ключ и сохранить в надежном месте.
\n

Использование авторизационных данных

Полученный токен вставьте в заголовок Authorization по следующей схеме:

Authorization: Bearer <token>\n\n

В результате заголовок будет выглядеть как-то так:

Authorization: Bearer y0_BfRRRRRV2L8sWWvNkSNNNNSrLHaNXg4cCMswFbL6MWab9lktL2KPsMw\n\n

Если запрос придет без заголовка с действительным токеном, MarketMate вернет HTTP-статус 401 Unauthorized.

Вызов методов

Запросы к API передаются по протоколу HTTPS, таймаут — 10 секунд, Keep-Alive не поддерживается.

Запросы нужно задавать с указанием версии API.

\"http_method\" https://public-api.market-mate.ru/v\"version\"/\"resource\"?\"parameters\"\n\n

где:

\"http_method\" ― DELETE, GET, POST, PATCH или PUT.
\n
\"version\" ― номер текущей версии API. На данный момент текущая версия — 1.
\n
\"resource\" ― URL ресурса, над которым выполняется действие. Названия ресурсов приведены в описании соответствующих методов.
\n
\"parameters\" ― обязательные и необязательные параметры запроса, которые не входят в состав URL ресурса.
\n

Формат входных данных

Входные структуры данных метода POST, PUT или PATCH передаются в теле запроса.

Формат входных данных — JSON.

Формат входных данных указывается в HTTP-заголовке Content-Type: application/json.

Требуемая кодировка запроса: UTF-8.

Если в запросе не указан заголовок Content-Type, MarketMate автоматически определяет формат данных. Сервис возвращает HTTP-статус 400 Bad Request в следующих случаях:

переданные данные невалидны;
\n
в структуре данных содержатся ошибки;
\n
в теле запроса используется неверная кодировка (отличная от UTF-8).
\n

Формат ответа

API возвращает ответы в кодировке UTF-8. Ответы могут быть только в формате JSON.

Типы ошибок и что с ними делать

Если запрос не удалось выполнить, MarketMate возвращает в ответ параметр result который будет равен false и параметр message. В message будет содержаться краткое описание ошибки.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"14119104","collectionId":"d063ea3c-b285-4f88-afad-e88852f7e6b3","publishedId":"2sAXjDcuiX","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"4337c9"},"publishDate":"2024-08-21T22:33:25.000Z"},"item":[{"name":"ERP","item":[{"name":"Организации","item":[{"name":"Получение списка организаций","id":"5a489d2e-fb18-462a-8cf8-e2d6ed9d6b37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://public-api.market-mate.ru/v1/erp/organization","description":"

Возвращает список организаций, к которым имеет доступ пользователь.

\n\n\n\n\n\n\n\n\n\n\n\n\n

МойСклад	1С
+	+

Query parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
page	Type: int32 Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `pageSize`. Default: `1` Max value: `9999`
pageSize	Type: int32 Размер страницы. Используется вместе с параметром `page`. Default: `20` Max value: `100`

Responses

200 OK

Body

{\n    \"result\": true,\n    \"organizations\": [\n        {\n            \"id\": \"string\",\n            \"name\": \"string\"\n        }\n    ],\n    \"pager\": {\n        \"page\": 0,\n        \"pageSize\": 0,\n        \"total\": 0,\n        \"pagesCount\": 0\n    }\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
result	Type: boolean Статус выполнения запроса
organizations	Type: Organization[] Список организаций
pager	Type: Pager Модель для пагинации.

Organization

Информация о организации.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
uuid	Type: str-uuid Уникальный идентификатор организации
name	Type: str Название организации

Модель для пагинации.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
page	Type: int32 Текущая страница.
pageSize	Type: int32 Размер страницы.
total	Type: int32 Сколько всего найдено элементов.
pagesCount	Type: int32 Сколько всего страниц.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"d063ea3c-b285-4f88-afad-e88852f7e6b3","id":"d063ea3c-b285-4f88-afad-e88852f7e6b3","name":"MarketMate Public API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","erp","organization"],"host":["public-api","market-mate","ru"],"query":[],"variable":[]}},"response":[],"_postman_id":"5a489d2e-fb18-462a-8cf8-e2d6ed9d6b37"},{"name":"Получение организации","id":"2d587ad2-669b-4c77-945d-a1d5780ab185","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://public-api.market-mate.ru/v1/erp/organization/00000000-0000-0000-0000-000000000000","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"d063ea3c-b285-4f88-afad-e88852f7e6b3","id":"d063ea3c-b285-4f88-afad-e88852f7e6b3","name":"MarketMate Public API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","erp","organization","00000000-0000-0000-0000-000000000000"],"host":["public-api","market-mate","ru"],"query":[],"variable":[]}},"response":[],"_postman_id":"2d587ad2-669b-4c77-945d-a1d5780ab185"},{"name":"Создание организации","id":"e2e9d777-7997-41f9-bb38-72fb5d8cc1af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"uuid\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://public-api.market-mate.ru/v1/erp/organization","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"d063ea3c-b285-4f88-afad-e88852f7e6b3","id":"d063ea3c-b285-4f88-afad-e88852f7e6b3","name":"MarketMate Public API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","erp","organization"],"host":["public-api","market-mate","ru"],"query":[],"variable":[]}},"response":[],"_postman_id":"e2e9d777-7997-41f9-bb38-72fb5d8cc1af"},{"name":"Изменение организации","id":"20d31f88-1a2c-4508-a3a3-1f4a46bda4c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://public-api.market-mate.ru/v1/erp/organization/00000000-0000-0000-0000-000000000000","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"d063ea3c-b285-4f88-afad-e88852f7e6b3","id":"d063ea3c-b285-4f88-afad-e88852f7e6b3","name":"MarketMate Public API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","erp","organization","00000000-0000-0000-0000-000000000000"],"host":["public-api","market-mate","ru"],"query":[],"variable":[]}},"response":[],"_postman_id":"20d31f88-1a2c-4508-a3a3-1f4a46bda4c6"}],"id":"539b7b8b-3f87-4899-ab56-5a4bd7aa9a75","description":"

Работа со списком организаций

\n","_postman_id":"539b7b8b-3f87-4899-ab56-5a4bd7aa9a75","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"d063ea3c-b285-4f88-afad-e88852f7e6b3","id":"d063ea3c-b285-4f88-afad-e88852f7e6b3","name":"MarketMate Public API","type":"collection"}}}],"id":"85e479cd-6e67-46ee-a161-cbc069d9cab6","description":"

В данном разделе описаны методы взаимодействия с сущностями и документами системы управления торговлей и складского учета.

Не все методы могут быть доступны для использования со всеми типами ERP-систем. В каждом из методов будет информация о возможности использования с каждой из систем.

\n","_postman_id":"85e479cd-6e67-46ee-a161-cbc069d9cab6","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"d063ea3c-b285-4f88-afad-e88852f7e6b3","id":"d063ea3c-b285-4f88-afad-e88852f7e6b3","name":"MarketMate Public API","type":"collection"}}},{"name":"Поставщики","item":[{"name":"Прайслисты","item":[{"name":"Предложения","item":[{"name":"Получение предложений прайслиста","id":"ab33a6ce-9507-4b3e-9443-89d2616de1b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://public-api.market-mate.ru/v1/distributor/pricelist/{pricelistId}/offers","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
pricelistId*	Type: int32 Уникальный идентификатор прайслиста

Query parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
page	Type: int32 Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `pageSize`. Default: `1` Max value: `9999`
pageSize	Type: int32 Размер страницы. Используется вместе с параметром `page`. Default: `20` Max value: `100`
distributorId	Type: int32 Уникальный идентификатор дистрибьютера Default: `any`
productId	Type: str-uuid Уникальный идентификатор связанного товара в МойСклад Default: `any`

Responses

200 OK

Body

{\n    \"result\": true,\n    \"pricelistOffers\": [\n        {\n            \"distributorId\": 0,\n            \"productId\": \"00000000-0000-0000-0000-000000000000\",\n            \"article\": \"string\",\n            \"price\": 0,\n            \"stock\": 0,\n            \"priceRRP\": null,\n            \"product\": {\n                \"offerId\": \"string\"\n            }\n        }\n    ],\n    \"pager\": {\n        \"page\": 0,\n        \"pageSize\": 0,\n        \"total\": 0,\n        \"pagesCount\": 0\n    }\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
result	Type: boolean Статус выполнения запроса
pricelistOffers	Type: PricelistOffer[] Список предложений прайслиста
pager	Type: Pager Модель для пагинации.

PricelistOffer

Информация о предложении прайслиста.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
distributorId	Type: int32 Уникальный идентификатор дистрибьютера
productId	Type: str-uuid Уникальный идентификатор связанного товара в МойСклад
article	Type: str Артикул поставщика
price	Type: decimal Цена поставщика
stock	Type: int32 Остаток поставщика
priceRRP	Type: int32 or null Рекомендуемая розничная цена от поставщика или `null`
product	Type: MoyskladProduct Информация о связанном товаре в МойСклад

MoyskladProduct

Информация о связанном товаре в МойСклад.

\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
offerId	Type: str Код товара в МойСклад

Модель для пагинации.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
page	Type: int32 Текущая страница.
pageSize	Type: int32 Размер страницы.
total	Type: int32 Сколько всего найдено элементов.
pagesCount	Type: int32 Сколько всего страниц.

Работа со списком предложений в прайслистах

\n","_postman_id":"773bb4a0-50ab-469d-80bf-de8013e65dd6","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"d063ea3c-b285-4f88-afad-e88852f7e6b3","id":"d063ea3c-b285-4f88-afad-e88852f7e6b3","name":"MarketMate Public API","type":"collection"}}},{"name":"Получение прайслиста","id":"27bcadea-2741-4899-b2ca-f485de458531","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://public-api.market-mate.ru/v1/distributor/pricelist/{pricelistId}","description":"

Path parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
pricelistId*	Type: int32 Уникальный идентификатор прайслиста

Возвращает список организаций, к которым имеет доступ пользователь.

\n\n\n\n\n\n\n\n\n\n\n\n\n

МойСклад	1С
+	+

Query parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
page	Type: int32 Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `pageSize`. Default: `1` Max value: `9999`
pageSize	Type: int32 Размер страницы. Используется вместе с параметром `page`. Default: `20` Max value: `100`

Responses

200 OK

Body

{\n    \"result\": true,\n    \"organizations\": [\n        {\n            \"uuid\": \"string\",\n            \"name\": \"string\"\n        }\n    ],\n    \"pager\": {\n        \"page\": 0,\n        \"pageSize\": 0,\n        \"total\": 0,\n        \"pagesCount\": 0\n    }\n}\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
result	Type: boolean Статус выполнения запроса
organizations	Type: Organization[] Список организаций
pager	Type: Pager Модель для пагинации.

Organization

Информация о организации.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
uuid	Type: str-uuid Уникальный идентификатор организации
name	Type: str Название организации

Модель для пагинации.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Description
page	Type: int32 Текущая страница.
pageSize	Type: int32 Размер страницы.
total	Type: int32 Сколько всего найдено элементов.
pagesCount	Type: int32 Сколько всего страниц.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"d063ea3c-b285-4f88-afad-e88852f7e6b3","id":"d063ea3c-b285-4f88-afad-e88852f7e6b3","name":"MarketMate Public API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","distributor","pricelist"],"host":["public-api","market-mate","ru"],"query":[],"variable":[]}},"response":[],"_postman_id":"d9084e87-d2e5-41f1-b7af-f8e9f58064f5"},{"name":"Создание прайслиста","id":"d98a0877-1577-4849-bd0d-ab412419d1da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"string\",\n \"enabled\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://public-api.market-mate.ru/v1/distributor/pricelist","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"d063ea3c-b285-4f88-afad-e88852f7e6b3","id":"d063ea3c-b285-4f88-afad-e88852f7e6b3","name":"MarketMate Public API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","distributor","pricelist"],"host":["public-api","market-mate","ru"],"query":[],"variable":[]}},"response":[],"_postman_id":"d98a0877-1577-4849-bd0d-ab412419d1da"},{"name":"Изменение прайслиста","id":"e7611613-e5d1-4ba1-9064-c9b37949613f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"enabled\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://public-api.market-mate.ru/v1/distributor/pricelist/7","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"d063ea3c-b285-4f88-afad-e88852f7e6b3","id":"d063ea3c-b285-4f88-afad-e88852f7e6b3","name":"MarketMate Public API","type":"collection"}},"urlObject":{"protocol":"https","path":["v1","distributor","pricelist","7"],"host":["public-api","market-mate","ru"],"query":[],"variable":[]}},"response":[],"_postman_id":"e7611613-e5d1-4ba1-9064-c9b37949613f"}],"id":"5eb23ba1-2bbd-448f-84a8-583c7b0b5430","description":"

Работа со прайслистами

\n","_postman_id":"5eb23ba1-2bbd-448f-84a8-583c7b0b5430","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"d063ea3c-b285-4f88-afad-e88852f7e6b3","id":"d063ea3c-b285-4f88-afad-e88852f7e6b3","name":"MarketMate Public API","type":"collection"}}}],"id":"a3729b2f-b8fd-47ff-b52b-0ae82fdc0885","description":"

Работа с поставщиками

\n","_postman_id":"a3729b2f-b8fd-47ff-b52b-0ae82fdc0885","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"d063ea3c-b285-4f88-afad-e88852f7e6b3","id":"d063ea3c-b285-4f88-afad-e88852f7e6b3","name":"MarketMate Public API","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"870b5022-5764-4af6-affb-29c9599cb225","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"e9e56a6c-df53-4da8-acd3-de28dbb9876f","type":"text/javascript","packages":{},"exec":[""]}}]}

Получение ключа авторизации

Использование авторизационных данных

Вызов методов

Формат входных данных

Формат ответа

Типы ошибок и что с ними делать

Query parameters

Responses

200 OK

Body

Organization

Pager

Path parameters

Query parameters

Responses

200 OK

Body

PricelistOffer

MoyskladProduct

Pager

Path parameters

Query parameters

Responses

200 OK

Body

Organization

Pager