TeleportService

<back to all web services

Documents_GetById_v2

Requires Authentication
The following routes are available for this service:
POST, GET/v2/Documents_GetById
Documents_GetById_v2 Parameters:
NameParameterData TypeRequiredDescription
message_idbodystringNo
DocumentsGetByIdResponse_v2 Parameters:
NameParameterData TypeRequiredDescription
errCodeformintNo
documentformDocumentModelNo
DocumentModel Parameters:
NameParameterData TypeRequiredDescription
message_idformstringNo
ownerformstringNo
recipientformstringNo
senderformstringNo
receiverformstringNo
messageformTeleportDocumentNo
typeformstringNo
statusformDocumentStatusNo
dateformDateTimeNo
numformstringNo
sumformdecimalNo
currencyIdformstringNo
hashformstringNo
addPropsformstringNo
add_dateformDateTimeNo
file_attachedformboolNo
receiver_teamformstringNo
sender_teamformstringNo
file_idformstringNo
companyformstringNo
branchformstringNo
update_dateformDateTimeNo
commentformstringNo
TeleportDocument Parameters:
NameParameterData TypeRequiredDescription
docHeaderformTeleportDocumentHeaderNo
tabHeaderformTeleportDocumentTabHeaderNo
docTableformList<TeleportDocumentTable>No
TeleportDocumentHeader Parameters:
NameParameterData TypeRequiredDescription
idformstringNo
ownerformstringNo
typeformstringNo
statusformDocumentStatusNo
dateformDateTimeNo
numformstringNo
hashformstringNo
sumformdecimalNo
currencyIdformstringNo
commentformstringNo
fileAttachedformboolNo
file_idformstringNo
propsformList<TeleportDocumentProps>No
marketplaceformstringNo
delivery_dateformDateTimeNo
marketplace_statusformstringNo
huckster_statusformstringNo
cancel_dateformDateTimeNo
canceled_after_deliveryformboolNo
marketplace_idformstringNo
marketplace_posting_numberformstringNo
marketplace_substatusformstringNo
payment_typeformstringNo
payment_methodformstringNo
marketplace_accountformstringNo
marketplace_shop_idformstringNo
marketplace_expressformboolNo
marketplace_delivery_methodformstringNo
marketplace_warehouse_idformstringNo
marketplace_pre_posting_numberformstringNo
DocumentStatus Enum:
new
transmitted
processed
canceled
agreement
confirmed
shipped
closed
draft
TeleportDocumentProps Parameters:
NameParameterData TypeRequiredDescription
nameformstringNo
headerformstringNo
typeformstringNo
enumvaluesformList<string>No
requiredformboolNo
valueformstringNo
TeleportDocumentTabHeader Parameters:
NameParameterData TypeRequiredDescription
articleformstringNo
nameformstringNo
unitformstringNo
quantityformstringNo
confirmedformstringNo
priceformstringNo
sumformstringNo
trademarkformstringNo
propsformList<TeleportDocumentProps>No
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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"message_id":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"errCode":0,"document":{"message_id":"String","owner":"String","recipient":"String","sender":"String","receiver":"String","message":{"docHeader":{"id":"String","owner":"String","type":"String","status":"new","date":"0001-01-01T00:00:00.0000000","num":"String","hash":"String","sum":0,"currencyId":"String","comment":"String","fileAttached":false,"file_id":"String","props":[{"name":"String","header":"String","type":"String","enumvalues":["String"],"required":false,"value":"String"}],"marketplace":"String","delivery_date":"0001-01-01T00:00:00.0000000","marketplace_status":"String","huckster_status":"String","cancel_date":"0001-01-01T00:00:00.0000000","canceled_after_delivery":false,"marketplace_id":"String","marketplace_posting_number":"String","marketplace_substatus":"String","payment_type":"String","payment_method":"String","marketplace_account":"String","marketplace_shop_id":"String","marketplace_express":false,"marketplace_delivery_method":"String","marketplace_warehouse_id":"String","marketplace_pre_posting_number":"String"},"tabHeader":{"article":"String","name":"String","unit":"String","quantity":"String","confirmed":"String","price":"String","sum":"String","trademark":"String","props":[{"name":"String","header":"String","type":"String","enumvalues":["String"],"required":false,"value":"String"}]},"docTable":[{"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"}]}]},"type":"String","status":"new","date":"0001-01-01T00:00:00.0000000","num":"String","sum":0,"currencyId":"String","hash":"String","addProps":"String","add_date":"0001-01-01T00:00:00.0000000","file_attached":false,"receiver_team":"String","sender_team":"String","file_id":"String","company":"String","branch":"String","update_date":"0001-01-01T00:00:00.0000000","comment":"String"}}