Описание версии 2.0

Внимание! Это устаревшая версия API!
Список версий и ссылка на актуальную версию ЗДЕСЬ

Взаимодействие с API e-AutoPay происходит в формате JSON по правилам REST.
Преимущество JSON в большей компактности по сравнению с SOAP/XML, а также в скорости анализа запросов.
После выдачи заказа или его сохранения данные кешируются на 5 минут.

Во многих языках программирования существуют модули и библиотеки для работы с JSON. Ниже перечислены рекомендуемые модули и библиотеки для PHP.

  • PHP: встроенная поддержка JSON началась в версии 5.2.0. В предыдущих версиях можно использовать библиотеку Services_JSON.

Доступ

Доступ осуществляется путём передачи ключа пользователя e-autopay user_api_key и ключа пользователя API customer_api_key. Входящие и выходящие данные сериализуются посредством JSON.

Для администратора аккаунта:
чтобы получить ключи в аккаунте администратора перейдите в раздел "Настройки"-"Настройки API".
Для получения user_api_key отметьте чек-бокс "Разрешить использование API-интерфейсов"
Для получения customer_api_key отметьте чек-бокс "Разрешить получение всех заказов через API-интерфейс"

Внимание! Администраторский customer_api_key дает доступ ко ВСЕМ заказам в аккаунте. Сервис e-autopay.com не несет ответственности при передаче ключа третьим лицам.

 

Для сторонних сервисов:
Для получения доступа необходимо зарегистрироваться в личном кабинете API и получить customer_api_key, а также получить от пользователя e-autopay ключ user_api_key.

Внимание! Этот customer_api_key дает доступ только к тем заказам, которые были записаны в систему с его помощью!

Сохранение одного заказа

Сохранение одного заказа (POST)

https://api.e-autopay.com/v02/user_api_key/orders
Тело запроса

{
	"customer_api_key": "$customer_api_key",
	"orders":[ {
		"customer" : {
			"surname": "Иванов", // фамилия (обязательное)
			"given_name": "Иван", // имя (обязательное)
			"patronymic": "Иванович", // отчество (обязательное)
			"country": "Россия", // страна (обязательное)
			"state": "Курская область", // регион (обязательное)
			"city": "Курск", // город (обязательное)
			"zip": "123456", // индекс (обязательное)
			"address": "ул. Пушкина, д. 1, кв. 2", // адрес (обязательное)
			"email": "ivan.ivanov@example.net", // email (обязательное)
			"phone": "+79991111111" // телефон (обязательное)
		},
		"credentials": {
			"created": "2014-01-01 00:00:00", // дата заказа (обязательное)
			"currency": "руб", // валюта заказа (необязательное, по умолчанию "руб".
                                  // если поле указано, валюта должна быть определена
                                  // у пользователя e-AutoPay в справочнике валют)
			"delivery_cost": 100.00, // цена доставки (необязательное, по умолчанию 0.00)
			"notes": "Бонус в подарок", // комментарий к заказу (необязательное)
			"ip": "127.0.0.1",  // ip-адрес покупателя
			"rpo": "1312312312312321", // номер почтового отправления
			"rpo_shipment_date": "01.02.2015", // дата отправки (строго в формате дд.мм.гггг)
			"referer": "http://site.ru?utm_source=source&utm_medium=medium&utm_campaign=campaign" // страница заказа
		},
		"basket": [{
			"good_id": "1",	// идентификатор товара	(обязательное)				
			"cost": "1000.00",	// цена товара (обязательное)
			"quantity": "1" // количество товара (обязательное)
		},{
			"good_id": "2",  // идентификатор товара (обязательное)					
			"cost": "2000.00", 	// цена товара (обязательное)
			"quantity": "2"	// количество товара (обязательное)
		}],
		"partner": {
			"login": "test123", // refID партнера
			"cost": "450", // сумма комиссионных
			"currency": "rub" // валюта
		},
                "additional_fields": [
                    {
                        "key": "Цвет", 
                        "value": "Красные"
                    },
                    {
                        "key": "Размер", 
                        "value": "44"
                    }]
		
	}]
}
		 

Ответ сервера

