Введение #
REST API Market Marketplace — позволяет манипулировать данными поставщика, используя запросы в формате JSON используя методы аутентификации
Аутентификация #
HTTP Базовая аутентификация #
Вы можете использовать HTTP Basic Auth, указав имя пользователя и пароль.
Для базовой аутентификации вы можете использовать плагин Basic Auth.
Иногда некоторые серверы могут неправильно анализировать заголовок авторизации (если вы видите ошибку “Имя пользователя отсутствует” при аутентификации по протоколу SSL, у вас проблема с сервером). В этом случае вы можете вместо этого указать имя пользователя / пароль в качестве параметров строки запроса.
Продукты #
API продуктов позволяет создавать, просматривать, обновлять и удалять продукты.
Свойства продукта #
Параметр | Тип | Описание |
---|---|---|
id |
целое число | Уникальный идентификатор для ресурса. READ-ONLY |
name |
строка | Название продукта Required — только для создания. |
slug |
строка | Ошибка продукта. |
permalink |
строка | URL-адрес продукта. READ-ONLY |
date_created |
Дата | -время — Дата создания продукта в часовом поясе сайта. READ-ONLY |
date_created_gmt |
Дата | -время — Дата создания продукта, как GMT. READ-ONLY |
date_modified |
Дата | -время — Дата последнего изменения продукта в часовом поясе сайта. READ-ONLY |
date_modified_gmt |
Дата | -время Дата последнего изменения продукта, как GMT. READ-ONLY |
type |
строка | Тип продукта. Параметры: простой, сгруппированный, внешний и переменный. Значение по умолчанию простое. |
status |
строка | Статус продукта (статус публикации). Параметры: черновик, ожидание, публикация. Это зависит от настроек администратора публикации поставщика |
featured |
логическое значение | Рекомендуемый продукт. Значение по умолчанию равно false. |
catalog_visibility |
строка | Видимость каталога. Параметры: видимый, каталог, поиск и скрытый. Отображается значение по умолчанию. |
description |
строка | Описание продукта. |
short_description |
строка | Краткое описание продукта. |
sku |
строка | Уникальный идентификатор. |
price |
строка | Текущая цена продукта. READ-ONLY |
regular_price |
строка | Обычная цена продукта. |
sale_price |
строка | Цена продажи продукта. |
date_on_sale_from |
Дата | -время начала цены продажи в часовом поясе сайта. |
date_on_sale_from_gmt |
Дата | -время начала цены продажи по Гринвичу. |
date_on_sale_to |
Дата | -дата окончания продажной цены в часовом поясе сайта. |
date_on_sale_to_gmt |
Дата | -дата окончания продажной цены по Гринвичу. |
price_html |
строка | Цена в формате HTML. READ-ONLY |
on_sale |
логическое значение | Показывает, есть ли продукт в продаже. READ-ONLY |
purchasable |
логическое значение | Показывает, можно ли купить продукт. READ-ONLY |
total_sales |
целое число | Объем продаж. READ-ONLY |
virtual |
логическое значение | Если продукт является виртуальным. Значение по умолчанию равно false. |
downloadable |
логическое значение | Если продукт можно загрузить. Значение по умолчанию равно false. |
downloads |
массив | Список загружаемых файлов. См. раздел Свойства загрузки продукта |
download_limit |
целое число | Количество загружаемых файлов, которые можно загрузить после покупки. Значение по умолчанию равно -1. |
download_expiry |
целое число | Количество дней до истечения срока доступа к загружаемым файлам. Значение по умолчанию равно -1. |
external_url |
строка | Внешний URL-адрес продукта. Только для внешних продуктов. |
button_text |
строка | Текст внешней кнопки продукта. Только для внешних продуктов. |
tax_status |
строка | Налоговый статус. Опции: облагается налогом, доставка и нет. По умолчанию облагается налогом. |
tax_class |
строка | Налоговый класс. |
manage_stock |
логическое значение | Управление запасами на уровне продукта. Значение по умолчанию равно false. |
stock_quantity |
целое число | Количество на складе. |
in_stock |
логическое значение | Определяет, указан ли продукт как “в наличии” или “отсутствует на складе” во внешнем интерфейсе. Значение по умолчанию равно true. |
backorders |
строка | При управлении запасами это определяет, разрешены ли резервные заказы. Параметры: нет, уведомлять и да. По умолчанию нет. |
backorders_allowed |
логическое значение | Показывает, разрешены ли обратные заказы. READ-ONLY |
backordered |
логическое значение | Показывает, находится ли продукт в резервном порядке. READ-ONLY |
sold_individually |
логическое значение | Разрешить покупку одного товара в одном заказе. Значение по умолчанию равно false. |
weight |
строка | Вес продукта. |
dimensions |
объект | Размеры продукта. См. раздел Свойства продукта — Размеры |
shipping_required |
логическое значение | Показывает, нужно ли отправлять продукт. READ-ONLY |
shipping_taxable |
логическое значение | Показывает, облагается ли налогом доставка продукта. READ-ONLY |
shipping_class |
строка | Ошибка класса доставки. |
shipping_class_id |
строка | Идентификатор класса доставки. READ-ONLY |
reviews_allowed |
логическое значение | Разрешить обзоры. Значение по умолчанию равно true. |
average_rating |
строка | Отзывы средний рейтинг. READ-ONLY |
rating_count |
целое число | Количество отзывов, которые есть у продукта. READ-ONLY |
related_ids |
массив | Список идентификаторов связанных продуктов. READ-ONLY |
upsell_ids |
массив | Список идентификаторов продуктов для продажи. |
cross_sell_ids |
массив | Список идентификаторов продуктов для перекрестных продаж. |
parent_id |
целое число | Идентификатор родительского продукта. |
purchase_note |
строка | Необязательное примечание для отправки клиенту после покупки. |
categories |
массив | Список категорий. См. раздел Свойства продуктов — Категории Required — только создавать |
tags |
массив | Список тегов. Смотрите Свойства тегов продукта |
attributes |
массив | Список атрибутов. См. раздел Свойства атрибутов продукта |
default_attributes |
массив | Атрибуты изменения по умолчанию. См. раздел Свойства атрибутов продукта по умолчанию |
variations |
массив | Список идентификаторов вариантов. READ-ONLY |
grouped_products |
массив | Список идентификаторов сгруппированных продуктов. |
menu_order |
целое число | Порядок в меню, используемый для пользовательской сортировки продуктов. |
meta_data |
массив | Метаданные. См. раздел Свойства метаданных продукта |
Свойства продукта — Загрузки #
Атрибут | Тип | Описание |
---|---|---|
id |
строка | Хэш файла MD5. READ-ONLY |
name |
строка | Имя файла. |
file |
строка | URL-адрес файла. |
Свойства продукта — Размеры #
Атрибут | Тип | Описание |
---|---|---|
length |
строка | Длина продукта. |
width |
строка | Ширина продукта. |
height |
строка | Высота продукта. |
Свойства категорий продуктов #
Атрибут | Тип | Описание |
---|---|---|
id |
целое число | Идентификатор категории. |
name |
строка | Название категории. READ-ONLY |
slug |
строка | Ошибка категории. READ-ONLY |
Свойства тегов продукта #
Атрибут | Тип | Описание |
---|---|---|
id |
целое число | Идентификатор тега. |
name |
строка | Имя тега. READ-ONLY |
slug |
строка | Ошибка с тегом. READ-ONLY |
Свойства продукта — Изображения #
Атрибут | Тип | Описание |
---|---|---|
id |
целое число | Идентификатор изображения. |
date_created |
дата-время | Дата создания изображения в часовом поясе сайта. READ-ONLY |
date_created_gmt |
дата-время | Дата создания образа, как GMT. READ-ONLY |
date_modified |
дата-время | Дата последнего изменения изображения в часовом поясе сайта. READ-ONLY |
date_modified_gmt |
дата-время | Дата последнего изменения изображения, как GMT. READ-ONLY |
src |
строка | URL-адрес изображения. |
name |
строка | Имя изображения. |
alt |
строка | Изображение альтернативного текста. |
position |
целое число | Положение изображения. 0 означает, что изображение является отображаемым. |
Свойства атрибутов продукта #
Атрибут | Тип | Описание |
---|---|---|
id |
целое число | Идентификатор атрибута. |
name |
строка | Имя атрибута. |
position |
целое число | Положение атрибута. |
visible |
логическое значение | Определите, отображается ли атрибут на вкладке “Дополнительная информация” на странице продукта. Значение по умолчанию равно false. |
variation |
логическое значение | Определите, можно ли использовать атрибут как вариант. Значение по умолчанию равно false. |
options |
массив | Список доступных имен терминов атрибута. |
Свойства атрибутов продукта по умолчанию #
Атрибут | Тип | Описание |
---|---|---|
id |
целое число | Идентификатор атрибута. |
name |
строка | Имя атрибута. |
option |
строка | Выбранное имя термина атрибута. |
Свойства метаданных продукта #
Атрибут | Тип | Описание |
---|---|---|
id |
целое число | Мета-идентификатор. READ-ONLY |
key |
строка | Мета-ключ. |
value |
строка | Мета-значение. |
Создание продукта #
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://help-ka.ru/market/wp-json/wcfmmp/v1/products",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "{
\"name\": \"TEST PRODUCT\",
\"type\": \"simple\",
\"regular_price\": \"20\",
\"description\": \"Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.\",
\"short_description\": \"Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.\",
\"featured_image\": {
\"src\": \"http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_front.jpg\"
},
\"gallery_images\": [
{
\"src\": \"http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_back.jpg\"
},
{
\"src\": \"http://demo.woothemes.com/woocommerce/wp-content/uploads/sites/56/2013/06/T_2_front.jpg\"
}
],
\"categories\": [\"37\", \"38\"]
}",
CURLOPT_HTTPHEADER => array(
"Authorization: Basic authorization_key",
"Cache-Control: no-cache",
"Content-Type: application/json",
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}```
>JSON response example:
```json
{
"id": 311,
"name": "Test Product",
"slug": "test-product",
"post_author": "2",
"permalink": "https://help-ka.ru/market/product/test-product/",
"date_created": "2018-12-13T11:38:00",
"date_created_gmt": "2018-12-13T11:38:00",
"date_modified": "2018-12-13T11:38:03",
"date_modified_gmt": "2018-12-13T11:38:03",
"type": "simple",
"status": "publish",
"featured": false,
"catalog_visibility": "visible",
"description": "<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.</p>\n",
"short_description": "<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.</p>\n",
"sku": "",
"price": "20",
"regular_price": "20",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"price_html": "<span class=\"woocommerce-Price-amount amount\"><span class=\"woocommerce-Price-currencySymbol\">₹</span>20.00</span>",
"on_sale": false,
"purchasable": true,
"total_sales": 0,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"external_url": "",
"button_text": "",
"tax_status": "taxable",
"tax_class": "",
"manage_stock": false,
"stock_quantity": null,
"low_stock_amount": "",
"in_stock": true,
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"sold_individually": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_required": true,
"shipping_taxable": true,
"shipping_class": "",
"shipping_class_id": 0,
"reviews_allowed": true,
"average_rating": "0.00",
"rating_count": 0,
"related_ids": [
37,
33,
35,
32,
34
],
"upsell_ids": [],
"cross_sell_ids": [],
"parent_id": 0,
"purchase_note": "",
"categories": [
{
"id": 37,
"name": "Accessories",
"slug": "accessories"
},
{
"id": 38,
"name": "Hoodies",
"slug": "hoodies"
}
],
"tags": [],
"images": [
{
"id": 312,
"date_created": "2018-12-13T11:38:01",
"date_created_gmt": "2018-12-13T11:38:01",
"date_modified": "2018-12-13T11:38:01",
"date_modified_gmt": "2018-12-13T11:38:01",
"src": "https://help-ka.ru/market/wp-content/uploads/2018/12/T_2_front-17.jpg",
"name": "T_2_front-17.jpg",
"alt": "",
"position": 0
},
{
"id": 313,
"date_created": "2018-12-13T11:38:02",
"date_created_gmt": "2018-12-13T11:38:02",
"date_modified": "2018-12-13T11:38:02",
"date_modified_gmt": "2018-12-13T11:38:02",
"src": "https://help-ka.ru/market/wp-content/uploads/2018/12/T_2_front-18.jpg",
"name": "T_2_front-18.jpg",
"alt": "",
"position": 1
},
{
"id": 314,
"date_created": "2018-12-13T11:38:03",
"date_created_gmt": "2018-12-13T11:38:03",
"date_modified": "2018-12-13T11:38:03",
"date_modified_gmt": "2018-12-13T11:38:03",
"src": "https://help-ka.ru/market/wp-content/uploads/2018/12/T_2_back-1.jpg",
"name": "T_2_back-1.jpg",
"alt": "",
"position": 2
}
],
"attributes": [],
"default_attributes": [],
"variations": [],
"grouped_products": [],
"menu_order": 0,
"meta_data": [
{
"id": 5990,
"key": "_catalog",
"value": "no"
},
{
"id": 5991,
"key": "disable_add_to_cart",
"value": "no"
},
{
"id": 5992,
"key": "disable_price",
"value": "no"
},
{
"id": 5993,
"key": "wcfm_policy_product_options",
"value": [
""
]
}
],
"_links": {
"self": [
{
"href": "https://help-ka.ru/market/wp-json/wcfmmp/v1/products/311"
}
],
"collection": [
{
"href": "https://help-ka.ru/market/wp-json/wcfmmp/v1/products"
}
]
}
}
Эта конечная точка поможет вам создать новый продукт.
HTTP-запрос #
POST https://help-ka.ru/market/wp-json/wcfmmp/v1/products/
Параметры запроса #
Принять все параметры для свойства продукта
Получить единый продукт #
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://help-ka.ru/market/wp-json/wcfmmp/v1/products/311",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"Authorization: Basic authorization_token",
"Cache-Control: no-cache",
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
Пример ответа в формате JSON:
{
"id": 311,
"name": "Test Product",
"slug": "test-product",
"post_author": "2",
"permalink": "https://help-ka.ru/market/product/test-product/",
"date_created": "2018-12-13T11:38:00",
"date_created_gmt": "2018-12-13T11:38:00",
"date_modified": "2018-12-13T11:38:03",
"date_modified_gmt": "2018-12-13T11:38:03",
"type": "simple",
"status": "publish",
"featured": false,
"catalog_visibility": "visible",
"description": "<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.</p>\n",
"short_description": "<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.</p>\n",
"sku": "",
"price": "20",
"regular_price": "20",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"price_html": "<span class=\"woocommerce-Price-amount amount\"><span class=\"woocommerce-Price-currencySymbol\">₹</span>20.00</span>",
"on_sale": false,
"purchasable": true,
"total_sales": 0,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"external_url": "",
"button_text": "",
"tax_status": "taxable",
"tax_class": "",
"manage_stock": false,
"stock_quantity": null,
"low_stock_amount": "",
"in_stock": true,
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"sold_individually": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_required": true,
"shipping_taxable": true,
"shipping_class": "",
"shipping_class_id": 0,
"reviews_allowed": true,
"average_rating": "0.00",
"rating_count": 0,
"related_ids": [
31,
32,
33,
38,
37
],
"upsell_ids": [],
"cross_sell_ids": [],
"parent_id": 0,
"purchase_note": "",
"categories": [
{
"id": 37,
"name": "Accessories",
"slug": "accessories"
},
{
"id": 38,
"name": "Hoodies",
"slug": "hoodies"
}
],
"tags": [],
"images": [
{
"id": 312,
"date_created": "2018-12-13T11:38:01",
"date_created_gmt": "2018-12-13T11:38:01",
"date_modified": "2018-12-13T11:38:01",
"date_modified_gmt": "2018-12-13T11:38:01",
"src": "https://help-ka.ru/market/wp-content/uploads/2018/12/T_2_front-17.jpg",
"name": "T_2_front-17.jpg",
"alt": "",
"position": 0
},
{
"id": 313,
"date_created": "2018-12-13T11:38:02",
"date_created_gmt": "2018-12-13T11:38:02",
"date_modified": "2018-12-13T11:38:02",
"date_modified_gmt": "2018-12-13T11:38:02",
"src": "https://help-ka.ru/market/wp-content/uploads/2018/12/T_2_front-18.jpg",
"name": "T_2_front-18.jpg",
"alt": "",
"position": 1
},
{
"id": 314,
"date_created": "2018-12-13T11:38:03",
"date_created_gmt": "2018-12-13T11:38:03",
"date_modified": "2018-12-13T11:38:03",
"date_modified_gmt": "2018-12-13T11:38:03",
"src": "https://help-ka.ru/market/wp-content/uploads/2018/12/T_2_back-1.jpg",
"name": "T_2_back-1.jpg",
"alt": "",
"position": 2
}
],
"attributes": [],
"default_attributes": [],
"variations": [],
"grouped_products": [],
"menu_order": 0,
"meta_data": [
{
"id": 5990,
"key": "_catalog",
"value": "no"
},
{
"id": 5991,
"key": "disable_add_to_cart",
"value": "no"
},
{
"id": 5992,
"key": "disable_price",
"value": "no"
},
{
"id": 5993,
"key": "wcfm_policy_product_options",
"value": [
""
]
}
],
"_links": {
"self": [
{
"href": "https://help-ka.ru/market/wp-json/wcfmmp/v1/products/311"
}
],
"collection": [
{
"href": "https://help-ka.ru/market/wp-json/wcfmmp/v1/products"
}
]
}
}
Этот API позволяет извлекать и просматривать конкретный продукт по идентификатору.
HTTP-запрос #
GET https://help-ka.ru/market/wp-json/wcfmmp/v1/products/<id>
Получить все продукты #
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://help-ka.ru/market/wp-json/wcfmmp/v1/products/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"Authorization: Basic authorization_key",
"Cache-Control: no-cache",
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
Пример ответа в формате JSON:
[
{
"id": 311,
"name": "Test Product",
"slug": "test-product",
"post_author": "2",
"permalink": "https://help-ka.ru/market/product/test-product/",
"date_created": "2018-12-13T11:38:00",
"date_created_gmt": "2018-12-13T11:38:00",
"date_modified": "2018-12-13T11:38:03",
"date_modified_gmt": "2018-12-13T11:38:03",
"type": "simple",
"status": "publish",
"featured": false,
"catalog_visibility": "visible",
"description": "<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.</p>\n",
"short_description": "<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.</p>\n",
"sku": "",
"price": "20",
"regular_price": "20",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"price_html": "<span class=\"woocommerce-Price-amount amount\"><span class=\"woocommerce-Price-currencySymbol\">₹</span>20.00</span>",
"on_sale": false,
"purchasable": true,
"total_sales": 0,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"external_url": "",
"button_text": "",
"tax_status": "taxable",
"tax_class": "",
"manage_stock": false,
"stock_quantity": null,
"low_stock_amount": "",
"in_stock": true,
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"sold_individually": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_required": true,
"shipping_taxable": true,
"shipping_class": "",
"shipping_class_id": 0,
"reviews_allowed": true,
"average_rating": "0.00",
"rating_count": 0,
"related_ids": [
36,
31,
33,
35,
34
],
"upsell_ids": [],
"cross_sell_ids": [],
"parent_id": 0,
"purchase_note": "",
"categories": [
{
"id": 37,
"name": "Accessories",
"slug": "accessories"
},
{
"id": 38,
"name": "Hoodies",
"slug": "hoodies"
}
],
"tags": [],
"images": [
{
"id": 312,
"date_created": "2018-12-13T11:38:01",
"date_created_gmt": "2018-12-13T11:38:01",
"date_modified": "2018-12-13T11:38:01",
"date_modified_gmt": "2018-12-13T11:38:01",
"src": "https://help-ka.ru/market/wp-content/uploads/2018/12/T_2_front-17.jpg",
"name": "T_2_front-17.jpg",
"alt": "",
"position": 0
},
{
"id": 313,
"date_created": "2018-12-13T11:38:02",
"date_created_gmt": "2018-12-13T11:38:02",
"date_modified": "2018-12-13T11:38:02",
"date_modified_gmt": "2018-12-13T11:38:02",
"src": "https://help-ka.ru/market/wp-content/uploads/2018/12/T_2_front-18.jpg",
"name": "T_2_front-18.jpg",
"alt": "",
"position": 1
},
{
"id": 314,
"date_created": "2018-12-13T11:38:03",
"date_created_gmt": "2018-12-13T11:38:03",
"date_modified": "2018-12-13T11:38:03",
"date_modified_gmt": "2018-12-13T11:38:03",
"src": "https://help-ka.ru/market/wp-content/uploads/2018/12/T_2_back-1.jpg",
"name": "T_2_back-1.jpg",
"alt": "",
"position": 2
}
],
"attributes": [],
"default_attributes": [],
"variations": [],
"grouped_products": [],
"menu_order": 0,
"meta_data": [
{
"id": 5990,
"key": "_catalog",
"value": "no"
},
{
"id": 5991,
"key": "disable_add_to_cart",
"value": "no"
},
{
"id": 5992,
"key": "disable_price",
"value": "no"
},
{
"id": 5993,
"key": "wcfm_policy_product_options",
"value": [
""
]
}
],
"_links": {
"self": [
{
"href": "https://help-ka.ru/market/wp-json/wcfmmp/v1/products/311"
}
],
"collection": [
{
"href": "https://help-ka.ru/market/wp-json/wcfmmp/v1/products"
}
]
}
},
{
"id": 31,
"name": "Beanie",
"slug": "beanie",
"post_author": "2",
"permalink": "<site_base_url>/product/beanie/",
"date_created": "2018-08-20T07:57:55",
"date_created_gmt": "2018-08-20T07:57:55",
"date_modified": "2018-08-20T07:57:55",
"date_modified_gmt": "2018-08-20T07:57:55",
"type": "simple",
"status": "publish",
"featured": false,
"catalog_visibility": "visible",
"description": "<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.</p>\n",
"short_description": "",
"sku": "",
"price": "18",
"regular_price": "20",
"sale_price": "18",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"price_html": "<del><span class=\"woocommerce-Price-amount amount\"><span class=\"woocommerce-Price-currencySymbol\">₹</span>20.00</span></del> <ins><span class=\"woocommerce-Price-amount amount\"><span class=\"woocommerce-Price-currencySymbol\">₹</span>18.00</span></ins>",
"on_sale": true,
"purchasable": true,
"total_sales": 0,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"external_url": "",
"button_text": "",
"tax_status": "taxable",
"tax_class": "",
"manage_stock": false,
"stock_quantity": null,
"low_stock_amount": "",
"in_stock": true,
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"sold_individually": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_required": true,
"shipping_taxable": true,
"shipping_class": "",
"shipping_class_id": 0,
"reviews_allowed": true,
"average_rating": "0.00",
"rating_count": 0,
"related_ids": [
34,
32,
33,
311
],
"upsell_ids": [],
"cross_sell_ids": [],
"parent_id": 0,
"purchase_note": "",
"categories": [
{
"id": 37,
"name": "Accessories",
"slug": "accessories"
}
],
"tags": [],
"images": [
{
"id": 13,
"date_created": "2018-08-20T07:57:54",
"date_created_gmt": "2018-08-20T07:57:54",
"date_modified": "2018-08-20T07:57:54",
"date_modified_gmt": "2018-08-20T07:57:54",
"src": "https://help-ka.ru/market/wp-content/uploads/2018/08/beanie.jpg",
"name": "Beanie",
"alt": "",
"position": 0
}
],
"attributes": [],
"default_attributes": [],
"variations": [],
"grouped_products": [],
"menu_order": 0,
"meta_data": [
{
"id": 75,
"key": "_customize_changeset_uuid",
"value": "c70ab6e1-48e3-43dd-875f-18b42284005f"
},
{
"id": 494,
"key": "_wcfm_product_views",
"value": "1"
}
],
"_links": {
"self": [
{
"href": "https://help-ka.ru/market/wp-json/wcfmmp/v1/products/31"
}
],
"collection": [
{
"href": "https://help-ka.ru/market/wp-json/wcfmmp/v1/products"
}
]
}
}
]
Эта конечная точка извлекает все продукты для авторизованного поставщика.
HTTP-запрос #
GET https://help-ka.ru/market/wp-json/wcfmmp/v1/products/
Обновление продукта #
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "<https://help-ka.ru/market/wp-json/wcfmmp/v1/products/311",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => "{\n \"name\": \"Test Product Name Change\"\n}",
CURLOPT_HTTPHEADER => array(
"Authorization: Basic authorization_token",
"Cache-Control: no-cache",
"Content-Type: application/json",
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
Пример ответа в формате JSON:
{
"id": 311,
"name": "Test Product Name Change",
"slug": "test-product",
"post_author": "2",
"permalink": "https://help-ka.ru/market/product/test-product/",
"date_created": "2018-12-13T11:38:00",
"date_created_gmt": "2018-12-13T11:38:00",
"date_modified": "2018-12-13T11:38:03",
"date_modified_gmt": "2018-12-13T11:38:03",
"type": "simple",
"status": "publish",
"featured": false,
"catalog_visibility": "visible",
"description": "<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.</p>\n",
"short_description": "<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.</p>\n",
"sku": "",
"price": "20",
"regular_price": "20",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"price_html": "<span class=\"woocommerce-Price-amount amount\"><span class=\"woocommerce-Price-currencySymbol\">₹</span>20.00</span>",
"on_sale": false,
"purchasable": true,
"total_sales": 0,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"external_url": "",
"button_text": "",
"tax_status": "taxable",
"tax_class": "",
"manage_stock": false,
"stock_quantity": null,
"low_stock_amount": "",
"in_stock": true,
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"sold_individually": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_required": true,
"shipping_taxable": true,
"shipping_class": "",
"shipping_class_id": 0,
"reviews_allowed": true,
"average_rating": "0.00",
"rating_count": 0,
"related_ids": [
36,
31,
33,
35,
34
],
"upsell_ids": [],
"cross_sell_ids": [],
"parent_id": 0,
"purchase_note": "",
"categories": [
{
"id": 37,
"name": "Accessories",
"slug": "accessories"
},
{
"id": 38,
"name": "Hoodies",
"slug": "hoodies"
}
],
"tags": [],
"images": [
{
"id": 312,
"date_created": "2018-12-13T11:38:01",
"date_created_gmt": "2018-12-13T11:38:01",
"date_modified": "2018-12-13T11:38:01",
"date_modified_gmt": "2018-12-13T11:38:01",
"src": "https://help-ka.ru/market/wp-content/uploads/2018/12/T_2_front-17.jpg",
"name": "T_2_front-17.jpg",
"alt": "",
"position": 0
},
{
"id": 313,
"date_created": "2018-12-13T11:38:02",
"date_created_gmt": "2018-12-13T11:38:02",
"date_modified": "2018-12-13T11:38:02",
"date_modified_gmt": "2018-12-13T11:38:02",
"src": "https://help-ka.ru/market/wp-content/uploads/2018/12/T_2_front-18.jpg",
"name": "T_2_front-18.jpg",
"alt": "",
"position": 1
},
{
"id": 314,
"date_created": "2018-12-13T11:38:03",
"date_created_gmt": "2018-12-13T11:38:03",
"date_modified": "2018-12-13T11:38:03",
"date_modified_gmt": "2018-12-13T11:38:03",
"src": "https://help-ka.ru/market/wp-content/uploads/2018/12/T_2_back-1.jpg",
"name": "T_2_back-1.jpg",
"alt": "",
"position": 2
}
],
"attributes": [],
"default_attributes": [],
"variations": [],
"grouped_products": [],
"menu_order": 0,
"meta_data": [
{
"id": 5990,
"key": "_catalog",
"value": "no"
},
{
"id": 5991,
"key": "disable_add_to_cart",
"value": "no"
},
{
"id": 5992,
"key": "disable_price",
"value": "no"
},
{
"id": 5993,
"key": "wcfm_policy_product_options",
"value": [
""
]
}
],
"_links": {
"self": [
{
"href": "https://help-ka.ru/market/wp-json/wcfmmp/v1/products/311"
}
],
"collection": [
{
"href": "https://help-ka.ru/market/wp-json/wcfmmp/v1/products"
}
]
}
}
Этот API позволяет вносить изменения в продукт.
HTTP-запрос #
PUT https://help-ka.ru/market/wp-json/wcfmmp/v1/products/<id>
Удалить продукт #
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://help-ka.ru/market/wp-json/wcfmmp/v1/products/311",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => array(
"Authorization: Basic authorization_token",
"Cache-Control: no-cache",
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
Пример ответа в формате JSON:
{
"id": 311,
"name": "Test Product Name Change",
"slug": "test-product",
"post_author": "2",
"permalink": "https://help-ka.ru/market/product/test-product/",
"date_created": "2018-12-13T11:38:00",
"date_created_gmt": "2018-12-13T11:38:00",
"date_modified": "2018-12-13T11:38:03",
"date_modified_gmt": "2018-12-13T11:38:03",
"type": "simple",
"status": "publish",
"featured": false,
"catalog_visibility": "visible",
"description": "<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.</p>\n",
"short_description": "<p>Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.</p>\n",
"sku": "",
"price": "20",
"regular_price": "20",
"sale_price": "",
"date_on_sale_from": null,
"date_on_sale_from_gmt": null,
"date_on_sale_to": null,
"date_on_sale_to_gmt": null,
"price_html": "<span class=\"woocommerce-Price-amount amount\"><span class=\"woocommerce-Price-currencySymbol\">₹</span>20.00</span>",
"on_sale": false,
"purchasable": true,
"total_sales": 0,
"virtual": false,
"downloadable": false,
"downloads": [],
"download_limit": -1,
"download_expiry": -1,
"external_url": "",
"button_text": "",
"tax_status": "taxable",
"tax_class": "",
"manage_stock": false,
"stock_quantity": null,
"low_stock_amount": "",
"in_stock": true,
"backorders": "no",
"backorders_allowed": false,
"backordered": false,
"sold_individually": false,
"weight": "",
"dimensions": {
"length": "",
"width": "",
"height": ""
},
"shipping_required": true,
"shipping_taxable": true,
"shipping_class": "",
"shipping_class_id": 0,
"reviews_allowed": true,
"average_rating": "0.00",
"rating_count": 0,
"related_ids": [
36,
31,
33,
35,
34
],
"upsell_ids": [],
"cross_sell_ids": [],
"parent_id": 0,
"purchase_note": "",
"categories": [
{
"id": 37,
"name": "Accessories",
"slug": "accessories"
},
{
"id": 38,
"name": "Hoodies",
"slug": "hoodies"
}
],
"tags": [],
"images": [
{
"id": 312,
"date_created": "2018-12-13T11:38:01",
"date_created_gmt": "2018-12-13T11:38:01",
"date_modified": "2018-12-13T11:38:01",
"date_modified_gmt": "2018-12-13T11:38:01",
"src": "https://help-ka.ru/market/wp-content/uploads/2018/12/T_2_front-17.jpg",
"name": "T_2_front-17.jpg",
"alt": "",
"position": 0
},
{
"id": 313,
"date_created": "2018-12-13T11:38:02",
"date_created_gmt": "2018-12-13T11:38:02",
"date_modified": "2018-12-13T11:38:02",
"date_modified_gmt": "2018-12-13T11:38:02",
"src": "https://help-ka.ru/market/wp-content/uploads/2018/12/T_2_front-18.jpg",
"name": "T_2_front-18.jpg",
"alt": "",
"position": 1
},
{
"id": 314,
"date_created": "2018-12-13T11:38:03",
"date_created_gmt": "2018-12-13T11:38:03",
"date_modified": "2018-12-13T11:38:03",
"date_modified_gmt": "2018-12-13T11:38:03",
"src": "https://help-ka.ru/market/wp-content/uploads/2018/12/T_2_back-1.jpg",
"name": "T_2_back-1.jpg",
"alt": "",
"position": 2
}
],
"attributes": [],
"default_attributes": [],
"variations": [],
"grouped_products": [],
"menu_order": 0,
"meta_data": [
{
"id": 5990,
"key": "_catalog",
"value": "no"
},
{
"id": 5991,
"key": "disable_add_to_cart",
"value": "no"
},
{
"id": 5992,
"key": "disable_price",
"value": "no"
},
{
"id": 5993,
"key": "wcfm_policy_product_options",
"value": [
""
]
}
],
"_links": {
"self": [
{
"href": "https://help-ka.ru/market/wp-json/wcfmmp/v1/products/311"
}
],
"collection": [
{
"href": "https://help-ka.ru/market/wp-json/wcfmmp/v1/products"
}
]
}
}
Эта конечная точка поможет вам удалить продукт.
HTTP-запрос #
DELETE https://help-ka.ru/market/wp-json/wcfmmp/v1/products/<id>
Заказы #
API заказов позволяет просматривать заказы или отдельный заказ.
Свойства заказа #
Атрибут | Тип | Описание |
---|---|---|
id |
целое число | Уникальный идентификатор для ресурса. read-only |
parent_id |
целое число | Идентификатор родительского заказа. |
number |
строка | Номер заказа. read-only |
order_key |
строка | Ключ заказа. read-only |
created_via |
строка | Показывает, где был создан заказ. read-only |
version |
целое число | Версия WooCommerce, в которой последний раз обновлялся заказ. read-only |
status |
строка | Статус заказа. Параметры: pending , processing , on-hold , completed , cancelled , refunded и failed . По умолчанию pending . |
currency |
строка | Валюта, с которой был создан заказ, в формате ISO. Параметры: AED , AFN , ALL , AMD , ANG , AOA , ARS , AUD , AWG , AZN , BAM , BBD , BDT , BGN , BHD , BIF , BMD , BND , BOB , BRL , BSD , BTC , BTN , BWP , BYR , BZD , CAD , CDF , CHF , CLP , CNY , COP , CRC , CUC , CUP , CVE , CZK , DJF , DKK , DOP , DZD , EGP , ERN , ETB , EUR , FJD , FKP , GBP , GEL , GGP , GHS , GIP , GMD , GNF , GTQ , GYD , HKD , HNL ,HRK , HTG , HUF , IDR , ILS , IMP , INR , IQD , IRR , IRT , ISK , JEP , JMD , JOD , JPY , KES , KGS , KHR , KMF , KPW , KRW , KWD , KYD , KZT , LAK , LBP , LKR , LRD , LSL , LYD , MAD , MDL , MGA , MKD , MMK , MNT , MOP , MRO , MUR , MVR , MWK , MXN , MYR , MZN , NAD , NGN , NIO , NOK , NPR , NZD , OMR , PAB , PEN , PGK , PHP , PKR , PLN , PRB , PYG , QAR ,RON , RSD , RUB , RWF , SAR , SBD , SCR , SDG , SEK , SGD , SHP , SLL , SOS , SRD , SSP , STD , SYP , SZL , THB , TJS , TMT , TND , TOP , TRY , TTD , TWD , TZS , UAH , UGX , USD , UYU , UZS , VEF , VND , VUV , WST , XAF , XCD , XOF , XPF , YER , ZAR и ZMW еще . По умолчанию USD . |
date_created |
дата-время | Дата создания заказа в часовом поясе сайта. read-only |
date_created_gmt |
дата-время | Дата создания заказа, как GMT. read-only |
date_modified |
дата-время | Дата последнего изменения заказа в часовом поясе сайта. read-only |
date_modified_gmt |
дата-время | Дата последнего изменения заказа, как GMT. read-only |
discount_total |
строка | Общая сумма скидки для заказа. read-only |
discount_tax |
строка | Общая сумма налога со скидкой для заказа. read-only |
shipping_total |
строка | Общая сумма доставки для заказа. read-only |
shipping_tax |
строка | Общая сумма налога на доставку для заказа. read-only |
cart_tax |
строка | Только сумма налогов на позиции. read-only |
total |
строка | Общий итог. read-only |
total_tax |
строка | Сумма всех налогов. read-only |
prices_include_tax |
логическое значение | Правда, цены включали налог при оформлении заказа. read-only |
customer_id |
целое число | Идентификатор пользователя, которому принадлежит заказ. 0 для гостей. По умолчанию 0 . |
customer_ip_address |
строка | IP-адрес клиента. read-only |
customer_user_agent |
строка | Пользовательский агент клиента. read-only |
customer_note |
строка | Примечание, оставленное клиентом при оформлении заказа. |
billing |
объект | Адрес для выставления счетов. |
shipping |
объект | Адрес доставки. |
payment_method |
строка | Идентификатор способа оплаты. |
payment_method_title |
строка | Название способа оплаты. |
transaction_id |
строка | Уникальный идентификатор транзакции. |
date_paid |
дата-время | Дата оплаты заказа в часовом поясе сайта. read-only |
date_paid_gmt |
дата-время | Дата оплаты заказа, как GMT. read-only |
date_completed |
дата-время | Дата выполнения заказа в часовом поясе сайта. read-only |
date_completed_gmt |
дата-время | Дата завершения заказа, как GMT. read-only |
cart_hash |
строка | MD5 хэш элементов корзины, чтобы гарантировать, что заказы не будут изменены. read-only |
meta_data |
массив | Метаданные. |
line_items |
массив | Данные о позициях. |
tax_lines |
массив | Данные налоговых строк. read-only |
shipping_lines |
массив | Данные о линиях доставки. |
fee_lines |
массив | Данные строк оплаты. |
coupon_lines |
массив | Данные строки купонов. |
refunds |
массив | Список возвратов. read-only |
set_paid |
логическое значение | Определите, является ли заказ оплаченным. Он установит статус обработки и уменьшит количество товаров на складе. По умолчанию false . write-only |
Свойства заказа — выставления счетов #
Атрибут | Тип | Описание |
---|---|---|
first_name |
строка | Имя. |
last_name |
строка | Фамилия. |
company |
строка | Название компании. |
address_1 |
строка | Адресная строка 1 |
address_2 |
строка | Адресная строка 2 |
city |
строка | Название города. |
state |
строка | Код ISO или название штата, провинции или района. |
postcode |
строка | Почтовый индекс. |
country |
строка | Код страны в формате ISO 3166-1 alpha-2. |
email |
строка | Эл. адрес. |
phone |
строка | Номер телефона. |
Свойства заказа — Доставка #
Атрибут | Тип | Описание |
---|---|---|
first_name |
строка | Имя. |
last_name |
строка | Фамилия. |
company |
строка | Название компании. |
address_1 |
строка | Адресная строка 1 |
address_2 |
строка | Адресная строка 2 |
city |
строка | Название города. |
state |
строка | Код ISO или название штата, провинции или района. |
postcode |
строка | Почтовый индекс. |
country |
строка | Код страны в формате ISO 3166-1 alpha-2. |
Заказ — свойства метаданных #
Атрибут | Тип | Описание |
---|---|---|
id |
целое число | Мета-идентификатор. read-only |
key |
строка | Мета-ключ. |
value |
строка | Мета-значение. |
Свойства позиций заказа #
Атрибут | Тип | Описание |
---|---|---|
id |
целое число | Идентификатор товара. read-only |
name |
строка | Название продукта. |
product_id |
целое число | Идентификатор продукта. |
variation_id |
целое число | Идентификатор варианта, если применимо. |
quantity |
целое число | Заказанное количество. |
tax_class |
целое число | Налоговый класс продукта. |
subtotal |
строка | Промежуточный итог строки (до скидок). |
subtotal_tax |
строка | Строка промежуточного итога налога (до скидок). read-only |
total |
строка | Общее количество строк (после скидок). |
total_tax |
строка | Строка общий налог (после скидок). read-only |
taxes |
массив | Налоги на строку. read-only |
meta_data |
массив | Метаданные. |
sku |
строка | Артикул продукта. read-only |
price |
строка | Цена продукта. read-only |
Свойства строк заказа — налога #
Атрибут | Тип | Описание |
---|---|---|
id |
целое число | Идентификатор товара. read-only |
rate_code |
строка | Код налоговой ставки. read-only |
rate_id |
строка | Идентификатор налоговой ставки. read-only |
label |
строка | Метка налоговой ставки. read-only |
compound |
логическое значение | Показать, если это сложная налоговая ставка. read-only |
tax_total |
строка | Общая сумма налогов (не включая налоги на доставку). read-only |
shipping_tax_total |
строка | Общий налог на доставку. read-only |
meta_data |
массив | Метаданные. |
Заказ — Свойства линий доставки #
Атрибут | Тип | Описание |
---|---|---|
id |
целое число | Идентификатор товара. read-only |
method_title |
строка | Название способа доставки. |
method_id |
строка | Идентификатор метода доставки. |
total |
строка | Общее количество строк (после скидок). |
total_tax |
строка | Строка общий налог (после скидок). read-only |
taxes |
массив | Налоги на строку. read-only |
meta_data |
массив | Метаданные. |
Свойства строк оплаты заказа #
Атрибут | Тип | Описание |
---|---|---|
id |
целое число | Идентификатор товара. read-only |
name |
строка | Название комиссии. |
tax_class |
строка | Налоговый класс платы. |
tax_status |
строка | Налоговый статус сбора. Параметры: taxable и none . |
total |
строка | Общее количество строк (после скидок). |
total_tax |
строка | Строка общий налог (после скидок). read-only |
taxes |
массив | Налоги на строку. read-only |
meta_data |
массив | Метаданные. |
Свойства строк заказа — купона #
Атрибут | Тип | Описание |
---|---|---|
id |
целое число | Идентификатор товара. read-only |
code |
строка | Код купона. |
discount |
строка | Общая скидка. |
discount_tax |
строка | Скидка на общий налог. read-only |
meta_data |
массив | Метаданные. |
Свойства возврата заказа #
Атрибут | Тип | Описание |
---|---|---|
id |
целое число | Идентификатор возврата. read-only |
reason |
строка | Причина возврата. read-only |
total |
строка | Общая сумма возврата. read-only |
Получить заказ #
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://help-ka.ru/market/wp-json/wcfmmp/v1/orders/274",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"Authorization: Basic authorization_token",
"Cache-Control: no-cache",
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
Пример ответа в формате JSON:
[
{
"id": 274,
"parent_id": 0,
"status": "on-hold",
"currency": "INR",
"version": "3.5.1",
"prices_include_tax": false,
"date_created": "2018-12-07T09:08:53",
"date_modified": "2018-12-07T09:08:58",
"discount_total": "0",
"discount_tax": "0",
"shipping_total": "20.00",
"shipping_tax": "0",
"cart_tax": "0",
"total": "654.00",
"total_tax": "0",
"customer_id": 1,
"order_key": "wc_order_5c0a38a5cc476",
"billing": {
"first_name": "test",
"last_name": "name",
"company": "",
"address_1": "TEST",
"address_2": "111",
"city": "Kolkata",
"state": "WB",
"postcode": "700001",
"country": "IN",
"email": "test@gmail.com",
"phone": "21111111111"
},
"shipping": {
"first_name": "test",
"last_name": "name",
"company": "",
"address_1": "PAS Road",
"address_2": "111",
"city": "Kolkata",
"state": "WB",
"postcode": "700001",
"country": "IN"
},
"payment_method": "cheque",
"payment_method_title": "Check payments",
"transaction_id": "",
"customer_ip_address": "::1",
"customer_user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36",
"created_via": "checkout",
"customer_note": "",
"date_completed": null,
"date_paid": null,
"cart_hash": "e053bc38a043cfc980292231c5b33318",
"number": "274",
"meta_data": [
{
"id": 5206,
"key": "_wcfmmp_order_processed",
"value": "yes"
},
{
"id": 5210,
"key": "_wcfm_new_order_notified",
"value": "yes"
}
],
"line_items": [
{
"id": 5,
"name": "Test Product",
"product_id": 257,
"variation_id": 0,
"quantity": 1,
"tax_class": "",
"subtotal": "299",
"subtotal_tax": "0",
"total": "299",
"total_tax": "0",
"taxes": [],
"meta_data": [
{
"id": 91,
"key": "_vendor_id",
"value": "2"
}
],
"sku": "",
"price": 299
},
{
"id": 6,
"name": "test prod",
"product_id": 272,
"variation_id": 0,
"quantity": 1,
"tax_class": "",
"subtotal": "299",
"subtotal_tax": "0",
"total": "299",
"total_tax": "0",
"taxes": [],
"meta_data": [
{
"id": 92,
"key": "_vendor_id",
"value": "2"
}
],
"sku": "",
"price": 299
}
],
"tax_lines": [],
"shipping_lines": [],
"fee_lines": [],
"coupon_lines": [],
"date_created_gmt": "2018-12-07T09:08:53",
"date_modified_gmt": "2018-12-07T09:08:58",
"date_completed_gmt": null,
"date_paid_gmt": null
}
]
Этот API позволяет извлекать и просматривать конкретный заказ.
HTTP-запрос #
GET https://help-ka.ru/market/wp-json/wcfmmp/v1/orders/<id>
Получить все заказы #
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://help-ka.ru/market/wp-json/wcfmmp/v1/orders/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"Authorization: Basic authorization_token",
"Cache-Control: no-cache",
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
Пример ответа в формате JSON:
[
{
"id": 274,
"parent_id": 0,
"status": "on-hold",
"currency": "INR",
"version": "3.5.1",
"prices_include_tax": false,
"date_created": "2018-12-07T09:08:53",
"date_modified": "2018-12-07T09:08:58",
"discount_total": "0",
"discount_tax": "0",
"shipping_total": "20.00",
"shipping_tax": "0",
"cart_tax": "0",
"total": "654.00",
"total_tax": "0",
"customer_id": 1,
"order_key": "wc_order_5c0a38a5cc476",
"billing": {
"first_name": "Test",
"last_name": "Name",
"company": "",
"address_1": "PAS Road",
"address_2": "69T/17",
"city": "Kolkata",
"state": "WB",
"postcode": "700033",
"country": "IN",
"email": "testname@gmail.com",
"phone": "1111111111"
},
"shipping": {
"first_name": "Test",
"last_name": "Name",
"company": "",
"address_1": "PAS Road",
"address_2": "69T/17",
"city": "Kolkata",
"state": "WB",
"postcode": "700033",
"country": "IN"
},
"payment_method": "cheque",
"payment_method_title": "Check payments",
"transaction_id": "",
"customer_ip_address": "::1",
"customer_user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.110 Safari/537.36",
"created_via": "checkout",
"customer_note": "",
"date_completed": null,
"date_paid": null,
"cart_hash": "e053bc38a043cfc980292231c5b33318",
"number": "274",
"meta_data": [
{
"id": 5206,
"key": "_wcfmmp_order_processed",
"value": "yes"
},
{
"id": 5210,
"key": "_wcfm_new_order_notified",
"value": "yes"
}
],
"line_items": [
{
"id": 5,
"name": "Test Product",
"product_id": 0,
"variation_id": 0,
"quantity": 1,
"tax_class": "",
"subtotal": "299",
"subtotal_tax": "0",
"total": "299",
"total_tax": "0",
"taxes": [],
"meta_data": [
{
"id": 91,
"key": "_vendor_id",
"value": "2"
}
],
"sku": null,
"price": 299
},
{
"id": 6,
"name": "new sadada",
"product_id": 0,
"variation_id": 0,
"quantity": 1,
"tax_class": "",
"subtotal": "299",
"subtotal_tax": "0",
"total": "299",
"total_tax": "0",
"taxes": [],
"meta_data": [
{
"id": 92,
"key": "_vendor_id",
"value": "2"
}
],
"sku": null,
"price": 299
}
],
"tax_lines": [],
"shipping_lines": [],
"fee_lines": [],
"coupon_lines": [],
"date_created_gmt": "2018-12-07T09:08:53",
"date_modified_gmt": "2018-12-07T09:08:58",
"date_completed_gmt": null,
"date_paid_gmt": null,
"vendor_order_details": {
"ID": "4",
"vendor_id": "2",
"order_id": "274",
"customer_id": "1",
"payment_method": "cheque",
"product_id": "257,272",
"variation_id": "0",
"quantity": "1",
"product_price": "299",
"purchase_price": "299",
"item_id": "5",
"item_type": "line_item",
"item_sub_total": "598",
"item_total": "598",
"shipping": "0",
"tax": "0",
"shipping_tax_amount": "0",
"commission_amount": "269.1",
"discount_amount": "0",
"discount_type": "",
"other_amount": "0",
"other_amount_type": "",
"withdrawal_id": "0",
"refunded_id": "0",
"refunded_amount": "0",
"withdraw_charges": "0",
"total_commission": "538.2",
"order_status": "on-hold",
"shipping_status": "pending",
"commission_status": "on-hold",
"withdraw_status": "pending",
"refund_status": "pending",
"is_refunded": "0",
"is_partially_refunded": "0",
"is_withdrawable": "1",
"is_auto_withdrawal": "0",
"is_trashed": "0",
"commission_paid_date": null,
"created": "2018-12-07 14:38:54",
"order_item_ids": "5,6",
"order_item_count": "2",
"is_refundeds": "0,0",
"refund_statuses": "pending,pending"
}
},
{
"id": 267,
"parent_id": 0,
"status": "on-hold",
"currency": "INR",
"version": "3.5.1",
"prices_include_tax": false,
"date_created": "2018-11-30T10:33:49",
"date_modified": "2018-11-30T10:33:51",
"discount_total": "0",
"discount_tax": "0",
"shipping_total": "10.00",
"shipping_tax": "0",
"cart_tax": "0",
"total": "628.00",
"total_tax": "0",
"customer_id": 1,
"order_key": "wc_order_5c01120d1cd6a",
"billing": {
"first_name": "Test",
"last_name": "Name",
"company": "",
"address_1": "PAS Road",
"address_2": "69T/17",
"city": "Kolkata",
"state": "WB",
"postcode": "700033",
"country": "IN",
"email": "testname@gmail.com",
"phone": "1111111111"
},
"shipping": {
"first_name": "Test",
"last_name": "Name",
"company": "",
"address_1": "PAS Road",
"address_2": "69T/17",
"city": "Kolkata",
"state": "WB",
"postcode": "700033",
"country": "IN"
},
"payment_method": "cheque",
"payment_method_title": "Check payments",
"transaction_id": "",
"customer_ip_address": "::1",
"customer_user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.102 Safari/537.36",
"created_via": "checkout",
"customer_note": "",
"date_completed": null,
"date_paid": null,
"cart_hash": "6fa21b29ee1b5a3716a5d3fef061014d",
"number": "267",
"meta_data": [
{
"id": 4912,
"key": "_wcfmmp_order_processed",
"value": "yes"
},
{
"id": 4916,
"key": "_wcfm_new_order_notified",
"value": "yes"
}
],
"line_items": [
{
"id": 1,
"name": "Polo",
"product_id": 40,
"variation_id": 0,
"quantity": 1,
"tax_class": "",
"subtotal": "20",
"subtotal_tax": "0",
"total": "20",
"total_tax": "0",
"taxes": [],
"meta_data": [
{
"id": 36,
"key": "_vendor_id",
"value": "2"
}
],
"sku": "",
"price": 20
},
{
"id": 2,
"name": "Test Prod2",
"product_id": 0,
"variation_id": 0,
"quantity": 1,
"tax_class": "",
"subtotal": "299",
"subtotal_tax": "0",
"total": "299",
"total_tax": "0",
"taxes": [],
"meta_data": [
{
"id": 37,
"key": "_vendor_id",
"value": "2"
}
],
"sku": null,
"price": 299
},
{
"id": 3,
"name": "Test Product",
"product_id": 0,
"variation_id": 0,
"quantity": 1,
"tax_class": "",
"subtotal": "299",
"subtotal_tax": "0",
"total": "299",
"total_tax": "0",
"taxes": [],
"meta_data": [
{
"id": 38,
"key": "_vendor_id",
"value": "2"
}
],
"sku": null,
"price": 299
}
],
"tax_lines": [],
"shipping_lines": [],
"fee_lines": [],
"coupon_lines": [],
"date_created_gmt": "2018-11-30T10:33:49",
"date_modified_gmt": "2018-11-30T10:33:51",
"date_completed_gmt": null,
"date_paid_gmt": null,
"vendor_order_details": {
"ID": "1",
"vendor_id": "2",
"order_id": "267",
"customer_id": "1",
"payment_method": "cheque",
"product_id": "40,254,255",
"variation_id": "0",
"quantity": "1",
"product_price": "20",
"purchase_price": "20",
"item_id": "1",
"item_type": "line_item",
"item_sub_total": "618",
"item_total": "618",
"shipping": "0",
"tax": "0",
"shipping_tax_amount": "0",
"commission_amount": "18",
"discount_amount": "0",
"discount_type": "",
"other_amount": "0",
"other_amount_type": "",
"withdrawal_id": "0",
"refunded_id": "0",
"refunded_amount": "0",
"withdraw_charges": "0",
"total_commission": "556.2",
"order_status": "on-hold",
"shipping_status": "pending",
"commission_status": "on-hold",
"withdraw_status": "pending",
"refund_status": "pending",
"is_refunded": "0",
"is_partially_refunded": "0",
"is_withdrawable": "1",
"is_auto_withdrawal": "0",
"is_trashed": "0",
"commission_paid_date": null,
"created": "2018-11-30 16:03:49",
"order_item_ids": "1,2,3",
"order_item_count": "3",
"is_refundeds": "0,0,0",
"refund_statuses": "pending,pending,pending"
}
}
]
Этот API помогает вам просматривать все заказы.
HTTP-запрос #
GET https://help-ka.ru/market/wp-json/wcfmmp/v1/orders/
HTTP-запрос с нумерацией страниц #
GET https://help-ka.ru/market/wp-json/wcfmmp/v1/orders/?per_page=2&page=2
Доступные параметры #
Атрибут | Тип | Описание |
---|---|---|
page |
целое число | Текущая страница коллекции. По умолчанию 1 . |
per_page |
целое число | Максимальное количество элементов, которые должны быть возвращены в результирующем наборе. По умолчанию 10 . |
search |
строка | Ограничьте результаты теми, которые соответствуют номеру заказа. |
after |
строка | Ограничить ответ ресурсами, опубликованными после заданной даты, соответствующей стандарту ISO8601. |
before |
строка | Ограничить ответ ресурсами, опубликованными до заданной даты, соответствующей стандарту ISO8601. |
order |
строка | Атрибут сортировки заказов по возрастанию или убыванию. Параметры: ASC и DESC . По умолчанию DESC . |
orderby |
строка | Сортировка коллекции по атрибуту объекта. Параметры: date , order_id , include , title и slug . По умолчанию order_id . |
Настройки #
API настроек позволяет получать настройки поставщиков по идентификатору или электронной почте.
Получить настройки по электронной почте #
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://help-ka.ru/market/wp-json/wcfmmp/v1/settings/email/test_vendor@gmail.com/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"Authorization: Basic authorization_token",
"Cache-Control: no-cache",
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
Этот API восстанавливает все настройки поставщика по адресу электронной почты поставщика.
HTTP-запрос #
GET https://help-ka.ru/market/wp-json/wcfmmp/v1/settings/email/<email>
Получить настройки по идентификатору #
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://help-ka.ru/market/wp-json/wcfmmp/v1/settings/id/2/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"Authorization: Basic authorization_token",
"Cache-Control: no-cache",
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
Этот API восстанавливает все настройки поставщика по идентификатору пользователя поставщика.
HTTP-запрос #
GET https://help-ka.ru/market/wp-json/wcfmmp/v1/settings/id/<id>
Пример ответа в формате JSON:
{
"gravatar": "",
"list_banner": "",
"banner_type": "single_img",
"banner": "",
"banner_video": "",
"banner_slider": [
{
"image": ""
}
],
"store_name": "Test Vendor Store",
"store_slug": "test_vendor_store",
"phone": "2222222222",
"shop_description": "<p><br data-mce-bogus=\"1\"></p>",
"address": {
"street_1": "PAS Road",
"street_2": "111",
"city": "Kolkata",
"zip": "700033",
"country": "IN",
"state": "WB"
},
"store_name_position": "on_banner",
"store_ppp": "10",
"payment": {
"method": "paypal",
"paypal": {
"email": "test@test.com"
},
"skrill": {
"email": ""
},
"bank": {
"ac_name": "",
"ac_number": "",
"bank_name": "",
"bank_addr": "",
"routing_number": "",
"iban": "",
"swift": "",
"ifsc": ""
}
},
"wcfmmp_shipping": {
"_wcfmmp_user_shipping_type": ""
},
"wcfmmp_shipping_by_country": {
"_wcfmmp_shipping_type_price": "",
"_wcfmmp_additional_product": "",
"_wcfmmp_additional_qty": "",
"_wcfmmp_pt": "",
"_wcfmmp_form_location": ""
},
"wcfmmp_shipping_rates": [
{
"wcfmmp_country_to": "",
"wcfmmp_country_to_price": "",
"wcfmmp_shipping_state_rates": [
{
"wcfmmp_state_to": "",
"wcfmmp_state_to_price": ""
}
]
}
],
"store_seo": {
"wcfmmp-seo-meta-title": "",
"wcfmmp-seo-meta-desc": "",
"wcfmmp-seo-meta-keywords": "",
"wcfmmp-seo-og-title": "",
"wcfmmp-seo-og-desc": "",
"wcfmmp-seo-og-image": "",
"wcfmmp-seo-twitter-title": "",
"wcfmmp-seo-twitter-desc": "",
"wcfmmp-seo-twitter-image": ""
},
"customer_support": {
"phone": "",
"email": "",
"address1": "",
"address2": "",
"country": "",
"city": "",
"state": "",
"zip": ""
},
"wcfm_store_hours": {
"day_times": [
{
"start": "",
"end": ""
},
{
"start": "",
"end": ""
},
{
"start": "",
"end": ""
},
{
"start": "",
"end": ""
},
{
"start": "",
"end": ""
},
{
"start": "",
"end": ""
},
{
"start": "",
"end": ""
}
]
},
"wcfm_policy_tab_title": "",
"wcfm_shipping_policy": "",
"wcfm_refund_policy": "",
"wcfm_cancellation_policy": "",
"store_hide_email": "no",
"store_hide_phone": "no",
"store_hide_address": "no",
"wcfm_vacation_mode": "no",
"wcfm_disable_vacation_purchase": "no"
}
Уведомления #
API уведомлений позволяет получать уведомления пользователя с сайта.
Получать уведомления #
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://help-ka.ru/market/wp-json/wcfmmp/v1/notifications/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => array(
"Authorization: Basic authorization_token",
"Cache-Control: no-cache",
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
Пример ответа в формате JSON:
[
{
"ID": "107",
"message": "#274 order status updated to On hold",
"message_type": "status-update",
"created": "2018-12-07 14:39:02"
},
{
"ID": "106",
"message": "#274 order status updated to On hold",
"message_type": "status-update",
"created": "2018-12-07 14:39:01"
},
{
"ID": "103",
"message": "You have received an Order #274 for Test Product",
"message_type": "order",
"created": "2018-12-07 14:38:58"
}
]
Этот API повторно отправляет все уведомления пользователей, поставщиков / администраторов.
HTTP-запрос #
GET https://help-ka.ru/market/wp-json/wcfmmp/v1/notifications/
HTTP-запрос с нумерацией страниц #
GET https://help-ka.ru/market/wp-json/wcfmmp/v1/notifications/?per_page=2&page=2
Доступные параметры #
Атрибут | Тип | Описание |
---|---|---|
page |
целое число | Текущая страница коллекции. По умолчанию 1 . |
per_page |
целое число | Максимальное количество элементов, которые должны быть возвращены в результирующем наборе. По умолчанию 10 . |
notification_status |
строка | Либо для повторного просмотра прочитанных, либо непрочитанных уведомлений. Параметры: read и unread . По умолчанию unread |
notification_type |
строка | Тип уведомления для повторного запроса. Параметры: all , direct , product_review , status-update , withdraw-request , refund-request , new_product , new_taxonomy_term , order,enquiry , support ,new_staff , new_customer , new_follower , registration , membership , vendor_approval , membership-reminder , membership-cancel , membership-expired , vendor-disable , vendor-enable , pay_for_product , shipment_tracking , shipment_received , verification , review . Значение по умолчанию равно all . |
order |
строка | Упорядочить атрибут сортировки по возрастанию или убыванию. Параметры: ASC и DESC . По умолчанию DESC . |
orderby |
строка | Сортировка коллекции по атрибуту объекта. Параметры: ID , message_type , created . По умолчанию ID . |
Ошибки #
Market – REST API использует следующие коды ошибок:
Код ошибки | Значение |
---|---|
400 | Неверный запрос — ваш запрос недействителен. |
401 | Неавторизованный — ваш ключ API неверен. |
403 | Запрещено — запрошенный котенок скрыт только для администраторов. |
404 | Не найдено — указанный котенок не найден. |
405 | Метод не разрешен — вы пытались получить доступ к котенку с помощью недопустимого метода. |
406 | Неприемлемо — вы запросили формат, который не является json. |
410 | Пропал — запрошенный котенок был удален с наших серверов. |
418 | Я чайник. |
429 | Слишком много запросов — вы запрашиваете слишком много котят! Замедляйтесь! |
500 | Внутренняя ошибка сервера — у нас возникла проблема с нашим сервером. Повторите попытку позже. |
503 | Служба недоступна — мы временно отключены для обслуживания. Пожалуйста, повторите попытку позже. |