Orders

If you have a Dub3-powered website then you also have the option of taking payment for products and services online, if you don't already. Normally you would manage your orders by logging into Dub3 and navigating to Modules > Payments in the Dub3 menu.

However, by integrating with the Adido Web Services API you can integrate your orders with third party systems, giving you the opportunity to bring your business processes closer together.

Note: This service requires authentication. Please learn about the authentication process before continuing.
Custom Types

AddNote

http://ws.adido.org.uk/Orders.asmx/AddNote

Add a note to an order. This note will then appear in Dub3, and any future calls to GetNotes.

Parameters

Name Type Description Example
Key String See Authenticate() XXX-XXX-XXX-XXX-XXX
OrderID Integer Order identifier 1
Text String The content of the note This is a note

Response

Name Type Description Example
AddNoteResponse Boolean True = Note added, False = Note failed true

Examples

VB
[ Adding a web reference ]

Dim orders As New AdidoOrders.Orders
Dim success as Boolean = orders.AddNote("XXX-XXX-XXX-XXX-XXX", 1, "This is a note")

C#
[ Adding a web reference ]

AdidoOrders.Orders orders = new AdidoOrders.Orders();
bool success = orders.AddNote("XXX-XXX-XXX-XXX-XXX", 1, "This is a note");

PHP

$wsdl="http://ws.adido.org.uk/orders.asmx?wsdl";
$client=new soapclient($wsdl, 'wsdl');
$param=array('Key'=>'XXX-XXX-XXX-XXX-XXX', 'OrderID'=>'1', 'Text'=>'This is a note');
echo $client->call('AddNote', $param);

HTTP GET

http://ws.adido.org.uk/orders.asmx/AddNote?Key=XXX-XXX-XXX-XXX-XXX&OrderID=1&Text=This is a note

GetAll

http://ws.adido.org.uk/Orders.asmx/GetAll

Return all orders taken via your Dub3 website, including customer details, delivery information and product data.

Parameters

Name Type Description Example
Key String See Authenticate() XXX-XXX-XXX-XXX-XXX

Response

Name Type Description Example
GetAllResponse ArrayOfOrder Array of Order objects, comprising of User, Address, Item and Note objects - See XML Schema

Example

VB
[ Adding a web reference ]

Dim orders As New AdidoOrders.Orders
Dim myOrders As AdidoOrders.Order() = orders.GetAll(key)

C#
[ Adding a web reference ]

AdidoOrders.Orders orders = new AdidoOrders.Orders();
AdidoOrders.Order[] myOrders = orders.GetAll(key);

PHP

$wsdl="http://ws.adido.org.uk/orders.asmx?wsdl";
$client=new soapclient($wsdl, 'wsdl');
$param=array('Key'=>'XXX-XXX-XXX-XXX-XXX');
echo $client->call('GetAll', $param);

HTTP GET

http://ws.adido.org.uk/orders.asmx/GetAll?Key=XXX-XXX-XXX-XXX-XXX

GetBeforeDate

http://ws.adido.org.uk/Orders.asmx/GetBeforeDate

Return all orders which occoured before the supplied date and time.

Parameters

Name Type Description Example
Key String See Authenticate() XXX-XXX-XXX-XXX-XXX
OrderDate DateTime Date and time for which order must be been registered before 2011-01-01 00:00:00
PageSize Integer The number of results to return. Zero will return all results. 0
PageIndex Integer The page number, in combination with page size. Zero is the first index. 0

Response

Name Type Description Example
GetBeforeDateResult ArrayOfOrder Array of Order objects, comprising of User, Address, Item and Note objects - See XML Schema

Example

VB
[ Adding a web reference ]

Dim orders As New AdidoOrders.Orders
Dim myOrders As AdidoOrders.Order() = orders.GetBeforeDate(key, Date.Now(), 0, 0)

C#
[ Adding a web reference ]

AdidoOrders.Orders orders = new AdidoOrders.Orders();
AdidoOrders.Order[] myOrders = orders.GetBeforeDate(key, System.DateTime.Now(), 0, 0);

