TeleportService

Documents_GetList_v2

The following routes are available for this service:
POST, GET	/v2/Documents_GetList

**DocumentsGetListBase** Parameters:
Name	Parameter	Data Type	Required
start_date	form	DateTime	No
end_date	form	DateTime	No
filters	form	List<DocumentsFilter>	No
status_change_off	form	bool	No
get_document	form	bool	No
use_updateDate	form	bool	No
document_type	form	string	No
offset	form	int	No
limit	form	int	No
at_pages	form	bool	No
get_count	form	bool	No
getStrategy	form	DocumentGetStrategy	No
maxCount	form	int	No

**DocumentsFilter** Parameters:
Name	Parameter	Data Type	Required
name	form	string	No
operation	form	string	No
value	form	string	No
range	form	DocumentsFilterRange	No
inValues	form	List<string>	No

**DocumentsFilterRange** Parameters:
Name	Parameter	Data Type	Required	Description
min	form	string	No
max	form	string	No

**DocumentGetStrategy** Enum:
all
sent
receive

**DocumentsGetListResponse_v2** Parameters:
Name	Parameter	Data Type	Required
errCode	form	int	No
totalCount	form	long	No
documents	form	List<DocumentsList>	No

**DocumentsList** Parameters:
Name	Parameter	Data Type	Required
message_id	form	string	No
sender	form	string	No
receiver	form	string	No
type	form	string	No
status	form	DocumentStatus	No
date	form	DateTime	No
num	form	string	No
sum	form	decimal	No
currencyId	form	string	No
hash	form	string	No
addProps	form	string	No
file_attached	form	bool	No
is_new	form	bool	No
company	form	string	No
branch	form	string	No
message	form	string	No
update_date	form	DateTime	No
comment	form	string	No
file_id	form	string	No
marketplace	form	string	No
delivery_date	form	DateTime	No
marketplace_status	form	string	No
huckster_status	form	string	No
cancel_date	form	DateTime	No
canceled_after_delivery	form	bool	No
marketplace_id	form	string	No
marketplace_posting_number	form	string	No
marketplace_substatus	form	string	No
payment_type	form	string	No
payment_method	form	string	No
trademark	form	string	No
marketplace_account	form	string	No
marketplace_shop_id	form	string	No
marketplace_express	form	bool	No
marketplace_warehouse_id	form	string	No
marketplace_warehouse_name	form	string	No
marketplace_delivery_method	form	string	No
marketplace_pre_posting_number	form	string	No
itemsInfo	form	DocumentItemsInfo	No
client_order_number	form	string	No

**DocumentStatus** Enum:
new
transmitted
processed
canceled
agreement
confirmed
shipped
closed
draft

**DocumentItemsInfo** Parameters:
Name	Parameter	Data Type	Required	Description
firstItem	form	TeleportDocumentTable	No
itemsQuantity	form	int	No

**TeleportDocumentTable** Parameters:
Name	Parameter	Data Type	Required
owner	form	string	No
id	form	string	No
uid	form	string	No
code	form	string	No
article	form	string	No
name	form	string	No
unit	form	string	No
quantity	form	decimal	No
confirmed	form	decimal	No
price	form	decimal	No
sum	form	decimal	No
trademark	form	string	No
props	form	List<TeleportDocumentPropsValue>	No

**TeleportDocumentPropsValue** Parameters:
Name	Parameter	Data Type	Required	Description
name	form	string	No
value	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v2/Documents_GetList HTTP/1.1 
Host: wbs.e-teleport.ru 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	start_date: 0001-01-01,
	end_date: 0001-01-01,
	filters: 
	[
		{
			name: String,
			operation: String,
			value: String,
			range: 
			{
				min: String,
				max: String
			},
			inValues: 
			[
				String
			]
		}
	],
	status_change_off: False,
	get_document: False,
	use_updateDate: False,
	document_type: String,
	offset: 0,
	limit: 0,
	at_pages: False,
	get_count: False,
	getStrategy: all,
	maxCount: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	errCode: 0,
	totalCount: 0,
	documents: 
	[
		{
			message_id: String,
			sender: String,
			receiver: String,
			type: String,
			status: new,
			date: 0001-01-01,
			num: String,
			sum: 0,
			currencyId: String,
			hash: String,
			addProps: String,
			file_attached: False,
			is_new: False,
			company: String,
			branch: String,
			message: String,
			update_date: 0001-01-01,
			comment: String,
			file_id: String,
			marketplace: String,
			delivery_date: 0001-01-01,
			marketplace_status: String,
			huckster_status: String,
			cancel_date: 0001-01-01,
			canceled_after_delivery: False,
			marketplace_id: String,
			marketplace_posting_number: String,
			marketplace_substatus: String,
			payment_type: String,
			payment_method: String,
			trademark: String,
			marketplace_account: String,
			marketplace_shop_id: String,
			marketplace_express: False,
			marketplace_warehouse_id: String,
			marketplace_warehouse_name: String,
			marketplace_delivery_method: String,
			marketplace_pre_posting_number: String,
			itemsInfo: 
			{
				firstItem: 
				{
					owner: String,
					id: String,
					uid: String,
					code: String,
					article: String,
					name: String,
					unit: String,
					quantity: 0,
					confirmed: 0,
					price: 0,
					sum: 0,
					trademark: String,
					props: 
					[
						{
							name: String,
							value: String
						}
					]
				},
				itemsQuantity: 0
			},
			client_order_number: String
		}
	]
}