Gateway ver. 3.4 Popis služeb

Gateway ver. 3.4 Popis služeb

Důvěrné – pouze pro partnery ABC Data s.r.o.

1/67

Obsah Cíl ............................................................................................................................................................4 Výhody ....................................................................................................................................................4 Architektura ............................................................................................................................................4 Způsoby volání WebServices (služeb) ...............................................................................................................4 Implementace dané služby .................................................................................................................................6 Přenos dat s kompresí........................................................................................................................................6

Typy dokladů ..........................................................................................................................................7 Šablony dokladů .................................................................................................................................................7 Kompatibilita dokladů .........................................................................................................................................7

Původ transakce – SystemId .................................................................................................................8 Služba Order (objednávka) ....................................................................................................................8 Stažení dat objednávky v XML ...........................................................................................................................8 Modifikace objednávek podávaných přes A-Partner ........................................................................................12 Služba OrderCreate (příjem objednávek XML) ................................................................................................12 Algoritmus přijetí objednávky............................................................................................................................16 Diagnostika a zpracování informací Gateway Order ........................................................................................16

Služba OrderProcessing (realizace objednávek) ...............................................................................18 Zprávy v XML pro objednávky platformy A-Partner ...........................................................................21 Služba Invoice (faktura) .......................................................................................................................22 Stažení faktury ve formátu XML .......................................................................................................................22 Stažení obrazu faktury v PDF...........................................................................................................................25 Stažení elektronické faktury .............................................................................................................................26 Stažení obrazu elektronické faktury – PDF Vizualizace ...................................................................................29 Stažení seznamu faktur ....................................................................................................................................31

Služba InvoiceEU (faktura End User) ..................................................................................................32 Služba SerialNumbers (sériová čísla produktů) .................................................................................35 Služba PriceList(produkty,značky,typy,hierarchie,slovníky) ............................................................37 Stažení údajů o produktech (GetProducts) ......................................................................................................37 Stažení dostupnosti skladu (GetProductsList) .................................................................................................41 Stažení slovníkových dat pro značky, typy a výrobce (GetPriceListDictionaries) ............................................42 Stažení ceníkové hierarchie (GetPriceListHierarchy) ......................................................................................43 Stažení kódů produktů (GetProductsCodes)....................................................................................................44 Stažení popisu produktu (GetProductDescription) ...........................................................................................45 Stažení dostupnosti produktů rozdělených podle skladů (GetStockDataByRegion) .......................................48 Stažení hierarchie podle vlastností (GetPriceListHierarchyByAttribs) .............................................................49 Stažení seznamu modifikovaných produktů (GetProductsModified) ...............................................................50

Služba Delivery .....................................................................................................................................53 Služba Resources ................................................................................................................................55 Stažení údajů o produktech ..............................................................................................................................55 Stažení zdroje ...................................................................................................................................................56

Služba Client .........................................................................................................................................58 Gateway Messanger (GM) – zprávy .....................................................................................................59 Příjem zprávy z klientského systému ...............................................................................................................59 Parametr ContextReference .............................................................................................................................59 Příjem zprávy přes systém Gateway ................................................................................................................60 Gateway Message ............................................................................................................................................60 Gateway Ping ...................................................................................................................................................61 2/67 Důvěrné – pouze pro partnery ABC Data s.r.o.

Potvrzení o přijetí žádosti k tvorbě objednávky ................................................................................................61 Potvrzení o přijetí žádosti k tvorbě objednávky ................................................................................................62

Informace o chybách ............................................................................................................................63 Chyba „ServiceNotSupported“..........................................................................................................................64

Bezpečnost ...........................................................................................................................................65 Adresy služeb .......................................................................................................................................66 Šablony dokladů a vzorové doklady .................................................................................................................66

Algoritmy stažení dokladů ...................................................................................................................67 Stažení dokladů faktur ......................................................................................................................................67 Stažení dokladů objednávek ............................................................................................................................67


3/67

Cíl ABC Data s.r.o. nabízí službu pro své partnery - GATEWAY ve verzi 3.4 která řeší integraci jejich systémů se systémovou platformou ABC Data s.r.o.. Ta obsahuje zejména moduly A-SHOP, INTRALINK a A-PARTNER. ■ ■ ■

A-SHOP INTRALINK A-PARTNER

- obchodní portál k předávání informací mezi dealerem a ABC Data s.r.o. - interní, obchodně-informační systém ABC Data s.r.o. - je zpřístupněn dealerovi pro obsluhu jeho zákazníků

Z toho vyplývá, že datová transakce může vycházet z různých systémů. GATEWAY je jednotné rozhranní ABC Data s.r.o. pro integraci se svým obchodním partnerem - dealerem a umožňuje stažení různých dat nezávisle na tom, ze kterého systému pochází daná transakce.

Výhody GATEWAY pomůže dealerům rozšířit a zvýšit kvalitu služeb a zautomatizovat oběh dokladů mezi vlastním systémem a systémem ABC Data s.r.o.. Automatická výměna dokladů šetří čas, zrychluje realizaci objednávek, vystavování faktur a především minimalizuje riziko chyb ručního přepisování dat.

Architektura GATEWAY je postavena na moderní architektuře WebServices tj. síťové služby přes Internet. Posílané elektronické dokumenty jsou v jazyce XML, který je pro tato řešení standardem.

Způsoby volání WebServices (služeb) Služby je možné vyvolat třemi různými způsoby podle konkrétní implementace dané služby. Mohou být implementovány služby, které lze volat pouze jedním způsobem. Možné způsoby volání jsou vždy uvedeny u popisu služby. Volání mohou být následující: ■ ■ ■

HTTP GET HTTP POST HTTP SOAP

První dvě volání používají standardní protokol HTTP (způsob GET a POST) HTTP GET posílá parametry v adrese URL. Délka požadavku je omezená na 2000 znaků. Je to nejjednodušší způsob vyvolání, použitelný např. pro otestování služby. HTTP POST neomezuje velikost posílaných dat a parametry vyvolání jsou předávány uvnitř volání HTTP (body). HTTP SOAP je nejvhodnější pro volání služeb; protokol SOAP byl vytvořen speciálně pro výměnu dat mezi službami. Dnešní programátorské nástroje umožňují snadnou integraci dané služby s protokolem SOAP (Microsoft.Net, IBM SOAP Toolkit atd.) V reálném provozu by měla být služba volána programem partnera/dealera, který iniciuje komunikaci se službou a vyměňuje potřebná data. Služba může být volána i z úrovně internetového prohlížeče. Volání dané služby bez parametrů zobrazí stránky s technickou dokumentací on-line. Dokumentace obsahuje seznam metod a způsoby volání. Po kliknutí na zvolenou metodu se zobrazí další dokumentace a je umožněno i provedení testu (pokud to je možné z úrovně prohlížeče, tzn. služba dovoluje volání HTTP GET). Tato možnost je neocenitelná v procesu testování a tvorby aplikace integrující se s danou službou. Vzorová dokumentace je generována automaticky při kliknutí na danou službu z úrovně prohlížeče. Např. pro službu order.asmx:


4/67

Příklady: SOAP 1.1 (příklad použití SOAP 1.1 - požadavek a odezva. Placeholders je třeba nahradit aktuální hodnotou). POST /WS/order.asmx HTTP/1.1 Host: gateway.systemb2b.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://gateway.systemb2b.com/schemas/Order/GetOrder" <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> string HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> xml SOAP 1.2 (příklad použití SOAP 1.2 - požadavek a odezva. Placeholders je třeba nahradit aktuální hodnotou). POST /WS/order.asmx HTTP/1.1 Host: gateway.systemb2b.com Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> string HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> xml Důvěrné – pouze pro partnery ABC Data s.r.o.

5/67

HTTP GET (příklad použití GET - požadavek a odezva. Placeholders je třeba nahradit aktuální hodnotou). GET /WS/order.asmx/GetOrder?OrderId=string HTTP/1.1 Host: gateway.systemb2b.com HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length xml HTTP POST (příklad použití POST - požadavek a odezva. Placeholders je třeba nahradit aktuální hodnotou). POST /WS/order.asmx/GetOrder HTTP/1.1 Host: gateway.systemb2b.com Content-Type: application/x-www-form-urlencoded Content-Length: length OrderId=string HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length xml Odpověď závisí na druhu služby - dokument XML popsaný šablonou XSD. V další části dokumentu jsou popsány vzorové odpovědi jednotlivých služeb a jejich typy.

Implementace dané služby Vrací-li vyvolaná služba chybu : <error> 3 ServiceNotSupported

znamená to, že Vám daná služba/metoda nebyla aktivována. Pro aktivaci služby kontaktujte technickou podporu.

Přenos dat s kompresí Služby je možno volat v módu, ve kterém jsou data posílány v komprimované podobě v souladu se standardem HTTP. Zákazník připravený na zpracování komprimovaných dat by měl poslat v požadavku HTTP hlavičku Accept-Encoding s obsahem gzip nebo deflate. V odpovědi sever vrací komprimovaná data. Tento způsob je doporučován pro služby, které vrací velké soubory.


6/67

Typy dokladů Ve verzi Gateway 2.2 byly implementovány následující služby: ■ ■ ■ ■ ■ ■

ORDER (údaje objednávky) ORDERPROCESSING (realizace objednávek) INVOICE (údaje faktury vystavené ABC Data s.r.o na dealera) INVOICEEU (faktura vystavená ABC Data s.r.o na koncového zákazníka jménem dealera) SERIALNUMBERS (sériová čísla produktů) PRICELIST (informace o produktech a ceníkové hierarchii)

Šablony dokladů Šablona dokladu popisuje strukturu, konkrétních dokladů a umožňuje ověření, je-li daný doklad v souladu s popisem v šabloně. Šablony dokladů jsou definovány pomocí standardu XML-schéma. Šablony jsou popsány v souborech s příponou XSD. Odkazy ke konkrétním šablonám najdete v: Šablony dokladů a vzorové doklady.

Kompatibilita dokladů Při tvorbě aplikace pro zpracování souboru XML je třeba pamatovat, že systém je pořád vyvíjen a že se mohou uvnitř souboru objevit nové informace (nová pole). Při rozšiřování dokladu se snažíme neměnit cesty XPATH již existujících polí. Dodatečná pole se mohou objevit v už existujících sekcích.


7/67

Původ transakce – SystemId Původem transakce je objednávka, která může pocházet z různých systémů, a proto hodně dokladů obsahuje pole |SystemId|, na základě kterého je možné tento systém ověřit. SystemId nabývá následujících hodnot: 0 – A-shop 1 – Intralink (interní systém ABC Data s.r.o) 10 – A-Partner pro koncového zákazníka 11 – A-PartnerAdmin (administrátor na straně dealera) 13 – A-Link 14 – ResellerWEB 16 – Gateway

Služba Order (objednávka) Název služby Lokalizace služby Adresa služby

: Order : order.asmx : https://gateway.systemb2b.com/ws/order.asmx

MOŽNÁ VOLÁNÍ SLUŽBY:

METODY SLUŽBY: ■ ■ ■ ■

■ ■ ■


■

■ ■

