Volta WebService ver. 1.0

Documentation in English

Aby rozpocząć korzystanie z usługi web service firmy Volta Sp z o.o. należy uzyskać oddzielny dostęp(ID, login oraz hasło), który jest niezależny od danych używanych w celu autoryzacji na stronach ivolta.pl. W tym celu prosimy o przesłanie maila na adres webservice@ivolta.pl z prośbą o dostęp do usługi. W mailu prosimy o podanie nazwy firmy, numeru NIP, imienia i nazwiska oraz adresu e-mail osoby koordynującej wdrożenie usługi po Państwa stronie.

Jeśli chcesz zobaczyć plik WSDL kliknij: VoltaWS.wsdl.

Wszelkie pytania oraz uwagi dotyczące usługi prosimy kierować pod adres webservice@ivolta.pl.

Dostępne metody:

Get_Product
Get_Products
Get_Product_Full
Get_Products_Full
Get_Products_Small
Get_Update_Products_Full
Get_Update_Products_Stocks
Get_Product_Url
Get_Product_Deliveries
Get_Categories
Get_Order
Get_Orders
Get_Order_Item
Get_Order_Items
Get_Order_Status
Get_Invoice
Get_Invoices
Get_Invoice_Item
Get_Invoice_Items
Get_Orders_For_Invoice
Get_Address
Get_Addresses
Create_Address
Calculate_Delivery_Cost
Create_Order
Get_Order_Numbers

Dostępne typy danych:

Product
ProductStock
ProductUrl
ProductFull
Delivery
Category
Order
OrderItem
Invoice
InvoiceItem
Address

Opis metod:

Get_Product

Umożliwia pobranie informacji o pojedynczym produkcie z oferty.

Wejście:

ID	int
Login	string
Password	string
ProductCode	string

Wyjście:

Result	boolean
Text	string
Product	Product

Get_Products

Umożliwia pobranie informacji o wszystkich produktach z oferty dla danej kategorii. W przypadku parametr CategoryId przyjmie wartość NULL wówczas pobrane zostaną produkty z wsztystkich kategorii.

Wejście:

ID	int
Login	string
Password	string
CategoryId	int

Wyjście:

Result	boolean
Text	string
Products	array of Product

Get_Product_Full

Umożliwia pobranie wszystkich dostępnych informacji o pojedynczym produkcie z oferty.

Wejście:

ID	int
Login	string
Password	string
ProductCode	string

Wyjście:

Result	boolean
Text	string
Product	ProductFull

Get_Products_Full

Umożliwia pobranie wszystkich dostępnych informacji o wszystkich produktach z oferty. W przypadku gdy parametr CategoryId przyjmie wartość NULL wówczas pobrane zostaną produkty z wsztystkich kategorii.

Wejście:

ID	int
Login	string
Password	string
CategoryId	int

Wyjście:

Result	boolean
Text	string
Products	array of ProductFull

Get_Products_Small

Umożliwia pobranie wszystkich produktów z minimalna ilościa danych. Możliwość ograniczenia przez parametr kategori

Wejście:

ID	int
Login	string
Password	string
CategoryId	int

Wyjście:

Result	boolean
Text	string
Products	array of ProductFull

Get_Update_Products_Full

Umożliwia pobranie wszystkich dostępnych informacji o produktach zmodyfikowanych w ostatnim czasie. W przypadku gdy parametr CategoryId przyjmie wartość NULL wówczas pobrane zostaną produkty z wsztystkich kategorii.

Wejście:

ID	int
Login	string
Password	string
CategoryId	int

Wyjście:

Result	boolean
Text	string
Products	array of ProductFull

Get_Update_Products_Stocks

Umożliwia pobranie listy produktów które zmieniły w ostatnich 24 godzinach stan magazynowy lub cenę. W przypadku gdy parametr CategoryId przyjmie wartość NULL wówczas pobrane zostaną produkty z wsztystkich kategorii.

Wejście:

ID	int
Login	string
Password	string
CategoryId	int

