Order API Interface Specification

Table of Content

1. Introduction
1. Overview
2. How to send requests
2. Basic Concepts
1. Message Transport
2. Authentication
3. JSON Message
1. ORD_AuthenticationRQ/RS
1. Support Operations
2. Business Rules
3. ORD_AuthenticationRQ
4. Sample Call Url Request
5. ORD_AuthenticationRS
6. Sample Message Response Success
7. Sample Message Response Not Success
2. ORD_GetOrderRQ/RS
1. Support Operations
2. Business Rules
3. ORD_GetOrderRQ
4. Sample Call Url Request
5. ORD_GetOrderRS
6. Sample Message Response
3. ORD_GetCustomerRQ/RS
1. Support Operations
2. Business Rules
3. ORD_GetCustomerRQ
4. Sample Call Url Request
5. ORD_GetCustomerRS
6. Sample Message Response
7. Sample Message Response Not Success
4. ORD_UpdateOrderRQ/RS
1. Support Operations
2. Business Rules
3. ORD_UpdateOrderRQ
4. Sample Call Url Request
5. ORD_UpdateOrderRS
6. Sample Message Response
5. ORD_ErrorRS
1. ORD_ErrorRS 'Status' Values List

1 Introduction

1.1 Overview

The use of this interface for communication with the exPub Service Providers using Call URL over a HTTPS protocol. The interface supports the exchange of:

• Order List
• Customer Information

1.2 How to send requests

Test environment data response: https://api.expubwebsites.net/OrderApi/GetOrder?test=true (Get Order List)
https://api.expubwebsites.net/OrderApi/GetInformationCustomer?test=true (Get Customer Information)

The addresses to which to send requests are the following: https://api.expubwebsites.net/OrderApi/Authentication?token={token get from Service Providers} (Check Authentication)
https://api.expubwebsites.net/OrderApi/GetOrder?token={token get from Service Providers} (Get Order List)
https://api.expubwebsites.net/OrderApi/GetInformationCustomer?token={token get from Service Providers}&order_id={order_id} (Get Customer Information)
https://api.expubwebsites.net/OrderApi/UpdateOrder?token={token get from Service Providers}&{Parameter} (Update Order)

You must send your token and parameter request. This can be achieved through various programming methods, which will vary according to the programming language you're using. API will return json string to your program.

2. Basic Concepts

2.1 Message Transport

All messages are transported via HTTPS GET/POST.

2.2 Authentication

The OrderAPI provides the credentials necessary for consuming the WebServices being offered to the receiving system. Security credentials consist of: Token – A login for authentication that is provided by the OrderAPI at the time of the order e.g. the requesting system should have the ability to connect to different URLs. Connections to the different servers may use the same account information

3 JSON Message

3.1 ORD_AuthenticationRQ/RS

This message identifies the initial request for checking authentication.

3.1.1 Support Operations

Portal requests information about the authentication.

3.1.2 Business Rules

This message is only sent from the portal to the Service Providers. Only requests received via GET/POST method will be accepted.

3.1.3 ORD_AuthenticationRQ

This message identifies the initial request for order data. Using this message the requester may retrieve status authentication.

Parameter	Required(R) Optional(O)	Notes	Data Type/ Possible values
token	R	A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message include an echo token with the identical value	String Length:1 -128

3.1.4 Sample Call Url Request

https://api.expubwebsites.net/OrderApi/Authentication?token=340FDFAE958CD5335A8CD22B390A6F76497ED23BFBBC877467

3.1.5 ORD_AuthenticationRS

The ORD_AuthenticationRS is the message used to indicate the status of processing the ORD_AuthenticationRQ message. This message returns json that meet the requested criteria and/or Warnings, or Errors if the request did not succeed.

Element(E)	Name	Notes	Data Type/ Possible values
E	API	API Name	String Length:1 -20
E	Version	The message version indicated by a decimal value.	Decimal
E	Token	A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message include an echo token with the identical value	String Length:1 -128
E	Status	Identifies the status of the call url request.	Integer
E	Message	Message call url request of status	String Length: 1 - 500
E	Request	Date Request	TimeStamp

3.1.6 Simple Message Response Success

{"API":"ORD_Authentication","Version":"0.1","Token":"340FDFAE958CL5335A8CD22B390A6F76497ED23BFBAC877467","Status":2,"Message":"Authentication Success","Request":"2015-06-11T09:56:12.6124108+07:00"}

3.1.6 Simple Message Response Not Success (Wrong Token)

{"API":"ORD_Authentication","Version":"0.1","Token":"340FDFAE958CD5335A8CD22B390A6F76497ED23BFBAC87746","Status":6,"Message":"Error Authentication Wrong Token !","Request":"2015-06-11T10:00:01.5397846+07:00"}

3.2 ORD_GetOrderRQ/RS

This message identifies the initial request for order data.

3.2.1 Support Operations

Portal requests information about the order

3.2.2 Business Rules

This message is only sent from the portal to the Service Providers. Only requests received via GET/POST method will be accepted.

3.2.3 ORD_GetOrderRQ