GetOrder - Parametry  OrderID [string] – č. objednávky EditBLOrderAccept - Parametry  OrderID [string] – č. objednávky EditBLOrderDelete - Parametry  OrderID [string] – č. objednávky EditBLOrderOwnerDataAssign - Parametry  OrderID [string] - č. objednávky  InvoiceNumber [string] – č. faktury dealera pro zákazníka obsluhovaného přes A-Partner  OwnerNote [string] - poznámka dealera k objednávce  Mode [string] – mód editace (REPLACE - pole v systému je nahrazováno novou hodnotou, CONCAT - k poli v systému je připojována na konci nová hodnota CreateOrder – Parametry  OrderChannel [string] – zpracování objednávek (MAIN)  OrderType [string] – typ objednávky (STANDARD)  ContextReference [string] – parametr nastaven zákazníkem pro pozdější sledování příchozích zpráv z GatewayMessangera (podrobnosti v popisu GatewayMessanger)  OrderData [string] – dokument OrderCreate obsahující údaje potřebné k vytvoření objednávky v systému GetOrderRequest – Parametry  RqId [int] – ID žádosti vracené metodou CreateOrder GetOrderRequestsRange – Parametry  StartDate [string] – počáteční datum rozmezí (yyyy-mm-dd)  EndDate [string] – koncové datum rozmezí (yyyy-mm-dd)

Stažení dat objednávky v XML Služba ORDER umožňuje stažení údajů objednávky ve formátu XML - metodou GetOrder voláním služby ORDER s parametrem čísla objednávky. V odpovědi systém vrací doklad XML popisující danou objednávku v závislosti na druhu objednávky. Systém vrací doklad podle systému, ze kterého objednávka pochází. Jsou možné dva doklady: ORDER – objednávka podaná v systému A-Shop, IntraLink (zadaná obchodníkem ABC Data s.r.o) ORDERBL – objednávka podaná v systému A-Partner, A-PartnerAdmin, ResellerWEB. Důvěrné – pouze pro partnery ABC Data s.r.o.

8/67

Informace o typu objednávky najdete v dokladu XML v poli |DocType|. Objednávky systému A-Partner obsahují více údajů, neboť se týkají tří stran (zákazník – dealer – distributor). Popis polí dokladu Order Pole DocType DocVersion
SystemId SystemName SourcePipe

Typ String String

String String String

OrderId Status

String String

OrderDate

DateTime XML String String

DeliveryPointId DeliveryAddress DeliveryCost CarrierName Currency RefOrderId OrderNote <User> Name <Payment> PaymentForOrder
LineNumber ProductId PartNumber ProductName Qty Price Value LineStatus <Sumary>

String String String String String

String

Integer String String String Integer Decimal Decimal String

Popis Začátek dokladu Sekce informací o dokladu Typ Dokladu [ORDER] Verze [2.0] Konec sekce informací o dokladu Začátek záhlaví Id Systému Název Systému Původ objednávek [ORD obvyklá obj., OFR dotaz, PCE konfigurátor PC-CE/ISO9001, PCC konfigurátor PC] Číslo objednávky Status objednávky [inrealisation – v realizaci,closed - uzavřená,deleted – zrušená] Datum objednávky Id dodací adresy Dodací adresa Je-li hodnota 0, nejsou připočteny dopravní náklady. Dopravní náklady nastavuje systém (tzv. „podlimitní objednávka“) nebo obchodník ABC Data s.r.o. Jméno přepravce Zkratka měny např. CZK Vlastní číslo zákazníka Poznámka zákazníka Začátek sekce o uživateli Jméno uživatele Sekce platby Způsob platby [CashOnDelivery – dobírka, BankTransfer - převod, Cash - hotovost, ProFormInvoice - proforma] Konec sekce platby Konec záhlaví Počet řádků objednávky Začátek řádku s položkou objednávky Číslo řádku Kód produktu podle ABC Data s.r.o. Kód produktu výrobce – P/N Název produktu Počet Cena bez DPH Hodnota bez DPH Status položky [valid - platná, deleted - zrušená] Konec řádku s položkou Konec všech položek Shrnutí [běžně prázdné] Konec objednávky

Vzorová odpověď služby ORDER (XML dokument popisující testovací objednávku) pro objednávku ORDER ORDER 2.0
<SystemId>1 <SystemName>InterLink <SourcePipe>ORD 7777777 <Status>Closed 2007-04-04T09:50:05.2700000+02:00 Warszawa, ul. 1 Maja 100 0


9/67

PLN Z12/2007 <User> Janusz Kowalski <Payment> <PaymentForOrder>BankTransfer
1 C0120071 <PartNumber>02802 1 214.6500 214.6500 Valid 2 C9720125 <PartNumber>CD-R80CBA100-B 1 152.9500 152.9500 Valid <Summary />

Popis polí dokladu ORDERBL Pole Typ DocType DocVersion
SystemId SystemName SourcePipe

String String


OrderId Status

String String

OrderDate DeliveryPointId DeliveryAddress InvoiceDeliveryPointId

DateTime String String String

InvoiceDeliveryAddress DeliveryCost

String Decimal

BLClientDeliveryCost

Decimal

CarrierName Currency RefOrderId OrderNote OwnerNote ClientId Name

String String String String String String String


Popis Začátek dokladu Sekce informací o dokladu Typ Dokladu [ORDERBL] Verze [2.0] Konec sekce informací o dokladu Začátek záhlaví Id Systému Název Systému Původ objednávek [ORD obvyklá obj.,OFR dotaz,PCE konfigurátor CE, PCC konfigurátor PC] Číslo objednávky Status objednávky [inrealisation – v realizaci, closed - uzavřená, deleted – zrušená] Datum objednávky Id dodací adresy Dodací adresa ID bodu doručovací faktury [hodnota XXX – znamená dohodu s prodejcem, XXY – místo kde je zboží], další hodnoty slouží pro konkretní adresu zákazníka Doručovací adresa faktury Je-li hodnota 0, nejsou připočteny dopravní náklady. Dopravní náklady nastavuje systém (tzv. „podlimitní objednávka“) nebo obchodník ABC Data Dopravní náklady připočítané systémem A-Partner (hodnota dealerem nastavené dopravy bez DPH) Jméno přepravce Zkrátka měny např. CZK Vlastní číslo zákazníka Poznámka zákazníka Poznámka dealera Začátek sekce zákazníka Identifikátor zákazníka v systému A-Partner Jméno zákazníka Konec sekce zákazníka

10/67

<User> Name Email <Partner>

String String

PartnerId PartnerParameter <Payment> PaymentForOrder

String String

BLClientPaymentForOrder

String

LineNumber ProductId PartNumber ProductName Qty Price BLClientPrice

Value BLClientValue

LineStatus <Sumary>

String

String String String String Integer Decimal Decimal Decimal Decimal String

Začátek sekce o uživateli Jméno uživatele Email Konec sekce uživatele Začátek sekce programu partner. Většinou se používají v online obchodech k obsluze partnerských programů. ID partnera programu partner. Parametr programu partner. Konec sekce programu partner Sekce platby Způsob platby [CashOnDelivery – dobírka, BankTransfer - převod, Cash - hotovost, ProFormInvoice - proforma] Způsob platby klienta A-Partner [CashOnDelivery - dobírka, CreditCard – kreditní karta, BankTransfer - převod, Unknown – žádné informace, dohoda dealera se zákazníkem] Konec sekce platby Konec záhlaví Začátek položky objednávky Začátek dané položky Číslo položky Kód produktu podle ABC Data s.r.o. Kód produktu výrobce P/N Název produktu Počet Cena bez DPH Cena bez DPH pro zákazníka Hodnota bez DPH Hodnota bez DPH objednávky pro zákazníka Status položky [valid - platná, deleted - zrušená] Konec položky Konec všech položek Shrnutí [běžně prázdné] Konec objednávky

Vzorová odpověď služby ORDER (XML dokument popisující testovací objednávku) pro objednávku ORDERBL ORDERBL 2.0
<SystemId>10 <SystemName>BiznesLink <SourcePipe>ORD 7777777 <Status>Closed 2007-04-03T14:00:00.1630000+02:00 000 Kopa, ul. Władysława IV 0 0.0000 Stolica PLN 200704034151966 V00000 Klik s.c. <User> Adam Kac <Email>[email protected] <Payment> <PaymentForOrder>BankTransfer


11/67

Unknown
5 C0125818 <PartNumber>F3U133b06 10 3.4700 3.4100 34.7000 34.1000 Valid <Summary />

Z příkladu vyplývá, že doklad ORDERBL obsahuje více informací, a společné informace jsou v stejných polích.

Modifikace objednávek podávaných přes A-Partner Pro lepší integraci systém umožňuje následující vzdálené akce: ■ potvrzení objednávky – metoda EditBLOrderAccept ■ odmítnutí objednávky – metoda EditBLOrderDelete ■ změna dat (poznámka pro zákazníka, č. faktury vystavené pro zákazníka) – metoda EditBLOrderOwnerDataAsign

Služba OrderCreate (příjem objednávek XML) Služba umožňuje přijetí objednávky ve formátu XML. Poslána objednávka je zpracovávána přes systém. V odpovědí na přednastavenou adresu služby na straně zákazníka (endpoint), zákazník obdrží zprávu poslánou přes GatewayMessanger o faktu vytvoření objednávky a jejím čísle. Schéma dokumentu: https://gateway.systemb2b.com/Schemas/OrderCreate.xsd Ukázka dokumentu: https://gateway.systemb2b.com/Schemas/OrderCreate.xml Vzhledem k počtu polí v dokumentu jsou vypsáné databázové typy omezující velikost políček a možnosti použítí národních znaků. Jedná se o typy pro MS SQL Server. Typ MSSQL varchar nvarchar

Typ ISO character varying national character varying - unicode

Sloupec R v tabulce označuje povinnost vypolňování polí:  M – mandatory (nutno vyplnit),  O – optional (volitelné)  O/M - optional to mandatory (pole volitelné se stané povinným v závisloti od hodnot jiných polí) Povinnost polí nebo sekcí popisuje XSD dokument. Pole DocType DocVersion
Mode CurrencyId

Typ XSD

Typ DB

R

String String

N/A N/A

M M

String String

varchar(20) varchar(3)

M M


Popis Začátek dokladu Sekce informací o dokladu Typ Dokladu [ORDERCREATE] Verze [1.0] Konec sekce informací o dokladu Začátek sekce záhlaví [PRODUCTION, TEST] Zkratka měny např. CZK

12/67

DeliveryType

String

varchar(20)

M

1. DELIVERYPOINT dodácí adresy definované v systému (čísla NNN např. 000, 001, AEP)Číslo bodu musí být zapsáno v políčku DeliveryPoint 2. ALTERNATE – adresa vyplněná v sekci AlternateDeliveryAddre ss 3. SELFPICK – osobní odběr R0 – Varšava; R1 Sosnovec 4. AGREEDAFTER – k újednání s obchodníkem v procesu realizace

Definované dodácí adresy vrací služba Client popsána v dokumentu. DeliveryPoint

String

varchar(3)

M

DeliveryDocuments

String

varchar(3)

M

ReferenceNumber

String

nvarchar(20)

O

RealisationDate

DateTime XML String

N/A

M

nvarchar(200)

O

Name Phone Email Notice

String String String String

varchar(50) varchar(150) nvarchar(256) nvarchar(512)

O O O O

DeliveryLetterNotice

String

nvarchar(70)

O

OrderNotice


1. Dodací adresa (např. 000, 001, AEP..) pro DeliveryType=DELIVERYP OINT 2. Vlastní dodací adresa pro DeliveryType=SELFPICK R0 – Varšava R1 - Sosnovec 3. Pro DeliveryType= AGREEDAFTER hodnota prázdná 4. Pro DeliveryType= ALTERNATE hodnota prázdná Adresa pro zasílání dokumentů (XXX újednáno s obchodníkem, XXY společně se zbožím, NNN – konkretní dodácí adresa, definováná v systému) Reference k objednávce podle zákazníka 20 znaků. Vlastní číslo objednávky. Vyžadované datum realizace Komentáře k objednávce Sekce kontaktních údajů k objednávce Název Telefon Mail Komentář kontaktu Konec sekce kontaktních údajů k objednávce Poznámky připojené k dodacímu listu Sekce alternativního adresu. Alternativní adresa má využití, když zásilka je na jiný adres, který není definován v systému

13/67

Name Address City PostCode Country Email

String String String String String String

nvarchar(115) nvarchar(35) nvarchar(25) nvarchar(12) varchar(35) varchar(256)

O/M O/M O/M O/M O O

Název příjemce Adres Město PSČ Země Kontaktní mail

Phone Notice <PartnerData>

String String

nvarchar(35) nvarchar(25)

O O

Name TaxId ContactName Address City PostCode Country Email Phone ContractNumber <Parameters>

String String String String String String String String String

nvarchar(115) varchar(20) nvarchar(115) nvarchar(35) nvarchar(25) varchar(12) nvarchar(35) varchar(256) varchar(35)

O O O O O O O O O

String

nvarchar(256)

O

String String

varchar(50) nvarchar(2048)

O O

ProductId Qty Price

String Int Decimal

varchar(15)

N/A N/A

M M O

ContractNumber LineReference

String String

nvarchar(256) nvarchar(50)

O O

String String


O O

AttachmentType AttachmentName AttachmentReference


varchar(50) nvarchar(255) nvarchar(50)

O O O

AttachmentFormat

String

varchar(50)

O

Kontaktní telefon Krátka poznámka Konec sekce alternativní adresy Sekce údajů koncového zákazníka. Název firmy Daňový identifikátor (DIČ) Kontaktní osoba Adres Město PSČ Země Kontaktní mail Kontaktní telefon Konec sekce Informace o smlouvě Sekce parametrů souvisejících se zpracováním Sekce jednoho parametru Název parametru Hodnota parametru Konec sekce jednoho parametru Konec sekce parametrů souvisejících se zpracováním Konec sekce záhlaví Sekce pozice v objednávce Sekce jednotlivého řádku objednávky Číslo produktu Počet kusů Cena – pro speciální objednávky, standartně systém dopočítá cenu dle zákazníka v průběhu zpracování objednávky Číslo smlouvy Referenční číslo (doplněné zákazníkem) Sekce parametrů produktů souvisejících se zpracováním Sekce jednoho parametru produktu Název parametru Hodnota parametru Konec sekce jednoho parametru produktu Konec sekce parametrů souvisejících se zpracováním produktu Konec sekce jednotlivého řádku objednávky Konec sekce pozice v objednávce Sekce příloh - pro zvláštní obchodní procesy. Sekce jednotlivé přílohy Typ přílohy Nazva souboru – přílohy Referenční číslo zadané zákazníkem Format přílohy

<Parameter> Name Value

<Parameters> <Parameter> Name Value


14/67

AttachmentBody <Parameters>

String

nvarchar(max)

O

String String


O O

<Parameter> Name Value

Příloha zakodována v Base 64 Sekce tykající se zpracování parametrů přílohy Sekce jednotlivého parametru přílohy Název parametru Hodnota parametru Konec sekce jednotlivého parametru přílohy Konec sekce tykající se zpracování parametrů přílohy Konec sekce jednotlivé přílohy Konec sekce příloh Konec dokumentu

Ukázka dokumentu objednávky (s minimem údajů) ORDERCREATE 1.0
<Mode>TEST PLN DELIVERYPOINT 000 XXY 2011-12-12T00:00:00.0 <Email />
<Email /> <PartnerData>
<Email /> <Parameters />
C3900899 3 <Parameters /> C4310258 2


15/67

<Parameters />

Algoritmus přijetí objednávky 1. Zákazník pošle žádost (metodou OrderCreate). 2. Systém zkontorluje žádost a odpoví prostřednictvím dokumentu GatewayResult nebo Gatewayerrors. V tomto kroku se kontoluje správnost struktury žádosti a základní logistické chyby (např.: špatná produkt, špatná dodácí adresa atd.). 3. System prostřednictvím GatewayMessanger pošle na předem definovanou adresu zprávu o přijetí žádosti (MessageType = ORDER.REQUEST.CONFIRMATION). 4. Systém zpracovává žádost. 5. System prostřednictvím GatewayMessanger pošle na předem definovanou adresu zprávu o stvoření objednávky v našém systému (MessageType = ORDER.CREATE.CONFIRMATION). 6. Zákazník si načte informace o objednávce (metoda GetOrder) a nebo sleduje stav v systému ECommerce.

Diagnostika a zpracování informací Gateway Order Informace o zpracovávání žádosti můžete obdržet jedním z následujících způsobů: 1. Skrze čtení zpráv GatewayMessanger – nejrychlejší způsob. 2. Skrze diagnostické metody GetOrderRequestsRange, GetOrderRequest – dodržte minimální interval 5 minut od podání žádosti na stvoření objednávky a úspěšné zprocesování 3. Skrze manuální kontrolu v systému A-Shop Služba GetOrderRequestsRange umožnuje stáhnout prvních tisíc žádosti v uvedeném časovém období. Služba GetOrderRequest navíc umožňuje zobrazit náhled obdrženého XML požadavku, odpovědi nebo obsahu vyjímky. Pole DocType DocVersion
ProcessingDate
Type

Typ String String

DateTime XML String

StartDate

DateTime XML

EndDate

DateTime XML

RqId

Int

OrderChannel OrderType ContextReference RequestDate ReferenceNumber RqId ResultType ProcessingStatus OrderId OrderProcessDate

String String String DateTime XML String Int String String String DateTime XML


Popis Začátek dokladu Sekce informací o dokladu Typ Dokladu [ORDERPROCESSING] Verze [2.0] Konec sekce informací o dokladu Začátek záhlaví Datum zpracování objednávek Konec záhlaví Druh výsledku: ORDERREQUESTSRANGE- seznam požadavků ORDERREQUEST- podrobnosti jednoho požadavku Parametr pro ORDERREQUESTSRANGE: Počáteční datum Parametr pro ORDERREQUESTSRANGE: Koncové datum Parametr pro ORDERREQUEST: Číslo žádosti Konec sekce záhlaví Začátek sekce žádostí Začátek sekce jednotlivá žádost Parametr volání metody Webové služby Parametr volání metody Webové služby Parametr volání metody Webové služby Datum a čas podání žádosti Číslo objednávky z dokumentu XML Číslo žádosti Zobrazený výsledek v čase volání metody Status zpracování objednávky Číslo objednávky Datum a čas vytvoření objednávky

16/67

OrderData

String

ResultBody

String

Výsledný XML žádosti (jako CDATA) – pole dostupné pro Type = ORDERREQUEST Vracený výsledek žádosti (XML jako CDATA) – pole dostupné pouze pro Type=ORDERREQUEST Konec sekce jednotlivá žádost Konec sekce žádostí Konec dokladu

Ukázka dokumentu GetOrderRequestsRange: ORDERREQUESTS 1.0
ORDERREQUESTSRANGE <StartDate>2014-02-01T00:00:00.0000000+01:00 <EndDate>2014-03-01T00:00:00.0000000+01:00
MAIN STANDARD ESD 2014-02-07T15:18:53.0000000+01:00 4/300/2013 138379 OK Completed BY58860 2014-02-07T15:19:15.0000000+01:00 MAIN STANDARD ESD 2014-02-07T15:21:44.0000000+01:00 4/300/2013 138381 ERROR DocumentFailed

Ukázka dokumentu GetOrderRequest: ORDERREQUESTS 1.0
ORDERREQUEST 17289
MAIN STANDARD 201207030933 2012-07-03T09:33:34.0000000+02:00 20111115154705 17289 ERROR


17/67

DocumentFailed ORDERCREATE 1.0
<Mode>TEST PLN SELFPICK R0 XXY 20111115154705 2011-12-01T00:00:00.0 Name +48 22 123 45 67 <Email>[email protected] Notatka 4p, budynek C
<Email /> <PartnerData>
<Email /> <Parameters> <Parameter> Custom ID 21
C3900899 1 <Parameters> <Parameter> ForceStock MR C4310258 1 <Parameters> <Parameter> ForceStock MR C6301668 1 <Parameters> <Parameter> ForceStock MR C6501494 1 <Parameters> <Parameter> ForceStock MR C6503227 1 <Parameters> <Parameter> ForceStock MR C6503234 1 <Parameters> <Parameter> ForceStock MR C7630166 1 <Parameters> <Parameter> ForceStock MR C9800380 1 <Parameters> <Parameter> ForceStock MR ]]> <error>100<error>100]]>

