Dokumentų gavimo procesas

Norint gauti dokumentus iš savo prekybos partnerio per „Edisoft“ platformą, reikės paeiliui panaudoti 3 API komandas:

‘ListMB’ arba ‘ListMBAll’
‘Receive’
‘ChangeDocumentStatus’

1. Komanda ‘ListMB’ arba ‘ListMBAll’

Komanda ‘ListMB’ leidžia gauti dokumentų sąrašą pagal nurodytus parametrus. ‘ListMB’ užklausoje reikia perduoti lentelėje aprašytus parametrus:

Parametras	Aprašymas	Privalomas
Name	Prisijungimo vardas	Taip
Password	Slaptažodis	Taip
PartnerILN	Jūsų partnerio ILN / GLN numeris	Ne
DocumentType	Dokumento tipas, kurį norite gauti (ORDER, INVOICE, DESADV, RECADV ar kt.)	Taip
DocumentStatus	Pasirenkamas dokumentų statusas: N (New) – tik nauji dokumentai R (Read) – tik perskaityti dokumentai Jei reikšmė nenurodoma, bus gražinami visi dokumentai	Ne

Užklausos pavyzdys naudojant komandą ‘ListMB’

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:wsedi">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:ListMB>
         <urn:Name>SomeName</urn:Name>
         <urn:Password>SomePassword</urn:Password>
         <urn:DocumentType>ORDER</urn:DocumentType>
         <urn:DocumentStatus>N</urn:DocumentStatus>
         <urn:Timeout>100</urn:Timeout>
      </urn:ListMB>
   </soapenv:Body>
</soapenv:Envelope>

Komanda ‘ListMBAll’ leidžia gauti visus jums skirtus dokumentus turinčius statusą N (New) . ‘ListMBAll’ užklausoje reikia perduoti lentelėje aprašytus parametrus:

Parametrus	Aprašymas	Privalomas
Name	Prisijungimo vardas	Taip
Password	Slaptažodis	Taip

Užklausos pavyzdys naudojant komandą ‘ListMBAll’

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:wsedi">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:ListMBAll>
         <urn:Name>SomeName</urn:Name>
         <urn:Password>SomePassword</urn:Password>
      </urn:ListMBAll>
   </soapenv:Body>
</soapenv:Envelope>

Įvykdžius komandą ‘ListMB’ arba ‘ListMBAll’, „Edisoft“ sistema atsiųs duomenis apie prašomus dokumentus. Atsakyme bus pateikti sekantys laukai:

Laukas	Aprašymas
<partner-iln>	Partnerio iš kurio gautas dokumentas ILN / GLN numeris
<tracking-id>	Dokumento numeris EDI platformoje
<document-type>	Dokumento tipas (ORDER, INVOICE, DESADV, RECADV ar kt.)
<document-status>	Dokumento statusas (N – new, R – read)
<document-number>	Siuntėjo nurodytas dokumento numeris
<document-date>	Dokumento data
<document-control-number>	Dokumento kontrolinis numeris
<receive-date>	Dokumento gavimo data
<file-name>	Failo pavadinimas

Atsakymo pavyzdys naudojant komandą ‘ListMB’ arba ‘ListMBAll’

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Body>
        <ListMBAllResponse xmlns="urn:wsedi">
            <ns1:ListMBAllResult xmlns:ns1="urn:wsedi">
                <ns1:Res>00000000</ns1:Res>
                <ns1:Cnt><![CDATA[<mailbox-response>
<document-info>
    <partner-iln>2000000000109</partner-iln>
    <tracking-id>14768804</tracking-id>
    <document-type>ORDER</document-type>
    <document-version>1.0</document-version>
    <document-standard>XML</document-standard>
    <document-test>P</document-test>
    <document-status>New</document-status>
    <document-number>ORD0001</document-number>
    <document-date>2023-01-26</document-date>
    <document-control-number></document-control-number>
    <receive-date>2023-01-26T10:27:23</receive-date>
    <file-name>ORDER_20230126102724016_0a0055e62d374991abbe06b262704f4a.xml</file-name>
</document-info>
</mailbox-response>]]></ns1:Cnt>
            </ns1:ListMBAllResult>
        </ListMBAllResponse>
    </soapenv:Body>
</soapenv:Envelope>

2. Komanda ‘Receive’

Komanda ‘Receive’ leidžia gauti EDI dokumentus pagal nurodytus parametrus. ‘Receive’ užklausoje reikia perduoti lentelėje aprašytus parametrus:

Parametras	Aprašymas	Privalomas
Name	Prisijungimo vardas	Taip
Password	Slaptažodis	Taip
PartnerILN	Jūsų partnerio ILN / GLN numeris	Taip
DocumentType	Dokumento tipas kurį norite gauti (ORDER, INVOICE, DESADV, RECADV ar kt.)	Taip
TrackingId	Dokumento numeris EDI platformoje	Taip
DocumentStandard	Dokumento formatas (EDIFACT, XML, CSV ar kt.)	Ne
Timeout	Užklausos vykdymui skirtas laikas, nurodomas sveikas skaičius (ms)	Taip

