Модуль позволяет производить нижеперечисленные действия. С более подробным описанием вы можете ознакомиться ниже.
| Свойство заказа | Описание |
| ID | Номер заказа |
| LID | Код сайта |
| ACCOUNT_NUMBER | Код заказа |
| TRACKING_NUMBER | Трек-номер заказа |
| PAY_SYSTEM_ID | Идентификатор платежной системы |
| DELIVERY_ID | Идентификатор службы доставки |
| DATE_INSERT | Дата добавления заказа в формате текущего сайта |
| DATE_UPDATE | Дата последнего изменения заказа в формате текущего сайта |
| PERSON_TYPE_ID | Идентификатор плательщика |
| USER_ID | Идентификатор пользователя, за кем закреплен заказ |
| PAYED | Флаг оплаченности заказа (Y/N) |
| DATE_PAYED | Дата оплаты заказа |
| EMP_PAYED_ID | Идентификатор пользователя оплатившего заказ |
| DEDUCTED | Флаг отгруженности заказа (Y/N) |
| DATE_DEDUCTED | Дата отгрузки заказа |
| EMP_DEDUCTED_ID | Идентификатор пользователя, отгрузившего заказ |
| REASON_UNDO_DEDUCTED | Комментарий причины отмены отгрузки заказа |
| STATUS_ID | Код статуса заказа |
| DATE_STATUS | Дата изменения статуса заказа |
| EMP_STATUS_ID | ID пользователя, изменивший статус заказа |
| MARKED | Флаг проблемности заказа (Y/N) |
| DATE_MARKED | Дата выставления флага проблемности заказа |
| EMP_MARKED_ID | Идентификатор пользователя, установивший флаг проблемности заказа |
| REASON_MARKED | Комментарий причины проблемности заказа |
| PRICE_DELIVERY | Стоимость доставки |
| ALLOW_DELIVERY | Флаг разрешена ли отгрузка заказа (Y/N) |
| DATE_ALLOW_DELIVERY | Дата выставления флага разрешения отгрузки заказа |
| EMP_ALLOW_DELIVERY_ID | Идентификатор пользователя, установивший флаг разрешение отгрузки заказа |
| RESERVED | Флаг зарезервировано ли всё кол-во товара в заказе (Y/N) |
| PRICE | Стоимость заказа |
| CURRENCY | Валюта заказа |
| DISCOUNT_VALUE | Значение скидки заказа |
| TAX_VALUE | Размер налога на заказ |
| SUM_PAID | Сумма оплаченного заказа |
| USER_DESCRIPTION | Комментарий пользователя оформившего заказ |
| PAY_VOUCHER_NUM | Номер документа оплаты |
| PAY_VOUCHER_DATE | Дата оплаты документа |
| ADDITIONAL_INFO | Дополнительная информация заказа |
| COMMENTS | Комментарии к заказу |
| COMPANY_ID | Идентификатор компании, к которой привязан заказ |
| CREATED_BY | Идентификатор пользователя, кто создал заказ |
| RESPONSIBLE_ID | Идентификатор ответственного пользователя |
| STAT_GID | Код статистики |
| DATE_PAY_BEFORE | Дата предоплаты |
| DATE_BILL | Дата выставления счета |
| IS_RECURRING | |
| RECURRING_ID | |
| LOCKED_BY | Флаг, кто заблокировал заказ |
| DATE_LOCK | Дата, когда был заблокирован заказ |
| RECOUNT_FLAG | |
| AFFILIATE_ID | Идентификатор аффилиата |
| DELIVERY_DOC_NUM | Номер документа отгрузки |
| DELIVERY_DOC_DATE | Дата документа отгрузки |
| UPDATED_1C | Флаг обновления данных в 1C |
| ORDER_TOPIC | Идентификатор темы на форуме, к которому привязан заказ |
| XML_ID | Внешний код заказа |
| ID_1C | Код в 1С |
| VERSION_1C | Версия обмена |
| VERSION | |
| EXTERNAL_ORDER | Флаг, определяющий является ли заказ внешним |
| STORE_ID | Код склада |
| CANCELED | Флаг отмены заказа |
| EMP_CANCELED_ID | Идентификатор пользователя, кто отменил заказ |
| DATE_CANCELED | Дата отмены заказа |
| REASON_CANCELED | Причина отмены заказа |
| BX_USER_ID | |
| SEARCH_CONTENT | |
| RUNNING |
| GET | /v1/orders[?filter] |
|
Получение списка заказов по фильтру Параметры для фильтрации:
|
|
GET /v1/orders[?filter]
{
"code": 200,
"status": "success",
"message": {
"info": {
"count_select": 11,
"count_all": 11
},
"data": {
"13": {
"ID": "13",
"LID": "s1",
"ACCOUNT_NUMBER": "13",
"TRACKING_NUMBER": "",
"PAY_SYSTEM_ID": "7",
"DELIVERY_ID": "2",
"DATE_INSERT": "2020-10-12 14:40:40",
"DATE_UPDATE": "2020-12-02 15:02:16",
"PERSON_TYPE_ID": "1",
"USER_ID": "1",
"PAYED": "N",
"DATE_PAYED": "2020-10-13 17:51:46",
"EMP_PAYED_ID": "1",
"DEDUCTED": "N",
"DATE_DEDUCTED": null,
"EMP_DEDUCTED_ID": null,
"REASON_UNDO_DEDUCTED": null,
"STATUS_ID": "N",
"DATE_STATUS": "2020-10-12 14:40:39",
"EMP_STATUS_ID": "1",
"MARKED": "N",
"DATE_MARKED": null,
"EMP_MARKED_ID": null,
"REASON_MARKED": null,
"PRICE_DELIVERY": "500.0000",
"ALLOW_DELIVERY": "N",
"DATE_ALLOW_DELIVERY": null,
"EMP_ALLOW_DELIVERY_ID": null,
"RESERVED": "N",
"PRICE": "42569.0000",
"CURRENCY": "RUB",
"DISCOUNT_VALUE": "0.0000",
"TAX_VALUE": "0.00",
"SUM_PAID": "0.00",
"USER_DESCRIPTION": "",
"PAY_VOUCHER_NUM": "",
"PAY_VOUCHER_DATE": null,
"ADDITIONAL_INFO": null,
"COMMENTS": "",
"COMPANY_ID": null,
"CREATED_BY": "1",
"RESPONSIBLE_ID": null,
"STAT_GID": null,
"DATE_PAY_BEFORE": null,
"DATE_BILL": null,
"IS_RECURRING": "N",
"RECURRING_ID": null,
"LOCKED_BY": "1",
"DATE_LOCK": "2020-12-02 15:01:15",
"RECOUNT_FLAG": "Y",
"AFFILIATE_ID": null,
"DELIVERY_DOC_NUM": null,
"DELIVERY_DOC_DATE": null,
"UPDATED_1C": "N",
"ORDER_TOPIC": null,
"XML_ID": "bx_5f8440b7b9f88",
"ID_1C": null,
"VERSION_1C": null,
"VERSION": "20",
"EXTERNAL_ORDER": "N",
"STORE_ID": null,
"CANCELED": "N",
"EMP_CANCELED_ID": "1",
"DATE_CANCELED": "2020-12-02 15:02:16",
"REASON_CANCELED": "",
"BX_USER_ID": null,
"SEARCH_CONTENT": null,
"RUNNING": "N"
},
. . .
}
},
"timestamp": 1606915781
}
|
|
| GET | /v1/orders/{id} |
|
Получение информации о заказе по id |
|
GET /v1/orders/{id}
{
"code": 200,
"status": "success",
"message": {
"main": {
"ID": 29,
"ACCOUNT_NUMBER": "29",
"STATUS_ID": "F",
"STATUS_DESCRIPTION": "Выполнен",
"USE_VAT": false,
"VAT_RATE": 0,
"VAT_SUM": 0,
"CURRENCY": "RUB",
"WEIGHT": "0 кг",
"DATE_INSERT": "2021-01-26 14:21:23",
"DATE_UPDATE": "2021-01-26 17:02:55",
"CANCELED": "Y",
"REASON_CANCELED": "TRETREt",
"LID": "s1",
"PRICE_TOTAL": "2 499 руб.",
"TAX_VALUE": "0 руб.",
"PRICE_DELIVERY_DISCOUNTED": "500 руб.",
"SUM_PAID": "0 руб.",
"ORDER_DISCOUNT_VALUE": "0 руб.",
"SUM_UNPAID": "2 499 руб.",
"DELIVERY_DISCOUNT": "0 руб.",
"PRICE_DELIVERY": "500 руб.",
"PRICE_BASKET_DISCOUNTED": "1 999 руб.",
"PRICE_BASKET": "1 999 руб."
},
"buyer": {
"USER_ID": 5,
"PERSON_TYPE_ID": "1",
"PERSON_TYPE_NAME": "Физическое лицо",
"BUYER_USER_NAME": "android",
"USER_DESCRIPTION": ""
},
"property": {
"1": {
"title": "Личные данные",
"sort": "100",
"data": {
"1": {
"ID": "1",
"PERSON_TYPE_ID": "1",
"NAME": "Ф.И.О.",
"TYPE": "STRING",
"REQUIRED": "Y",
"DEFAULT_VALUE": "",
"SORT": "100",
"USER_PROPS": "Y",
"IS_LOCATION": "N",
"PROPS_GROUP_ID": "1",
"DESCRIPTION": "",
"IS_EMAIL": "N",
"IS_PROFILE_NAME": "Y",
"IS_PAYER": "Y",
"IS_LOCATION4TAX": "N",
"IS_FILTERED": "Y",
"CODE": "FIO",
"IS_ZIP": "N",
"IS_PHONE": "N",
"IS_ADDRESS": "N",
"ACTIVE": "Y",
"UTIL": "N",
"INPUT_FIELD_LOCATION": "0",
"MULTIPLE": "N",
"SIZE": 40,
"VALUE": "<Без имени>"
},
"2": {
"ID": "2",
"PERSON_TYPE_ID": "1",
"NAME": "E-Mail",
"TYPE": "STRING",
"REQUIRED": "Y",
"DEFAULT_VALUE": "",
"SORT": "110",
"USER_PROPS": "Y",
"IS_LOCATION": "N",
"PROPS_GROUP_ID": "1",
"DESCRIPTION": "",
"IS_EMAIL": "Y",
"IS_PROFILE_NAME": "N",
"IS_PAYER": "N",
"IS_LOCATION4TAX": "N",
"IS_FILTERED": "Y",
"CODE": "EMAIL",
"IS_ZIP": "N",
"IS_PHONE": "N",
"IS_ADDRESS": "N",
"ACTIVE": "Y",
"UTIL": "N",
"INPUT_FIELD_LOCATION": "0",
"MULTIPLE": "N",
"SIZE": 40,
"VALUE": "test@asd.ru"
},
"3": {
"ID": "3",
"PERSON_TYPE_ID": "1",
"NAME": "Телефон",
"TYPE": "STRING",
"REQUIRED": "Y",
"DEFAULT_VALUE": "",
"SORT": "120",
"USER_PROPS": "Y",
"IS_LOCATION": "N",
"PROPS_GROUP_ID": "1",
"DESCRIPTION": "",
"IS_EMAIL": "N",
"IS_PROFILE_NAME": "N",
"IS_PAYER": "N",
"IS_LOCATION4TAX": "N",
"IS_FILTERED": "N",
"CODE": "PHONE",
"IS_ZIP": "N",
"IS_PHONE": "Y",
"IS_ADDRESS": "N",
"ACTIVE": "Y",
"UTIL": "N",
"INPUT_FIELD_LOCATION": "0",
"MULTIPLE": "N",
"VALUE": "123123123123"
}
}
},
"2": {
"title": "Данные для доставки",
"sort": "200",
"data": {
"4": {
"ID": "4",
"PERSON_TYPE_ID": "1",
"NAME": "Индекс",
"TYPE": "STRING",
"REQUIRED": "Y",
"DEFAULT_VALUE": "101000",
"SORT": "130",
"USER_PROPS": "Y",
"IS_LOCATION": "N",
"PROPS_GROUP_ID": "2",
"DESCRIPTION": "",
"IS_EMAIL": "N",
"IS_PROFILE_NAME": "N",
"IS_PAYER": "N",
"IS_LOCATION4TAX": "N",
"IS_FILTERED": "N",
"CODE": "ZIP",
"IS_ZIP": "Y",
"IS_PHONE": "N",
"IS_ADDRESS": "N",
"ACTIVE": "Y",
"UTIL": "N",
"INPUT_FIELD_LOCATION": "0",
"MULTIPLE": "N",
"SIZE": 8,
"VALUE": "101000"
},
"6": {
"ID": "6",
"PERSON_TYPE_ID": "1",
"NAME": "Местоположение",
"TYPE": "LOCATION",
"REQUIRED": "Y",
"DEFAULT_VALUE": "0000073738",
"SORT": "140",
"USER_PROPS": "Y",
"IS_LOCATION": "Y",
"PROPS_GROUP_ID": "2",
"DESCRIPTION": "",
"IS_EMAIL": "N",
"IS_PROFILE_NAME": "N",
"IS_PAYER": "N",
"IS_LOCATION4TAX": "N",
"IS_FILTERED": "N",
"CODE": "LOCATION",
"IS_ZIP": "N",
"IS_PHONE": "N",
"IS_ADDRESS": "N",
"ACTIVE": "Y",
"UTIL": "N",
"INPUT_FIELD_LOCATION": "5",
"MULTIPLE": "N",
"SIZE": 40,
"VALUE": "Россия, Центр, Москва"
},
"5": {
"ID": "5",
"PERSON_TYPE_ID": "1",
"NAME": "Город",
"TYPE": "STRING",
"REQUIRED": "N",
"DEFAULT_VALUE": "Москва",
"SORT": "145",
"USER_PROPS": "Y",
"IS_LOCATION": "N",
"PROPS_GROUP_ID": "2",
"DESCRIPTION": "",
"IS_EMAIL": "N",
"IS_PROFILE_NAME": "N",
"IS_PAYER": "N",
"IS_LOCATION4TAX": "N",
"IS_FILTERED": "Y",
"CODE": "CITY",
"IS_ZIP": "N",
"IS_PHONE": "N",
"IS_ADDRESS": "N",
"ACTIVE": "Y",
"UTIL": "N",
"INPUT_FIELD_LOCATION": "0",
"MULTIPLE": "N",
"SIZE": 40,
"VALUE": "Москва"
},
"7": {
"ID": "7",
"PERSON_TYPE_ID": "1",
"NAME": "Адрес доставки",
"TYPE": "STRING",
"REQUIRED": "Y",
"DEFAULT_VALUE": "",
"SORT": "150",
"USER_PROPS": "Y",
"IS_LOCATION": "N",
"PROPS_GROUP_ID": "2",
"DESCRIPTION": "",
"IS_EMAIL": "N",
"IS_PROFILE_NAME": "N",
"IS_PAYER": "N",
"IS_LOCATION4TAX": "N",
"IS_FILTERED": "N",
"CODE": "ADDRESS",
"IS_ZIP": "N",
"IS_PHONE": "N",
"IS_ADDRESS": "Y",
"ACTIVE": "Y",
"UTIL": "N",
"INPUT_FIELD_LOCATION": "0",
"MULTIPLE": "N",
"MULTILINE": "Y",
"COLS": 30,
"ROWS": 3,
"VALUE": "asdasdasdasd"
}
}
}
},
"basket": {
"44": {
"ID": "47",
"LID": "s1",
"MODULE": "catalog",
"PRODUCT_ID": "44",
"QUANTITY": "1.0000",
"WEIGHT": "0.00",
"DELAY": "N",
"CAN_BUY": "Y",
"PRICE": 1999,
"CUSTOM_PRICE": "N",
"BASE_PRICE": 1999,
"PRODUCT_PRICE_ID": "3",
"PRICE_TYPE_ID": "1",
"CURRENCY": "RUB",
"BARCODE_MULTI": "N",
"RESERVED": "N",
"RESERVE_QUANTITY": null,
"NAME": "Штаны Полосатый Рейс",
"CATALOG_XML_ID": "clothes_offers_s1",
"VAT_RATE": "0.0000",
"NOTES": "Розничная цена",
"DISCOUNT_PRICE": 0,
"PRODUCT_PROVIDER_CLASS": "\\Bitrix\\Catalog\\Product\\CatalogProvider",
"CALLBACK_FUNC": null,
"ORDER_CALLBACK_FUNC": null,
"PAY_CALLBACK_FUNC": null,
"CANCEL_CALLBACK_FUNC": null,
"DIMENSIONS": "a:3:{s:5:\"WIDTH\";N;s:6:\"HEIGHT\";N;s:6:\"LENGTH\";N;}",
"TYPE": null,
"SET_PARENT_ID": null,
"DETAIL_PAGE_URL": "/catalog/pants/pants-striped-flight/",
"FUSER_ID": "11",
"MEASURE_CODE": "796",
"MEASURE_NAME": "шт",
"ORDER_ID": "29",
"DATE_INSERT": "2021-01-26 14:21:12",
"DATE_UPDATE": "2021-01-26 14:21:23",
"PRODUCT_XML_ID": "177#182",
"SUBSCRIBE": "N",
"RECOMMENDATION": null,
"VAT_INCLUDED": "Y",
"SORT": "100",
"DATE_REFRESH": null,
"DISCOUNT_NAME": null,
"DISCOUNT_VALUE": null,
"DISCOUNT_COUPON": null,
"XML_ID": "bx_600ffb287e880",
"MARKING_CODE_GROUP": null,
"PARENT": {
"ID": 4,
"IBLOCK_ID": 2,
"OFFER_IBLOCK_ID": 3,
"SKU_PROPERTY_ID": 19
},
"PROPS": {
"ARTNUMBER": {
"ID": "176",
"BASKET_ID": "47",
"NAME": "Артикул",
"VALUE": "177-77-05",
"CODE": "ARTNUMBER",
"SORT": "1",
"XML_ID": "bx_600ffb287eaea"
},
"COLOR_REF": {
"ID": "177",
"BASKET_ID": "47",
"NAME": "Цвет",
"VALUE": "Фиолетовый",
"CODE": "COLOR_REF",
"SORT": "2",
"XML_ID": "bx_600ffb287ec1b"
},
"SIZES_CLOTHES": {
"ID": "178",
"BASKET_ID": "47",
"NAME": "Размеры одежды",
"VALUE": "XS",
"CODE": "SIZES_CLOTHES",
"SORT": "3",
"XML_ID": "bx_600ffb287ecfc"
}
},
"FORMATED_TEXT": "Штаны Полосатый Рейс [Артикул: 177-77-05; Цвет: Фиолетовый; Размеры одежды: XS] - 1 шт x 1 999 руб.",
"FORMATED_SUM": "1 999 руб.",
"FORMATED_BASE_SUM": "1 999 руб.",
"PICTURE_URL": "/upload/resize_cache/iblock/a45/80_80_1/a45e9b580c748a2ea9bf68ae65491f57.jpg"
}
},
"pay": {
"3": {
"ID": "29",
"ORDER_ID": "29",
"ACCOUNT_NUMBER": "29/1",
"PAID": "N",
"DATE_PAID": "2021-01-26 14:22:26",
"EMP_PAID_ID": "1",
"PAY_SYSTEM_ID": "3",
"PS_STATUS": null,
"PS_STATUS_CODE": null,
"PS_INVOICE_ID": null,
"PS_STATUS_DESCRIPTION": null,
"PS_STATUS_MESSAGE": null,
"PS_SUM": null,
"PS_CURRENCY": null,
"PS_RESPONSE_DATE": null,
"PAY_VOUCHER_NUM": "",
"PAY_VOUCHER_DATE": null,
"DATE_PAY_BEFORE": null,
"DATE_BILL": "2021-01-26 14:21:23",
"XML_ID": "bx_600ffb335727f",
"SUM": 2499,
"PRICE_COD": 0,
"CURRENCY": "RUB",
"PAY_SYSTEM_NAME": "Яндекс.Деньги",
"RESPONSIBLE_ID": "1",
"EMP_RESPONSIBLE_ID": null,
"DATE_RESPONSIBLE_ID": "2021-01-26 14:22:26",
"COMMENTS": "",
"COMPANY_ID": "0",
"PAY_RETURN_NUM": "",
"PAY_RETURN_DATE": "2021-01-26 00:00:00",
"EMP_RETURN_ID": "1",
"PAY_RETURN_COMMENT": "",
"IS_RETURN": "Y",
"MARKED": "N",
"DATE_MARKED": null,
"EMP_MARKED_ID": null,
"REASON_MARKED": null,
"UPDATED_1C": "N",
"ID_1C": null,
"VERSION_1C": null,
"EXTERNAL_PAYMENT": "N",
"CHECK_DATA": {},
"SUM_FORMATED": "2 499 руб."
}
},
"delivery": {
"57": {
"ID": "57",
"ORDER_ID": "29",
"ACCOUNT_NUMBER": "29/2",
"DATE_INSERT": "2021-01-26 14:21:23",
"STATUS_ID": "DN",
"DELIVERY_LOCATION": null,
"BASE_PRICE_DELIVERY": 500,
"PRICE_DELIVERY": 500,
"WEIGHT": "0.0000",
"CUSTOM_PRICE_DELIVERY": "N",
"CURRENCY": "RUB",
"DISCOUNT_PRICE": null,
"ALLOW_DELIVERY": "N",
"DATE_ALLOW_DELIVERY": null,
"EMP_ALLOW_DELIVERY_ID": null,
"DEDUCTED": "N",
"DATE_DEDUCTED": "2021-01-26 14:23:37",
"EMP_DEDUCTED_ID": "1",
"REASON_UNDO_DEDUCTED": null,
"RESERVED": "N",
"DELIVERY_ID": "2",
"DELIVERY_DOC_NUM": "",
"DELIVERY_DOC_DATE": null,
"TRACKING_NUMBER": "",
"TRACKING_STATUS": null,
"TRACKING_DESCRIPTION": null,
"TRACKING_LAST_CHECK": null,
"TRACKING_LAST_CHANGE": null,
"XML_ID": "bx_600ffb3341fd3",
"PARAMS": false,
"DELIVERY_NAME": "Доставка курьером",
"CANCELED": "N",
"DATE_CANCELED": null,
"EMP_CANCELED_ID": null,
"REASON_CANCELED": "",
"MARKED": "N",
"DATE_MARKED": null,
"EMP_MARKED_ID": null,
"REASON_MARKED": null,
"SYSTEM": "N",
"RESPONSIBLE_ID": "0",
"EMP_RESPONSIBLE_ID": null,
"DATE_RESPONSIBLE_ID": "2021-01-26 14:22:50",
"COMMENTS": "",
"COMPANY_ID": "0",
"UPDATED_1C": "N",
"ID_1C": null,
"VERSION_1C": null,
"EXTERNAL_DELIVERY": "N",
"ITEMS": {
"47": {
"BASKET_ID": 47,
"QUANTITY": 1
}
},
"PRICE_DELIVERY_FORMATTED": "500 руб."
}
}
},
"timestamp": 1612770778
}
|
|
| GET | /v1/orders/status/{id} |
|
Получение информации о статусе заказа по id |
|
GET /v1/orders/status/{id}
{
"code": 200,
"status": "success",
"message": "F",
"timestamp": 1612770632
}
|
|
| GET | /v1/orders/statuses |
|
Получение списка статусов заказа |
|
GET /v1/orders/statuses
{
"code": 200,
"status": "success",
"message": {
"N": "Принят, ожидается оплата",
"P": "Оплачен, формируется к отправке",
"F": "Выполнен",
"DN": "Ожидает обработки",
"DA": "Комплектация заказа",
"DG": "Ожидаем приход товара",
"DT": "Ожидаем забора транспортной компанией",
"DS": "Передан в службу доставки",
"DF": "Отгружен"
},
"timestamp": 1612770677
}
|
|
| POST | /v1/orders/cancel (params=id,[reason]) |
|
Отмена заказа по id Параметры запроса:
|
|
POST /v1/orders/cancel (params=id,[reason])
{
"code": 200,
"status": "success",
"message": null,
"timestamp": 1612772374
}
|
|
Оставьте заявку и мы свяжемся с вами!