Služba OrderProcessing (realizace objednávek) Název služby Lokalizace služby Adresa služby

: OrderProcessing : orderprocessing.asmx : https://gateway.systemb2b.com/ws/orderprocessing.asmx


METODY SLUŽBY: ■

■ ■ ■


GetOrderProcessingInDay – Parametry  ProcessingDay [string] – datum (yyyy-mm-dd)  OrderSystemTypes [string] – systémy (ALL – objednávky ze všech systémů platformy A-Shop/A-Partner; ONLYBL objednávky pouze z platformy A-partner)

Služba OrderProcessing umožňuje stažení údajů ve formátu XML o zrealizovaných (částečně nebo plně) objednávkách daného dne. Pro stažení údajů je třeba vyvolat metodu GetOrderProcessingInDay služby orderprocessing.asmx s parametrem data dne a systémů, od kterých chceme údaje stáhnout. Pole DocType DocVersion

Typ

Popis

String String

Začátek dokladu Sekce informací o dokladu Typ Dokladu [ORDERPROCESSING] Verze [2.0] Konec sekce informací o dokladu Začátek záhlaví


18/67

ProcessingDate
OrderId SystemId InvoiceId EUInvoiceId

DateTime XML

OrderStatus

String


Datum zpracování objednávek Konec záhlaví Začátek sekce zpracovaných dokladů Začátek dané položky Číslo objednávky Id Systému Číslo faktury Číslo faktury vystavené dealerem na koncového zákazníka Status objednávky [Realisation – stále v realizaci, Closed - uzavřená] Konec sekce zpracovaných dokladů Konec všech položek Konec dokladu

Vzorová odpověď služby OrderProcessing (XML dokument popisující seznam realizovaných objednávek a vystavených faktur) ORDERPROCESSING 2.0
2007-04-03T00:00:00.0000000+02:00

Metoda GetOrderLinesOpen služby orderprocessing.asmx umožňuje získat informace ohledně otevřených objednávkách. R0 – Varšava R1 – Sosnovec Pole DocType DocVersion
LangId Mode ModeParameter
OrderId Date Ordered Allocated Send Outstanding Picked Carrier PID LineNumber RegionId

Typ String String


String DateTime XML Integer Integer Integer Integer Integer String String Integer String


Popis Začátek dokladu Sekce informací o dokladu Typ Dokladu [ORDERSOPENLINES] Verze [2.1] Konec sekce informací o dokladu Začátek záhlaví Jazyková zkratka [PL,EN,CS,SK] Režim [ORDER] Parametr [ALL,Číslo_objednávky] Konec záhlaví Začátek sekce pozice objednávek Začátek dané pozice Číslo objednávky Datum objednávky Objednaných kusů Alokovaných kusů Poslaných Neposlaných Hotových k odeslání Kód přepravce Kód produktu Číslo pozice v objednávce Kraj Konec sekce pozice

19/67

Konec sekce pozice objednávek Konec dokladu

Vzorová odpověď (doklad popisující seznam objednávek v realizaci) ORDERSOPENLINES 2.1
PL <Mode>ORDER <ModeParameter>ALL


Ordered="1" Ordered="1" Ordered="1" Ordered="1" Ordered="1" Ordered="1" Ordered="1" Ordered="1"

20/67

Zprávy v XML pro objednávky platformy A-Partner Protože objednávky platformy A-Partner jsou zadávány asynchronně (systém dealera nemá informaci, „kdy“ a „že“ zákazník objednávku v A-Partneru zadal), je systém vybaven modulem automatických zpráv. Pro integraci systémů partnerů s A-Partnerem a zjednodušení procesu stažení dat objednávek posílá A-Partner (pokud je tak nastaven) na uvedenou emailovou schránku zprávu o zadání objednávky ve formátu XML. Konfigurace zpráv najdete v modulu nastavení systému A-PartnerAdmin. Zpráva, kromě čísla objednávky, obsahuje dodatečné informace (např. jméno zákazníka, zda požaduje objednávka potvrzení atd.). Daná zpráva může být následně zpracována systémem dealera, tzn. přijetí čísla objednávky a volání služby ORDER pro stažení dat transakce. Soubor XML kromě čísla objednávky obsahuje také data doplňující např. jméno zákazníka, zda požaduje objednávka potvrzení atd. Pole OrderId AcceptRequired OrderDate ClientId Name <User> Name

Typ String String DateTime XML

String String

String

Popis Začátek dokladu Sekce informací o objednávce Číslo objednávky Je-li požadováno potvrzení [1-ano, 0-ne] Datum objednávky Konec sekce informací o objednávce Sekce informací o zákazníkovi Identifikátor zákazníka v A-Partneru Jméno zákazníka Konec sekce informací o zákazníkovi Začátek sekce o uživateli Jméno uživatele Konec sekce o uživateli Konec dokladu

Vzorová zpráva XML 4150345 1 2007-03-30 16:10:37 10 ABC DATA Sp. z o. o. <User> test user


21/67

Služba Invoice (faktura) Název služby Lokalizace služby Adresa služby

: Invoice : invoice.asmx : https://gateway.systemb2b.com/ws/invoice.asmx


METODY SLUŽBY: ■ ■

■ ■ ■


■ ■ ■

GetInvoice – Parametry  InvoiceID [string] – č. faktury GetInvoicePDF – Parametry  InvoiceID [string] – č. faktury  PrintType [string] – typ výtisku Možné hodnoty:  ORYGINAL (originál);  COPY (kopie) GetElectronicInvoice – Parametry  InvoiceID [string] – č. faktury GetElectronicInvoiceVisualization – Parametry  InvoiceID [string] – č. faktury GetInvoiceRange – Parametry  StartDate [string] – počáteční datum rozmezí (yyyy-mm-dd)  EndDate [string] – koncové datum rozmezí (yyyy-mm-dd)

Služba Invoice umožňuje stažení údajů faktury ve formátu XML, obrazu PDF faktury v rozmezí dat, kdy byly faktury vystaveny.

Stažení faktury ve formátu XML Pro stažení údajů XML faktury je třeba volat metodu GetInvoice služby Invoice s parametrem čísla faktury. V odpovědi systém vrací XML dokument popisující danou fakturu. Vrácený doklad může mít různé podoby v závislosti na nastavení: 1. Doklad obsahující strukturalizované údaje faktury v případě, že není podepsaná dohoda o výměně elektronických faktur nebo faktura byla vystavena v papírové podobě. Nemá právní moc. (DocType=INVOICEDATA) 2. Doklad obsahující strukturalizované údaje faktury v případě, že je podepsaná dohoda o výměně elektronických faktur a služba je v testovacím řízení. Faktura byla vystavena v papírové podobě, ale technická infrastruktura je přípravená k vystavování elektronických faktur. Nemá právní moc. (DocType=ELECTRONICINVOICE-TEST) 3. Právní doklad Elektronická Faktura v případě, že je podepsaná dohoda o výměně elektronických faktur a služba je v pracovním řízení. Papírová faktura neexistuje. (DocType=ELECTRONICINVOICE) Popis polí dokladu vraceného díky metodě GetInvoice Pole Typ Popis DocType DocVersion
DocName InvoiceId InvoiceDate SystemId OrderId

String String

String String DateTime XML String String


Začátek dokladu Sekce informací o dokladu Typ Dokladu [INVOICEDATA, EINVOICE, EINVOICETEST] Verze [2.0] Konec sekce informací o dokladu Začátek záhlaví Název dokladu [Faktura DPH] Číslo faktury Datum vystavení faktury Id Systému Číslo objednávky

22/67

ClientOrderId

String

DueDate BankAccountNumberToPay DocumentType EndUserInvoiceId

DateTime XML String String String

Currency ElectronicFlag <Seller> Name Address PostalCode City TaxId RecyclingId WEEECODE Name Address PostalCode City TaxId <ShipTo> DeliveryPointId Name Address PostalCode City TaxId Notice
ProductId PartNumber ProductName ProductType

String String

Qty Price Value VatRate VatValue ValueWithVat OrderLineNumber ParentOrderLineNumber

Integer Decimal Decimal String Decimal Decimal Integer Integer

WarrantyInformation Notice <Summary> TotalNetValue TotalChargesValue TotalVatValue RoundValue TotalInvoiceValue ToPay BaseCurrencyId

String




String


String

String Decimal Decimal Decimal Decimal Decimal Decimal String


Číslo objednávky zákazníka [pole RefOrderId z objednávky] Datum platby Číslo bankovního účtu pro zaplacení faktury Typ dokladu [IN – faktura, CR - dobropis] Číslo faktury koncového uživatele, pokud byla vystavena měna faktury např. CZK Elektronická faktura (1-ano, 0-ne) Začátek sekce prodejce Jméno prodejce Adresa prodejce PSČ Město DIČ Identifikační kód recyklace odpadů Identifikační kód autorských poplatků Konec sekce prodejce Začátek sekce zákazníka (plátce faktury) Jméno kupujícího Adresa kupujícího PSČ Město DIČ Konec sekce zákazníka Začátek sekce dodací adresy Kód dodací adresy Název odběratele zboží Dodací adresa PSČ Město DIČ Konec sekce dodací adresy Začátek sekce poznámek Poznámka Konec sekce poznámek Konec záhlaví Začátek položky faktury Začátek dané položky Kód produktu podle ABC Data s.r.o. Kód produktu podle výrobce Název produktu Typ produktu [Single – „sám“, Parent – „rodič“, Child - „dítě“] - slouží k definování sestav (bundles) Počet Cena bez DPH Cena bez DPH pro zákazníka Sazba DPH [%] Hodnota DPH Hodnota s DPH Číslo položky objednávky V případě komponenty sestavy (bundle) je to číslo položky objednávky „rodiče“ Informace o záruce Začátek sekce poznámek k položce faktury Poznámka k položce faktury Konec sekce poznámek k položce faktury Konec informací o položce Konec všech položek faktury Začátek sekce shrnutí Hodnota faktury bez DPH Hodnota dodatečných poplatků Součet hodnot DPH Hodnota zaokrouhlení Hodnota faktury celkem Hodnota k zaplacení Začátek sekce informací o DPH Základní měna státu prodejce

