Настройка Ysell.pro через API

Это старая версия документа!

API — application programming interface, или «интерфейс прикладного программирования» — служит интерфейсом между программами и облегчает их взаимодействие.
Ysell предоставляет возможность работы c веб-сервисами через собственный API.

Для работы API необходимо установить API token для пользователя.
Bearer authentication это схема аутентификации HTTP, в которой используются маркеры безопасности, называемые bearer tokens. bearer token - это шифрованная строка, обычно генерируемая сервером в ответ на запрос на вход в систему. Клиент должен отправить этот токен в заголовке Authorization при формировании запроса: Authorization: Bearer <token>

Перейдите в раздел управления пользователями (Settings → Users)
Добавьте нового пользователя (необходимо заполнить поле API token случайным значением)

Curl

curl -X 'GET' \
  'https://719.eu6.ysell.pro/api/v1/product' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer'

Response body

[
  {
    "id": 1,
    "ext_id": "1",
    "title": "Melozio",
    "condition": "New",
    "manufacturer_id": 1,
    "purchase_price": "2.50",
    "netto": 100,
    "main_supplier": {
      "id": 1,
      "product_id": 1,
      "supplier_id": 1,
      "supplier_num": "45245634",
      "note": "",
      "url": "",
      "qty": 0,
      "price": "2.50",
      "discount_enabled": 0,
      "discount_price": null,
      "discount_qty": 0,
      "main": 1
    },
    "listings": [],
    "image": ""
  },

Получение списка товара с клиента

Get products list - Получение списка товара с клиента
Параметр page - укажите страницу, с которой происходит загрузка
Per-page - Кол-во товара на страницу

Create New Product

Curl

curl -X 'POST' \
  'https://719.eu6.ysell.pro/api/v1/product' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer  123321' \
  -H 'Content-Type: multipart/form-data' \
  -F 'productDimensionW=10' \
  -F 'masterboxWeight=17' \
  -F 'packageDimensionD=6' \
  -F 'productWeight=0.1' \
  -F 'masterboxDimensionD=60' \
  -F 'packageDimensionH=12' \
  -F 'productWeightUnits=kg' \
  -F 'manufacturer_id=1' \
  -F 'masterboxDimensionH=60' \
  -F 'product_image=https://719.eu6.ysell.pro/product_images/150/1.jpg' \
  -F 'masterboxQty=200' \
  -F 'productDimensionD=6' \
  -F 'masterboxWeightUnits=kg' \
  -F 'packageDimensionUnits=cm' \
  -F 'productDimensionH=12' \
  -F 'packageWeightUnits=kg' \
  -F 'masterboxDimensionUnits=cm' \
  -F 'packageDimensionW=10' \
  -F 'productDimensionUnits=cm' \
  -F 'title=Tequila Sunset' \
  -F 'ext_id=p-719-155' \
  -F 'masterboxDimensionW=120' \
  -F 'id=155' \
  -F 'packageWeight=0.5'

Response body

{
  "id": 155,
  "ext_id": "p-719-155",
  "title": "Tequila Sunset",
  "condition": "New",
  "manufacturer_id": 1,
  "purchase_price": null,
  "netto": 0,
  "main_supplier": null,
  "listings": [],
  "image": "https://719.eu6.ysell.pro/product_images/150/1.jpg"
}

Создание товара ID 155, названием Tequila Sunset, с указанием размера товара, упаковки товара, мастербокса, изображения товара.

id - ID товара в системе.
ext_id - Product ID товара
title - Название товара
product_image - ссылка на изображение товара.
manufacturer_id - ID из созданных ранее производителей товара.
packageDimensionW - размеры упаковки товара (Ширина)
packageDimensionH - размеры упаковки товара (Высота)
packageDimensionD - размеры упаковки товара (Глубина)
packageDimensionUnits - единицы измерения для упаковки товара
packageWeight - вес товара
packageWeightUnits - единицы измерения для веса товара
masterboxDimensionW - размеры коробки с товаром (Ширина)
masterboxDimensionH - размеры коробки с товаром (Высота)
masterboxDimensionD - размеры коробки с товаром (Глубина)
masterboxDimensionUnits - единицы измерения для коробки с товаром
masterboxQty - кол-во товара в Masterbox
masterboxWeight - вес коробки с товаром
masterboxWeightUnits - единицы измерения веса коробки с товаром
productDimensionD - размеры единицы товара (Глубина)
productDimensionW - размеры единицы товара (Ширина)
productDimensionH - размеры единицы товара (Высота)
productDimensionUnits - единицы измерения размера единицы товара
productWeightUnits - единицы измерения веса единицы товара
productWeight - вес единицы товара.

Curl

curl -X 'GET' \
  'https://719.eu6.ysell.pro/api/v1/product/155' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer  123321'

Response body

{
  "id": 155,
  "ext_id": "p-719-155",
  "title": "Tequila Sunset",
  "condition": "New",
  "manufacturer_id": 1,
  "purchase_price": null,
  "netto": 0,
  "main_supplier": null,
  "listings": [],
  "image": "https://719.eu6.ysell.pro/product_images/150/1.jpg"
}

Получение информации о товаре по его идентификатору.

Find Product by ID - используется для получение информации о конкретном товаре.

productId - укажите ID товара.

Update product - используйте для редактирования ранее созданных ID товара. В блоке Request body укажите информацию для редактирования.

productId - введите ID товара.

Curl

curl -X 'DELETE' \
  'https://719.eu6.ysell.pro/api/v1/product/153' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer  123321'

Удаление ID товара

Delete Product - используйте для удаления ID товара.

Create fbm/fba lisging - используйте для создания листингов Амазон.
productId - введите ID товара для добавления fbm/fba листинга.
company_id - ID компании, которая будет указана как владелец листинга.
marketplace_id - ID торговой площадки Список ID маркетплейсов
platform - маркетплейс, который будет использоваться для формирования листинга.
sku - указанный SKU будет использоваться при создании листинга.
asin - указанный ASIN будет использоваться при создании листинга.
type - укажите тип листинга - FBA/FBM
title - укажите название ID
price - укажите цену листинга.

Curl

curl -X 'POST' \
  'https://719.eu6.ysell.pro/api/v1/product/set-supplier' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer  123321' \
  -H 'Content-Type: multipart/form-data' \
  -F 'discount_enabled=1' \
  -F 'price=11' \
  -F 'discount_price=' \
  -F 'product_id=155' \
  -F 'supplier_id=3' \
  -F 'url=google.com' \
  -F 'note=Note' \
  -F 'supplier_num=322' \
  -F 'qty=14' \
  -F 'discount_qty=' \
  -F 'main=1'

Response body

{
  "id": 45,
  "product_id": 155,
  "supplier_id": 3,
  "supplier_num": "322",
  "note": "Note",
  "url": "google.com",
  "qty": "14",
  "price": "11",
  "discount_enabled": "1",
  "discount_price": null,
  "discount_qty": null,
  "main": "1"
}

Обновление Supplier товара

Update product Suplier - используется для обновления информации о поставщике товара

product_id - укажите ID товара.
supplier_id - укажите ID поставщика.
supplier_num - номер товара у поставщика
price - цена товара
discount_price - цена со скидкой
discount_enabled - опция для включения скидочной цены. 1 - включить. 0 - отключить.
qty - кол-во товара.
main - является ли поставщик основным
url - ссылка на сайт постащика
note = примечание.

Операции с поставщиками

Операции с производителями

Операции с торговыми площадками

Операции с заказами

Price schema operations

По умолчанию все API методы возвращают 20 записей.

Обратите внимание на заголовки ответа

x-pagination-current-page: 1 - текущая страница

x-pagination-page-count: 1 - всего страниц

x-pagination-per-page: 20 - записей на страницу

x-pagination-total-count: 9 - всего записей

Для указания номера страницы укажите параметр page=НомерСтраницы

Настройка Ysell.pro через API

Product

Supplier

Manufacturer

Marketplace

Order

Price

Prep

PrepShipments

Wiki.ysell.pro