This message identifies the initial request for order data. Using this message the requester may retrieve a list of order

Parameter	Required(R) Optional(O)	Notes	Data Type/ Possible values
token	R	A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message include an echo token with the identical value	String Length:1 -128
start_date	O	format date	String / (yyyy-MM-dd)
end_date	O	format date	String / (yyyy-MM-dd)

3.2.4 Sample Message Call Url Request

https://api.expubwebsites.net/OrderApi/GetOrder?token=340FDFAE958CD5335A8CD22B390A6F76497ED23BFBAC877467

3.2.4 ORD_GetOrderRS

The ORD_GetOrderRS is the message used to indicate the status of processing the ORD_GetOrderRQ message. This message returns a list of order that meet the requested criteria and/or Warnings, or Errors if the request did not succeed.

Element(E)	Name	Notes	Data Type/ Possible values
E	API	API Name	String Length:1 -20
E	Version	The message version indicated by a decimal value.	Decimal
E	Token	A reference for additional message identification, assigned by the requesting host system. When a request message includes an echo token the corresponding response message include an echo token with the identical value	String Length:1 -128
E	Status	Identifies the status of the call url request.	Integer
E	Message	Message call url request of status	String Length: 1 - 500
E	Request	Date Request	TimeStamp
E	FoundItem	Count Order	Integer
E	Orders
E	Orders.OrderId	The Order that uniquely identifies	Integer
E	Orders.ParentOrderId	Identity Order Another Order	Integer
E	Orders.OrderNumber	Name number of order	String Length: 1 - 20
E	Orders.OrderSubtotal	The total amount not including any associated tax	Decimal
E	Orders.OrderTax	The price of tax	Decimal
E	Orders.OrderTotal	The total amount not including any associated tax	Decimal
E	Orders.OutstandingAmount	Outstanding balance	Decimal
E	Orders.OrderDiscount	The price of discount	Decimal
E	Orders.OrderCurrencyCode	Currency code	String Length: 1 - 3 / Possible values: USD, THB
E	Orders.OrderStatusId	Order Status	Integer / Possible values: 15 = ReadyToInvoice 30 = Complete
E	Orders.ShippingFee	The price of sending	Decimal
E	Orders.PaymentFee	The price of payment	Decimal
E	Orders.PaymentStatusId	Payment Status	Integer / Possible values: 10 = Pending 20 = Authorize 30 = Paid 35 = PartiallyRefunded 40 = Refunded 50 = Voided 60 = NotPaid
E	Orders.PaidDate	Paid Date	TimeStamp
E	Orders.DeliveryDate	Delivery Date	TimeStamp
E	Orders.PaymentMethodName	Text type in pay	String Length: 1 - 100
E	Orders.Notes	Information from customer	String Length: 1 - 1000
E	Orders.TrackingNumber	Number of EMS	String Length: 1 - 100
E	Orders.DateCreated	Date of order	DateTime
E	Order.OurRef	Our Refferent Number	Integer
E	Order.YourRef	Your Refferent Number	Integer
E	Orders.BillingFirstName	First Name	String Length: 1 - 100
E	Orders.BillingLastName	Last Name	String Length: 1 - 100
E	Orders.BillingPhoneNumber	Telephone number assigned to a single	String Length: 1 - 50
E	Orders.BillingMobileNumber	Telephone number assigned to a single	String Length: 1 - 50
E	Orders.BillingFaxNumber	Fax Number	String Length: 1 - 50
E	Orders.BillingEmail	Used to pass detailed email information	String Length: 1 - 255
E	Orders.BillingCompany	Company Name	String Length: 1 - 100
E	Orders.BillingAddress1	Contact Address	String Length: 1 - 100
E	Orders.BillingAddress2	Contact Address	String Length: 1 - 100
E	Orders.BillingCity	City Name	String Length: 1 - 100
E	Orders.BillingStateProvince	State Province Name	String Length: 1 - 100
E	Orders.BillingZipPostalCode	Zip code	String Length: 1 - 30
E	Orders.BillingCountry	Country Name	String Length: 1 - 100
E	Orders.BillingCountryId	Country Code	String Length: 1 - 2 / Possible values: US, TH, ES,..
E	Orders.ShippingStatusId	Shipping Status	Integer / Possible values: 10 = NotYetShipped 20 = Shipped 30 = ShippingNotRequired
E	Orders.ShippingFirstName	First Name	String Length: 1 - 100
E	Orders.ShippingLastName	Last Name	String Length: 1 - 100
E	Orders.ShippingPhoneNumber	Telephone number assigned to a single	String Length: 1 - 50
E	Orders.ShippingMobileNumber	Telephone number assigned to a single	String Length: 1 - 50
E	Orders.ShippingFaxNumber	Fax Number	String Length: 1 - 50
E	Orders.ShippingEmail	Used to pass detailed email information	String Length: 1 - 255
E	ShippingCompany	Company Name	String Length: 1 - 100
E	Orders.ShippingAddress1	Contact Address	String Length: 1 - 100
E	Orders.ShippingAddress2	Contact Address	String Length: 1 - 100
E	Orders.ShippingCity	City Name	String Length: 1 - 100
E	Orders.ShippingStateProvince	State Province Name	String Length: 1 - 100
E	Orders.ShippingZipPostalCode	Zip code	String Length: 1 - 30
E	Orders.ShippingCountry	Country Name	String Length: 1 - 100
E	Orders.ShippingCountryId	Country Code	String Length: 1 - 2 / Possible values: US, TH, ES,..
E	Orders.PersonLegacyId	External Person Id	Integer
E	Orders.CompanyLegacyId	External Company Id	Integer
E	Orders.OrderProductVariants	Information about a product in order
E	Orders.OrderProductVariants.OrderProductVariantId	Product Variant Id	Integer
E	Orders.OrderProductVariants.UnitPrice	The price of product	Decimal
E	Orders.OrderProductVariants.Quantity	The quantity of product	Integer
E	Orders.OrderProductVariants.OrderItemCode	Code of product	String Length: 1 - 50
E	Orders.OrderProductVariants.OrderItemDescription	Description of product	String Length: 1 - 200