PHP

$wsdl="http://ws.adido.org.uk/orders.asmx?wsdl";
$client=new soapclient($wsdl, 'wsdl');
$param=array('Key'=>'XXX-XXX-XXX-XXX-XXX', 'OrderDate'=>'2011-01-01 00:00:00', 'PageSize'=>'0', 'PageIndex'=>'0');
echo $client->call('GetBeforeDate', $param);

HTTP GET

http://ws.adido.org.uk/orders.asmx/GetBeforeDate?Key=XXX-XXX-XXX-XXX-XXX&OrderDate=2011-01-01=&PageSize=0&PageIndex=0

GetBeforeID

http://ws.adido.org.uk/Orders.asmx/GetBeforeID

Return all orders which occoured before the supplied ID.

Parameters

Name Type Description Example
Key String See Authenticate() XXX-XXX-XXX-XXX-XXX
OrderID Integer ID for which order must be been registered before 100
PageSize Integer The number of results to return. Zero will return all results. 0
PageIndex Integer The page number, in combination with page size. Zero is the first index. 0

Response

Name Type Description Example
GetBeforeIDResult ArrayOfOrder Array of Order objects, comprising of User, Address, Item and Note objects - See XML Schema

Example

VB
[ Adding a web reference ]

Dim orders As New AdidoOrders.Orders
Dim myOrders As AdidoOrders.Order() = orders.GetBeforeID(key, 100, 0, 0)

C#
[ Adding a web reference ]

AdidoOrders.Orders orders = new AdidoOrders.Orders();
AdidoOrders.Order[] myOrders = orders.GetBeforeID(key, 100, 0, 0);

PHP

$wsdl="http://ws.adido.org.uk/orders.asmx?wsdl";
$client=new soapclient($wsdl, 'wsdl');
$param=array('Key'=>'XXX-XXX-XXX-XXX-XXX', 'OrderID'=>'100', 'PageSize'=>'0', 'PageIndex'=>'0');
echo $client->call('GetBeforeID', $param);

HTTP GET

http://ws.adido.org.uk/orders.asmx/GetBeforeID?Key=XXX-XXX-XXX-XXX-XXX&OrderID=100=&PageSize=0&PageIndex=0

GetByID

http://ws.adido.org.uk/Orders.asmx/GetByID

Return an order where the OrderID matches the supplied OrderID.

Parameters

Name Type Description Example
Key String See Authenticate() XXX-XXX-XXX-XXX-XXX
OrderID Integer Order identifier 50

Response

Name Type Description Example
GetByIDResult Order Order object, comprising of User, Address, Item and Note objects - See XML Schema

Example

VB
[ Adding a web reference ]

Dim orders As New AdidoOrders.Orders
Dim order As AdidoOrders.Order = orders.GetByID(key, 55)

C#
[ Adding a web reference ]

AdidoOrders.Orders orders = new AdidoOrders.Orders();
AdidoOrders.Order order = orders.GetByID(key, 55);

PHP

$wsdl="http://ws.adido.org.uk/orders.asmx?wsdl";
$client=new soapclient($wsdl, 'wsdl');
$param=array('Key'=>'XXX-XXX-XXX-XXX-XXX', 'OrderID'=>'55');
echo $client->call('GetByID', $param);

HTTP GET

http://ws.adido.org.uk/orders.asmx/GetByID?Key=XXX-XXX-XXX-XXX-XXX&OrderID=55

GetFromDate

http://ws.adido.org.uk/Orders.asmx/GetFromDate

Return all orders which occoured after the supplied date and time.

Parameters

Name Type Description Example
Key String See Authenticate() XXX-XXX-XXX-XXX-XXX
OrderDate DateTime Date and time for which order must be been registered after 2011-01-01 00:00:00
PageSize Integer The number of results to return. Zero will return all results. 0
PageIndex Integer The page number, in combination with page size. Zero is the first index. 0

Response