{
	"orders":[{
		"order_id": "1234", // идентификатор заказа
		"status": "new", // статус заказа
		"status_date": "2014-01-01 00:00:00",// дата/время последней смены статуса
		"confirmed": true, // факт подтверждения заказа
		"customer" : {
			"surname": "Иванов", // фамилия
			"given_name": "Иван", // имя
			"patronymic": "Иванович", // отчество
			"country": "Россия", // страна
			"state": "Курская область", // регион
			"city": "Курск", // город
			"zip": "123456", // индекс
			"address": "ул. Пушкина, д. 1, кв. 2", // адрес
			"email": "ivan.ivanov@example.net", // email
			"phone": "+79991111111" // телефон
		},
		"credentials": {
			"created": "2014-01-01 00:00:00", // дата заказа
			"currency": "руб", // валюта заказа
			"amount": 5000.00, // стоимость заказа
			"delivery_cost": 100.00, // цена доставки
			"notes": "Бонус в подарок", // комментарий к заказу
			"logist_comment": "Комментарии логистики", // комментарии логистики
			"author_comment": "Комментарии автора", // комментарии автора
			"comments":{
				  "logist":[{
					"created_at":"2017-05-16 13:18:33",
					"comment":"Text Comment Logist"
				   },
				   {
					"created_at":"2017-05-16 16:08:17",
					"comment":"Another Text Comment Logist"
				  }],
				  "author":[{
					"created_at":"2017-05-16 13:20:33",
					"comment":"Text Comment Author"
				   },
				   {
					"created_at":"2017-05-16 16:20:17",
					"comment":"Another Text Comment Author"
				  }],
				 },
			"ip": "127.0.0.1",  // ip-адрес покупателя
			"rpo": "1312312312312321", // номер почтового отправления
			"rpo_shipment_date": "01.02.2015", // дата отправки (строго в формате дд.мм.гггг)
			"utm": {
				"utm_source": "source",
				"utm_medium": "medium",
				"utm_campaign": "campaign"
			}
		},
		"basket": [{
			"good_id": "1", // идентификатор товара
			"good_name": "Название товара",  // название товара
			"cost": "1000.00",	// цена товара
			"quantity": "1" // количество товара
			},
			{
			"good_id": "2", // идентификатор товара
			"good_name": "Название товара",  // название товара
			"cost": "2000.00", 	// цена товара
			"quantity": "2"	// количество товара
		}],
		"partner": {
			"login": "test123", // refID партнера
			"cost": "450", // сумма комиссионных
			"currency": "rub" // валюта
			},
                "additional_fields": [
                    {
                        "key": "Цвет", 
                        "value": "Красные"
                    },
                    {
                        "key": "Размер", 
                        "value": "44"
                    }]
		}]
}
					 

Примечание

  • Если партнера в заказе нет, объект "partner" передавать не нужно совсем

Сохранение нескольких заказов

Сохранение нескольких заказов (POST)

https://api.e-autopay.com/v02/user_api_key/orders
Тело запроса

{
	"customer_api_key": "$customer_api_key",
	"orders": [{
		"customer" : {
			"surname": "Иванов", // фамилия (обязательное)
			"given_name": "Иван", // имя (обязательное)
			"patronymic": "Иванович", // отчество (обязательное)
			"country": "Россия", // страна (обязательное)
			"state": "Курская область", // регион (обязательное)
			"city": "Курск", // город (обязательное)
			"zip": "123456", // индекс (обязательное)
			"address": "ул. Пушкина, д. 1, кв. 2", // адрес (обязательное)
			"email": "ivan.ivanov@example.net", // email (обязательное)
			"phone": "+79991111111" // телефон (обязательное)
		},
		"credentials": {
			"created": "2014-01-01 00:00:00", // дата заказа (обязательное)
			"currency": "руб", // валюта заказа (необязательное, по умолчанию "руб".
									  // если поле указано, валюта должна быть определена
									  // у пользователя e-AutoPay в справочнике валют)
			"delivery_cost": 100.00, // цена доставки (необязательное, по умолчанию 0.00)
			"notes": "Бонус в подарок", // комментарий к заказу (необязательное)
			"ip": "127.0.0.1",  // ip-адрес покупателя
			"rpo": "1312312312312321", // номер почтового отправления
			"rpo_shipment_date": "01.02.2015", // дата отправки (строго в формате дд.мм.гггг)
			"referer": "http://site.ru?utm_source=source&utm_medium=medium&utm_campaign=campaign" // страница заказа
		},
		"basket": [{
			"good_id": "1", // идентификатор товара (обязательное)					
			"cost": "1000.00", // цена товара (обязательное)
			"quantity": "1" // количество товара (обязательное)
		},{
			"good_id": "2", // идентификатор товара	(обязательное)				
			"cost": "2000.00", // цена товара (обязательное)
			"quantity": "2"	// количество товара (обязательное)
		}],
		"partner": {
			"login": "test123", // refID партнера
			"cost": "450", // сумма комиссионных
			"currency": "rub" // валюта
		},
                "additional_fields": [
                    {
                        "key": "Цвет", 
                        "value": "Красные"
                    },
                    {
                        "key": "Размер", 
                        "value": "44"
                    }]
		},{
		"customer" : {
			"surname": "Иванов", // фамилия (обязательное)
			"given_name": "Иван", // имя (обязательное)
			"patronymic": "Иванович", // отчество (обязательное)
			"country": "Россия", // страна (обязательное)
			"state": "Курская область", // регион (обязательное)
			"city": "Курск", // город (обязательное)
			"zip": "123456", // индекс (обязательное)
			"address": "ул. Пушкина, д. 1, кв. 2", // адрес (обязательное)
			"email": "ivan.ivanov@example.net", // email (обязательное)
			"phone": "+79991111111" // телефон (обязательное)
		},
		"credentials": {
			"created": "2014-01-01 00:00:00", // дата заказа (обязательное)
			"currency": "руб", // валюта заказа (необязательное, по умолчанию "руб".
									  // если поле указано, валюта должна быть определена
									  // у пользователя e-AutoPay в справочнике валют)
			"delivery_cost": 100.00, // цена доставки (необязательное, по умолчанию 0.00)
			"notes": "Бонус в подарок", // комментарий к заказу (необязательное)
			"ip": "127.0.0.1",  // ip-адрес покупателя
			"rpo": "1312312312312321", // номер почтового отправления
			"rpo_shipment_date": "01.02.2015", // дата отправки (строго в формате дд.мм.гггг)
			"referer": "http://site.ru?utm_source=source&utm_medium=medium&utm_campaign=campaign" // страница заказа
			},
			"basket": [{
				"good_id": "1",// идентификатор товара (обязательное)					
				"cost": "1000.00",// цена товара (обязательное)
				"quantity": "1" // количество товара (обязательное)
			},{
				"good_id": "2", // идентификатор товара (обязательное)					
				"cost": "2000.00", 	// цена товара (обязательное)
				"quantity": "2"	// количество товара (обязательное)
			}],
			"partner": {
				"login": "test123", // refID партнера(партнер должен быть зарегистрирован)
				"cost": "450", // сумма комиссионных
				"currency": "rub" // валюта
			},
                "additional_fields": [
                    {
                        "key": "Цвет", 
                        "value": "Красные"
                    },
                    {
                        "key": "Размер", 
                        "value": "44"
                    }]
	}, .......
	]
}
		 

