What is the Northamber Gateway XML Feed?

Northamber's Gateway allows anyone set up with a Gateway account to submit XML over HTTPS to do the following:

• submit bulk orders
• check price & availability
• check the status of orders
• get shipping tracking details
• get invoice details

What is HTTPS?

Hypertext Transfer Protocol over Secure Socket Layer or HTTPS provides authentication and encrypted communication and is widely used on the World Wide Web for security-sensitive communication such as payment transactions and corporate information systems.

How do I set up my XML feed?

In order to use the Gateway service, you first need to set up a Gateway account with Northamber. If you would like to set up an account, click here to contact Technical Support.

Once an account is set up, all data submissions are made to:

https://www.northamber.com/gateway/gateway.aspx

You can use the following submission methods to submit data to Northamber:

• XmlHttp via HTTPS POST - You can use XmlHttp to submit data using HTTPS POST (i.e. form submission). Click here for example XmlHttp Request code.
• File Upload - You can use the file upload button on the Gateway File Upload page to submit XML files. Click here to go to the Gateway XML File Upload page.

How do I place orders through Northamber's Gateway?

You can use an OrderRequest to place orders with Northamber. If successful, an OrderResponse will be returned, indicating that the data has been submitted successfully. Otherwise, you will receive a TransactionError response.

<?xml version="1.0" encoding="utf-8"?>
<OrderRequest version="1.0" xml:lang="en-GB">
	<TransactionHeader username="" password="" />
	<OrderDetails customerPOId="" statusId="" backOrder="" shippingCode="" shipComplete="">
		<BillTo>
			<Address>
				<CustomerName></CustomerName>
				<AddressLine1></AddressLine1>
				<AddressLine2></AddressLine2>
				<AddressLine3></AddressLine3>
				<City></City>
				<County></County>
				<PostCode></PostCode>
				<Country></Country>
				<Email></Email>
			</Address>
		</BillTo>
		<ShipTo>
			<Address>
				<CustomerName></CustomerName>
				<AddressLine1></AddressLine1>
				<AddressLine2></AddressLine2>
				<AddressLine3></AddressLine3>
				<City></City>
				<County></County>
				<PostCode></PostCode>
				<Country></Country>
			</Address>
		</ShipTo>
		<ProductLines>
			<Item lineNumber="" quantity="">
				<SupplierPartID></SupplierPartID>
				<UnitPrice currency="GBP"></UnitPrice>
			</Item>
		</ProductLines>
	</OrderDetails>
</OrderRequest>

The OrderResponse is a simple acknowledgement for receiving of the order message. It does not confirm the placing of the order – it only confirms the receipt of the order and returns a result code back to the purchasing system.

To request more detailed information about a submitted order, you will need to submit an OrderStatusRequest.

1. Orders should be placed before 5.30pm to guarantee next day delivery. Orders placed after that will be delivered the following business day. Use the Saturday (SAT) option if you want next day delivery on a Friday.
2. Next Day AM/PM deliveries must be placed before 5pm and cannot be placed on Saturdays or Sundays. Orders placed on a Friday will arrive in the chosen time slot on the following Monday (Tuesday, if Bank Holiday). Use the Saturday (SAT) option if you want next day delivery on a Friday.
3. Saturday deliveries can only be placed on Fridays before 5pm. Orders must be to the UK mainland only.

• Example XML OrderRequest
• Example OrderResponse
• Example TransactionError

How can I check price & availability?

You can use an PNARequest to check the price and availability of a product. If successful, a PNAResponse will be returned. Otherwise, you will receive a TransactionError response.

<?xml version="1.0" encoding="utf-8"?>
<PNARequest version="1.0" xml:lang="en-GB">
	<TransactionHeader username="" password=""/>
	<PNAList>
		<PNAItem supplierPartId="" manufacturerPartNumber="" />
	</PNAList>
</PNARequest>

For each item, you can submit either a Northamber part number (supplierPartId) or a manufacturer part number (manufacturerPartNumber). If both are supplied, then the supplierPartId will be used.

If the part number is not recognised, then no result will be returned for that item.

• Example XML PNARequest
• Example PNAResponse
• Example TransactionError

How can I check the status of an order?

You can use an OrderStatusRequest to check the status of orders. If successful, an OrderStatusResponse will be returned. Otherwise, you will receive a TransactionError response.

<?xml version="1.0" encoding="utf-8"?>
<OrderStatusRequest version="1.0" xml:lang="en-GB">
	<TransactionHeader username="" password="" />
	<Orders>
		<Order customerPOId="" supplierOrderId="" />
	</Orders>
</OrderStatusRequest>

• Example XML OrderStatusRequest
• Example OrderStatusResponse
• Example TransactionError

How can I check shipment tracking details?

Once an order has been dispatched, you can use an OrderTrackingRequest to obtain details about the shipping status and delivery of your order.

<?xml version="1.0" encoding="utf-8" ?>
<OrderTrackingRequest version="1.0" xml:lang="en-GB">
	<TransactionHeader username="" password=""/>
	<Invoices>
		<Invoice supplierInvoiceId="" />
	</Invoices>
</OrderTrackingRequest>

N.B. You can only track one order at a time.

• Example XML OrderTrackingRequest
• Example XML OrderTrackingResponse
• Example TransactionError

How can I check invoice details?

You can use an InvoiceRequest to obtain invoice details. If successful, an InvoiceResponse will be returned. Otherwise, you will receive a TransactionError response.

Invoices can be called up in two different ways:

You can use the <Invoices> section to specify each individual invoice by the Northamber Invoice ID (supplierInvoiceId), the Northamber Order ID (supplierOrderId) or your own Customer Reference Number (customerPOId):

<?xml version="1.0" encoding="utf-8" ?>
<InvoiceRequest version="1.0" xml:lang="en-GB">
	<TransactionHeader username="" password="" />
	<Invoices>
		<Invoice customerPOId="" supplierInvoiceId="" supplierOrderId="" />
	</Invoices>
</InvoiceRequest>

Or you can specify an order date range using a <DateRange> section:

<?xml version="1.0" encoding="utf-8" ?>
<InvoiceRequest version="1.0" xml:lang="en-GB">
	<TransactionHeader username="" password="" />
	<DateRange orderDateStart="2008/11/10" orderDateEnd="2008/12/05" />
</InvoiceRequest>

Each <InvoiceRequest> should include either a <DateRange> or an <Invoices> section but not both together. The <DateRange> section will be ignored if you have included an <Invoices> section in the same <InvoiceRequest>.

N.B. You will only get the full invoice information if you use an <Invoices> section and specify an ID for each invoice. If you use a <DateRange> section, then you will only get the following details:

• Invoice ID
• Order ID
• Customer Reference
• Order Date
• Delivery Date
• Invoice Date
• Paid In Full (Yes/No)
• Balance

Goods remain strictly the property of Northamber PLC until paid for in full. Strictly subject to our terms & conditions. E&OE.

All InvoiceResponses are copies of invoices.

• Example XML InvoiceRequest using an <Invoices> section
• Example XML InvoiceRequest using a <DateRange> section
• Example InvoiceResponse
• Example TransactionError

Error Messages Returned by the TransactionError File