TeleportService

<back to all web services

Documents_GetList_v2

Requires Authentication
The following routes are available for this service:
POST, GET/v2/Documents_GetList
DocumentsGetListBase Parameters:
NameParameterData TypeRequiredDescription
start_dateformDateTimeNo
end_dateformDateTimeNo
filtersformList<DocumentsFilter>No
status_change_offformboolNo
get_documentformboolNo
use_updateDateformboolNo
document_typeformstringNo
offsetformintNo
limitformintNo
at_pagesformboolNo
get_countformboolNo
getStrategyformDocumentGetStrategyNo
DocumentsFilter Parameters:
NameParameterData TypeRequiredDescription
nameformstringNo
operationformstringNo
valueformstringNo
rangeformDocumentsFilterRangeNo
inValuesformList<string>No
DocumentsFilterRange Parameters:
NameParameterData TypeRequiredDescription
minformstringNo
maxformstringNo
DocumentGetStrategy Enum:
all
sent
receive
DocumentsGetListResponse_v2 Parameters:
NameParameterData TypeRequiredDescription
errCodeformintNo
totalCountformlongNo
documentsformList<DocumentsList>No
DocumentsList Parameters:
NameParameterData TypeRequiredDescription
message_idformstringNo
senderformstringNo
receiverformstringNo
typeformstringNo
statusformDocumentStatusNo
dateformDateTimeNo
numformstringNo
sumformdecimalNo
currencyIdformstringNo
hashformstringNo
addPropsformstringNo
file_attachedformboolNo
is_newformboolNo
companyformstringNo
branchformstringNo
messageformstringNo
update_dateformDateTimeNo
commentformstringNo
file_idformstringNo
marketplaceformstringNo
delivery_dateformDateTimeNo
marketplace_statusformstringNo
huckster_statusformstringNo
cancel_dateformDateTimeNo
canceled_after_deliveryformboolNo
marketplace_idformstringNo
marketplace_posting_numberformstringNo
marketplace_substatusformstringNo
payment_typeformstringNo
payment_methodformstringNo
trademarkformstringNo
marketplace_accountformstringNo
marketplace_shop_idformstringNo
marketplace_expressformboolNo
marketplace_warehouse_idformstringNo
marketplace_delivery_methodformstringNo
marketplace_pre_posting_numberformstringNo
DocumentStatus Enum:
new
transmitted
processed
canceled
agreement
confirmed
shipped
closed
draft

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<Documents_GetList_v2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TeleportService.ServiceModel">
  <at_pages>false</at_pages>
  <document_type>String</document_type>
  <end_date>0001-01-01T00:00:00</end_date>
  <filters>
    <DocumentsFilter>
      <inValues xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </inValues>
      <name>String</name>
      <operation>String</operation>
      <range>
        <max>String</max>
        <min>String</min>
      </range>
      <value>String</value>
    </DocumentsFilter>
  </filters>
  <getStrategy>all</getStrategy>
  <get_count>false</get_count>
  <get_document>false</get_document>
  <limit>0</limit>
  <offset>0</offset>
  <start_date>0001-01-01T00:00:00</start_date>
  <status_change_off>false</status_change_off>
  <use_updateDate>false</use_updateDate>
</Documents_GetList_v2>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentsGetListResponse_v2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TeleportService.ServiceModel">
  <documents>
    <DocumentsList>
      <addProps>String</addProps>
      <branch>String</branch>
      <cancel_date>0001-01-01T00:00:00</cancel_date>
      <canceled_after_delivery>false</canceled_after_delivery>
      <comment>String</comment>
      <company>String</company>
      <currencyId>String</currencyId>
      <date>0001-01-01T00:00:00</date>
      <delivery_date>0001-01-01T00:00:00</delivery_date>
      <file_attached>false</file_attached>
      <file_id>String</file_id>
      <hash>String</hash>
      <huckster_status>String</huckster_status>
      <is_new>false</is_new>
      <marketplace>String</marketplace>
      <marketplace_account>String</marketplace_account>
      <marketplace_delivery_method>String</marketplace_delivery_method>
      <marketplace_express>false</marketplace_express>
      <marketplace_id>String</marketplace_id>
      <marketplace_posting_number>String</marketplace_posting_number>
      <marketplace_pre_posting_number>String</marketplace_pre_posting_number>
      <marketplace_shop_id>String</marketplace_shop_id>
      <marketplace_status>String</marketplace_status>
      <marketplace_substatus>String</marketplace_substatus>
      <marketplace_warehouse_id>String</marketplace_warehouse_id>
      <message>String</message>
      <message_id>String</message_id>
      <num>String</num>
      <payment_method>String</payment_method>
      <payment_type>String</payment_type>
      <receiver>String</receiver>
      <sender>String</sender>
      <status>new</status>
      <sum>0</sum>
      <trademark>String</trademark>
      <type>String</type>
      <update_date>0001-01-01T00:00:00</update_date>
    </DocumentsList>
  </documents>
  <errCode>0</errCode>
  <totalCount>0</totalCount>
</DocumentsGetListResponse_v2>