TeleportService

<back to all web services

Documents_Download_v2

Requires Authentication
The following routes are available for this service:
POST, GET/v2/Documents_Download
Documents_Download_v2 Parameters:
NameParameterData TypeRequiredDescription
StartDateTimebodyDateTime?No
FieldStrategybodyFieldStrategyNo
PageSizebodyintNo
CursorbodystringNo
FieldStrategy Enum:
Date
UpdateDate
DocumentsDownloadResponse Parameters:
NameParameterData TypeRequiredDescription
DocumentsformList<DocumentsList>No
CursorformstringNo
HasNextformboolNo
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_warehouse_nameformstringNo
marketplace_delivery_methodformstringNo
marketplace_pre_posting_numberformstringNo
itemsInfoformDocumentItemsInfoNo
client_order_numberformstringNo
DocumentStatus Enum:
new
transmitted
processed
canceled
agreement
confirmed
shipped
closed
draft
DocumentItemsInfo Parameters:
NameParameterData TypeRequiredDescription
firstItemformTeleportDocumentTableNo
itemsQuantityformintNo
TeleportDocumentTable Parameters:
NameParameterData TypeRequiredDescription
ownerformstringNo
idformstringNo
uidformstringNo
codeformstringNo
articleformstringNo
nameformstringNo
unitformstringNo
quantityformdecimalNo
confirmedformdecimalNo
priceformdecimalNo
sumformdecimalNo
trademarkformstringNo
propsformList<TeleportDocumentPropsValue>No
TeleportDocumentPropsValue Parameters:
NameParameterData TypeRequiredDescription
nameformstringNo
valueformstringNo

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_Download HTTP/1.1 
Host: wbs.e-teleport.ru 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<Documents_Download_v2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TeleportService.ServiceModel">
  <Cursor>String</Cursor>
  <FieldStrategy>Date</FieldStrategy>
  <PageSize>0</PageSize>
  <StartDateTime>0001-01-01T00:00:00</StartDateTime>
</Documents_Download_v2>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentsDownloadResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TeleportService.ServiceModel">
  <Cursor>String</Cursor>
  <Documents>
    <DocumentsList>
      <addProps>String</addProps>
      <branch>String</branch>
      <cancel_date>0001-01-01T00:00:00</cancel_date>
      <canceled_after_delivery>false</canceled_after_delivery>
      <client_order_number>String</client_order_number>
      <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>
      <itemsInfo>
        <firstItem>
          <article>String</article>
          <code>String</code>
          <confirmed>0</confirmed>
          <id>String</id>
          <name>String</name>
          <owner>String</owner>
          <price>0</price>
          <props>
            <TeleportDocumentPropsValue>
              <name>String</name>
              <value>String</value>
            </TeleportDocumentPropsValue>
          </props>
          <quantity>0</quantity>
          <sum>0</sum>
          <trademark>String</trademark>
          <uid>String</uid>
          <unit>String</unit>
        </firstItem>
        <itemsQuantity>0</itemsQuantity>
      </itemsInfo>
      <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>
      <marketplace_warehouse_name>String</marketplace_warehouse_name>
      <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>
  <HasNext>false</HasNext>
</DocumentsDownloadResponse>