Order
AddToBasket
Description
Adds an item to your basket. Currently only adding numbers to your basket is available. Please check back later for updates to this functions features.
Parameters
| string type | The type of item you are adding. Currently only support 'number'. |
| string number | The number you are adding to your basket. |
| RequiredOptional | |
Request
- XML
- PHP
- Ruby
- Python
- C#
<?xml version="1.0"?>
<NoveroRequest>
<Request target="Order" name="AddToBasket" id="TestRequest">
<number>01245830173</number>
<type>number</type>
</Request>
</NoveroRequest>
<?php
require_once('TTNCApi.php');
$Api = new TTNCApi('<username>', '<password>', '<VKey>');
$Request = $Api->NewRequest('Order', 'AddToBasket', 'TestRequest');
$Request->SetData('number', '01245830173');
$Request->SetData('type', 'number');
$Api->MakeRequests();
$Response = $Api->GetResponseFromId('TestRequest');
?>
require TTNCApi
api = TTNCApi.new('<username>', '<password>', '<vkey>')
request = api.newrequest('Order', 'AddToBasket', 'TestRequest')
request.setdata('number', '01245830173')
request.setdata('type', 'number')
api.makerequest()
p request.getresponse()
api = TTNCApi('<username>', '<password>', '<vkey>')
request = api.newrequest('Order', 'AddToBasket', 'TestRequest')
request.setdata('number', '01245830173')
request.setdata('type', 'number')
api.makerequest()
p request.getresponse()
using System;
using TTNCApi;
class Program
{
static void Main(string[] args)
{
TTNCApi api = new TTNCApi("<username>", "<password>", "<vkey>");
TTNCRequest request = api.NewRequest("Order", "AddToBasket", "TestRequest");
request.setData("number", "01245830173");
request.setData("type", "number");
api.MakeRequests();
TTNCParser dic = request.GetResponse();
}
}
Response
<?xml version="1.0"?>
<NoveroResponse>
<Response target="Order" name="AddToBasket" Code="200" RequestId="TestRequest">
<ResponseMessage>Added to Basket</ResponseMessage>
<Success>Added to Basket</Success>
</Response>
</NoveroResponse>
ViewBasket
Description
Display items currently in your basket. The basket is only stored across requests if using a SessionId as specified in Auth::SessionLogin.
Parameters
This function takes no parameters.
Request
- XML
- PHP
- Ruby
- Python
- C#
<?xml version="1.0"?>
<NoveroRequest>
<Request target="Order" name="ViewBasket" id="TestRequest"/>
</NoveroRequest>
<?php
require_once('TTNCApi.php');
$Api = new TTNCApi('<username>', '<password>', '<VKey>');
$Request = $Api->NewRequest('Order', 'ViewBasket', 'TestRequest');
$Api->MakeRequests();
$Response = $Api->GetResponseFromId('TestRequest');
?>
require TTNCApi
api = TTNCApi.new('<username>', '<password>', '<vkey>')
request = api.newrequest('Order', 'ViewBasket', 'TestRequest')
api.makerequest()
p request.getresponse()
api = TTNCApi('<username>', '<password>', '<vkey>')
request = api.newrequest('Order', 'ViewBasket', 'TestRequest')
api.makerequest()
p request.getresponse()
Response
<?xml version="1.0"?>
<NoveroResponse>
<Response target="Order" name="ViewBasket" Code="200" RequestId="View1">
<Items>
<Item>
<Code>STANO</Code>
<Description>Standard 01234 Number - 01234******</Description>
<Display>Standard Number</Display>
<Charge>10.00</Charge>
<Number>01234******</Number>
</Item>
...
</Items>
<ItemTotals>
<TotalNet>10.00</TotalNet>
<TotalVAT>2.00</TotalVAT>
<TotalGrand>12.00</TotalGrand>
</ItemTotals>
</Response>
</NoveroResponse>
RemoveFromBasket
Description
Removes a specified item from your basket. The basket is only stored across requests if using a SessionId as specified in Auth::SessionLogin.
Parameters
| string code | To remove a number from your basket, use the appropriate code which can be retrieved from Order::ViewBasket
|
||||||||||||
| string number | The number to remove from your basket. | ||||||||||||
| RequiredOptional | |||||||||||||
Request
- XML
- PHP
- Ruby
- Python
- C#
<?xml version="1.0"?>
<NoveroRequest>
<Request target="Order" name="RemoveFromBasket" id="TestRequest">
<code>STANO</code>
<number>01245830173</number>
</Request>
</NoveroRequest>
<?php
require_once('TTNCApi.php');
$Api = new TTNCApi('<username>', '<password>', '<VKey>');
$Request = $Api->NewRequest('Order', 'RemoveFromBasket', 'TestRequest');
$Request->SetData('code', 'STANO');
$Request->SetData('number', '01245830173');
$Api->MakeRequests();
$Response = $Api->GetResponseFromId('TestRequest');
?>
require TTNCApi
api = TTNCApi.new('<username>', '<password>', '<vkey>')
request = api.newrequest('Order', 'RemoveFromBasket', 'TestRequest')
request.setdata('code', 'STANO')
request.setdata('number', '01245830173')
api.makerequest()
p request.getresponse()
api = TTNCApi('<username>', '<password>', '<vkey>')
request = api.newrequest('Order', 'RemoveFromBasket', 'TestRequest')
request.setdata('code', 'STANO')
request.setdata('number', '01245830173')
api.makerequest()
p request.getresponse()
using System;
using TTNCApi;
class Program
{
static void Main(string[] args)
{
TTNCApi api = new TTNCApi("<username>", "<password>", "<vkey>");
TTNCRequest request = api.NewRequest("Order", "RemoveFromBasket", "TestRequest");
request.setData("code", "STANO");
request.setData("number", "01245830173");
api.MakeRequests();
TTNCParser dic = request.GetResponse();
}
}
Response
<?xml version="1.0"?>
<NoveroResponse>
<Response target="Order" name="RemoveFromBasket" Code="200" RequestId="TestRequest">
<ResponseMessage></ResponseMessage>
<Success></Success>
</Response>
</NoveroResponse>
PlaceOrder
Description
Places an order for the items in the current basket. The basket is only stored across requests if using a SessionId as specified in Auth::SessionLogin.
Parameters
| int TokenId* | The unique identifier for a Token (saved card) on the account associated with the current API session. TokenIds can be retrieved from NoveroUser::GetCards(). |
| int CV2* | The last 3-4 digits on the signature strip of the specified card. This must be provided for security reasons. |
| RequiredOptional | |
*If you are billed for Numbers and Services in arrears, these fields are not required, otherwise you must ensure card details are saved to your account before using this API function.
Request
- XML
- PHP
- Ruby
- Python
- C#
<?xml version="1.0"?>
<NoveroRequest>
<Request target="Order" name="PlaceOrder" id="TestRequest">
<TokenId>12883</TokenId>
<CV2>****</CV2>
</Request>
</NoveroRequest>
<?php
require_once('TTNCApi.php');
$Api = new TTNCApi('<username>', '<password>', '<VKey>');
$Request = $Api->NewRequest('Order', 'PlaceOrder', 'TestRequest');
$Request->SetData('TokenId', '12883');
$Request->SetData('CV2', '****');
$Api->MakeRequests();
$Response = $Api->GetResponseFromId('TestRequest');
?>
require TTNCApi
api = TTNCApi.new('<username>', '<password>', '<vkey>')
request = api.newrequest('Order', 'PlaceOrder', 'TestRequest')
request.setdata('TokenId', '12883')
request.setdata('CV2', '****')
api.makerequest()
p request.getresponse()
api = TTNCApi('<username>', '<password>', '<vkey>')
request = api.newrequest('Order', 'PlaceOrder', 'TestRequest')
request.setdata('TokenId', '12883')
request.setdata('CV2', '****')
api.makerequest()
p request.getresponse()
using System;
using TTNCApi;
class Program
{
static void Main(string[] args)
{
TTNCApi api = new TTNCApi("<username>", "<password>", "<vkey>");
TTNCRequest request = api.NewRequest("Order", "PlaceOrder", "TestRequest");
request.setData("TokenId", "12883");
request.setData("CV2", "****");
api.MakeRequests();
TTNCParser dic = request.GetResponse();
}
}
Response
<?xml version="1.0"?>
<NoveroResponse>
<Response target="Order" name="PlaceOrder" Code="200" RequestId="TestRequest">
<OrderStatus>OK</OrderStatus>
<InvoiceId>138800</InvoiceId>
</Response>
</NoveroResponse>