Welcome to AOB Web Services API (v1.0)
This article contains information and details associate with the AOB Web API. This API was developed to create a basic call and response mechanism for quickly transmitting a Distributors “Purchase Order” items directly to their Shopping Cart at http://distributors.artofbeauty.com :
The AOB API currently consists of two calls:
- Clear Shopping Cart Call – This Call transmits instruction whether to clear data currently in the Shopping Cart.
- Add Items to Shopping Cart Call – Used to transmit items and quantities to the shopping cart.
All calls are made to a secure address using https post and name/value pairs.
The AOB API currently makes the following Responses (Responses are given in XML format):
“ResponseCode” indicates level of success where:
0 – Success
1– Partial Success
2 – Failure
Sample “Calls” & “Responses”:
Clear Shopping Cart:
Call
url to call: https://distributors.artofbeauty.com/content/Shoppingcart/
parameters: LoginName={LoginName/Email}&password={Your Password}&ClearCart=true
Response Examples:
<?xml version="1.0" encoding="utf-8"?>
<Response>
<ResponseCode>2</ResponseCode>
<ResponseMessage>Incorrect Login Name or
Password</ResponseMessage>
</Response>
Response Indicates: Login Name or Password is incorrect.
Solution : Login to https://distributors.artofbeauty.com and change/validate login.
<?xml version="1.0" encoding="utf-8"?>
<Response>
<ResponseCode>0</ResponseCode>
<ResponseMessage>Success</ResponseMessage>
</Response>
Response Indicates: The request was successful and shopping cart is cleared.
Add Items to Shopping Cart:
Call
url to call: https://distributors.artofbeauty.com/content/Addtoorder/
parameters: LoginName={LoginName/Email}&password={Your Password}&item.1={PartNumber1}&qty.1={QTY1)&item.2={PartNumber2}&qty.2={QTY2)....&item.N={PartNumberN}&qty.N={QTYN)
Item numbers start with 1 and should be continuous (example: item.1 , item.2) . If a number is missing the API will not process remaining items.
PartNumber is case sensitive. For time being all part numbers in upper case but in a future AOB reserves the right to use mixed case naming policy.
Response Examples:
<?xml version="1.0" encoding="utf-8"?>
<Response>
<ResponseCode>0</ResponseCode>
<AcceptedItems>
<item>
<partnumber>ZP001</partnumber>
<qty>1</qty>
<price>3.00</price>
</item>
<item>
<partnumber>QTLIP01</partnumber>
<qty>3</qty>
<price>12.00</price>
</item>
</AcceptedItems>
</Response>
Response Indicates: Success
<?xml version="1.0" encoding="utf-8"?>
<Response>
<ResponseCode>1</ResponseCode>
<AcceptedItems>
<item>
<partnumber>QTLIP01</partnumber>
<qty>3</qty>
<price>12.00</price>
</item>
</AcceptedItems>
<RejectedItems>
<item>zp001</item>
</RejectedItems>
</Response>
Response Indicates: Partial Success
<?xml version="1.0" encoding="utf-8"?>
<Response>
<ResponseCode>2</ResponseCode>
<RejectedItems>
<item>zp001</item>
<item>QLIP01</item>
</RejectedItems>
</Response>
Response Indicates: Failure.
ADDITIONAL SUPPORT PLEASE EMAIL: support@aobmail.com