Ответ сервера

{
	"orders":[{
		"order_id": "1234", // идентификатор заказа
		"status": "new", // статус заказа
		"status_date": "2014-01-01 00:00:00",// дата/время последней смены статуса
		"confirmed": true, // факт подтверждения заказа
		"customer" : {
			"surname": "Иванов", // фамилия
			"given_name": "Иван", // имя
			"patronymic": "Иванович", // отчество
			"country": "Россия", // страна
			"state": "Курская область", // регион
			"city": "Курск", // город
			"zip": "123456", // индекс
			"address": "ул. Пушкина, д. 1, кв. 2", // адрес
			"email": "ivan.ivanov@example.net", // email
			"phone": "+79991111111" // телефон
		},
		"credentials": {
			"created": "2014-01-01 00:00:00", // дата заказа
			"currency": "руб", // валюта заказа
			"amount": 5000.00, // стоимость заказа
			"delivery_cost": 100.00, // цена доставки
			"notes": "Бонус в подарок", // комментарий к заказу
			"logist_comment": "Комментарии логистики", // комментарии логистики
			"author_comment": "Комментарии автора", // комментарии автора
			"comments":{
				  "logist":[{
					"created_at":"2017-05-16 13:18:33",
					"comment":"Text Comment Logist"
				   },
				   {
					"created_at":"2017-05-16 16:08:17",
					"comment":"Another Text Comment Logist"
				  }],
				  "author":[{
					"created_at":"2017-05-16 13:20:33",
					"comment":"Text Comment Author"
				   },
				   {
					"created_at":"2017-05-16 16:20:17",
					"comment":"Another Text Comment Author"
				  }],
				 },
			"ip": "127.0.0.1",  // ip-адрес покупателя
			"rpo": "1312312312312321", // номер почтового отправления
			"rpo_shipment_date": "01.02.2015", // дата отправки (строго в формате дд.мм.гггг)
			"utm": {
				"utm_source": "source",
				"utm_medium": "medium",
				"utm_campaign": "campaign"
			}
		},
		"basket": [{
			"good_id": "1",	// идентификатор товара
			"good_name": "Название товара",  // название товара
			"cost": "1000.00",	// цена товара
			"quantity": "1" // количество товара
		},{
			"good_id": "2", // идентификатор товара
			"good_name": "Название товара",  // название товара
			"cost": "2000.00", 	// цена товара
			"quantity": "2"	// количество товара
		}
		],
		"partner": {
			"login": "test123", // refID партнера
			"cost": "450", // сумма комиссионных
			"currency": "rub" // валюта
		},
                "additional_fields": [
                    {
                        "key": "Цвет", 
                        "value": "Красные"
                    },
                    {
                        "key": "Размер", 
                        "value": "44"
                    }]
	},{
		"order_id": "12345", // идентификатор заказа
		"status": "new", // статус заказа
		"status_date": "2014-01-01 00:00:00",// дата/время последней смены статуса
		"confirmed": true, // факт подтверждения заказа
		"customer" : {
			"surname": "Иванов", // фамилия
			"given_name": "Иван", // имя
			"patronymic": "Иванович", // отчество
			"country": "Россия", // страна
			"state": "Курская область", // регион
			"city": "Курск", // город
			"zip": "123456", // индекс
			"address": "ул. Пушкина, д. 1, кв. 2", // адрес
			"email": "ivan.ivanov@example.net", // email
			"phone": "+79991111111" // телефон
		},
		"credentials": {
			"created": "2014-01-01 00:00:00", // дата заказа
			"currency": "руб", // валюта заказа
			"amount": 5000.00, // стоимость заказа
			"delivery_cost": 100.00, // цена доставки
			"notes": "Бонус в подарок", // комментарий к заказу
			"logist_comment": "Комментарии логистики", // комментарии логистики
			"author_comment": "Комментарии автора", // комментарии автора
			"comments":{
				  "logist":[{
					"created_at":"2017-05-16 13:18:33",
					"comment":"Text Comment Logist"
				   },
				   {
					"created_at":"2017-05-16 16:08:17",
					"comment":"Another Text Comment Logist"
				  }],
				  "author":[{
					"created_at":"2017-05-16 13:20:33",
					"comment":"Text Comment Author"
				   },
				   {
					"created_at":"2017-05-16 16:20:17",
					"comment":"Another Text Comment Author"
				  }],
				 },
			"ip": "127.0.0.1",  // ip-адрес покупателя
			"rpo": "1312312312312321", // номер почтового отправления
			"rpo_shipment_date": "01.02.2015", // дата отправки (строго в формате дд.мм.гггг)
			"utm": {
				"utm_source": "source",
				"utm_medium": "medium",
				"utm_campaign": "campaign"
			}
		},
		"basket": [{
			"good_id": "1",	// идентификатор товара
			"good_name": "Название товара",  // название товара
			"cost": "1000.00",	// цена товара
			"quantity": "1" 	// количество товара
		},{
			"good_id": "2", // идентификатор товара
			"good_name": "Название товара",  // название товара
			"cost": "2000.00", 	// цена товара
			"quantity": "2"	// количество товара
		}
		],
		"partner": {
			"login": "test123", // refID партнера
			"cost": "450", // сумма комиссионных
			"currency": "rub" // валюта
		},
                "additional_fields": [
                    {
                        "key": "Цвет", 
                        "value": "Красные"
                    },
                    {
                        "key": "Размер", 
                        "value": "44"
                    }]
	}, ......
	]
}
					 