23/67

ExchangeRate VatRate NetValue VatValue GrossValue

Decimal Decimal Decimal Decimal Decimal

Kurz pro základní měnu Začátek sekce rozčlenění sazeb DPH Sazba DPH [%] Hodnota bez DPH v dané sazbě Hodnota DPH pro danou sazbu Hodnota s DPH položky s danou sazbou Konec sekce rozčlenění sazeb DPH Konec sekce informací o DPH Konec sekce shrnutí Konec dokladu

Vzorová odpověď služby INVOICE po vyvolání metody GetInvoice (XML doklad popisující testovací fakturu) INVOICEDATA 2.0
Faktura VAT G000000 2007-04-04T00:00:00.0000000+02:00 <SystemId>0 7777777 z/7/000i 2007-05-10T00:00:00.0000000+02:00 IN <EndUserInvoiceId /> PLN <Seller>
<WEEECODE /> Test Spółka z o.o.
ul. Krucza 1
60-111 Warka 123456789 <ShipTo> Test
ul. Bilardowa 13
22-111 Kule Wielkie 123456788
C7800033 <PartNumber>SP0411N Single 1 106.3900 106.3900 22% 23.4100


24/67

129.79580000 2 <ParentOrderLineNumber /> <WarrantyInformation /> <Summary> 106.3900 0.0000 23.4100 106.3900 129.8000 <ExchangeRate /> 22%

Stažení obrazu faktury v PDF Pro stažení obrazu PDF faktury je třeba vyvolat metodu GetInvoicePDF. V odpovědi vrací služba XML soubor s enkódovaným obrazem PDF faktury (formát Base64). Pole DocType DocVersion
InvoiceId InvoiceDate BodyEncoding
Body

Typ String String

String DateTime String String

Popis Začátek dokladu Sekce informací o dokladu Typ Dokladu [INVOICEPDF] Verze [2.0] Konec sekce informací o dokladu Začátek záhlaví Číslo faktury Datum faktury Informace o způsobu kódování souboru PDF [Base64] Konec záhlaví Kódovaný obraz faktury v souboru PDF Konec dokladu

Pro uložení souboru na disku je třeba přečíst pole BODY, dekódovat ho jako tok bajtů a ten uložit na disk. Pole BODY obsahuje PDF soubor zakódovaný metodou BASE64. INVOICEPDF 2.0
G000000 2007-04-04T00:00:00.0000000+02:00 Base64
JVBERi0xLjQKJfv8/f4KMiAwIG9iago8PAovQ3JlYXRpb25EYXRlIDw0NDNhMzIzMDMwMzczMDM0M zAzNDMxMzYzMzM3MzSFDAAsdasdasdasdasdasdasdUzNj4KL0tleXdvcmRzIDxmZWZmPgovQXV0aG9yIDw+Ci9Ua XRsZSA8PgovQ3JlYXRvciA8PgovU3ViamVjdCA8PgovTW9kRGF0ZSA8NDQzYTMyMzAzMDM3MzAzNDMwMzQzMTM 2MzMzNzasdasasFasfASFaSFaM1MzY+


25/67

Stažení elektronické faktury Elektronické faktury mohou stahovat partneři, kteří podepsali smlouvu o přeposílání elektronických faktur. Pro stažení XML údajů faktury je třeba vyvolat metodu GetInvoice služby Invoice s parametrem čísla faktury. Systém vrátí XML doklad. V případě, že služba elektronického fakturování je spuštěná, DocType přijme hodnotu ELECTRONICINVOICETEST pro testovací řízení a hodnotu ELECTRONICINVOICE pro pracovní řízení. V případě, že partner nemá zapojenou službu elektronických faktur, vrácený doklad je označený v políčku DocType jako INVOICEDATA. Stejně tak v případě, že faktura byla vystavená v papírové podobě. XML údaje s hodnotou EINVOICE by měly být uloženy v archívu faktur partnera po období určené zákonem. V případě, že smlouva o výměně elektronikých faktur není podepsaná, je třeba na to pamatovat a ihned ukládat veškeré údaje vrácené službou ve složkách vlastní sítě. Takový postup dovolí přejít na elektronickou fakturu bez nutnosti modifikace integrujících programů. Prostě po podepsání smlouvy a zapojení služby Elektronikých Faktur se ukládáné soubory stanou elektronickými fakturami v právním smyslu. V případě elektronického dobropisu se mění formát dokladu a má podobu popsanou níže. Popis polí dokladu CR (dobropis) vraceného metodou GetInvoice: Pole DocType DocVersion
CreditNoteId InvoiceId InvoiceDate SaleDate ClientId OrderId ClientOrderId DueDate BankAccountNumberToPay BankName SWIFT DocumentType Currency DeliveryTerm PaymentMethod <Seller> Name Address PostalCode City TaxId Phone Fax RecyclingId WEEECODE Name Address PostalCode City

Typ String String

String String DateTime XML DateTime XML String String String DateTime XML String String String String String String String String String String String String String String String String

String String String String Důvěrné – pouze pro partnery ABC Data s.r.o.

Opis Začátek dokladu Sekce informací o dokladu Typ Dokladu [ELECTRONICCREDITNOTE] Verze [1.0] Konec sekce informací o dokladu Začátek záhlaví Číslo dobropisu Číslo faktury Datum vystavení faktury Datum vystavení objednávky Číslo zákazníka Číslo objednávky Číslo objednávky zákazníka [pole RefOrderId z objednávky] Data platební Číslo bankovního účtu pro platební potřeby Jméno banky SWIFT banky Typ dokumentu [IN – faktura, CR - drobnopis] Měna faktury np. Kč Podmínky dodávky Způsob platby Začátek sekce prodejce Jméno prodejce Adresa prodejce PSČ Město DIČ Číslo telefonu Číslo faxu Registrační číslo odpadu Copyright registrační číslo Konec sekce prodejce Začatek sekce zákazníka (plátce faktury) Jméno kupujicího Adresa kupujicího PSČ Město

26/67

TaxId <ShipTo> DeliveryPointId Name Address PostalCode City Notice
ProductId PartNumber ProductName ProductType

Qty Price Value VatRate VatValue ValueWithVat Qty Price Value VatValue ValueWithVat Qty Price Value VatValue ValueWithVat OrderLineNumber ParentOrderLineNumber WarrantyInformation Notice <Summary> TotalNetValue TotalChargesValue TotalVatValue RoundValue TotalInvoiceValue ToPay BaseCurrencyId ExchangeRate VatRate NetValue VatValue GrossValue

String

Integer Decimal Decimal String Decimal Decimal

DIČ Konec sekce zákazníka Začatek sekce místa dodání Kód místo dodání Jméno subjektu pobírajícího zboží Adresa dodávky PSČ Město Konec sekce místa dodání začátek sekce komentáře Komentáře Konec sekce komentáře Konec záhlaví Začátek linie faktury Začátek konkretní linie Kód výrobku podle ABC Data Kód výrobku podle výrobce Jméno výrobku Typ výrobku [Single – obyčejný, Parent – rodič, Child - dítě], políčko slouží k definici souborů (bundli) Předchozí hodnoty Množství Cena netto Cena netto pro zákazníka Sazba DPH [%] Hodnota DPH Hodnota brutto

Integer Decimal Decimal Decimal Decimal

Hodnoty po úpravě Množství Cena netto Cena netto pro zákazníka klienta Hodnota DPH Hodnota brutto

Integer Decimal Decimal Decimal Decimal

Rozdíly v hodnotách Množství Cena netto Cena netto pro zákazníka klienta Hodnota DPH Hodnota brutto


String


Integer Integer String String

String Decimal Decimal Decimal Decimal Decimal Decimal String Decimal Decimal Decimal Decimal Decimal


Číslo Linie objednávek V případě složky číslo smlouvy linie rodiče (rodič výrobku) Informace o záruce Začátek sekce poznámek k položce faktury Poznámka k položce faktury Konec sekce poznámek k položce faktury Konec informací o položce Konec všech položek faktury Začátek sekce shrnutí Hodnota faktury bez DPH Hodnota dodatečných poplatků Součet hodnot DPH Hodnota zaokrouhlení Hodnota faktury celkem Hodnota k zaplacení Začátek sekce informací o DPH Waluta bazowa w kraju sprzedawcy Kurz pro základní měnu Začátek sekce rozčlenění sazeb DPH Sazba DPH [%] Hodnota bez DPH v dané sazbě Hodnota DPH pro danou sazbu Hodnota s DPH položky s danou sazbou Konec sekce rozčlenění sazeb DPH Konec sekce informací o DPH

27/67

Konec sekce shrnutí Konec dokladu

V případě, že elektronická faktura ještě není dostupná ve službě Gateway, sysém vrátí chybu ElectronicInvoiceNotAvailableYet. To znamená, že je třeba akci zkusit provést později. Doporučuje se stahovat faktury až další den. Chyba NoInvoice znamená, že faktura se zadaným číslem vůbec neexistuje. Vzorová odpověď služby INVOICE po vyvolání metody GetInvoice (XML doklad popisující testovací dobropis) ELECTRONICCREDITNOTE 1.0
C000000 G000000 2007-04-04T00:00:00.0000000+02:00 <SaleDate>2007-04-04T00:00:00.0000000+02:00 0 7777777 z/7/000i 2007-05-10T00:00:00.0000000+02:00 IN <SWIFT>IN IN <EndUserInvoiceId /> PLN IN <ElectronicFlag>0 <Seller>
<WEEECODE /> Test Spółka z o.o.
ul. Krucza 1
60-111 Warka 123456789 <ShipTo> 002 Test
ul. Bilardowa 13
22-111 Kule Wielkie
C7800033 Důvěrné – pouze pro partnery ABC Data s.r.o.

28/67

<PartNumber>SP0411N Single 1 1145.86 1145.86 0.22 252.09 1397.95 0 1145.86 0.00 0.22 -252.09 252.09 -1 0.00 -1145.86 -504.18 -1145.86 2 <ParentOrderLineNumber /> <WarrantyInformation /> <Summary> 106.3900 0.0000 23.4100 106.3900 129.8000 <ExchangeRate /> 0.22

Stažení obrazu elektronické faktury – PDF Vizualizace Pro stažení obrázku elektronické faktury je třeba vyvolat metodu GetElectronicInvoiceVisualization. V odpovědi služba vrací xml soubor obsahující zakódovaný obrázek PDF faktury. Pole DocType

Typ String

DocVersion String Důvěrné – pouze pro partnery ABC Data s.r.o.

Opis Začátek dokladu Sekce informací o dokladu Typ Dokumentu [INVOICE-ELECTRONICVISUALIZATION-PDF] Verze [2.0] Konec sekce informací o dokladu

29/67

InvoiceId InvoiceDate BodyEncoding
Body

String DateTime XML String String

Začátek záhlaví Číslo faktury Datum faktury Informace o způsobu kódování souboru PDF [Base64] Konec záhlaví Kódovaný obraz faktury v souboru PDF Konec dokladu

Pro uložení souboru na disk je třeba přečíst pole BODY, dekódovat je na tok bajtů a takový tok uložit na disk. Název souboru je na dekódujícím programu. Pole BODY obsahuje PDF soubor zakódovaný pomocí metody BASE64. INVOICE-ELECTRONIC-VISUALIZATION-PDF 1.0
G000000 2007-04-04T00:00:00.0000000+02:00 Base64
JVBERi0xLjQKJfv8/f4KMiAwIG9iago8PAovQ3JlYXRpb25EYXRlIDw0NDNhMzIzMDMwMzczMDM0M zAzNDMxMzYzMzM3MzSFDAAsdasdasdasdasdasdasdUzNj4KL0tleXdvcmRzIDxmZWZmPgovQXV0aG9yIDw+Ci9Ua XRsZSA8PgovQ3JlYXRvciA8PgovU3ViamVjdCA8PgovTW9kRGF0ZSA8NDQzYTMyMzAzMDM3MzAzNDMwMzQzMTM 2MzMzNzasdasasFasfASFaSFaM1MzY+


30/67

Stažení seznamu faktur Pro stažení seznamu faktur vystavených na partnera ABC Data s.r.o., je třeba volat metodu GetInvoiceRange s parametry počátečního a koncového data požadovaného rozmezí. Popis polí vráceného dokumentu metodou GetInvoiceRange Pole Typ Popis DocType DocVersion
InvoiceId StartDate EndDate
InvoiceId InvoiceDate

String String

String DateTime XML DateTime XML

DocumentType RefDocId

String DateTime XML String String

RefDocType

String

HasPDFImage

Integer

TotalNetValue TotalChargesValue TotalVatValue TotalInvoiceValue

Decimal Decimal Decimal Decimal

Začátek dokladu Sekce informací o dokladu Typ Dokladu [INVOICES] Verze [2.0] Konec sekce informací o dokladu Začátek záhlaví Číslo faktury Začátek rozmezí Konec rozmezí Konec záhlaví Začátek daného seznamu dokladů Číslo faktury Datum Faktury Typ dokladu [IN – faktura,CR – dobropis faktury] Reference faktury – u faktury je to číslo objednávky, u dobropisu je to číslo faktury Informace jaký doklad je v poli |RefDocId| [ORDER – objednávka, INVOICE – faktura] Má-li faktura v systému vygenerovaný PDF obraz [1 – ano, 0 – ne] Hodnota faktury bez DPH Dodatečné poplatky bez DPH Hodnota DPH Hodnota faktury s DPH Konec seznamu dokladů Konec dokladu

Vzorová odpověď služby INVOICE po volání GetInvoiceRange (XML dokument popisující testovací fakturu) INVOICES 2.0
<StartDate>2007-04-01T00:00:00.0000000+02:00 <EndDate>2007-04-03T00:00:00.0000000+02:00


