| Version: 2.0 |
| |
|
| 2008-12-17 |
Added ship_address_company which is optional. If this is available it will print out on the shipping label. |
| 2008-07-09 |
If you set "provisioned" to no, our server will not hit your Shipment Update URL with that item. |
| 2008-02-20 |
Adding ship_address_line3 to the WSDL |
| 2008-02-13 |
Adding FEDEX-FIMS as a shipment_service. Select this for Affordable International Shipments. |
| 2007-12-10 |
Added "OverrideValidation=1" to the shipment_special option. If your order keeps getting a validation error, add this and we will accept the order even if validation fails. |
| 2007-10-08 |
We are now validating GROUND shipments against carriers for improved accuracy.
Several things could happen:
A. shipment_method could be changed from GROUND to GROUNDHOMEDELIVERY.
B. ship_address_line1, ship_address_city, ship_address_state, ship_address_zip, and/or ship_address_country could be changed to the validated address.
BUG: Our address validation provider joins "ship_address_line1" and "ship_address_line2" into one field and then returns it to us. So we end up with the entire address in "ship_address_line1". The bug is that we don't blank out "ship_address_line2" yet so it shows up twice. In most cases this is not a problem since line2 is normally just STE 200, APT 2D, etc and duplications do not hurt. When we trust the validation more, we'll start blanking ship_address_line2 appropriately.
|
| 2007-09-20 |
Added ability to get a report on Private Inventory quantities. Please send a request for this report to ss_orders@abptech.com.
Data can be sent via 2 transport methods:
A. XML attached to an email.
B. XML sent in an http POST.
Following is a list of what each device_condition represents:
| |
| device_condition | Explanation |
|---|
| 0 | Shipped out to a customer. |
| 1 | Brand New. Available to Ship. |
| 2 | Used/Scratched/Dented. Available to Ship as Used. |
| 4 | Received back from customer for warranty work.
Sending to Manufacturer for replacement/repair. |
| 6 | Unusable and Not under warranty, ABP will ask for further instructions. |
| 100 | Under review. |
| 900 | The device has been added to our datbase table, but has not been booted/redirected to your server yet. |
| 998 | Replaced by Manufacturer |
| 999 | Bad - Shipped back to customer, Destroyed, Etc... |
|
|
| 2007-07-11 |
Adding Shipping Insurance to all orders where we generate the Shipping Label.
"Insurance=0" can be put into the "shipment_special" field to stop this since Shipping Insurance makes the shipping charges a little more expensive. |
| 2007-07-02 |
Removed DELIVERWITHOUTSIGNATURE from "shipment_special" since FedEx only allows this in certain circumstances that are out of our ability to calculate. |
| 2007-05-31 |
Extended "Order Query Answer" to return details for each device. |
| 2007-04-26 |
Changed "itemlist::line_number" to a string |
| 2007-04-23 |
Depreciated "item_name". |
| 2007-04-23 |
Removed "ResidentialDelivery=1" from the shipment_special option as it is not needed. |
| 2007-04-02 |
Added "shipment_service". |
| 2007-04-02 |
Added "shipment_special". |
| 2007-04-02 |
Removed "product_name". |
| 2007-04-02 |
Added "New_Order_ItemList" array. |
| 2007-04-02 |
Replaced "ship_label_url" with "order_label_url" and "item_label_url". |
| Version: 1.4 |
| 2007-02-20 |
Added the ability that we can send the "product_name" back to your server in the Shipment Update stage |
| 2006-11-08 |
Added "ship_phone" field. (see description below) |
| 2006-10-18 |
Shortened "action". (see description below) |
| 2006-10-17 |
Added action="replacement:blind" to be used for shipping consignment devices. |
| 2006-10-17 |
Beta: Added ability to receive either "plain_paper" or "PNG4X6" Thermal Printer labels.
If left blank or non-existent, default is "plain_paper". |
| Version: 1.3 |
| 2006-07-17 |
Fixed - Emails originating from the service contain extraneous characters at the end.
It does not affect the rest of the process. |
| 2006-04-05 |
Added "tracking_number" to Query_Order function return. |
| 2006-02-27 |
Added query function (Query_Order). |
| Version: 1.2 |
| 2006-01-18 |
Added Ability to send File Attachment. |
| 2006-01-17 |
Added Ability to receive confirmation via an Email. |
|
|
| Array | Element Name | Description | ver |
| New_Order_Array |
|
|
|
| New_Order_Array |
customer_number |
Assigned to you by ABP |
1.2 |
| New_Order_Array |
customer_password |
Assigned to you by ABP |
1.2 |
| New_Order_Array |
action |
Available Actions:
- test
Does not create new order
- new
Used to blind ship a new device.
- replacement
Used to blind ship a used device. Ask your sales person.
|
1.2 |
| New_Order_Array |
customer_name |
Your Company Name |
1.2 |
| New_Order_Array |
customer_email |
Your Email Address |
1.2 |
| New_Order_Array |
send_me_email |
yes/no To receive an email confirmation, put yes. |
1.2 |
| New_Order_Array |
po_number |
Unique transaction number from your System.
- 25 characters max.
- This must be unique because we will pass this back to you in subsequent processes.
- Please use only ascii characters with no spaces. |
1.2 |
| New_Order_Array |
shipment_service |
Allowed Values:
US and Canada:
- GROUND [default]
- 3DAY
- 2DAY
- OVERNIGHT
- USPS-PRIORITY
- USPS-EXPRESS
- Special Carrier (Approved in advanced/subject to processing fee)
International:- FEDEX-INTERNATIONAL_GROUND (Canada and Puerto Rico Only)
- FEDEX-INTERNATIONAL_ECONOMY
- FEDEX-INTERNATIONAL_PRIORITY
- FEDEX-INTERNATIONAL_FIRST
- FEDEX-FIMS
- USPS-PRIORITY_INTERNATIONAL
- USPS-EXPRESS_MAIL_INTERNATIONAL
- Special Carrier (Approved in advance/subject to processing fee)
|
2.0 |
| New_Order_Array |
shipment_special |
Allowed Values:
Blank or Comma Separated List of the following:- SignatureOption=[DIRECT or INDIRECT or ADULT]
- SaturdayDelivery=1
- Insurance=0
- OverrideValidation=1
Note: Insurance=0 turns off Shipping Insurance from the carrier.
Note: Use OverrideValidation=1 if you know the address is right but keep getting Address Validation errors. |
2.0 |
| New_Order_Array |
ship_phone |
Ship-to Phone Number for Fedex/UPS/etc to call in case of a problem.
10 digits (ie. 9728311600) |
1.4 |
| New_Order_Array |
ship_address_company |
Ship-to Company Name (i.e. ABP Technology) |
2.0 |
| New_Order_Array |
ship_address_name |
Ship-to Name (i.e. John Doe) |
1.2 |
| New_Order_Array |
ship_address_line1 |
Main address line (ie "1850 Crown Drive") |
1.2 |
| New_Order_Array |
ship_address_line2 |
2nd Address line (ie Apt #, Suite #1850, etc) |
1.2 |
| New_Order_Array |
ship_address_line3 |
3rd Address line (used for International orders) |
2.0 |
| New_Order_Array |
ship_address_city |
City to ship to. |
1.2 |
| New_Order_Array |
ship_address_state |
State to ship to | US Standard Canada Standard |
1.2 |
| New_Order_Array |
ship_address_zip |
ZIP/Postal Code to ship to |
1.2 |
| New_Order_Array |
ship_address_country |
Country to ship to | Use the ISO 3166 standard i.e. "US" or "CA" |
1.2 |
| New_Order_Array |
order_label_url |
optional-
URL you want printed for the order. |
1.2 |
| New_Order_Array |
comments |
optional-
Comments |
1.2 |
| |
|
|
|
| New_Order_ItemList |
|
|
|
| New_Order_ItemList |
line_number |
Should be unique per order.
Notice that there is no quantity. We expect each device ordered to be on a separate line_number so that the labels can be printed if need be. |
2.0 |
| New_Order_ItemList |
item_id |
item_id(s) available to everybody can be seen here: http://reseller.abptech.com/web-links.
If you have a private SKU, we'll supply this information to you. |
2.0 |
| New_Order_ItemList |
item_name |
Depreciated - item_name(s) available to everybody can be seen here: http://reseller.abptech.com/web-links.
If you have a private SKU, we'll supply this information to you.
Note: The server will look up the item_id you sent and use this as the item name. |
2.0 |
| New_Order_ItemList |
item_label_url |
optional-
URL you want us to print for each device. |
2.0 |
| New_Order_ItemList |
provisioned |
yes/no - Do you want the device provisioned to your server before shipping?
Product Lines that can be automatically provisioned:
- Snom VOIP Phones
- Aastra VOIP Phones
- Linksys VOIP Phones
- Linksys VOIP ATAs
- Polycom VOIP Phones
We can help you build a suitable provisioning server.
Check with ABP about automatic provisioning of other Product Lines.
|
2.0 |
| |
|
|
|
| New_Order_Answer |
|
|
|
| New_Order_Answer |
request_number |
Our unique request number which the device will reference when it comes back to you to get it's provisioning |
1.2 |
| New_Order_Answer |
status |
See Order_Query_Answer |
1.2 |
| New_Order_Answer |
file_number |
optional: The file number if you sent a file. |
1.2 |
| New_Order_Answer |
number_of_items |
The number of items the service accepted for an integrity check. |
2.0 |
| |
|
|
|
| Order_Query_Answer |
|
|
|
| Order_Query_Answer |
request_number |
See New_Order_Array |
1.0 |
| Order_Query_Answer |
date_received |
See New_Order_Array |
1.0 |
| Order_Query_Answer |
action |
See New_Order_Array |
1.0 |
| Order_Query_Answer |
status |
| Status | Description |
|---|
| Received | This means that we have received the order and it is waiting to be worked. |
| Cust_Complete | This means that we have generated the shipping label, associated the SNs and tracking numbers to the different item_lines, and returned the data to you via the "Shipment Update URL". |
| Complete | This order is complete. |
| Cust_Failed | We received an error (lack of OK) from your "Shipment Update URL" |
| ns_failed | The ordered errored when being put into our billing system. |
| something_failed | An unexpected error cropped up. We will investigate this and update you if needed. |
| cancelled - by abp | We cancelled the order for some reason. |
| cancelled - by customer | You asked us to cancel the order before we worked it. |
| Denied-1 | We have received the device back from your customer in New condition. |
| Denied-2 | We have received the device back from your customer in Used condition. |
| Credited-Denied-1 | We have updated our inventory system showing the device returned. |
| Credited-Denied-2 | We have updated our inventory system showing the device returned. |
|
1.0 |
| Order_Query_Answer |
tracking_number |
See New_Order_Array |
1.0 |
| Order_Query_Answer |
customer_number |
See New_Order_Array |
1.0 |
| Order_Query_Answer |
serial_num |
See New_Order_Array |
1.0 |
| Order_Query_Answer |
product_name |
See New_Order_Array |
1.0 |
| Order_Query_Answer |
itemlist |
See Order_Query_ItemList |
2.0 |
| Order_Query_Answer |
po_number |
See New_Order_Array |
2.0 |
| Order_Query_Answer |
customer_name |
See New_Order_Array |
2.0 |
| Order_Query_Answer |
customer_email |
See New_Order_Array |
2.0 |
| Order_Query_Answer |
send_email |
See New_Order_Array |
2.0 |
| Order_Query_Answer |
shipment_service |
See New_Order_Array |
2.0 |
| Order_Query_Answer |
shipment_special |
See New_Order_Array |
2.0 |
| Order_Query_Answer |
ship_phone |
See New_Order_Array |
2.0 |
| Order_Query_Answer |
ship_address_company |
See New_Order_Array |
2.0 |
| Order_Query_Answer |
ship_address_name |
See New_Order_Array |
2.0 |
| Order_Query_Answer |
ship_address_line1 |
See New_Order_Array |
2.0 |
| Order_Query_Answer |
ship_address_line2 |
See New_Order_Array |
2.0 |
| Order_Query_Answer |
ship_address_city |
See New_Order_Array |
2.0 |
| Order_Query_Answer |
ship_address_state |
See New_Order_Array |
2.0 |
| Order_Query_Answer |
ship_address_zip |
See New_Order_Array |
2.0 |
| Order_Query_Answer |
ship_address_country |
See New_Order_Array |
2.0 |