Получение информации об одном заказе

Получение информации об одном заказе (GET)

https://api.e-autopay.com/v02/user_api_key/orders/order_id?{"customer_api_key":"customer_api_key"}
Ответ сервера

{
	"orders":[{
		"order_id": "1234", // идентификатор заказа
		"status": "new", // статус заказа
		"status_date": "2014-01-01 00:00:00",// дата/время последней смены статуса
		"confirmed": true, // факт подтверждения заказа
		"customer" : {
			"surname": "Иванов", // фамилия
			"given_name": "Иван", // имя
			"patronymic": "Иванович", // отчество
			"country": "Россия", // страна
			"state": "Курская область", // регион
			"city": "Курск", // город
			"zip": "123456", // индекс
			"address": "ул. Пушкина, д. 1, кв. 2", // адрес
			"email": "ivan.ivanov@example.net", // email
			"phone": "+79991111111" // телефон
		},
		"credentials": {
			"created": "2014-01-01 00:00:00", // дата заказа
			"currency": "руб", // валюта заказа
			"amount": 5000.00, // стоимость заказа
			"delivery_cost": 100.00, // цена доставки
			"notes": "Бонус в подарок", // комментарий к заказу
			"logist_comment": "Комментарии логистики", // комментарии логистики
			"author_comment": "Комментарии автора", // комментарии автора
			"comments":{
				  "logist":[{
					"created_at":"2017-05-16 13:18:33",
					"comment":"Text Comment Logist"
				   },
				   {
					"created_at":"2017-05-16 16:08:17",
					"comment":"Another Text Comment Logist"
				  }],
				  "author":[{
					"created_at":"2017-05-16 13:20:33",
					"comment":"Text Comment Author"
				   },
				   {
					"created_at":"2017-05-16 16:20:17",
					"comment":"Another Text Comment Author"
				  }],
				 },
			"ip": "127.0.0.1",  // ip-адрес покупателя
			"rpo": "1312312312312321", // номер почтового отправления
			"rpo_shipment_date": "01.02.2015", // дата отправки (строго в формате дд.мм.гггг)
			"utm": {
				"utm_source": "source",
				"utm_medium": "medium",
				"utm_campaign": "campaign"
			}
		},
		"basket": [{
			"good_id": "1", // идентификатор товара
			"good_name": "Название товара", // название товара
			"cost": "1000.00",	// цена товара
			"quantity": "1" // количество товара
		},{
			"good_id": "2", // идентификатор товара
			"good_name": "Название товара", // название товара
			"cost": "2000.00", // цена товара
			"quantity": "2"	// количество товара
		}
		]
	}]
}

			 

Получение информации о нескольких заказах

Получение информации о нескольких заказах (GET)

https://api.e-autopay.com/v02/user_api_key/orders/order_id,order_id,order_id,...?{"customer_api_key":"customer_api_key"}
Ответ сервера