31/67

Služba InvoiceEU (faktura End User) Název služby Lokalizace služby Adresa služby

: InvoiceEU : invoiceeu.asmx : https://gateway.systemb2b.com/ws/invoiceeu.asmx

MOŽNÁ VOLÁNÍ SLUŽBY: ■ ■ ■

METODY SLUŽBY:


 GetInvoice - Parametry o InvoiceID [string] – číslo faktury

Služba InvoiceEU umožňuje stažení údajů o faktuře vystavené ABC Data s.r.o. přímo na koncového zákazníka jménem dealera ve formátu XML. Pro stažení faktury je třeba vyvolat metodu GetInvoice služby invoiceeu.asmx s parametrem čísla faktury. V odpovědi systém vrací XML dokument popisující danou fakturu. Popis polí dokladu získaného metodou GetInvoice Pole Typ Popis DocType DocVersion
InvoiceId OwnerInvoiceId InvoiceDate SystemId OrderId DueDate BankAccountNumberToPay DocumentType Currency <Seller> Name Address PostalCode City TaxId Name Address PostalCode City TaxId <ShipTo> Name Address PostalCode City TaxId Notice
ProductId

String String

String String DateTime XML String String DateTime XML String String String String String String String String



String

String


Začátek dokladu Sekce informací o dokladu Typ Dokladu [INVOICEEU] Verze [2.0] Konec sekce informací o dokladu Začátek záhlaví Číslo faktury Číslo faktury dealera vystavené ABC Data s.r.o. Datum vystavení faktury Id Systému Číslo objednávky Datum platby Číslo bankovního účtu, na které je třeba zaplatit za fakturu Typ dokladu [IN – faktura, CR - dobropis] Měna faktury např. CZK Začátek sekce prodejce Jméno prodejce Adresa prodejce PSČ Město DIČ Konec sekce prodejce Začátek sekce zákazníka (plátce faktury) Jméno kupujícího Adresa kupujícího PSČ Město DIČ Konec sekce zákazníka Začátek sekce dodací adresy Název odběratele zboží Dodací adresa PSČ Město DIČ Konec sekce dodací adresy Začátek sekce poznámek Poznámka Konec sekce poznámek Konec záhlaví Začátek položky faktury Začátek dané položky Kód produktu podle ABC Data s.r.o.

32/67

PartNumber ProductName Qty Price Value VatRate VatValue ValueWithVat OrderLineNumber <Summary> TotalNetValue TotalCharges TotalVatValue TotalInvoiceValue ToPay

String String Integer Decimal Decimal String Decimal Decimal Integer

Kód produktu podle výrobce Název produktu Počet Cena bez DPH Cena bez DPH pro zákazníka Sazba DPH [%] Hodnota DPH Hodnota s DPH Číslo položky objednávky Konec informací o položce Konec všech položek faktury

Decimal Decimal Decimal Decimal Decimal

Hodnota Hodnota Hodnota Hodnota Hodnota

faktury bez DPH dodatečných poplatků DPH faktury k úhradě

Konec dokladu

Vzorová odpověď služby InvoiceEU (XML doklad popisující testovací fakturu EU) INVOICEEU 2.0
X2222223 G003300 2007-04-05T13:42:29.3930000+02:00 <SystemId>14 7777777 2007-04-05T13:42:29.3930000+02:00 IN IN PLN <Seller> sklep
ul.Kowala 2
02-125 Warszawa 333-333-00-11 Adam Cymanowski
Koderki 71b/5
80-234 Poznań <ShipTo> Adam Cymanowski
Kobiela 123
11-112 Płock
C0810067 1 211.6100 211.6100 22%


33/67

258.1600 258.1600 1 C5210034 1 23.3200 23.3200 22% 28.4500 28.4500 2 <Summary> 234.9300 11.4800 54.2000 300.6100 300.6100


34/67

Služba SerialNumbers (sériová čísla produktů) Název služby Lokalizace služby Adresa služby

: SerialNumbers : serialnumbers.asmx : https://gateway.systemb2b.com/ws/serialnumbers.asmx


■ ■ ■


METODY SLUŽBY:  GetSerialNumbersForInvoice – Parametry o InvoiceId [string] – číslo faktury  GetSerialNumbersForInvoiceRange - Parametry o StartDate [string] – počáteční datum rozmezí (yyyy-mm-dd) o EndDate [string] – koncové datum rozmezí (yyyy-mm-dd)  GetSerialNumbersForOrder - Parametry o OrderId [string]  GetSerialNumbersForOrderRange - Parametry o StartDate [string] - počáteční datum rozmezí (yyyy-mm-dd) o EndDate [string] - koncové datum rozmezí (yyyy-mm-dd)

Služba SerialNumbers umožňuje stažení sériových čísel prodaných produktů. Touto službou může dealer např. podporovat vlastní servisní bázi nebo řešení reklamace. Sériová čísla mohou být stažena:  pro konkrétní objednávku (metoda GetSerialNumbersForOrder),  pro konkrétní fakturu (metoda GetSerialNumbersForInvoice),  pro více objednávek (metoda GetSerialNumbersForOrderRange) objednávky zadané v rozmezí dat,  pro více faktur (metoda GetSerialNumbersForInvoiceRange) faktury zadané v rozmezí dat. Dealer má plnou možnost libovolně definovat a vybrat faktury a objednávky. 

Poznámka: k jedné objednávce může systém vystavit i několik faktur.

Struktura získaného dokladu je jednotná. Pole |Type| v sekci
informuje o druhu získaných údajů (INVOICE, ORDER, INVOICERANGE, ORDERRANGE). Použijeme-li rozmezí dat, obsahuje Sekce
doplňující pole |StartDate| a |EndDate| Popis polí dokladu získaného službou SerialNumbers Pole Typ Popis <SerialNumbers> DocType DocVersion
Type StartDate EndDate
OrderId InvoiceId ProductId PartNumber SerialNumber ProductName

String String

String DateTime XML DateTime XML



Začátek dokladu Sekce informací o dokladu Typ Dokladu [SERIALNUMBERS] verze [2.0] Konec sekce informací o dokladu Začátek záhlaví Typ dat [INVOICE,ORDER,INVOICERANGE, ORDERRANGE] Začátek rozmezí - pouze v případě [INVOICERANGE,ORDERRANGE] Konec rozmezí - pouze v případě [INVOICERANGE, ORDERRANGE] Konec záhlaví Začátek sekce sériových čísel Údaje spojené se sériovým číslem Číslo objednávky Číslo faktury Kód produktu podle ABC Data s.r.o. Kód produktu podle výrobce Sériové číslo produktu Název produktu Konec údajů spojených se sériovým číslem Konec seznamů dokladů Konec dokladu

35/67

Vzorová odpověď pro rozmezí faktur <SerialNumbers xmlns="http://gateway.systemb2b.com/schemas/SerialNumbers" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://gateway.systemb2b.com/schemas/SerialNumbers SerialNumbers.xsd"> SERIALNUMBERS 2.0
INVOICERANGE <StartDate>2007-04-01T00:00:00.0000000+02:00 <EndDate>2007-04-04T00:00:00.0000000+02:00
5000000 D222222 C9400736 <PartNumber>BE/X195G+TD52 <SerialNumber>X195G+TD52V30700664 5111111 G222222 C9400746 <PartNumber>XE/730LS+TD16 <SerialNumber>730LS+TD16V30700251

Vzorová odpověď pro konkrétní fakturu <SerialNumbers xmlns="http://gateway.systemb2b.com/schemas/SerialNumbers" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://gateway.systemb2b.com/schemas/SerialNumbers SerialNumbers.xsd"> SERIALNUMBERS 2.0
INVOICE
5277983 D995545 C6300558 <PartNumber>BX80547RE2800CN 871663 <SerialNumber>Q647A432


36/67

Služba PriceList(produkty,značky,typy,hierarchie,slovníky) Název služby Lokalizace služby Adresa služby

: PriceList : pricelist.asmx : https://gateway.systemb2b.com/ws/pricelist.asmx


■ ■ ■


METODY SLUŽBY:  GetProduct - Parametry o ProductId [string] – kód produktu  GetProducts  GetProductsCodes  GetProductsList – Parametry o ListType [string] – typ seznam Možné hodnoty:  PRODUCTS (ListParameter = NEW/ ENDOFLIFE/ LIMITED)  PRODUCTSCOMPACT (ListParameter = STOCKAVALIABLE) o ListParameter [string] – parameter seznamu Možné hodnoty:  NEW – nové výrobky  ENDOFLIFE – odstraněné výrobky  LIMITED – stanovený klientem seznam výrobků  GetPriceListDictionaries  GetPriceListHierarchy  GetProductDescription - Parametry o ProductId [string] – kód produktu o Mode [string] – formát popisu produktu Možné hodnoty:  XML  HTML  TEXT  GetStockDataByRegion  GetPriceListHierarchyByAttribs  GetProductsModified - Parametry o ListType [string] - parameter seznamu Možné hodnoty:  DEFINITION - vrací produkty, ve kterých se změnily klíčové hodnoty (ceny, sklad, atd.)  DESCRIPTION - vrací produkty, ve kterých se změnil název nebo popis o DateForm [string] - Datum, od kdy mají být vyhledány změny v produktech. Zadávejte datum ve formátu YYYY-MM-DD

Stažení údajů o produktech (GetProducts) Služby PriceList umožňuje stažení informací týkajících se produktů dostupných v ceníku: typ produktu, výrobce a místo produktu v ceníkové hierarchii. Informace o produktu mohou být staženy:  pro konkrétní produkt (metoda GetProduct)  pro všechny produkty (metoda GetProducts)  pro všechny produkty (metoda GetProductsCodes)  pro seznam výrobků (metoda GetProductsList) Popis polí dokladu získaného službou PriceList - GetProducts Pole Typ Popis Důvěrné – pouze pro partnery ABC Data s.r.o.

Začátek dokladu

37/67

DocType DocVersion
LangId
ProductId PartNumber ClientProductId ProductName MajorGroup MinorGroup HierarchyId ProducerId Price CurrencyId Available RecyclingFee CopyrightFee VatRate WarrantyId AttribGroupId BarCodeType BarCode

String String

String

String String String String String String String String Decimal String String Decimal Decimal Decimal String Integer

String String

Sekce informací o dokladu Typ Dokladu [PRODUCT, PRODUCTS] verze [2.1] Konec sekce informací o dokladu Začátek záhlaví Zkratka jazyku [PL,EN,CS,SK] Konec záhlaví Začátek seznamu produktů Údaje spojené s produktem Kód produktu podle ABC Data s.r.o. Kód produktu výrobce P/N Kod produktu podle zákazníka Název produktu Kód značky produktu Kód typu produktu Kód hierarchie produktu v ceníku Kód výrobce produktu Cena SRP produktu Zkrátka měny např. CZK Dostupnost produktu [+,-] Recyklační poplatek Autorský poplatek DPH Typ záruky(obsaženo ve výstupu PriceListDictionaries) Skupina atributů,vracená metodou GetPriceListHierarchyByAttribs Začátek údajů o čárových kódech Údaje o čárových kódech Konec údajů o čárových kódech

Konec údajů spojených s produktem Konec seznamu produktů Konec dokladu

Vzorová odpověď pro produkt (metoda GetProduct): PRODUCT 2.1
PL
C7800237 <PartNumber>SP2004C MyNumber <MajorGroup>SAH <MinorGroup>HDD 21726 SAMSUNG 154.2300 PLN + 0 0 0.19 <WarrantyId>A 123456


38/67

EAN13 5907808446540

Vzorová odpověď pro seznam všech produktů (metoda GetProducts): PRODUCTS 2.0
PL
C0150366 <PartNumber>3CR990B-97 MyNumber <MajorGroup>3C <MinorGroup>NAC 26078 3COM 244.2100 PLN - 0 0 0.22 <WarrantyId>D 123456 C0150372 <PartNumber>3CRGPC10075 <MajorGroup>3C <MinorGroup>NAW 24639 3COM 140.4300 PLN + 0 0 0.19 <WarrantyId>A 123456

Popis polí dokladu získaného službou PriceList - GetProductsList

Pole

Typ


Opis 39/67

DocType DocVersion
LangId

ListType ListParameter

String String



String String

ProductId PartNumber ClientProductId ProductName MajorGroup MinorGroup HierarchyId ProducerId Price CurrencyId Available RecyclingFee CopyrightFee VatRate WarrantyId

String String String String String String String String Decimal String String Decimal Decimal Decimal String

AttribGroupId

Integer

BarCodeType BarCode

String String

Začátek dokladu Sekce informací o dokladu Typ Dokladu [PRODUCTSLIST] Verze [2.1] Konec sekce informací o dokladu Začátek záhlaví Zkratka jazyku [PL,EN,CS,SK] Parametr [PRODUCTS] Parametr [NEW,ENDOFLIFE,LIMITED] Konec záhlaví Začátek seznamu produktů Parametr popisující typ seznamu [PRODUCTS] Parametr opisující seznam [NEW,ENDOFLIFE,LIMITED] Údaje spojené s produktem Kód produktu podle ABC Data s.r.o. Kód produktu výrobce P/N Kód produktu podle zákazníka Název produktu Kód značky produktu Kód typu produktu Kód hierarchie produktu v ceníku Kód výrobce produktu Cena SRP produktu Zkrátka měny např. CZK Dostupnost produktu [+,-] Recyklační poplatek Autorský poplatek DPH Typ záruky(obsaženo ve výstupu PriceListDictionaries) Skupina atributů,vracená metodou GetPriceListHierarchyByAttribs

Údaje o čárových kódech Konec údajů o čárových kódech

Konec údajů spojených s produktem Konec seznamu produktů Konec dokladu

