Различия

Показаны различия между двумя версиями страницы.

--- ru:api_start [2022/05/11 16:44]
support
+++ ru:api_start [2023/03/28 21:49] (текущий)
support
@@ Строка 7: / Строка 7: @@
 >Для работы API необходимо установить API token для пользователя.
->>Bearer authentication это схема аутентификации HTTP, в которой используются маркеры безопасности, называемые bearer tokens. bearer token - это шифрованная строка, обычно генерируемая сервером в ответ на запрос на вход в систему. Клиент должен отправить этот токен в заголовке Authorization при формировании запроса: Authorization: Bearer <token>
+>>Bearer authentication это схема аутентификации HTTP, в которой используются маркеры безопасности, называемые bearer tokens. bearer token - это шифрованная строка. Клиент должен отправить этот токен в заголовке Authorization при формировании запроса: Authorization: Bearer <token>
 ----
->Перейдите в раздел управления пользователями (Settings -> Users)
+>Перейдите в раздел меню **Settings** - **Ysell API**
->Добавьте нового пользователя (необходимо заполнить поле API token случайным значением)
+>Создайте новый Access Token нажатием на Create New Token
->>{{:ru:api.png?700|}} {{:ru:api_1.png?500|}}
+>>{{:ru:apiysell2_1.png?300|}} {{:ru:apiysell_22.png?600|}}
+----
+>Перейдите в раздел Settings - ysell API
+>>{{:ru:apwi.png?600|}}
 ----
->Авторизуйтесь с помощью API token нажатием на Authorize
+>Авторизуйтесь с помощью API token нажатием на Authorize. Введите в строке аутентификации **Bearer** //сгенерированный API key//
->>{{:ru:api_23.png?600|}}
+>>{{:ru:api_23.png?600|}} {{:ru:apibearer_2.png?600|}}
 ====== Product ======
@@ Строка 207: / Строка 211: @@
 ----
 <WRAP right box>
 **Curl**
@@ Строка 275: / Строка 280: @@
 //Обновление Supplier товара//
 </WRAP>
+----
 >**Update product Suplier** - используется для обновления информации о поставщике товара
@@ Строка 293: / Строка 300: @@
 ====== Supplier ======
-<WRAP right box 35%>
+<WRAP right box>
 **Curl**
 <code>
@@ Строка 355: / Строка 362: @@
 ----
-<WRAP right box 35%>
+<WRAP right box>
 **Curl**
 <code>
@@ Строка 388: / Строка 395: @@
 ----
-<WRAP right box 35%>
+<WRAP right box>
 **Curl**
 <code>
@@ Строка 421: / Строка 428: @@
 >GET /supplier/{supplierNum}/product Find product by supplier num - используйте для возврата информации ID товара по номеру поставщика.
 >
->{{:ru:api_14.png?750|}}
+>{{:ru:api_14.png?500|}}
 >
 >
@@ Строка 430: / Строка 437: @@
 ----
-<WRAP right box 35%>
+<WRAP right box>
 **Curl**
 <code>
@@ Строка 758: / Строка 765: @@
 ----
 <WRAP right box>
 **Curl**
@@ Строка 811: / Строка 819: @@
 ----
+====== Shipments ======
+>//Операции с отправками//
+<WRAP right box>
+**Curl**
+<code>
+curl -X 'GET' \
+  'https://719.eu6.ysell.pro/api/v1/prep-shipment?page=1&per-page=10&sort=1' \
+  -H 'accept: */*' \
+  -H 'Authorization: Bearer 123321'
+</code>
+**Response body**
+<code>
+{
+    "id": 1,
+    "company_id": 719,
+    "shipment_num": "719-1",
+    "shipment_type": "warehouse",
+    "shipment_type_description": "Send to the warehouse",
+    "status": 0,
+    "status_description": "New",
+    "total_cost": 0,
+    "declared_qty": 211,
+    "declared_box_qty": 0,
+    "processed_qty": 0,
+    "messages": []
+  },
+ </code>
+//Получение информации о отправке 719-1 //
+</WRAP>
+>**GET /prep-shipment Get prep shipment list** - используется получения информации о отправке с Преп-центра.
+>
+>**company_id** - ID компании.
+>
+>**shipment_num** - номер отправки
+>
+>**shipment_type** - тип отправки
+>
+>**shipment_type_description** - описание для типа отправки.
+>
+>**status** - статус отправки.
+>
+>**status_description** - описание статуса отправки
+>
+>**total_cost** - цена за обработку отправки.
+>
+>**declared_qty** - количество  единиц товара, указанного клиентом.
+>
+>**declared_box_qty** - количество коробок с товаром, указанного клиентом.
+>
+>**processed_qty** - обработанное Преп центром количество товара.
+>
+>**messages** - текст примечания к отправке.