Name Type Description Example
GetFromDateResult ArrayOfOrder Array of Order objects, comprising of User, Address, Item and Note objects - See XML Schema

Example

VB
[ Adding a web reference ]

Dim orders As New AdidoOrders.Orders
Dim myOrders As AdidoOrders.Order() = orders.GetFromDate(key, Date.Now(), 0, 0)

C#
[ Adding a web reference ]

AdidoOrders.Orders orders = new AdidoOrders.Orders();
AdidoOrders.Order[] myOrders = orders.GetFromDate(key, System.DateTime.Now(), 0, 0);

PHP

$wsdl="http://ws.adido.org.uk/orders.asmx?wsdl";
$client=new soapclient($wsdl, 'wsdl');
$param=array('Key'=>'XXX-XXX-XXX-XXX-XXX', 'OrderDate'=>'2011-01-01 00:00:00', 'PageSize'=>'0', 'PageIndex'=>'0');
echo $client->call('GetFromDate', $param);

HTTP GET

http://ws.adido.org.uk/orders.asmx/GetFromDate?Key=XXX-XXX-XXX-XXX-XXX&OrderDate=2011-01-01=&PageSize=0&PageIndex=0

GetFromID

http://ws.adido.org.uk/Orders.asmx/GetFromID

Return all orders which occoured after the supplied ID.

Parameters

Name Type Description Example
Key String See Authenticate() XXX-XXX-XXX-XXX-XXX
OrderID Integer ID for which order must be been registered after 100
PageSize Integer The number of results to return. Zero will return all results. 0
PageIndex Integer The page number, in combination with page size. Zero is the first index. 0

Response

Name Type Description Example
GetFromIDResult ArrayOfOrder Array of Order objects, comprising of User, Address, Item and Note objects - See XML Schema

Example

VB
[ Adding a web reference ]

Dim orders As New AdidoOrders.Orders
Dim myOrders As AdidoOrders.Order() = orders.GetFromID(key, 100, 0, 0)

C#
[ Adding a web reference ]

AdidoOrders.Orders orders = new AdidoOrders.Orders();
AdidoOrders.Order[] myOrders = orders.GetFromID(key, 100, 0, 0);

PHP

$wsdl="http://ws.adido.org.uk/orders.asmx?wsdl";
$client=new soapclient($wsdl, 'wsdl');
$param=array('Key'=>'XXX-XXX-XXX-XXX-XXX', 'OrderID'=>'100', 'PageSize'=>'0', 'PageIndex'=>'0');
echo $client->call('GetFromID', $param);

HTTP GET

http://ws.adido.org.uk/orders.asmx/GetFromID?Key=XXX-XXX-XXX-XXX-XXX&OrderID=100=&PageSize=0&PageIndex=0

GetItems

http://ws.adido.org.uk/Orders.asmx/GetItems

Return all items (products, vat, delivery) for an order.

Parameters

Name Type Description Example
Key String See Authenticate() XXX-XXX-XXX-XXX-XXX
OrderID Integer Order identifier 50

Response

Name Type Description Example
GetItemsResult ArrayOfItem Array of Item objects - See XML Schema

Example

VB
[ Adding a web reference ]

Dim orders As New AdidoOrders.Orders
Dim items As AdidoOrders.Item() = orders.GetItems(key, 50)

C#
[ Adding a web reference ]

AdidoOrders.Orders orders = new AdidoOrders.Orders();
AdidoOrders.Item[] items = orders.GetItems(key, 50);

PHP

$wsdl="http://ws.adido.org.uk/orders.asmx?wsdl";
$client=new soapclient($wsdl, 'wsdl');
$param=array('Key'=>'XXX-XXX-XXX-XXX-XXX', 'OrderID'=>'55');
echo $client->call('GetItems', $param);

HTTP GET

http://ws.adido.org.uk/orders.asmx/GetItems?Key=XXX-XXX-XXX-XXX-XXX&OrderID=55

GetNotes

http://ws.adido.org.uk/Orders.asmx/GetNotes