Privalomi parametrai (PartnerILN, DocumentType, TrackingId) gaunami įvykdžius pirmą komandą ‘ListMB’ arba ‘ListMBAll’. Dokumentų su statusu R (Read) gauti negalima.

Užklausos pavyzdys naudojant komandą ‘Receive’

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:wsedi">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:Receive>
            <urn:Name>SomeName</urn:Name>
            <urn:Password>SomePassword</urn:Password>
            <urn:PartnerIln>2000000000109</urn:PartnerIln>
            <urn:DocumentType>ORDER</urn:DocumentType>
            <urn:TrackingId>14768804</urn:TrackingId>
            <urn:Timeout>100</urn:Timeout>
        </urn:Receive>
    </soapenv:Body>
</soapenv:Envelope>

Įvykdžius komandą ‘Receive’, „Edisoft“ sistema atsiųs rezultatą. Atsakyme bus pateikti sekantys laukai:

Laukas	Aprašymas
<ns1:res>	Patvirtinimo arba klaidos kodas
<ns1:cnt>	CDATA viduje įterpiamas pilnas Edisoft XML formato dokumentas

Galimi klaidų kodai ir jų aprašymai:

Klaidos kodas	Aprašymas
00000000	API operacija sėkmingai įvykdyta
00000001	Autentifikacijos klaida
00000003	Neteisingi parametrai
00000004	Nėra tokio ryšio
00000005	Baigėsi užklausos vykdymui skirtas laikas
00000006	Sistemos klaida

Atsakymo pavyzdys naudojant komandą ‘Receive’

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Body>
        <ReceiveResponse xmlns="urn:wsedi">
            <ns1:ReceiveResult xmlns:ns1="urn:wsedi">
                <ns1:Res>00000000</ns1:Res>
                <ns1:Cnt><![CDATA[<Document-Order>
<Document-Header>
<DocumentReceiveDateTime>2023-01-26T10:27:10</DocumentReceiveDateTime>
<DocumentProcessDateTime>2023-01-26T10:27:23</DocumentProcessDateTime>
<DocumentID>21823748</DocumentID>
<DocumentUID>0a0055e62d374991abbe06b262704f4a</DocumentUID>
<DocumentLink>https://bltest.ediweb.eu/edi//showDocument?uid=MGEwMDU1ZTYyZDM3NDk5MWFiYmUwNmIyNjI3MDRmNGE%3D</DocumentLink>
<DocumentType>ORDER</DocumentType>
<DocumentSource>S</DocumentSource>
<OriginalFileName><![CDATA[ORDER_20230126102710417]]]]>><![CDATA[</OriginalFileName></Document-Header>
<Order-Header>
<OrderNumber>ORD0001</OrderNumber>
<OrderDate>2023-01-26</OrderDate>
<OrderCurrency>EUR</OrderCurrency>
<ExpectedDeliveryDate>2023-02-15</ExpectedDeliveryDate>
<DocumentFunctionCode>9</DocumentFunctionCode>
</Order-Header>
<Document-Parties>
<Sender>
<ILN>2000000000109</ILN>
<Name>LT Test Buyer(SOAP)</Name>
</Sender>
<Receiver>
<ILN>2000000000110</ILN>
<Name>LT Test Supplier(SOAP)</Name>
</Receiver>
<Creator>
<SystemUniqueCode>2000000000109WS</SystemUniqueCode>
<CodeBySender>2000000000109WS</CodeBySender>
<Name>LT Test Buyer(StrongPoint) WS servise</Name>
<E-mail>denis@edisoft.lt</E-mail>
<CreationType>M</CreationType>
</Creator>
</Document-Parties>
<Order-Parties>
<Buyer>
<ILN>2000000000109</ILN>
<Name>LT Test Buyer(SOAP)</Name>
</Buyer>
<Seller>
<ILN>2000000000110</ILN>
<Name>LT Test Supplier(SOAP)</Name>
</Seller>
<DeliveryPoint>
<ILN>9981616200001</ILN>
<Name>Prekybos centras 01</Name>
<CodeBySupplier>01</CodeBySupplier>
<CodeByBuyer>S009</CodeByBuyer>
<StreetAndNumber>Ateities g. 1</StreetAndNumber>
<CityName>Vilnius</CityName>
<Country>LT</Country>
</DeliveryPoint>
</Order-Parties>
<Order-Lines>
<Line>
<Line-Item>
<LineNumber>1</LineNumber>
<EAN>5903355000001</EAN>
<BuyerItemCode>8004001</BuyerItemCode>
<ItemDescription>Prekė 1</ItemDescription>
<OrderedQuantity>100.000</OrderedQuantity>
<OrderedUnitPacksize>1.000</OrderedUnitPacksize>
<UnitOfMeasure>vnt.</UnitOfMeasure>
<OrderedUnitNetPrice>0.0000</OrderedUnitNetPrice>
</Line-Item>
</Line>
<Line>
<Line-Item>
<LineNumber>2</LineNumber>
<EAN>5903355000002</EAN>
<BuyerItemCode>8004002</BuyerItemCode>
<ItemDescription>Prekė 2</ItemDescription>
<OrderedQuantity>4.000</OrderedQuantity>
<OrderedUnitPacksize>1.000</OrderedUnitPacksize>
<UnitOfMeasure>vnt.</UnitOfMeasure>
<OrderedUnitNetPrice>0.0000</OrderedUnitNetPrice>
</Line-Item>
</Line>
<Line>
<Line-Item>
<LineNumber>3</LineNumber>
<EAN>5903355000003</EAN>
<BuyerItemCode>8004003</BuyerItemCode>
<ItemDescription>Prekė 3</ItemDescription>
<OrderedQuantity>2.000</OrderedQuantity>
<OrderedUnitPacksize>1.000</OrderedUnitPacksize>
<UnitOfMeasure>vnt.</UnitOfMeasure>
<OrderedUnitNetPrice>0.0000</OrderedUnitNetPrice>
</Line-Item>
</Line>
<Line>
<Line-Item>
<LineNumber>4</LineNumber>
<EAN>5903355000004</EAN>
<BuyerItemCode>8004004</BuyerItemCode>
<ItemDescription>Prekė 4</ItemDescription>
<OrderedQuantity>12.000</OrderedQuantity>
<OrderedUnitPacksize>1.000</OrderedUnitPacksize>
<UnitOfMeasure>vnt.</UnitOfMeasure>
<OrderedUnitNetPrice>0.0000</OrderedUnitNetPrice>
</Line-Item>
</Line>
</Order-Lines>
<Order-Summary>
<TotalLines>4</TotalLines>
<TotalOrderedAmount>118.0000</TotalOrderedAmount>
<TotalNetAmount>0.0000</TotalNetAmount>
</Order-Summary>
</Document-Order>]]></ns1:Cnt>
            </ns1:ReceiveResult>
        </ReceiveResponse>
    </soapenv:Body>
