ru:api_start

Различия

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

Ссылка на это сравнение

Предыдущая версия справа и слева Предыдущая версия
Следующая версия 		Предыдущая версия
ru:api_start [2022/05/02 16:02]
support 		ru:api_start [2023/03/28 21:49] (текущий)
support
Строка 7: Строка 7:
  
 >Для работы API необходимо установить API token для пользователя. >Для работы 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 ====== ====== Product ======
Строка 59: Строка 66:
 //Получение списка товара с клиента// //Получение списка товара с клиента//
 </WRAP> </WRAP>
 +
 +----
 +
 >**Get products list**  - Получение списка товара с клиента >**Get products list**  - Получение списка товара с клиента
 > Параметр **page** - укажите страницу, с которой происходит загрузка > Параметр **page** - укажите страницу, с которой происходит загрузка
 > **Per-page** - Кол-во товара на страницу > **Per-page** - Кол-во товара на страницу
->{{:ru:api_2.png?900|}}+>{{:ru:api_2.png?790|}}
 > >
 > >
Строка 150: Строка 160:
 >**productWeightUnits** - единицы измерения веса единицы товара >**productWeightUnits** - единицы измерения веса единицы товара
 >**productWeight** - вес единицы товара. >**productWeight** - вес единицы товара.
->>{{:ru:api_3.png?780|}}+>>{{:ru:api_3.png?600|}}
  
 ---- ----
Строка 182: Строка 192:
 > >
 >**productId** - укажите ID товара.  >**productId** - укажите ID товара. 
->{{:ru:api_4.png?850|}}+>{{:ru:api_4.png?650|}}
 > >
 > >
Строка 201: Строка 211:
  
 ---- ----
 +
 <WRAP right box> <WRAP right box>
 **Curl** **Curl**
Строка 269: Строка 280:
 //Обновление Supplier товара// //Обновление Supplier товара//
 </WRAP> </WRAP>
 +
 +----
  
 >**Update product Suplier** - используется для обновления информации о поставщике товара >**Update product Suplier** - используется для обновления информации о поставщике товара
Строка 287: Строка 300:
 ====== Supplier ====== ====== Supplier ======
  
-<WRAP right box 35%>+<WRAP right box>
 **Curl** **Curl**
 <code> <code>
Строка 349: Строка 362:
 ---- ----
  
-<WRAP right box 35%>+<WRAP right box>
 **Curl** **Curl**
 <code> <code>
Строка 378: Строка 391:
 > >
 >Укажите название поставщика. ID поставщика будет присвоено автоматически.  >Укажите название поставщика. ID поставщика будет присвоено автоматически. 
->{{:ru:api_13.png?800|}}+>{{:ru:api_13.png?600|}}
  
 ---- ----
  
-<WRAP right box 35%>+<WRAP right box>
 **Curl** **Curl**
 <code> <code>
Строка 415: Строка 428:
 >GET /supplier/{supplierNum}/product Find product by supplier num - используйте для возврата информации ID товара по номеру поставщика.  >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** **Curl**
 <code> <code>