Return all notes for an order.

Parameters

Name Type Description Example
Key String See Authenticate() XXX-XXX-XXX-XXX-XXX
OrderID Integer Order identifier 50

Response

Name Type Description Example
GetNotesResponse ArrayOfNote Array of Note objects - See XML Schema

Example

VB
[ Adding a web reference ]

Dim orders As New AdidoOrders.Orders
Dim notes As AdidoOrders.Note() = orders.GetNotes(key, 50)

C#
[ Adding a web reference ]

AdidoOrders.Orders orders = new AdidoOrders.Orders();
AdidoOrders.Note[] notes = orders.GetNotes(key, 50);

PHP

$wsdl="http://ws.adido.org.uk/orders.asmx?wsdl";
$client=new soapclient($wsdl, 'wsdl');
$param=array('Key'=>'XXX-XXX-XXX-XXX-XXX', 'OrderID'=>'55');
echo $client->call('GetNotes', $param);

HTTP GET

http://ws.adido.org.uk/orders.asmx/GetNotes?Key=XXX-XXX-XXX-XXX-XXX&OrderID=55

Search

http://ws.adido.org.uk/Orders.asmx/Search

Search all orders.

Parameters

Name Type Description Example
Key String See Authenticate() XXX-XXX-XXX-XXX-XXX
Params SearchParams Search parameters object
PageSize Integer The number of results to return. Zero will return all results. 0
PageIndex Integer The page number, in combination with page size. Zero is the first index. 0

Response

Name Type Description Example
GetFromDateResult ArrayOfOrder Array of Order objects, comprising of User, Address, Item and Note objects - See XML Schema

Example

VB
[ Adding a web reference ]

Dim orders As New AdidoOrders.Orders
Dim myOrders As AdidoOrders.Order() = orders.Search(key, New orders.SearchParams, 0, 0)

C#
[ Adding a web reference ]

AdidoOrders.Orders orders = new AdidoOrders.Orders();
AdidoOrders.Order[] myOrders = orders.Search(key, new orders.SearchParams(), 0, 0);

SetStatus

http://ws.adido.org.uk/Orders.asmx/SetStatus

Update the status of an order.

Parameters

Name Type Description Example
Key String See Authenticate() XXX-XXX-XXX-XXX-XXX
OrderID Integer Order identifier 50
StatusID Integer Status identifier 14
StatusID

  • 1 - Awaiting confirmation
  • 2 - Order aborted
  • 3 - Awaiting notification
  • 4 - Awaiting phone payment
  • 5 - Awaiting cheque payment
  • 6 - Awaiting shipping quote
  • 7 - Account payment
  • 8 - Awaiting clearance
  • 9 - Not authorised
  • 10 - Payment error
  • 11 - Tampered
  • 12 - Order complete
  • 13 - Awaiting stock
  • 14 - Goods despatched
  • 15 - Payment refunded
  • 16 - Awaiting account payment
  • 17 - Subscription payment
  • 18 - Deferred payment
  • 19 - Awaiting review
  • 20 - Review complete

Response

Name Type Description Example
SetStatusResponse Boolean True = Status updated, False = Status failed to update true

Example

VB
[ Adding a web reference ]

Dim orders As New AdidoOrders.Orders
Dim success as Boolean = orders.SetStatus(key, 50, 14)

C#
[ Adding a web reference ]

AdidoOrders.Orders orders = new AdidoOrders.Orders();
bool success = orders.SetStatus(key, 50, 14);

PHP

$wsdl="http://ws.adido.org.uk/orders.asmx?wsdl";
$client=new soapclient($wsdl, 'wsdl');
$param=array('Key'=>'XXX-XXX-XXX-XXX-XXX', 'OrderID'=>'50', 'StatusID'=>'14');
echo $client->call('SetStatus', $param);

HTTP GET

http://ws.adido.org.uk/orders.asmx/SetStatus?Key=XXX-XXX-XXX-XXX-XXX&OrderID=50&StatusID=14

Documentation

Resources