Различия

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

--- ru:api_start [2022/05/02 20:58]
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. Введите в строке аутентификации **Bearer** //сгенерированный API key//
+>>{{:ru:api_23.png?600|}} {{:ru:apibearer_2.png?600|}}
 ====== Product ======
@@ Строка 59: / Строка 66: @@
 //Получение списка товара с клиента//
 </WRAP>
+----
 >**Get products list**  - Получение списка товара с клиента
 > Параметр **page** - укажите страницу, с которой происходит загрузка
 > **Per-page** - Кол-во товара на страницу
->{{:ru:api_2.png?900|}}
+>{{:ru:api_2.png?790|}}
 >
 >
@@ Строка 150: / Строка 160: @@
 >**productWeightUnits** - единицы измерения веса единицы товара
 >**productWeight** - вес единицы товара.
->>{{:ru:api_3.png?780|}}
+>>{{:ru:api_3.png?600|}}
 ----
@@ Строка 182: / Строка 192: @@
 >
 >**productId** - укажите ID товара.
->{{:ru:api_4.png?850|}}
+>{{:ru:api_4.png?650|}}
 >
 >
@@ Строка 201: / Строка 211: @@
 ----
 <WRAP right box>
 **Curl**
@@ Строка 269: / Строка 280: @@
 //Обновление Supplier товара//
 </WRAP>
+----
 >**Update product Suplier** - используется для обновления информации о поставщике товара
@@ Строка 287: / Строка 300: @@
 ====== Supplier ======
-<WRAP right box 35%>
+<WRAP right box>
 **Curl**
 <code>
@@ Строка 349: / Строка 362: @@
 ----
-<WRAP right box 35%>
+<WRAP right box>
 **Curl**
 <code>
@@ Строка 378: / Строка 391: @@
 >
 >Укажите название поставщика. ID поставщика будет присвоено автоматически.
->{{:ru:api_13.png?800|}}
+>{{:ru:api_13.png?600|}}
 ----
-<WRAP right box 35%>
+<WRAP right box>
 **Curl**
 <code>
@@ Строка 415: / Строка 428: @@
 >GET /supplier/{supplierNum}/product Find product by supplier num - используйте для возврата информации ID товара по номеру поставщика.
 >
->{{:ru:api_14.png?750|}}
+>{{:ru:api_14.png?500|}}
 >
 >
@@ Строка 424: / Строка 437: @@
 ----
-<WRAP right box 35%>
+<WRAP right box>
 **Curl**
 <code>
@@ Строка 718: / Строка 731: @@
 ----
+<WRAP right box>
+**Curl**
+<code>
+curl -X 'GET' \
+  'https://719.eu6.ysell.pro/api/v1/order/75' \
+  -H 'accept: */*' \
+  -H 'Authorization: Bearer '
+</code>
+//Получение информации по заказа с ID 75//
+</WRAP>
+>GET /order/{ID} Return order by ID - используется для возврата информации по заказу.
+>
+>ID - укажите ID заказа.
+>
+> {{:ru:api_25.png?600|}}
-====== Price ======
+----
->Price schema operations
+<WRAP right box>
+**Curl**
+<code>
+curl -X 'DELETE' \
+  'https://719.eu6.ysell.pro/api/v1/order/60' \
+  -H 'accept: */*' \
+  -H 'Authorization: Bearer '
+</code>
+//Получение информации по заказа с ID 75//
+</WRAP>
+>Delete /order/{ID} Delete Order by ID - используется для удаления заказа
+>
+>ID - введите ID заказа
+>
+>{{:ru:api_26.png?600|}}
-====== Prep ======
+----
-====== PrepShipments ======
+<WRAP right box>
+**Curl**
+<code>
+curl -X 'POST' \
+  'https://719.eu6.ysell.pro/api/v1/order-item' \
+  -H 'accept: */*' \
+  -H 'Authorization: Bearer ' \
+  -H 'Content-Type: multipart/form-data' \
+  -F 'p_id=155' \
+  -F 'order_id=70' \
+  -F 'shipment_items_cost=20' \
+  -F 'qty=15' \
+  -F 'asin=TestAsin' \
+  -F 'id=' \
+  -F 'product_name=TestName' \
+  -F 'item_price=15' \
+  -F 'sku=TestSKU'
+</code>
+**Response body**
+<code>
+{
+  "id": 147,
+  "order_id": "70",
+  "sku": "TestSKU",
+  "qty": "15",
+  "image": "https://719.eu6.ysell.pro/product_images/155/51yLgO1l4xL (1).jpg",
+  "item_price": "15",
+  "unit_price": null,
+  "product_id": null,
+  "item_type": "product"
+}
+ </code>
+//Добавление товара к заказу Id 70//
+</WRAP>
+>Post /order-item Create new order item - используется для добавления позиции к заказу.
+>
+>**order_id** - укажите ID заказа
+>
+>**asin** - ASIN товара
+>
+>**p_id** - ID товара.
+>
+>**product_name** - название товара
+>
+>**sku** - SKU товара
+>
+>**qty** - Кол-во товара в заказе
+>
+>**item_price** - цена единицы товара.
+>{{:ru:api_27.png?600|}}
+----
+====== Shipments ======
-<WRAP center round important 80%>
+>//Операции с отправками//
-По умолчанию все API методы возвращают **20 записей**.
+<WRAP right box>
+**Curl**
-Обратите внимание на заголовки ответа
+<code>
+curl -X 'GET' \
- **x-pagination-current-page**: 1  - текущая страница
+  'https://719.eu6.ysell.pro/api/v1/prep-shipment?page=1&per-page=10&sort=1' \
+  -H 'accept: */*' \
- **x-pagination-page-count**: 1 - всего страниц
+  -H 'Authorization: Bearer 123321'
+</code>
-** x-pagination-per-page**: 20  - записей на страницу
+**Response body**
+<code>
- **x-pagination-total-count**: 9  - всего записей
+{
+    "id": 1,
-Для указания номера страницы укажите параметр **page=НомерСтраницы**
+    "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** - текст примечания к отправке.