Строка 630: Строка 643:
  
 ====== Order ====== ====== Order ======
 +
 >//Операции с заказами// >//Операции с заказами//
 +<WRAP right box 35%>
 +**Curl**
 +<code>
 +curl -X 'GET' \
 +  'https://719.eu6.ysell.pro/api/v1/order?sort=o-719-67&page=1' \
 +  -H 'accept: */*' \
 +  -H 'Authorization: Bearer '
 +</code>
 +</WRAP>
 > >
 >Get /order Returns order - используется для получения информации о заказе >Get /order Returns order - используется для получения информации о заказе
 > >
 +>{{:ru:api_22.png?600|}}
 +
 +----
 +<WRAP right box 35%>
 +**Curl**
 +<code>
 +curl -X 'POST' \
 +  'https://719.eu6.ysell.pro/api/v1/order' \
 +  -H 'accept: */*' \
 +  -H 'Authorization: Bearer 123321' \
 +  -H 'Content-Type: multipart/form-data' \
 +  -F 'buyer_state=' \
 +  -F 'buyer_phone_number=+49 421 668 9414 0' \
 +  -F 'payment_date=2022-04-30' \
 +  -F 'status_id=' \
 +  -F 'buyer_country=DE' \
 +  -F 'purchase_date=2022-04-30' \
 +  -F 'ship_state=' \
 +  -F 'ship_city=Bremen' \
 +  -F 'ship_name=Gomez' \
 +  -F 'buyer_email=gomez@gmail.com' \
 +  -F 'currency=' \
 +  -F 'platform=amazon' \
 +  -F 'ship_country=DE' \
 +  -F 'buyer_addr1=Walter-Geerdes-Str' \
 +  -F 'buyer_postal_code=28307' \
 +  -F 'buyer_addr2=Walter-Geerdes-Str' \
 +  -F 'buyer_city=Bremen' \
 +  -F 'buyer_name=Gomez' \
 +  -F 'platform_order_id=Amazon-1' \
 +  -F 'latest_ship_date=2022-04-30' \
 +  -F 'ship_email=info@fulfillment-box.de' \
 +  -F 'id=' \
 +  -F 'company_id=719' \
 +  -F 'ship_phone_number=+49 421 668 9414 0' \
 +  -F 'ship_addr1=Walter-Geerdes-Str' \
 +  -F 'ship_addr2=14' \
 +  -F 'ship_postal_code=28307 '</code>
 +</WRAP>
 +>POST /order Create new order - используется для создания заказов.
 > >
-====== Price ====== +>id - Идентификатор заказа. При наличии чек-бокса Send empty value, идентификатор генерируется автоматически. 
->Price schema operations+> 
 +>status_id - [[ru:orderdescription|Status ID]] заказа. Активный чек-бокс Send empty value проставляет статус автоматически 
 +> 
 +>company_id - [[ru:comp|ID компании]] в ysell.pro 
 +> 
 +>platform - платформа для формирования заказа 
 +> 
 +>platform_order_id - идентификатор заказа на платформе 
 +> 
 +>purchase_date - дата приобретения заказа 
 +> 
 +>payment_date - дата оплаты заказа 
 +> 
 +>latest_ship_date - Окончание периода времени, в течение которого вы обязались отправить заказ 
 +> 
 +>currency - валюта 
 +> 
 +>ship_name - Имя получателя 
 +> 
 +>ship_email - Адрес электронной почты получателя 
 +> 
 +>ship_addr1 - Адрес получателя 
 +> 
 +>ship_city - Город получателя 
 +> 
 +>ship_postal_code - Почтовый индекс получателя 
 +> 
 +>ship_country - Страна получателя заказа 
 +> 
 +>ship_phone_number - Номер телефона получателя заказа
  
-====== Prep ======+---- 
 +<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|}}
  
-====== PrepShipments ======+---- 
 +<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|}}
  
 +----
  
 +<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|}}
  
-<WRAP center round important 80%> +----
-По умолчанию все API методы возвращают **20 записей**.+
  
-Обратите внимание на заголовки ответа +====== Shipments ======
  
- **x-pagination-current-page**: 1  - текущая страница +>//Операции с отправками// 
- +<WRAP right box> 
- **x-pagination-page-count**: 1 - всего страниц +**Curl** 
- +<code> 
-** x-pagination-per-page**: 20  - записей на страницу +curl -X 'GET' \ 
- +  'https://719.eu6.ysell.pro/api/v1/prep-shipment?page=1&per-page=10&sort=1' \ 
- **x-pagination-total-count**: 9  - всего записей +  -H 'accept: */*' \ 
- +  -H 'Authorization: Bearer 123321' 
-Для указания номера страницы укажите параметр **page=НомерСтраницы**+</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> </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** - текст примечания к отправке.
  • ru/api_start.1651500130.txt.gz
  • Последнее изменение: 2022/05/02 16:02
  • — support