W dokladu, který vrací metoda GetProductsList, může se nám objevit několik seznamů výrobků (sekce ). Je to zapříčiněné parametry ListType a ListParameter. Parametry se nacházejí v sekci
(ListType a ListParameter). Daný seznam je popsán atrybuty elementu . Vzorová odpověď pro seznam produktů podle parametrů ListType=”PRODUCTS” a ListParameter=”NEW”: PRODUCTSLIST 2.0
PL PRODUCTS NEW
C0150366 <PartNumber>3CR990B-97 MyNumber Důvěrné – pouze pro partnery ABC Data s.r.o.

40/67

<MajorGroup>3C <MinorGroup>NAC 26078 3COM 244.2100 PLN - 0 0 0.22 <WarrantyId>D 123456 C0150372 <PartNumber>3CRGPC10075 MyNumber <MajorGroup>3C <MinorGroup>NAW 24639 3COM 140.4300 PLN + 0 0 0.22 <WarrantyId>A 123456

Stažení dostupnosti skladu (GetProductsList) Pro stažení dostupnosti skladu je třeba vyvolat metodu GetProductsList s parametry: ListType=PRODUCTSCOMPACT ListParameter=STOCKAVALIABLE Vracený seznam je ve verzi COMPACT, který obsahuje minimum informací nezbytných pro zpracování na straně zákazníka. Díky tomu je rozměr souboru menší při zachování schématu normálního ceníku. Popis polí dokladu získaného službou PriceList – GetProductsList (verze COMPACT)

Pole DocType DocVersion
LangId

Typ String String



ProductId PartNumber ClientProductId Price CurrencyId

String String String Decimal String


Opis Začátek dokladu Sekce informací o dokladu Typ Dokladu [PRODUCTSLISTCOMPACT] Verze [1.0] Konec sekce informací o dokladu Začátek záhlaví Zkratka jazyku [PL,EN,CS,SK] Parametr [PRODUCTSCOMPACT] Parametr [STOCKAVALIABLE] Konec záhlaví Začátek seznamu produktů Údaje spojené s produktem Kód produktu podle ABC Data s.r.o. Kód produktu výrobce P/N Kód produktu podle zákazníka Cena SRP produktu Zkrátka měny např. CZK

41/67

Available

String

Dostupnost produktu [+,-] Konec údajů spojených s produktem Konec seznamu produktů Konec dokladu

Vzorová odpověď pro seznam produktů podle parametrů ListType=”PRODUCTSCOMPACT” a ListParameter=”STOCKAVALIABLE”: PRODUCTSLISTCOMPACT 2.0
PL PRODUCTSCOMPACT STOCKAVALIABLE
C6503319 <PartNumber>CM1730-PLCH01 2027.9400 PLN + C6503319 <PartNumber>CM1730-PLCH01 2027.9400 PLN +

Stažení slovníkových dat pro značky, typy a výrobce (GetPriceListDictionaries) Pro stažení názvů výrobců, značek a typů produktů je třeba vyvolat metodu GetPriceListDictionaries, Popis polí dokladu získaného službou PriceList Pole Typ Popis DocType DocVersion
LangId
DictionaryId <Entry> EntryId EntryName

String String

String


Začátek dokladu Sekce informací o dokladu Typ Dokladu [PRICELISTDICTIONARIES] Verze [2.0] Konec sekce informací o dokladu Začátek záhlaví Zkrátka jazyku [PL,EN,CS,SK] Konec záhlaví Začátek seznamu zápisů ve slovníku Id slovníku [MajorGroup, MinorGroup, ProducerId](atribut prvku slovníku) Začátek zápisu Kód zápisu Název zápisu Konec údajů spojených se zápisem v slovníku Konec slovníku Konec dokladu

Vzorová odpověď (pouhá část skutečné odpovědi dané služby): Důvěrné – pouze pro partnery ABC Data s.r.o.

42/67

PRICELISTDICTIONARIES 2.0
PL
<Entry> <EntryId>3COM <EntryName>3Com <Entry> <EntryId>3M <EntryName>3M <Entry> <EntryId>3C <EntryName>3Com <Entry> <EntryId>3CC <EntryName>3CC 3COM Karty <Entry> <EntryId>ACC <EntryName>Inne akcesoria <Entry> <EntryId>ACD <EntryName>Akcesoria GSM Low

Stažení ceníkové hierarchie (GetPriceListHierarchy) K stažení ceníkové hierarchie slouží metoda GetPriceListHierarchy, Popis polí dokladu získaného službou PriceList - Hierarchy Pole Typ Popis DocType DocVersion
LangId
<Entry> HierarchyId HierarchyLevel1 HierarchyLevel2 HierarchyLevel3 NameL1 NameL2 NameL3

String String

String



Začátek dokladu Sekce informací o dokladu Typ Dokladu [PRICELISTHIERARCHY] Verze [2.0] Konec sekce informací o dokladu Začátek záhlaví Zkratka jazyku [PL,EN,CS,SK] Konec záhlaví Začátek seznamu zápisů hierarchie ceníku Začátek zápisu Kód v ceníkové hierarchii produktů Kód v hierarchii produktů pro úroveň 1 Kód v hierarchii produktů pro úroveň 2 Kód v hierarchii produktů pro úroveň 3 Název 1 ceníkové úrovně Název 2 ceníkové úrovně Název 3 ceníkové úrovně Konec údajů spojených se zápisem v slovníku Konec slovníku Konec dokladu

43/67

Vzorová odpověď (pouhá část skutečné odpovědi dané služby): PRICELISTHIERARCHY 2.0
PL
<Entry> 26078 987 654 321 3Com Karty sieciowe <Entry> 24639 987 654 321 3Com Lokalne sieci bezprzewodowe (Wireless LAN) Karty i punkty dostępowe 802.11g (54Mbit/2.4GHz)

Stažení kódů produktů (GetProductsCodes) K stažení kódů produktů slouží metoda GetProductsCodes. Popis polí dokladu získaného službou PriceList Pole Typ Popis DocType DocVersion
LangId
ProductId PartNumber ClientProductId BarCode BarCodeType

String String


Začátek dokladu Sekce informací o dokladu Typ Dokladu [PRODUCTSCODES] Verze [1.0] Konec sekce informací o dokladu Začátek záhlaví Zkrátka jazyku [PL,EN,CS,SK] Konec záhlaví Začatek seznamu s kódama produktů Začatek údajů spojených s produktem Kód produktu podle ABC Data Kód produktu podle výrobce Kód produktu podle zákazníka Kód Typ kódu Konec údajů spojených s produktem Konec seznamu s kódama produktů Konec dokladu

Vzorová odpověď Důvěrné – pouze pro partnery ABC Data s.r.o.

44/67

PRODUCTSCODES 1.0
PL
C0150366 <PartNumber>3CR990B-97 MyNumber 11095205611790 EAN13 C0150372 <PartNumber>3CRGPC10075 MyNumber2 105205611793 UPCA

UPOZORNĚNÍ: občas u produktů se objeví 2 part numbery, je tedy zapotřebí natáhnout do svých systému jak element <PartNumber>, tak i element ALTOPN.

Stažení popisu produktu (GetProductDescription) Ke stažení opisu produktu slouží metoda GetProductDescription. Popis polí dokladu vraceného službou PriceList – ProductDescription (pro Mode HTML a TEXT) Pole Typ Opis DocType DocVersion
LangId

String String

String


Začátek dokladu Sekce informací o dokladu Typ Dokumentu [PRODUCTDESCRIPTION] Verze [2.0] Konec sekce informací o dokladu Začátek záhlaví zkratka jazyka [PL,EN,CS,SK] Konec záhlaví Začátek seznamu produktů Začátek údajů spojených s produktem

45/67

ProductId Type Data

String

String String

Kód produktu Začátek kolekce popisů Začátek popisu Formát popisu [TEXT,HTML] Popis produktu Konec popisu Konec kolekce popisů Konec údajů spojených s produktem Konec seznamu produktů Konec dokumentu

Příkladová odpověď (TEXT): PRODUCTDESCRIPTION 2.0
PL
C7800493 TEXT

Příkladová odpověď (HTML): PRODUCTDESCRIPTION 2.0
PL
C7800493 HTML Symbol producentaHD161HJNazwa produktuDysk Samsung Spin Point S166 HD161HJ, 160GB, Serial ATA/300, 7200RPM, 8MB cacheProducentSamsungKlasa produktuDysk


46/67

twardyRodzaj dyskuStandardowy (nośnik magnetyczny)Format szerokości3.5 caliPojemność dysku:160 GBInterfejsSerial ATA 300Szybkość interfejsu dysku300 MB/sTyp napędu:Wewnętrzny

]]>

Popis polí dokladu vraceného službou PriceList – ProductDescription (pro mód XML a TEXT) Pole DocType DocVersion
LangId
ProductId Type PartCategory TypeId Value UnitMeasureName

Typ String String

String

String

String String


Opis Začátek dokladu Sekce informací o dokladu Typ Dokumentu [PRODUCTDESCRIPTION] Verze [2.0] Konec sekce informací o dokladu Začátek záhlaví zkratka jazyka [PL,EN,CS,SK] Konec záhlaví Začátek seznamu produktů Začátek údajů spojených s produktem Kód produktu Začátek kolekce popisů Začátek popisu Formát popisu [XML] Kategorie produktu Začátek seznamu hodnot Začátek hodnot Typ hodnoty Hodnota popisující produkt Jednotka hodnoty Konec hodnot Konec seznamu hodnot Konec Konec Konec Konec Konec

popisu kolekce popisů údajů spojených s produktem seznamu produktů dokumentu

Příkladová odpověď (XML) (pouhá část skutečné odpovědi dané služby): PRODUCTDESCRIPTION 2.0
PL
C7800493 XML


47/67

<PartCategory>Dysk twardy 604 Standardowy (nośnik magnetyczny) 224 3.5 cali 75 160 GB 598 Wewnętrzny

Stažení dostupnosti produktů rozdělených podle skladů (GetStockDataByRegion) Ke stažení dostupnosti produktů rozdělených podle skladů slouží metoda GetStockDataByRegion. Popis polí dokladu vraceného službou PriceList – GetStockDataByRegion Pole Typ Opis <StockDataByRegion> DocType DocVersion ProductId PartNumber ClientProductId RegionId Available

String String


String String

Začátek dokladu Sekce informací o dokladu Typ Dokumentu [STOCKDATABYREGION] Verze [1.0] Konec sekce informací o dokladu Začátek seznamu produktů Začátek údajů spojených s produktem Kód produktu podle ABC Data Kód produktu podle výrobce Kód produktu podle zákazníka Začátek sekce podle skladů Začátek sekce pro sklad Kód skladu Dostupnost produktu Konec sekce pro sklad Konec sekce podle skladů Konec údajů spojených s produktem Konec seznamu produktů Konec dokumentu

R0 – Varšava R1 - Sosnovec Příkladová odpověď (část): <StockDataByRegion xmlns="http://gateway.systemb2b.com/schemas/StockDataByRegion" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://gateway.systemb2b.com/schemas/StockDataByRegion StockDataByRegion.xsd">


48/67

STOCKDATABYREGION 1.0 C0005000 <PartNumber>DMC-LS6E-K R0 - …

Stažení hierarchie podle vlastností (GetPriceListHierarchyByAttribs) Ke stažení hierarchii podle vlastností slouží metoda GetPriceListHierarchyByAttribs. Popis polí dokladu získaného službou PriceList - Hierarchy Pole Typ Popis DocType DocVersion
LangId
<Entry> HierarchyId HierarchyLevel1 HierarchyLevel2 HierarchyLevel3 NameL1 NameL2 NameL3

String String

String


Začátek dokladu Sekce informací o dokladu Typ Dokladu [PRICELISTHIERARCHYBYATTRIBS] Verze [1.0] Konec sekce informací o dokladu Začátek záhlaví Zkratka jazyku [PL,EN,CS,SK] Konec záhlaví Začátek seznamu zápisů hierarchie ceníku Začátek zápisu Kód v ceníkové hierarchii produktů Kód v hierarchii produktů pro úroveň 1 Kód v hierarchii produktů pro úroveň 2 Kód v hierarchii produktů pro úroveň 3 Název 1 ceníkové úrovně Název 2 ceníkové úrovně Název 3 ceníkové úrovně Konec údajů spojených se zápisem v slovníku Konec slovníku Konec dokladu

Vzorová odpověď (pouhá část skutečné odpovědi dané služby): PRICELISTHIERARCHYBYATTRIBS 1.0
PL
<Entry> 326 89 105 326 Komputery gotowe Komputery Komputer Důvěrné – pouze pro partnery ABC Data s.r.o.

49/67

<Entry> 328 89 106 328 Komputery gotowe Serwery Serwer …

Stažení seznamu modifikovaných produktů (GetProductsModified) Pro stažení modifikovaných produktů slouží metoda GetProductsModified. Seznam produktů zobrazuje určité informace. Typ a formát vrácené informace závisí na vstupních parametrech předaných metodě GetProductsModified (popsáno v metodách služby PriceList). Parametry volání metody jsou v sekci
(ListType i DateFrom). Daný seznam je popsán atributami v sekci . V případě, že jsou stahovány produkty, u kterých došlo ke klíčovým změnám (ListType = DEFINITION), seznam polí elementu odpovídá seznamu metody GetProductList. Pokud se dotazujemy na změny v popisech produktu (ListType = DESCRIPTION), tak seznam polí elementu je pouze kód produktu podle ABC Data s.r.o. (ProductId). Popis polí dokladu získaného službou PriceList – GetProductsModified (pro ListType = DEFINITION)

LangId

ListType DateFrom

Typ String String


ListType

String

DateFrom

String

ProductId PartNumber ClientProductId ProductName MajorGroup MinorGroup HierarchyId ProducerId Price CurrencyId Available RecyclingFee CopyrightFee VatRate WarrantyId