Wyjście:

Result	boolean
Text	string
ProductStocks	array of ProductStock

Get_Product_Url

Umożliwia pobranie adresu URL do produktu w sklepie iVolta

Wejście:

ID	int
Login	string
Password	string
ProductCode	int

Wyjście:

Result	boolean
Text	string
ProductUrl	ProductUrl

Get_Product_Deliveries

Umożliwia pobranie wszystykich aktywnych dostaw dla zadanego produktu.

Wejście:

ID	int
Login	string
Password	string
ProductCode	string

Wyjście:

Result	boolean
Text	string
Deliveries	array of Delivery

Get_Categories

Umożliwia pobranie wszystykich dostępnych kategorii dla produktów.

Wejście:

ID	int
Login	string
Password	string

Wyjście:

Result	boolean
Text	string
Categories	array of Category

Get_Order

Umożliwia pobranie informacji o danym zamówieniu.

Wejście:

ID	int
Login	string
Password	string
OrderNumber	string

Wyjście:

Result	boolean
Text	string
Order	Order

Get_Orders

Umożliwia pobranie informacji o zamówieniach wprowadzonych w danym przedziale czasowym.

Wejście:

ID	int
Login	string
Password	string
DateFrom	date
DateTo	date

Wyjście:

Result	boolean
Text	string
Orders	array of Order

Get_Order_Item

Umożliwia pobranie informacji o pojedynczej pozycji w wybranym zamówieniu.

Wejście:

ID	int
Login	string
Password	string
OrderNumber	string
PositionNumber	int

Wyjście:

Result	boolean
Text	string
OrderItem	OrderItem

Get_Order_Items

Umożliwia pobranie informacji o wszystkich pozycjach w wybranym zamówieniu.

Wejście:

ID	int
Login	string
Password	string
OrderNumber	string

Wyjście:

Result	boolean
Text	string
OrderItems	array of OrderItem

Get_Order_Status

Umożliwia pobranie statusu zamówienia.

Wejście:

ID	int
Login	string
Password	string
OrderNumber	string

Wyjście:

Result	boolean
Text	string
OrderStatus	string

Get_Invoice

Umożliwia pobranie informacji o wybranej fakturze.

Wejście:

ID	int
Login	string
Password	string
InvoiceNumber	string

Wyjście:

Result	boolean
Text	string
Invoice	Invoice

Get_Invoices

Umożliwia pobranie informacji o fakturach, które zostały wystawione w wybranym przedziale czasowym.

Wejście:

ID	int
Login	string
Password	string
DateFrom	date
DateTo	date

Wyjście:

Result	boolean
Text	string
Invoices	array of Invoice

Get_Invoice_Item

Umożliwia pobranie informacji o pojedynczej pozycji w wybranej fakturze.

Wejście:

ID	int
Login	string
Password	string
InvoiceNumber	string
PositionNumber	int

Wyjście:

Result	boolean
Text	string
InvoiceItem	InvoiceItem

Get_Invoice_Items

Umożliwia pobranie informacji o wszystkich pozycjach w wybranej fakturze.

Wejście:

ID	int
Login	string
Password	string
InvoiceNumber	string

Wyjście:

Result	boolean
Text	string
InvoiceItems	array of InvoiceItem

Get_Orders_For_Invoice

Umożliwia pobranie zamówień do wybranej faktury.

Wejście:

ID	int
Login	string
Password	string
InvoiceNumber	string

Wyjście:

Result	boolean
Text	string
Orders	array of Order

Get_Address

Umożliwia pobranie informacji o pojedyńczym adresie klienta.

Wejście:

ID	int
Login	string
Password	string
AddressId	string

Wyjście:

Result	boolean
Text	string
Address	Address

Get_Addresses

Umożliwia pobranie informacji o wszystkich adresach klienta.

Wejście:

ID	int
Login	string
Password	string

Wyjście:

Result	boolean
Text	string
Addresses	array of Address

Create_Address

Umożliwia stworzenie nowego adresu klienta.

Wejście:

