Setting Ysell.pro through API

This is an old revision of the document!

API — application programming interface, it serves as an interface between programs and simplify their interaction.
Ysell provides the opportunity of working with web-services via our own API.

To work with the API you should specify API token for the User.
Bearer authentication is scheme of autentification of HTTP which uses markers of security, it's called bearer tokens. Bearer token is encoded string usually generated by server in answer to request of entering to the system. A client should send the token in the Authorization header while creating the request: Authorization: Bearer <token>

Go to the tab of users managing (Settings → Users)
Add a new user (API token should be field with random value)

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": ""
  },

Получение списка товара с клиента Getting products list of the client

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 = примечание.

Curl

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

Response body

[
  {
    "id": 1,
    "name": "Nespresso DE",
    "memo": ""
  },
  {
    "id": 2,
    "name": "SET",
    "memo": ""
  },
  {
    "id": 3,
    "name": "A&V furniture company ",
    "memo": null
  },
  {
    "id": 4,
    "name": "Test",
    "memo": ""
  },
  {
    "id": 5,
    "name": "2",
    "memo": ""
  },
]

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

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

/supplier Return all supplier - возвращает список поставщиков с клиента.

Curl

curl -X 'POST' \
  'https://719.eu6.ysell.pro/api/v1/supplier' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer ' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": 0,
  "name": "testSupplier2"
}'

Response body

{
  "id": 16,
  "name": "testSupplier2",
  "memo": null
}

Создание поставщика с названием testSupplier2

Post /Supplier Create new supplier

Укажите название поставщика. ID поставщика будет присвоено автоматически.

Curl

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

Response body

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

Получение информации по ID товара по номеру поставщика “322”

GET /supplier/{supplierNum}/product Find product by supplier num - используйте для возврата информации ID товара по номеру поставщика.

Curl

curl -X 'PUT' \
  'https://719.eu6.ysell.pro/api/v1/supplier/3' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer 123321' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": 0,
  "name": "UpdatedSupplier"
}'

Response body

{
  "id": 3,
  "name": "UpdatedSupplier",
  "memo": null
}

Обновление информации о поставщике с ID “3”

PUT /supplier/{supplierID} Update Supplier - используйте для редактирования информации о поставщике.

supplierId - укажите идентификатор поставщика

Curl

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

Удаление поставщика с ID “3”

Delete /supplier/{supplierID} - используйте для удаления информации о поставщике.
supplierId - Идентификатор поставщика.

Curl

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

Response body

[
  {
    "id": 1,
    "name": "Nespresso"
  },
  {
    "id": 3,
    "name": "A&V furniture company "
  },
]

Получение информации о производителях с клиента

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

GET /manufacturer Return all manufacturers - Используется для возврата информации о производителях с клиента.

Curl

curl -X 'POST' \
  'https://719.eu6.ysell.pro/api/v1/manufacturer' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer ' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": 0,
  "name": "NewManufacturer"
}'

Response body

{
  "id": 23,
  "name": "NewManufacturer"
}

Создание производителя “NewManufacturer”

Post /maufacturer Create new Manufacturer

Введите в строку “name” название производителя. ID производителя будет присвоен автоматически.

Curl

curl -X 'PUT' \
  'https://719.eu6.ysell.pro/api/v1/manufacturer/22' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer 123321' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": 0,
  "name": "NewManufacturer2"
}'

Response body

{
  "id": 22,
  "name": "NewManufacturer2"
}

Обновление информации о производителе с названием “NewManufacturer” - присвоение названия “NewManufacturer2”

PUT /manufacturer/{manufacturerID} Update Manufacturer - Используйте для редактирования информация о поставщике

manufacturerId - укажите ID производителя.
В строке “Name” укажите название производителя.

Curl

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

Удаление информации о производителе с ID “22”

Delete /manufacturer/{manufacturerID} Delete Manufacturer

Curl

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

Response body

[
  {
    "id": 1,
    "country_code": "GB",
    "currency": "GBP",
    "marketplace_id": "A1F83G8C2ARO7P",
    "url": "https://amazon.co.uk",
    "created_at": null,
    "updated_at": null,
    "sales_channel": "amazon.co.uk",
    "region": "AMAZON_EU",
    "endpoint": "https://mws-eu.amazonservices.com",
    "domain_zone": "co.uk"
  },
 ]

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

GET /marketplace Return all marketplaces - возвращает информацию о подключенных к клиенту маркетплейсах

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

Curl

curl -X 'GET' \
  'https://719.eu6.ysell.pro/api/v1/order?sort=o-719-67&page=1' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer '

Get /order Returns order - используется для получения информации о заказе

Curl

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 '

POST /order Create new order - используется для создания заказов.

id - Идентификатор заказа. При наличии чек-бокса Send empty value, идентификатор генерируется автоматически.

status_id - Status ID заказа. Активный чек-бокс Send empty value проставляет статус автоматически

company_id - 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 - Номер телефона получателя заказа

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=НомерСтраницы

Setting Ysell.pro through API

Product

Supplier

Manufacturer

Marketplace

Order

Price

Prep

PrepShipments

Wiki.ysell.pro