{
	"orders": [{
		"order_id": "1234", // идентификатор заказа
		"status": "new", // статус заказа
		"status_date": "2014-01-01 00:00:00",// дата/время последней смены статуса
		"confirmed": true, // факт подтверждения заказа
		"customer" : {
			"surname": "Иванов", // фамилия
			"given_name": "Иван", // имя
			"patronymic": "Иванович", // отчество
			"country": "Россия", // страна
			"state": "Курская область", // регион
			"city": "Курск", // город
			"zip": "123456", // индекс
			"address": "ул. Пушкина, д. 1, кв. 2", // адрес
			"email": "ivan.ivanov@example.net", // email
			"phone": "+79991111111" // телефон
		},
		"credentials": {
			"created": "2014-01-01 00:00:00", // дата заказа
			"currency": "руб", // валюта заказа
			"amount": 5000.00, // стоимость заказа
			"delivery_cost": 100.00, // цена доставки
			"notes": "Бонус в подарок", // комментарий к заказу
			"logist_comment": "Комментарии логистики", // комментарии логистики
			"author_comment": "Комментарии автора", // комментарии автора
			"comments":{
				  "logist":[{
					"created_at":"2017-05-16 13:18:33",
					"comment":"Text Comment Logist"
				   },
				   {
					"created_at":"2017-05-16 16:08:17",
					"comment":"Another Text Comment Logist"
				  }],
				  "author":[{
					"created_at":"2017-05-16 13:20:33",
					"comment":"Text Comment Author"
				   },
				   {
					"created_at":"2017-05-16 16:20:17",
					"comment":"Another Text Comment Author"
				  }],
				 },
			"ip": "127.0.0.1",  // ip-адрес покупателя
			"rpo": "1312312312312321", // номер почтового отправления
			"rpo_shipment_date": "01.02.2015", // дата отправки (строго в формате дд.мм.гггг)
			"utm": {
				"utm_source": "source",
				"utm_medium": "medium",
				"utm_campaign": "campaign"
			}
		},
		"basket": [{
			"good_id": "1", // идентификатор товара
			"good_name": "Название товара", // название товара
			"cost": "1000.00",// цена товара
			"quantity": "1" // количество товара
		},{
			"good_id": "2", // идентификатор товара
			"good_name": "Название товара", // название товара
			"cost": "2000.00", // цена товара
			"quantity": "2"	// количество товара
		}
		]
	},{
		"order_id": "12345", // идентификатор заказа
		"status": "new", // статус заказа
		"status_date": "2014-01-01 00:00:00",// дата/время последней смены статуса
		"confirmed": true, // факт подтверждения заказа
		"customer" : {
			"surname": "Иванов", // фамилия
			"given_name": "Иван", // имя
			"patronymic": "Иванович", // отчество
			"country": "Россия", // страна
			"state": "Курская область", // регион
			"city": "Курск", // город
			"zip": "123456", // индекс
			"address": "ул. Пушкина, д. 1, кв. 2", // адрес
			"email": "ivan.ivanov@example.net", // email
			"phone": "+79991111111" // телефон
		},
		"credentials": {
			"created": "2014-01-01 00:00:00", // дата заказа
			"currency": "руб", // валюта заказа
			"amount": 5000.00, // стоимость заказа
			"delivery_cost": 100.00, // цена доставки
			"notes": "Бонус в подарок", // комментарий к заказу
			"logist_comment": "Комментарии логистики", // комментарии логистики
			"author_comment": "Комментарии автора", // комментарии автора
			"comments":{
				  "logist":[{
					"created_at":"2017-05-16 13:18:33",
					"comment":"Text Comment Logist"
				   },
				   {
					"created_at":"2017-05-16 16:08:17",
					"comment":"Another Text Comment Logist"
				  }],
				  "author":[{
					"created_at":"2017-05-16 13:20:33",
					"comment":"Text Comment Author"
				   },
				   {
					"created_at":"2017-05-16 16:20:17",
					"comment":"Another Text Comment Author"
				  }],
				 },
			"ip": "127.0.0.1",  // ip-адрес покупателя
			"rpo": "1312312312312321", // номер почтового отправления
			"rpo_shipment_date": "01.02.2015", // дата отправки (строго в формате дд.мм.гггг)
			"utm": {
				"utm_source": "source",
				"utm_medium": "medium",
				"utm_campaign": "campaign"
			}
		},
		"basket": [{
			"good_id": "1", // идентификатор товара
			"good_name": "Название товара",  // название товара
			"cost": "1000.00",	// цена товара
			"quantity": "1" 	// количество товара
		},{
			"good_id": "2", // идентификатор товара
			"good_name": "Название товара",  // название товара
			"cost": "2000.00", 	// цена товара
			"quantity": "2"	// количество товара
		}
		]

},.......
]
}

			 

Получение информации о заказах за заданный период

Получение информации о заказах за указанный период времени (GET)

https://api.e-autopay.com/v02/user_api_key/orders/2017-03-08..2017-04-08?{"customer_api_key":"customer_api_key"}

Ответ сервера