</soapenv:Envelope>

3. Komanda ‘ChangeDocumentStatus’

Komanda ‘ChangeDocumentStatus’ leidžia pakeisti dokumento statusą iš ‘New’ į ‘Read’. Atlikus statuso pakeitimą, sekantį kartą naudojant komandą ‘ListMBAll’ nebegausite jau atsisiųstų dokumentų. ‘ChangeDocumentStatus’ užklausoje reikia perduoti lentelėje aprašytus parametrus:

Parametras	Aprašymas	Privalomas
Name	Prisijungimo vardas	Taip
Password	Slaptažodis	Taip
TrackingId	Dokumento numeris EDI platformoje	Taip
Status	Naujas dokumento statusas	Taip

Užklausos pavyzdys naudojant komandą ‘ChangeDocumentStatus’

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:wsedi">
    <soapenv:Header/>
    <soapenv:Body>
        <urn:ChangeDocumentStatus>
            <urn:Name>SomeName</urn:Name>
            <urn:Password>SomePassword</urn:Password>
            <urn:TrackingId>14768804</urn:TrackingId>
            <urn:Status>R</urn:Status>
        </urn:ChangeDocumentStatus>
    </soapenv:Body>
</soapenv:Envelope>

Įvykdžius komandą ‘ChangeDocumentStatus’, „Edisoft“ sistemoje pakeičiamas dokumento statusas ir atsiunčiamas atsakymas apie rezultatą. Atsakyme bus pateikti sekantys laukai:

Laukas	Aprašymas
<tracking-id>	Dokumento numeris EDI platformoje
<new-document-status>	Atnaujintas dokumento statusas

Atsakymo pavyzdys naudojant komandą ‘ChangeDocumentStatus’

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <soapenv:Body>
        <ChangeDocumentStatusResponse xmlns="urn:wsedi">
            <ns1:ChangeDocumentStatusResult xmlns:ns1="urn:wsedi">
                <ns1:Res>00000000</ns1:Res>
                <ns1:Cnt><![CDATA[<change-status-response>
    <tracking-id>14768804</tracking-id>
    <new-document-status>14768804</new-document-status>
</change-status-response>]]></ns1:Cnt>
            </ns1:ChangeDocumentStatusResult>
        </ChangeDocumentStatusResponse>
    </soapenv:Body>
</soapenv:Envelope>

13/02/2023