3.2.5 Sample Message Response

{"API":"ORD_GetOrder","Version":"0.1","Token":"340FDFAE958CD5335A8CD22B390A6F76497ED23BFBAC877467","Status":1,"Message":"Success","Request":"2015-06-17T14:01:50.9078506+07:00","FoundItem":2,"Orders":[{"OrderId":9036,"ParentOrderId":9035,"OrderNumber":"1","OrderSubtotal":295.0000,"OrderTax":0.0000,"OrderTotal":295.0000,"OutstandingAmount":0.0000,"OrderDiscount":0.0000,"OrderCurrencyCode":"USD","OrderStatusId":30,"ShippingFee":0.0000,"PaymentFee":0.0000,"PaymentStatusId":30,"PaidDate":null,"DeliveryDate":null,"PaymentMethodName":"PayPal Express","Notes":null,"TrackingNumber":null,"DateCreated":"2014-03-09T01:53:06.343","OurRef":null,"YourRef":9315,"BillingFirstName":"Bill","BillingLastName":"Smith","BillingPhoneNumber":"1-123-456","BillingMobileNumber":null,"BillingEmail":"{{{bill@billscompany.com}}}","BillingFaxNumber":null,"BillingCompany":null,"BillingAddress1":"2000 Main Street","BillingAddress2":"","BillingCity":"Smallville","BillingStateProvince":"Florida","BillingZipPostalCode":null,"BillingCountry":null,"BillingCountryId":null,"ShippingStatusId":10,"ShippingFirstName":"Bill","ShippingLastName":"Smith","ShippingPhoneNumber":"1-123-456","ShippingMobileNumber":null,"ShippingEmail":"{{{bill@billscompany.com}}}","ShippingFaxNumber":null,"ShippingCompany":null,"ShippingAddress1":"2000 Main Street","ShippingAddress2":"","ShippingCity":"Smallville","ShippingStateProvince":"Florida","ShippingZipPostalCode":"20152","ShippingCountry":null,"ShippingCountryId":null,"OrderProductVariants":[{"OrderProductVariantId":12345,"UnitPrice":295.0000,"Quantity":1,"OrderItemCode":null,"OrderItemDescription":null}]},{"OrderId":5432,"ParentOrderId":0,"OrderNumber":"ORD-541","OrderSubtotal":295.0000,"OrderTax":0.0000,"OrderTotal":295.0000,"OutstandingAmount":295.0000,"OrderDiscount":0.0000,"OrderCurrencyCode":"USD","OrderStatusId":30,"ShippingFee":0.0000,"PaymentFee":0.0000,"PaymentStatusId":10,"PaidDate":null,"DeliveryDate":null,"PaymentMethodName":"Direct Checkout","Notes":null,"TrackingNumber":null,"DateCreated":"2014-03-09T02:24:57.867","OurRef":null,"YourRef":9315,"BillingFirstName":"Bill","BillingLastName":"Smith","BillingPhoneNumber":"1-123-456","BillingMobileNumber":null,"BillingEmail":"{{{bill@billscompany.com}}}","BillingFaxNumber":null,"BillingCompany":null,"BillingAddress1":"2000 Main Street","BillingAddress2":"","BillingCity":"Smallville","BillingStateProvince":"Florida","BillingZipPostalCode":"20152","BillingCountry":null,"BillingCountryId":null,"ShippingStatusId":10,"ShippingFirstName":"Bill","ShippingLastName":"Smith","ShippingPhoneNumber":"1-123-456","ShippingMobileNumber":null,"ShippingEmail":"bill@billscompany.com","ShippingFaxNumber":null,"ShippingCompany":null,"ShippingAddress1":"2000 Main Street","ShippingAddress2":"","ShippingCity":"Smallville","ShippingStateProvince":"Florida","ShippingZipPostalCode":"20152","ShippingCountry":null,"ShippingCountryId":null,"OrderProductVariants":[{"OrderProductVariantId":11706,"UnitPrice":295.0000,"Quantity":1,"OrderItemCode":null,"OrderItemDescription":null}]}]}