| POST, GET | /v2/Documents_GetById |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| message_id | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| errCode | form | int | No | |
| document | form | DocumentModel | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| message_id | form | string | No | |
| owner | form | string | No | |
| recipient | form | string | No | |
| sender | form | string | No | |
| receiver | form | string | No | |
| message | form | TeleportDocument | 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 | |
| add_date | form | DateTime | No | |
| file_attached | form | bool | No | |
| receiver_team | form | string | No | |
| sender_team | form | string | No | |
| file_id | form | string | No | |
| company | form | string | No | |
| branch | form | string | No | |
| update_date | form | DateTime | No | |
| comment | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| docHeader | form | TeleportDocumentHeader | No | |
| tabHeader | form | TeleportDocumentTabHeader | No | |
| docTable | form | List<TeleportDocumentTable> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| id | form | string | No | |
| owner | form | string | No | |
| type | form | string | No | |
| status | form | DocumentStatus | No | |
| date | form | DateTime | No | |
| num | form | string | No | |
| hash | form | string | No | |
| sum | form | decimal | No | |
| currencyId | form | string | No | |
| comment | form | string | No | |
| fileAttached | form | bool | No | |
| file_id | form | string | No | |
| props | form | List<TeleportDocumentProps> | 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 | |
| marketplace_account | form | string | No | |
| marketplace_shop_id | form | string | No | |
| marketplace_express | form | bool | No | |
| marketplace_delivery_method | form | string | No | |
| marketplace_warehouse_id | form | string | No | |
| marketplace_warehouse_name | form | string | No | |
| marketplace_pre_posting_number | form | string | No | |
| MarketplaceAccount | form | MarketplaceAccountHeader | No | |
| MarketplaceWarehouse | form | MarketplaceWarehouseHeader | No | |
| client_order_number | form | string | No |
| new | |
| transmitted | |
| processed | |
| canceled | |
| agreement | |
| confirmed | |
| shipped | |
| closed | |
| draft |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| name | form | string | No | |
| header | form | string | No | |
| type | form | string | No | |
| enumvalues | form | List<string> | No | |
| required | form | bool | No | |
| value | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| marketplace | form | string | No | |
| shop_id | form | string | No | |
| account | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| shop_id | form | string | No | |
| warehouse_id | form | string | No | |
| warehouse_name | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| article | form | string | No | |
| name | form | string | No | |
| unit | form | string | No | |
| quantity | form | string | No | |
| confirmed | form | string | No | |
| price | form | string | No | |
| sum | form | string | No | |
| trademark | form | string | No | |
| props | form | List<TeleportDocumentProps> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| 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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v2/Documents_GetById HTTP/1.1
Host: wbs.e-teleport.ru
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<Documents_GetById_v2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TeleportService.ServiceModel">
<message_id>String</message_id>
</Documents_GetById_v2>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<DocumentsGetByIdResponse_v2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TeleportService.ServiceModel">
<document>
<addProps>String</addProps>
<add_date>0001-01-01T00:00:00</add_date>
<branch>String</branch>
<comment>String</comment>
<company>String</company>
<currencyId>String</currencyId>
<date>0001-01-01T00:00:00</date>
<file_attached>false</file_attached>
<file_id>String</file_id>
<hash>String</hash>
<message>
<docHeader>
<MarketplaceAccount>
<account>String</account>
<marketplace>String</marketplace>
<shop_id>String</shop_id>
</MarketplaceAccount>
<MarketplaceWarehouse>
<shop_id>String</shop_id>
<warehouse_id>String</warehouse_id>
<warehouse_name>String</warehouse_name>
</MarketplaceWarehouse>
<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>
<currencyId>String</currencyId>
<date>0001-01-01T00:00:00</date>
<delivery_date>0001-01-01T00:00:00</delivery_date>
<fileAttached>false</fileAttached>
<file_id>String</file_id>
<hash>String</hash>
<huckster_status>String</huckster_status>
<id>String</id>
<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>
<num>String</num>
<owner>String</owner>
<payment_method>String</payment_method>
<payment_type>String</payment_type>
<props>
<TeleportDocumentProps>
<enumvalues xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:string>String</d7p1:string>
</enumvalues>
<header>String</header>
<name>String</name>
<required>false</required>
<type>String</type>
<value>String</value>
</TeleportDocumentProps>
</props>
<status>new</status>
<sum>0</sum>
<type>String</type>
</docHeader>
<docTable>
<TeleportDocumentTable>
<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>
</TeleportDocumentTable>
</docTable>
<tabHeader>
<article>String</article>
<confirmed>String</confirmed>
<name>String</name>
<price>String</price>
<props>
<TeleportDocumentProps>
<enumvalues xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:string>String</d7p1:string>
</enumvalues>
<header>String</header>
<name>String</name>
<required>false</required>
<type>String</type>
<value>String</value>
</TeleportDocumentProps>
</props>
<quantity>String</quantity>
<sum>String</sum>
<trademark>String</trademark>
<unit>String</unit>
</tabHeader>
</message>
<message_id>String</message_id>
<num>String</num>
<owner>String</owner>
<receiver>String</receiver>
<receiver_team>String</receiver_team>
<recipient>String</recipient>
<sender>String</sender>
<sender_team>String</sender_team>
<status>new</status>
<sum>0</sum>
<type>String</type>
<update_date>0001-01-01T00:00:00</update_date>
</document>
<errCode>0</errCode>
</DocumentsGetByIdResponse_v2>