ID	int
Login	string
Password	string
Address	Address

Wyjście:

Result	boolean
Text	string
AddressId	int

Calculate_Delivery_Cost

Umożliwia obliczenie kosztu dostawy dla podanych indeksów oraz formy płatności i formy dostawy.

Wejście:

ID	int
Login	string
Password	string
Order	Order
OrderItems	array of OrderItem

Wyjście:

Result	boolean
Text	string
DeliveryCost	float

Create_Order

Umożliwia złożenie zamówienia na wybrany asortyment.

Wejście:

ID	int
Login	string
Password	string
Order	Order
OrderItems	array of OrderItem

Wyjście:

Result	boolean
Text	string
OrderNumber	string

Get_Order_Numbers

Umożliwia pobranie wszystkich numerów danego zamówienia.

Wejście:

ID	int
Login	string
Password	string
OrderNumber	string

Wyjście:

Result	boolean
Text	string
Number	string
ClientNumber	string

Opis typów danych:

Product

Typ do przechowywania danych o pojedynczym produkcie.

Code	string
Price	float
BasePrice	float
Currency	string
Amount	string
AmountBranch	float

ProductStock

Typ do przechowywania danych o stanie magazynowym jednego produktu.

Code	string
Name	string
Price	float
BasePrice	float
Currency	string
Amount	string
AmountBranch	float

ProductUrl

Typ do przechowywania informacji o URL dla jednego produktu

Code	string
Url	string

Product_Full

Typ do przechowywania danych o pojedynczym produkcie. Parametr ShortDescription uzupeniany jest tylko w metodzie Get_Product_Full.

Code	string
Name	string
Price	float
BasePrice	float
Currency	string
Amount	float
AmountBranch	float
ProducerName	string
ProducerCode	string
EAN	string
CategoryId	int
CategoryName	string
LongDescription	string
ShortDescription	string
Specification	string
Image	string
Status	string

Delivery

Typ do przechowywania danych o pojedynczej dostawie.

Number	string
Date	date
Amount	int

Product_Codes

Typ do przechowywania danych o kodach pojedynczego produktu.

Code	string
EAN	string
ProducerCode	string

Order

Typ do przechowywania danych o pojedynczym zamówieniu. W przypadku parametru RealizationMethod jest on wymagany tylko w metodzie Create_Order. W pozostałych metodach przyjmuje wartość NULL.

Dostępne wartości dla parametru RealizationMethod to:
Available - Zamawiam tylko dostępne
Partly - Realizuj częściowo
Waiting - Czekam na wszystko.
Wartość domyślną jest Waiting.

Number	string
CustomerNumber	string
ItemsNumber	int
CreationDate	date
RealizationTerm	date
DeliveryCode	int
DeliveryDescription	string
PaymentCode	int
PaymentDescription	string
NetValue	float
GrossValue	float
AddressId	int
RealizationMethod	string
Remarks	string

OrderItem

Typ do przechowywania danych o pojedynczej pozycji na zamówieniu. W Create_Order parametr Amount może przyjąć maksymalnie wartość 30.

ProductCode	string
PositionNumber	int
Amount	int
SentAmount	int
NetPrice	float
GrossPrice	float
NetValue	float
VatRate	float
IsService	boolean

Invoice

Typ do przechowywania danych o pojedynczej fakturze.

Number	string
ItemsNumber	int
CreationDate	date
NetValue	float
GrossValue	float
PaymentTerm	string
Waybill	string

InvoiceItem

Typ do przechowywania danych o pojedynczej pozycji na fakturze.

ProductCode	string
PositionNumber	int
Amount	int
NetPrice	float
GrossPrice	float
NetValue	float
GrossValue	float
VatRate	float
IsService	boolean

Address

Typ do przechowywania danych o pojedynczym adresie klienta.

Id	int
Description	string
Country	string
City	string
Post	string
PostCode	string
Street	string
HouseNumber	string
FlatNumber	string
AreaCode	string
Phone	string
Email	string
Remarks	string