{
	"orders": [{
		"order_id": "1234", // идентификатор заказа
		"status": "new", // статус заказа
		"status_date": "2014-01-01 00:00:00",// дата/время последней смены статуса
		"confirmed": true, // факт подтверждения заказа
		"customer" : {
			"surname": "Иванов", // фамилия
			"given_name": "Иван", // имя
			"patronymic": "Иванович", // отчество
			"country": "Россия", // страна
			"state": "Курская область", // регион
			"city": "Курск", // город
			"zip": "123456", // индекс
			"address": "ул. Пушкина, д. 1, кв. 2", // адрес
			"email": "ivan.ivanov@example.net", // email
			"phone": "+79991111111" // телефон
		},
		"credentials": {
			"created": "2014-01-01 00:00:00", // дата заказа
			"currency": "руб", // валюта заказа
			"amount": 5000.00, // стоимость заказа
			"delivery_cost": 100.00, // цена доставки
			"notes": "Бонус в подарок", // комментарий к заказу
			"logist_comment": "Комментарии логистики", // комментарии логистики
			"author_comment": "Комментарии автора", // комментарии автора
			"comments":{
				  "logist":[{
					"created_at":"2017-05-16 13:18:33",
					"comment":"Text Comment Logist"
				   },
				   {
					"created_at":"2017-05-16 16:08:17",
					"comment":"Another Text Comment Logist"
				  }],
				  "author":[{
					"created_at":"2017-05-16 13:20:33",
					"comment":"Text Comment Author"
				   },
				   {
					"created_at":"2017-05-16 16:20:17",
					"comment":"Another Text Comment Author"
				  }],
				 },
			"ip": "127.0.0.1",  // ip-адрес покупателя
			"rpo": "1312312312312321", // номер почтового отправления
			"rpo_shipment_date": "01.02.2015", // дата отправки (строго в формате дд.мм.гггг)
			"utm": {
				"utm_source": "source",
				"utm_medium": "medium",
				"utm_campaign": "campaign"
			}
		},
		"basket": [{
			"good_id": "1", // идентификатор товара
			"good_name": "Название товара", // название товара
			"cost": "1000.00",// цена товара
			"quantity": "1" // количество товара
		},{
			"good_id": "2", // идентификатор товара
			"good_name": "Название товара", // название товара
			"cost": "2000.00", // цена товара
			"quantity": "2"	// количество товара
		}
		]
	},{
		"order_id": "12345", // идентификатор заказа
		"status": "new", // статус заказа
		"status_date": "2014-01-01 00:00:00",// дата/время последней смены статуса
		"confirmed": true, // факт подтверждения заказа
		"customer" : {
			"surname": "Иванов", // фамилия
			"given_name": "Иван", // имя
			"patronymic": "Иванович", // отчество
			"country": "Россия", // страна
			"state": "Курская область", // регион
			"city": "Курск", // город
			"zip": "123456", // индекс
			"address": "ул. Пушкина, д. 1, кв. 2", // адрес
			"email": "ivan.ivanov@example.net", // email
			"phone": "+79991111111" // телефон
		},
		"credentials": {
			"created": "2014-01-01 00:00:00", // дата заказа
			"currency": "руб", // валюта заказа
			"amount": 5000.00, // стоимость заказа
			"delivery_cost": 100.00, // цена доставки
			"notes": "Бонус в подарок", // комментарий к заказу
			"logist_comment": "Комментарии логистики", // комментарии логистики
			"author_comment": "Комментарии автора", // комментарии автора
			"comments":{
				  "logist":[{
					"created_at":"2017-05-16 13:18:33",
					"comment":"Text Comment Logist"
				   },
				   {
					"created_at":"2017-05-16 16:08:17",
					"comment":"Another Text Comment Logist"
				  }],
				  "author":[{
					"created_at":"2017-05-16 13:20:33",
					"comment":"Text Comment Author"
				   },
				   {
					"created_at":"2017-05-16 16:20:17",
					"comment":"Another Text Comment Author"
				  }],
				 },
			"ip": "127.0.0.1",  // ip-адрес покупателя
			"rpo": "1312312312312321", // номер почтового отправления
			"rpo_shipment_date": "01.02.2015", // дата отправки (строго в формате дд.мм.гггг)
			"utm": {
				"utm_source": "source",
				"utm_medium": "medium",
				"utm_campaign": "campaign"
			}
		},
		"basket": [{
			"good_id": "1", // идентификатор товара
			"good_name": "Название товара",  // название товара
			"cost": "1000.00",	// цена товара
			"quantity": "1" 	// количество товара
		},{
			"good_id": "2", // идентификатор товара
			"good_name": "Название товара",  // название товара
			"cost": "2000.00", 	// цена товара
			"quantity": "2"	// количество товара
		}
		]

},.......
]
}

			 

Обновление заказов

Обновление заказов (POST)

https://api.e-autopay.com/v02/user_api_key/orders/update
Тело запроса