String String String String String String String String Decimal String String Decimal Decimal Decimal String

AttribGroupId

Integer


Opis Začátek dokladu Sekce informací o dokladu Typ Dokladu [PRODUCTSLIST] Verze [2.1] Konec sekce informací o dokladu Začátek záhlaví Zkratka jazyku [PL,EN,CS,SK] Parametr [DEFINITION, DESCRIPTION] Parametr datum Od ve formátu YYYY-MM-DD Konec záhlaví Začátek seznamu produktů Parametr popisující typ seznamu [DEFINITION, DESCRIPTION] Parametr popisující datum Začátek údajů spojených s produktem Kód produktu podle ABC Data s.r.o. Kód produktu výrobce P/N Kód produktu podle zákazníka Název produktu Kód značky produktu Kód typu produktu Kód hierarchie produktu v ceníku Kód výrobce produktu Cena SRP produktu Zkrátka měny např. CZK Dostupnost produktu [+,-] Recyklační poplatek Autorský poplatek DPH Typ záruky(obsaženo ve výstupu PriceListDictionaries) Skupina atributů,vracená metodou GetPriceListHierarchyByAttribs Konec údajů spojených s produktem Konec seznamu produktů Konec dokladu

50/67

Popis polí dokladu získaného službou PriceList – GetProductsModified (pro ListType = DEFINITION)

LangId

ListType DateFrom

Typ String String


ListType

String

DateFrom

String

ProductId

String

Opis Začátek dokladu Sekce informací o dokladu Typ Dokladu [PRODUCTSLIST] Verze [2.1] Konec sekce informací o doklad Začátek záhlaví Zkratka jazyku [PL,EN,CS,SK] Parametr [DEFINITION, DESCRIPTION] Parametr datum Od ve formátu YYYY-MM-DD Konec záhlaví Začátek seznamu produktů Parametr popisující typ seznamu [DEFINITION, DESCRIPTION] Parametr popisující datum Začátek údajů spojených s produktem Kód produktu podle ABC Data s.r.o. Konec údajů spojených s produktem Konec seznamu produktů Konec dokladu

Příkladová odpověď (XML) pro parametry ListType=”DEFINITION” a DateFrom=”2013-11-01”: PRODUCTSLIST 2.1
PL DEFINITION NEW
C0150366 <PartNumber>3CR990B-97 MyNumber <MajorGroup>3C <MinorGroup>NAC 26078 3COM 244.2100 PLN - 0 0 0.22 <WarrantyId>D 123456 C0150372 <PartNumber>3CRGPC10075 MyNumber <MajorGroup>3C <MinorGroup>NAW 24639 3COM Důvěrné – pouze pro partnery ABC Data s.r.o.

51/67

140.4300 PLN + 0 0 0.22 <WarrantyId>A 123456


52/67

Služba Delivery Název služby Lokalizace služby Adresa služby

: Delivery : Delivery.asmx : https://gateway.systemb2b.com/ws/delivery.asmx


METODY SLUŽBY: 

■ ■ ■


 

GetDeliveryLettersProcessingInDay - Parametry o ProcessingDate [string] – data (yyyy-mm-dd) GetDeliveryLettersProcessingForOrder - Parametry o OrderId [string] GetDeliveryLettersProcessingForInvoice - Parametry o InvoiceId [string]

Služba Delivery poskytuje informace ve formátu XML. Informace o produktu mohou být staženy:  Dodací list pro konkrétní den (metoda GetDeliveryLettersProcessingInDay)  Dodací list pro konkretní objednávku (metoda GetDeliveryLettersProcessingForOrder)  Dodací list pro konkretní fakturu (metoda GetDeliveryLettersProcessingForInvoice) K tomu abychom získali dodací listy k danému dni je zapotřebí zavolat metodu GetDeliveryLettersProcessingInDay sluzby delivery.asmx s parametrem datum Popis polí dokladu vraceného službou GetDeliveryLettersProcessingInDay

Pole DocType DocVersion CarrierId CarrierDocumentId OrderId SystemId InvoiceId EUInvoiceId

Typ String String


Opis Začátek dokumentu Sekce informací o dokladu Typ Dokumentu [DELIVERYLETTERS] Verze [2.0] Konec sekce informací o dokladu Začátek sekce zpracovaných dodacích listů Začátek konkretního listu ID dopravce Číslo listu dopravce Začátek sekce pozice pro list dopravce Začátek dané linie Číslo objednávky ID Systému Číslo faktury Číslo faktury pro koncového zákazníka, kdy byla vystavena Konec linie Konec sekce pozice pro list dopravce Konec sekce konkretního listu Konec sekcji zpracovaných dodacích listů Konec dokladu

Příkladová odpověď služby Delivery po zavolání metody GetDeliveryLettersProcessingInDay (dokument xml popisující dodací list)

53/67

10549281803

Popis polí dokladu vraceného službou GetDeliveryLettersProcessingForOrder a GetDeliveryLettersProcessingForInvoice

DocumentId Type

Typ String String

CarrierId CarrierDocumentId

Opis Začátek dokumentu Sekce informací o dokladu Typ dokumentu [DELIVERYLETTERSFORINVOICE pro faktury, DELIVERYLETTERSFORORDER pro objednávky] Verze [2.0] Konec sekce informací o dokladu Začátek záhlaví OrderId nebo InvoiceId – parametr pro vstup Typ dokumentu [INVOICE – faktura,ORDER – objednávka] Konec záhlaví Začátek sekce zpracovaných dodacích listů Začátek konkretního listu ID dopravce Číslo dodacích listů Konec sekce konkretního listu Konec sekce zpracovaných dodacích listů Konec dokladu

Příkladová odpověď služby Delivery po zavolání metody GetDeliveryLettersProcessingForOrder (dokument xml popisuje seznam dodacích listů) DELIVERYLETTERSFORORDER 2.0
8201967 ORDER
DHL 10549281803


54/67

Služba Resources Název služby Lokalizace služby Adresa služby

: Resources : Resources.asmx : https://gateway.systemb2b.com/ws/resources.asmx


■ ■ ■

METODY SLUŽBY:




GetResources - Parametry o ResourceClass [string] – typ zdroje Možné hodnoty:  PRODUCT o ResourceKey [string] - kód produktu



GetResource - Parametry o ResourceClass [string] – typ zdroje Možné hodnoty:  PRODUCT o ResourceKey [string] - kód produktu o ResourceType [string] – typ souboru Možné hodnoty:  IMG – obrázek o ResourceSubType [string] – podtyp souboru Možné hodnoty pro typ IMG:  MAIN – velký obrázek  THUMB1 – obrázek 60px  THUMB2 – obrázek 120px  THUMB3 – obrázek 200px o ResourceName [string] – C kód produktu s příponou formátu obrázku

Stažení údajů o produktech Služba Resources umožňuje stažení informací týkajících se zdrojů, které jsou k dispozici pro určitou skupinu zdrojů, jako je třída PRODUCT, která v metodě (GetResources) poskytuje informace o dostupnosti obrázků, a metoda (GetResource) umožnuje jejich stažení. Popis polí dokladu získaného službou Resources - GetResources

LangId ResourceClass ResourceKey

Typ String String


AsBytes

Integer

AsDoc

Integer

Type String SubType String Name String Důvěrné – pouze pro partnery ABC Data s.r.o.

Popis Začátek dokladu Sekce informací o dokladu Typ Dokladu [RESOURCES] verze [2.0] Konec sekce informací o dokladu Začátek záhlaví Zkratka jazyku [PL,EN,CS,SK] Třída zdrrojů, [PRODUCT] Klíč zdrojů, pro třídu PRODUCT – povolené hodnoty: C kód produktu Konec záhlaví Začátek seznamu zdrojů Údaje týkající se zdrojů Informace zdali zdroj je dostupny jako binární stream [0,1] Informace zdali zdroj je dostupny prostřednictvim metody GetResource [0,1] Typ zdroje [IMG] - obrázek Podtyp zdroje, [MAIN,THUMB1,THUMB2,THUMB3] Název zdroje

55/67

Konec údajů týkajících se zdrojů Konec seznamu zdrojů Konec dokladu

Vzorová odpověď pro metoda (GetResources): RESOURCES 2.0
PL PRODUCT C0350377
IMG <SubType>MAIN C0350377.jpg IMG <SubType>THUMB1 C0350377.jpg IMG <SubType>THUMB2 C0350377.jpg IMG <SubType>THUMB3 C0350377.jpg IMG <SubType>MAIN C0350377_1.jpg IMG <SubType>THUMB1 C0350377_1.jpg IMG <SubType>THUMB2 C0350377_1.jpg IMG <SubType>THUMB3 C0350377_1.jpg

Stažení zdroje V závislosti na atributech sekce Resource v dokumentu vráceném metodou GetResources jsou 2 způsoby, jak získat odpovídající zdroj, (mějte na paměti, že ne všechny zdroje mohou být stahovány pomocí těchto dvou metod) 1) Stahování prostřednictvím metody GetResource (AsDoc="1") 2) Jako binární proud (AsBytes="1"), prostřednictvím www stránky: https://gateway.systemb2b.com/pageset/resource.aspx S parametry: Důvěrné – pouze pro partnery ABC Data s.r.o.

56/67

ResourceClass ResourceKey ResourceType ResourceSubType ResourceName Příklad: https://gateway.systemb2b.com/pageset/resource.aspx?ResourceClass=PRODUCT&ResourceKey=C035 0377&ResourceType=IMG&ResourceSubType=THUMB1&ResourceName=C0350377.jpg Popis polí dokladu získaného službou Resources – GetResource

LangId ResourceClass ResourceKey

Typ String String


ResourceType ResourceSubType

String String

ResourceName BodyEncoding
Body

String String

Popis Začátek dokladu Sekce informací o dokladu Typ Dokladu [RESOURCES] verze [2.0] Konec sekce informací o dokladu Začátek záhlaví Zkratka jazyku [PL,EN,CS,SK] Třída zdrrojů, [PRODUCT] Klíč zdrojů, pro třídu PRODUCT – povolené hodnoty: C kód produktu Typ zdroje, pro PRODUCT [IMG] Podtyp zdroje třídy PRODUCT a typu IMG: [MAIN,THUMB1,THUMB2,THUMB3] Název zdroje Informace o způsobu kodování zdroje [Base64] Konec záhlaví Zakódovány zdroj Konec dokladu

Vzorová odpověď pro metoda (GetResource): RESOURCE 2.0
PL PRODUCT C0350377 IMG THUMB1 C0350377.jpg Base64
/9j/4AAQSkZJRgABAQEA+gD6AAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5P TgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAA1ADwD ASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaE II0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpK Wmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/ 8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElK U1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6On q8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD1/wAW+JE8OaUZtpaaQMIuOAQM5NeG6r44167umW81KUcbAiM0YHf+EgE/Wuh+L+u3q+KbbSAyi18pWxt5+b rz+Feea0Qs5dQMGd+3pil1setgsJCdNzmrnTaf8StbtE8qK5nfaMZzvyOP72f8mt628a+L9SmiSweR3K5KBUJx0z2rlvCnh2PWdF1W9EhSe0UFVx8rA hj/AEqOzklTUbTy5HQ7tuUYg4wfSk3Y7YYbDyjJRS5l3Os1rxD420iMz393d26dOIY8D8mNcq3xE8TGXMetXR544X+WKivYtR1XXFsUuLm4EzkIjSE7 ucdz0B7+xrsT4X8OwxQ2N1dkXEQAb7HHkK3+02OTQZN0KCSrRV32R0Pww8d33iG5uNP1SYSXCDch2BSR3zivTq8w8Madpul+LbWaK5geWSNog6MAW46 Mvrx1r0+mjysX7N1L09meE/Gm4B8XabF5SqY4C2/HLZzx+ledag5ktLeQ9Wkdj+deofHe3RLjRrsIA53oW9QMH+teVTtvsLYejtR1PVy93oNHonw5GP DGvkdTED+j1zUT+Xd2knp835Jmt74dTj+w9dgyQRbk/wA65yWRY/7Odj8pXDH/AICBUs2w+lWp6r8i/wCHJLhoZLsTMlzLiCJx1Rc4OPfJrR1MzaFps s0E4yzeXGR1Hv8AX/Gqvha1iu2n0pJ1E8kaz2jk4HmDkofxBFVtWs9RmhktJIZvkfeEKncp9DTR5GPUlXfMcrLc3VvcRXBMiSlspIG5B9fWvp3wBrc3 iDwXp9/cndOylJGH8TKSCf0r5rg0jVdb1G3063tpXuC2FTbjHufYV9P+EtAXw14XsdKDbmgj+dvVjyT+ZqjjZwPx2tjLoukzBchLllJ9Nw/+tXi3lML cBgwcOMLj1Br601awt9TsXtLqFJYJOHRxkGuLf4UeGnbcLeVfTbKRig78JjI0YuLR4n4f1240KS9jSMMlxE0UisP1qnezMLSGN5EwnQBhnn2r3uL4U+ GEfc1k0h/23JrYtfBOgWYAh0q2X32A0jX+0Iptxjqz5msr24t3Jt45HyONgOQexGO9drp3jfxjIqxtYSXGBgTNakv+de7RaNZRYEdrCv0QVaWzjT+EA +woMKuNdS3MkeY/DnR9duvFlz4h1nzEj8ho4IpeGBJHOBwBgH869ZqCOIRyZFT0zknNzd2IRmk2iiiggXaKMCiigAAAoxRRQAYpaKKAP//Z


57/67

Služba Client Název služby Lokalizace služby Adresa služby

: GetDeliveryPoints : Client.asmx : https://gateway.systemb2b.com/ws/Client.asmx

MOŽNÁ VOLÁNÍ SLUŽBY: ■ ■ ■

METODY SLUŽBY:




GetDeliveryPoints