{
	"customer_api_key": "$customer_api_key",
	"orders": [{	
		"order_id": "1234", // идентификатор заказа (обязательное)
		"customer" : {
			"surname": "Иванов", // фамилия
			"given_name": "Иван", // имя
			"patronymic": "Иванович", // отчество
			"country": "Россия", // страна
			"state": "Курская область", // регион
			"city": "Курск", // город
			"zip": "123456", // индекс
			"address": "ул. Пушкина, д. 1, кв. 2", // адрес
			"email": "ivan.ivanov@example.net", // email
			"phone": "+79991111111" // телефон
		},
		"credentials": {
			"created": "2014-01-01 00:00:00", // дата заказа
			"currency": "руб", // валюта заказа 
			"delivery_cost": 100.00, // цена доставки
			"notes": "Бонус в подарок", // комментарий к заказу
			"ip": "127.0.0.1",  // ip-адрес покупателя
			"rpo": "1312312312312321", // номер почтового отправления
			"rpo_shipment_date": "01.02.2015", // дата отправки (строго в формате дд.мм.гггг)
			"referer": "http://site.ru?utm_source=source&utm_medium=medium&utm_campaign=campaign" // страница заказа
		},
		"basket": [{
			"good_id": "1", // идентификатор товара	(обязательное)				
			"cost": "1000.00", // цена товара
			"quantity": "1" // количество товара
		},{
			"good_id": "2", // идентификатор товара	(обязательное)				
			"cost": "2000.00", // цена товара
			"quantity": "2"	// количество товара
		}
		],
		"partner": {
			"login": "test123", // refID партнера (обязательное)
			"cost": "450", // сумма комиссионных
			"currency": "rub" // валюта
		},
                "additional_fields": [
                    {
                        "key": "Цвет", 
                        "value": "Красные"
                    },
                    {
                        "key": "Размер", 
                        "value": "44"
                    }]
		},{
		"order_id": "12345", // идентификатор заказа (обязательное)
		"customer" : {
			"surname": "Иванов", // фамилия
			"given_name": "Иван", // имя
			"patronymic": "Иванович", // отчество
			"country": "Россия", // страна
			"state": "Курская область", // регион
			"city": "Курск", // город
			"zip": "123456", // индекс
			"address": "ул. Пушкина, д. 1, кв. 2", // адрес
			"email": "ivan.ivanov@example.net", // email
			"phone": "+79991111111" // телефон
		},
		"credentials": {
			"created": "2014-01-01 00:00:00", // дата заказа
			"currency": "руб", // валюта заказа 
			"delivery_cost": 100.00, // цена доставки
			"notes": "Бонус в подарок", // комментарий к заказу
			"ip": "127.0.0.1",  // ip-адрес покупателя
			"rpo": "1312312312312321", // номер почтового отправления
			"rpo_shipment_date": "01.02.2015", // дата отправки (строго в формате дд.мм.гггг)
			"referer": "http://site.ru?utm_source=source&utm_medium=medium&utm_campaign=campaign" // страница заказа
		},
		"basket": [{
			"good_id": "1",// идентификатор товара (обязательное)				
			"cost": "1000.00",// цена товара
			"quantity": "1" // количество товара
		},{
			"good_id": "2", // идентификатор товара	(обязательное)				
			"cost": "2000.00", 	// цена товара
			"quantity": "2"	// количество товара
		}
		],
		"partner": {
			"login": "test123", // refID партнера (обязательное)
			"cost": "450", // сумма комиссионных
			"currency": "rub" // валюта
		},
                "additional_fields": [
                    {
                        "key": "Цвет", 
                        "value": "Красные"
                    },
                    {
                        "key": "Размер", 
                        "value": "44"
                    }]
		}, .......
		]
}
		 

Ответ сервера