Služba umožňuje stažení dat ve formátu XML o jednotlivých dodacích adresách zákazníka. Popis polí dokladu získaného službou Client - GetDeliveryPoints

Pole DocType DocVersion DeliveryPointId Name City Address PostalCode CountryCode ClientDeliveryPointId Enabled GLN

Typ String String

Popis Začátek dokladu Sekce informací o dokladu Typ Dokladu [DELIVERYPOINTS] verze [1.0] Konec sekce informací o dokladu Začátek sekce dodací adresy zákazníka Začátek sekce dodací adresa zákazníka ID dodací adresy Název zákazníka Město Adresa PSČ Kod kraje ID doručovacího bodu (např.: 000, 001) Dostupný / Nedostupný (1/0) Global Logistic Number Konec sekce dodací adresa zákazníka Konec sekce dodací adresy zákazníka Konec dokladu

Vzorová odpověď pro metoda (GetDeliveryPoints): DELIVERYPOINTS 1.0 Klient Test Warszawa
Daniszewska 14
00-000 PL 000 D111 <Enabled>1


58/67

Gateway Messanger (GM) – zprávy Mechanismus GatewayMessanger umožňuje zasílání zpráv mezi systémy. Umožnuje asynchronní komunikaci dvou stran. Taka komunikace je nutná k efektivní integraci systémů. Zprávou může být např.: informování systému zákazníka o zpracování žádosti, stvoření objednávky, změny statusu atd. Struktura zprávy je sjednocena, ale obsah jednotlivých elementů je závislý od typu zprávy.

Příjem zprávy z klientského systému Pro správnou obousměrnou komunikaci, je nutné, aby zákazník (endpoint) využil jednoho ze způsobu: 



Web Service (protokol SOAP), o názvu MessageReceiver s metodou ReceiveMessage podle definice WSDL: https://gateway.systemb2b.com/GM/WS/MessageReceiver.asmx?wsdl XmlMessage: předávána zprava ve formátu Gateway Message libovolného typu. ContextReference: Předaná hodnota zákazníkem. Popis v obsahu dokumentu. Stránka WWW, která po HTTP Post příjme zprávu a odpoví na její přijetí XMLMessage: zpráva XML ve formátu Gateway Message ContextReference: Předaná hodnota zákazníkem. Popis v obsahu dokumentu.

Vrácená hodnota: 

V případě, že nenastane chybový stav, služba vrátí dokument GatewayResult (ResultType = OK) Jednoduchý příklad GatewayResult bez dalších parametrů

GatewayResult 1.0
Identyfikator nadany przez klienta OK 2011-11-02T14:59:50.2813117+02:00



V případě, že nastane chybový stav, viz sekce – „Informace o chybách“ Příklad jednoduché chyby:

<error> kod informacja

Parametr ContextReference Tento parametr zadává zákazník, který pozdějí slouží k pozdějšímu sledování komunikace. To umožňuje klientovi propojit jednotlivé zprávy v případě potřeby. Tento parametr je nepovinný, ale doporučujeme jeho použití. Jeho Důvěrné – pouze pro partnery ABC Data s.r.o.

59/67

jedinečnost se doporučuje, aby se jednoznačně identifikovala konkrétní výměná dat.

Příjem zprávy přes systém Gateway Gateway dokáže také přijímat zprávy generované zákazníckým systémem stejným způsobem, jak zákazník přijímá zprávy ze služby Gateway. Link na službu: https://gateway.systemb2b.com/GM/WS/MessageReceiver.asmx 

Web Service (protokol SOAP,HTTP POST), o názvu MessageReceiver s metodou ReceiveMessage podle definice WSDL: https://gateway.systemb2b.com/GM/WS/MessageReceiver.asmx?wsdl XmlMessage: předávána zprava ve formátu Gateway Message libovolného typu. ContextReference: Předaná hodnota zákazníkem.

Gateway Message Dokument obsahuje informace ze systému Gateway, které odebírá zákazník. Schéma dokumentu: https://gateway.systemb2b.com/GM/Schemas/GatewayMessage.xsd Příklad dokument: https://gateway.systemb2b.com/GM/Schemas/GatewayMessage.xml Na základě tohoto dokumentu systém Gateway může zasílat zákazníkovi různé informace tykající se například tvorby objednávky. Z každou zprávou je spojený typ, kód a obsah.


MessageGuid MessageDate MessageModule MessageType MessageCode LangId

Typ String String

String [Guid] DateTime XML String

Začátek dokumentu Sekce informace o dokumentu Typ Dokumentu [GatewayMessage] Verze [1.0] Konec sekce informace o dokumentu Začátek sekce záhlaví ID zprávy Datum stvoření zprávy Modul zdroj zpráv

String

Typ zprávy

String String

Kod zprávy: INFORMATION, ERROR Zkratka jazyka [PL,EN,CS,SK]

MessageTitle MessageText

Popis

Konec sekce záhlaví String String

Titulek zprávy Text zprávy

<Parameters>

Sekce parametrů zprávy

<Parameter>

Sekce jednotlivého parametru String

Název parametru

String

Hodnota parametru Konec sekce jednotlivého parametru

Konec sekce parametrů zprávy

Sekce pro další obsah vložený do zprávy

Name Value

ContentGuid ContentBodyType ContentBodyName

String String [Guid] String

Jednotlivý obsah vložený do dokumentu Jedinečný identifikátor obsahu

String

Název [např. Invoice201111020002.pdf]

Typ textu [Invoice, DeliveryNote atd.]


60/67

ContentFormat ContentBodyEncoding ContentBody

String

Formát [XML, TXT,PDF atd.]

String

Kódování [Base64, PlainText atd.]

String

Obsah

<Parameters>

Sekce parametrů spojených s obsahem Kolejność danych parametrów może się zmienić i w danej wiadomości mogą się pojawić nowe parametry jeżeli zajdzie taka potrzeba biznesowa. Dlatego zawsze należy odczytywać dany parametr (Nazwa Parametru) nie zważając na miejsce jego wystapienia w sekcji. Sekce jednotlivého parametru obsahu

<Parameter>

Name Value

String

Název parametru

String

hodnota parametru

Konec sekce jednotlivého parametru obsahu

Konec sekce parametrů spojených s obsahem

Konec jednotlivého obsahu vloženého do dokumentu

Konec sekce pro další obsah vložený do zprávy

Konec dokumentu

Gateway Ping Testovací zpráva zasílána zákazníkovi. Slouží k testovacím účelům k zjištění spojení mezi systémem Gateway a systémem na stráně zákazníka (Endpoint). MessageModule = GATEWAY MessageType = MESSAGE.PING Příklad: GatewayMessage 1.0
<MessageGuid>7198492C-3702-4846-8767-C9F4DB0CDE7F <MessageDate>2011-11-15T15:45:50.207 <MessageModule> GATEWAY <MessageType>MESSAGE.PING <MessageCode>INFORMATION EN
<MessageTitle/> <MessageText/>

Potvrzení o přijetí žádosti k tvorbě objednávky Zpráva je zaslána přes systém Gateway jako odpověď na žádost k tvorbě nové objednávky. Objednávka ještě není vytvořená v systému. Zpráva pouze informuje, že systém Gateway zaregistroval žádost. MessageModule = GATEWAY.ORDER.PROCESSOR Důvěrné – pouze pro partnery ABC Data s.r.o.

61/67

MessageType = ORDER.REQUEST.CONFIRMATION Parametry:  RqId : [string], číslo žádosti Příklad GatewayMessage 1.0
<MessageGuid>7198492C-3702-4846-8767-C9F4DB0CDE7F <MessageDate>2011-11-15T15:45:50.207 <MessageModule> GATEWAY.ORDER.PROCESSOR <MessageType>ORDER.REQUEST.CONFIRMATION <MessageCode>INFORMATION EN
<MessageTitle/> <MessageText/> <Parameters> <Parameter> RqId 12345

Potvrzení o přijetí žádosti k tvorbě objednávky Zpráva zasílana přes Gateway po vytvoření objednávky v systému E-Commerce. Objednávka je již vytvořená v systému a má přiřazené číslo (OrderId). Můžete ho stáhnout metodou GetOrder služby Order. MessageModule = GATEWAY.ORDER.PROCESSOR MessageType = ORDER.CREATE.CONFIRMATION Parametry:  RqId: [string], číslo žádosti.  OrderId : [string], číslo nově vytvořené objednávky v systému E-Commerce.  ReferenceNumber : [string] číslo objednávky zadané přes zákazníka v žádosti. Příklad: GatewayMessage 1.0 Důvěrné – pouze pro partnery ABC Data s.r.o.

62/67

<MessageGuid>7198492C-3702-4846-8767-C9F4DB0CDE7F <MessageDate>2011-11-15T15:45:50.207 <MessageModule>GATEWAY.ORDER.PROCESSOR <MessageType>ORDER.CREATE.CONFIRMATION <MessageCode>INFORMATION EN
<MessageTitle/> <MessageText/> <Parameters> <Parameter> RqId 12345 <Parameter> OrderId 9112121 <Parameter> ReferenceNumber Z121212S

Informace o chybách Dojde-li během činnosti k chybě, vrací služba xml dokument s popisem chyby. V závislosti na typu vyvolání (GET, POST, SOAP) vrací služba informaci o chybě. Volání HTTP GET, HTTP POST vrací XML dokument s popisem chyby: Například: <error> 10000 NoOrder

Vyvolání SOAP vrací informaci o chybě v souladu se specifikaci standardu SOAP. Součást soap:Fault obsahuje informaci o chybě v XML dokumentu vráceného při voláních GET a POST. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <soap:Fault> soap:Client Server was unable to process the request https://gateway.systemb2b.com/ws/order.asmx <detail> <error> 1000 NoOrder


63/67

Chyba „ServiceNotSupported“ viz. Implementace dané služby (kapitola Architektura)


64/67

Bezpečnost Datový přenos probíhá přes protokol HTTPS, tzn. zprávy jsou kódovány 128bit klíčem protokolu SSL. Aplikace dealera by měla ověřit certifikát serveru a jeho platnost, tedy zda je certifikát serveru vystavený pro *systemb2b.com, a zda je podepsaný: Thawte Premium Server CA.

.


65/67

Adresy služeb Služby dostupné protokolem HTTPS (pozor na HTTPS na začátku adresy dané služby – šifrované spojení SSL) Hlavní stránka obsahující odkazy o všech služeb, šablon a příkladů. https://gateway.systemb2b.com Adresy jednotlivých služeb (tyto adresy používá program na straně partnera) Služba Order poskytuje údaje o objednávce: https://gateway.systemb2b.com/ws/order.asmx Služba OrderProcessing zpřístupňuje údaje o zpracovávaných objednávkách dealera: https://gateway.systemb2b.com/ws/orderprocessing.asmx Služba Invoice předává údaje o fakturách: https://gateway.systemb2b.com/ws/invoice.asmx Služba InvoiceEU se používá k získání údajů faktury na koncového zákazníka: https://gateway.systemb2b.com/ws/invoiceeu.asmx Služba SerialNumbers zpřístupňuje údaje o skenovaných sériových číslech zboží: https://gateway.systemb2b.com/ws/serialnumbers.asmx

Šablony dokladů a vzorové doklady https://gateway.systemb2b.com/schemas/order.xsd - šablona objednávky https://gateway.systemb2b.com/schemas/order.xml - příklad konkrétní objednávky https://gateway.systemb2b.com/schemas/orderbl.xsd - šablona objednávky ORDERBL https://gateway.systemb2b.com/schemas/orderbl.xml - příklad konkrétní objednávky https://gateway.systemb2b.com/schemas/invoice.xsd - šablona faktury invoice https://gateway.systemb2b.com/schemas/invoice.xml - příklad faktury invoice https://gateway.systemb2b.com/schemas/invoices.xsd - šablona seznamu faktur invoicerange https://gateway.systemb2b.com/schemas/invoices.xml - příklad seznamu faktur invoicerange https://gateway.systemb2b.com/schemas/invoicepdf.xsd - šablona seznamu faktur PDF https://gateway.systemb2b.com/schemas/invoicepdf.xml - příklad seznamu faktur PDF https://gateway.systemb2b.com/schemas/invoiceeu.xsd - šablona faktury invoiceEU https://gateway.systemb2b.com/schemas/invoiceeu.xml - příklad faktury invoiceEU https://gateway.systemb2b.com/schemas/serialnumbers.xsd - šablona sériových čísel https://gateway.systemb2b.com/schemas/serialnumbersinvoice.xml - příklad sériových čísel https://gateway.systemb2b.com/schemas/serialnumbersinvoicerange.xml - příklad sériových čísel z více faktur


66/67

Algoritmy stažení dokladů Stažení dokladů faktur Gateway používá několik služeb pro stažení XML dokumentů faktur a objednávek. Díky tomu poskytuje univerzální řešení a každý dealer si může sám zvolit nejvhodnější způsob stažení informací. Dále je uveden vzorový algoritmus stažení dokladů: 1. Zavolání služby OrderProcessing s parametrem vhodného data, 2. Služba vrátí XML dokument s informací o čísle objednávky, faktury a faktuře (tzn. jednoznačnou informaci o vystavených fakturách z daného dne) 3. Odeslat dotaz na službu (pokud není prázdné číslo v daném záznamu) :  Order pro objednávku → parametr ORDERID  Invoice pro fakturu → parametr INVOICEID  InvoiceEU pro fakturu na koncového zákazníka → parametr EUINVOICEID

Stažení dokladů objednávek Mají-li být objednávky staženy již v okamžiku vystavení faktury, může být použit algoritmus v popsaný bodě „stažení dokladů faktur“. Je-li však potřeba stahovat informace o objednávkách v systému A-Partner průběžně, je možné použít systém XML zpráv popsaný v bodě „zprávy v XML“.


67/67

Gateway ver. 3.4 Popis služeb

Recommend Documents