{
	"orders":[{
		"order_id": "1234", // идентификатор заказа
		"status": "new", // статус заказа
		"status_date": "2014-01-01 00:00:00",// дата/время последней смены статуса
		"confirmed": true, // факт подтверждения заказа
		"customer" : {
			"surname": "Иванов", // фамилия
			"given_name": "Иван", // имя
			"patronymic": "Иванович", // отчество
			"country": "Россия", // страна
			"state": "Курская область", // регион
			"city": "Курск", // город
			"zip": "123456", // индекс
			"address": "ул. Пушкина, д. 1, кв. 2", // адрес
			"email": "ivan.ivanov@example.net", // email
			"phone": "+79991111111" // телефон
		},
		"credentials": {
			"created": "2014-01-01 00:00:00", // дата заказа
			"currency": "руб", // валюта заказа
			"amount": 5000.00, // стоимость заказа
			"delivery_cost": 100.00, // цена доставки
			"notes": "Бонус в подарок", // комментарий к заказу
			"logist_comment": "Комментарии логистики" // комментарии логистики
			"author_comment": "Комментарии автора", // комментарии автора
			"comments":{
				  "logist":[{
					"created_at":"2017-05-16 13:18:33",
					"comment":"Text Comment Logist"
				   },
				   {
					"created_at":"2017-05-16 16:08:17",
					"comment":"Another Text Comment Logist"
				  }],
				  "author":[{
					"created_at":"2017-05-16 13:20:33",
					"comment":"Text Comment Author"
				   },
				   {
					"created_at":"2017-05-16 16:20:17",
					"comment":"Another Text Comment Author"
				  }],
				 },
		},
		"basket": [{
			"good_id": "1",	// идентификатор товара
			"good_name": "Название товара",  // название товара
			"cost": "1000.00",	// цена товара
			"quantity": "1" // количество товара
		},{
			"good_id": "2", // идентификатор товара
			"good_name": "Название товара",  // название товара
			"cost": "2000.00", 	// цена товара
			"quantity": "2"	// количество товара
		}
		],
		"partner": {
			"login": "test123", // refID партнера
			"cost": "450", // сумма комиссионных
			"currency": "rub" // валюта
		},
                "additional_fields": [
                    {
                        "key": "Цвет", 
                        "value": "Красные"
                    },
                    {
                        "key": "Размер", 
                        "value": "44"
                    }]
	},{
		"order_id": "12345", // идентификатор заказа
		"status": "new", // статус заказа
		"status_date": "2014-01-01 00:00:00",// дата/время последней смены статуса
		"confirmed": true, // факт подтверждения заказа
		"customer" : {
			"surname": "Иванов", // фамилия
			"given_name": "Иван", // имя
			"patronymic": "Иванович", // отчество
			"country": "Россия", // страна
			"state": "Курская область", // регион
			"city": "Курск", // город
			"zip": "123456", // индекс
			"address": "ул. Пушкина, д. 1, кв. 2", // адрес
			"email": "ivan.ivanov@example.net", // email
			"phone": "+79991111111" // телефон
		},
		"credentials": {
			"created": "2014-01-01 00:00:00", // дата заказа
			"currency": "руб", // валюта заказа
			"amount": 5000.00, // стоимость заказа
			"delivery_cost": 100.00, // цена доставки
			"notes": "Бонус в подарок", // комментарий к заказу
			"logist_comment": "Комментарии логистики" // комментарии логистики
			"author_comment": "Комментарии автора", // комментарии автора
			"comments":{
				  "logist":[{
					"created_at":"2017-05-16 13:18:33",
					"comment":"Text Comment Logist"
				   },
				   {
					"created_at":"2017-05-16 16:08:17",
					"comment":"Another Text Comment Logist"
				  }],
				  "author":[{
					"created_at":"2017-05-16 13:20:33",
					"comment":"Text Comment Author"
				   },
				   {
					"created_at":"2017-05-16 16:20:17",
					"comment":"Another Text Comment Author"
				  }],
				 },
			"ip": "127.0.0.1",  // ip-адрес покупателя
			"rpo": "1312312312312321", // номер почтового отправления
			"rpo_shipment_date": "01.02.2015", // дата отправки (строго в формате дд.мм.гггг)
			"utm": {
				"utm_source": "source",
				"utm_medium": "medium",
				"utm_campaign": "campaign"
			}
		},
		"basket": [{
			"good_id": "1",	// идентификатор товара
			"good_name": "Название товара",  // название товара
			"cost": "1000.00",	// цена товара
			"quantity": "1" 	// количество товара
		},{
			"good_id": "2", // идентификатор товара
			"good_name": "Название товара",  // название товара
			"cost": "2000.00", 	// цена товара
			"quantity": "2"	// количество товара
		}
		],
		"partner": {
			"login": "test123", // refID партнера
			"cost": "450", // сумма комиссионных
			"currency": "rub" // валюта
		},
                "additional_fields": [
                    {
                        "key": "Цвет", 
                        "value": "Красные"
                    },
                    {
                        "key": "Размер", 
                        "value": "44"
                    }]
	}, ......

	]
}
					 

Примечание

  • Для удаления товара из заказа необходимо указать значение "quantity" равным нулю
  • Для добавления товара к заказу достаточно добавить его в корзину
  • При редактировании партнера можно лишь обнулить комиссию. Удалить партнера из заказа нельзя
  • При нахождении заказа в статусах
    • Отправленные
    • Доставленные
    • Напоминание 1
    • Напоминание 2
    Можно редактировать только поле "notes"

Статусы заказа

Код Описание
"archive" Архив
"new" Новый
"confirmed" Подтвержден оператором
"sent" Отправлен клиенту
"cancelled" Возврат
"in_hands_paid" Вручен и оплачен
"unconfirmed" Неподтвержден
"delayed" Отсрочен
"refused" Отказ
"delivered_unpaid" Доставлен к месту получения
"complectation" Комплектация
"ready_for_delivery" Подготовлен к отправке
"problem" Проблемный
"delivered_paid" Доставлен к месту получения и оплачен
"pending" Ожидает подтверждения (Call-центр)
"specified" Уточненный
"in_hands_unpaid" Вручен
"wanted" В розыске
"absence" Отсутствие продукта
"returned" Получен возврат
"notice1" Напоминание 1
"notice2" Напоминание 2


Коды сообщений

В случае возникновения ошибок - возвращается объект с описание ошибки

{
   error: {
	   "code": "HTTP Код",
	   "message": "Сообщение"
   }
}