How our Web Service Process works
What is needed to deploy the Web Service.
- Login Credentials -
customer_number and customer_password assigned by ABP.
- Provisioning Server URL -
Your Provisioning Server address for us to point the devices at. Different Manufacturers work different ways.
Pre-provisioning: In order to provide 100% quality with minimal delay, we pre-boot every device before they can be used on an order. Please click here to see how it works.
- Shipment Update URL -
When the device ships, our server needs to browse to a web page on your server to give you information about the order. It will do this once for each device in the order.
We can give you back the following parameters to this URL:
- [SS_ID] : The request_number we sent back on the original SOAP reply.
- [LN] : The line_number you sent in the original request.
- [PO] : The po_number you sent in the original SOAP request.
- [SN] : The Serial Number for the device
- [MAC] : MAC Address for the device
- [TN] : The tracking_number for the package.
- 12 characters is Fedex Express
- 13 characters is UPS
- 14 characters is UPS
- 15 characters is Fedex Ground
- 20 characters is USPS
- 24 characters is UPS
- Google can find them all
- [PN] : The product_name you sent in the original SOAP request.
Here is an example showing how your page should look when browsed.
- Return URL - [Optional Additional Charge]
If ABP is going to handle your Reverse Logistics (See "Returns" below), we have a process set up to notifiy you when a device is received. We will browse a "Return URL" that you build. This URL should accept the following parameters in the query string:
- [PO] The PO you gave to us in the original SOAP order.
- [SN] Serial Number of the device.
- [MAC] MAC Address of the device if available.
- [LN] The Line Number that the device was associated to.
- [Device_Condition] = Device Condition on Receipt.
- 1 = New (Can be reshipped as new)
- 2 = Used (Can be reshipped as Used [marking on box/device, missing cables, scratches, etc])
- 6 = Unusable (Device is destroyed)
- [Condition_Note] = Notes about the device's condition.
Please program your Return URL to: 1. Set the device's provisioning back to our generic ABP SIP account. 2. Set your server back so that we can use that device on a new order.
With or with our the "Return URL" built out, you will also receive an email of the return.
High Level Process
- Pre-Provisioning -
See Here
- Ordering -
You send us an XML SOAP Request and we reply with the request_number of the order and the file_number if you sent a file. We can also send you a confirmation email if you request it in the service.
- We work the order -
When the ABP shipping person processes the order, several things will happen:
- We scan the SN and/or MAC of the device into our system.
- Our system will browse to your server giving you data in C above.
- Shipping -
We ship the order as specified.
- Billing -
Sales Orders are automatically put into our billing system to bill for the charges. These are batched nightly after the device has been provisioned and shipped. At this time, you can see the order via your Partner Portal.
- Denials -
Same as "Returns" below.
- Returns - [Optional Additional Charge]
Please have the customer insert a "Return Authorization" into the shipment. It should have the following elements:
- Shipping Address
[Your Company Name] Return Department 1850 Crown Drive Dallas, TX 75019
- [Description of the device failure] or [Instructions for us to put the device back into your private inventory and re-ship]
- A number where we can fax this form (any other papers) for your records.
- Keep the following in mind:
i) If the customer marks on the manufacturer box or device, we can't re-ship it as new. ii) Ideally, they should use a shipping method with tracking capabilities iii) All parts and peices need to be returned.  iv) The device should be inserted into a plain brown or carrier supplied cardboard shipping box with adequate padding. Bags don't protect them.
- Last, have them write your company name prominently on the brown shipping box only.
When the ABP shipping person processes the return, several things will happen:
- We scan the SN and/or MAC of the device into our system.
- Our system will browse to your server giving you data in D above.
- Shipping Claims -
If you need to file a shipping claim, please send and email to ss_orders@abptech.com with the order number and tracking number and we will file it for you.
Things to think about when developing your application:
- Replacing Failures in the field -
You will probably want to ship a new device to the customer before they ship the old one back. This means you'll need to be able to associate mulitiple devices to the same SIP account. And be able to accept returns of just one device back when the end user sends the old one back.
Our system is designed so that you have us ship a new device to the customer, and then have the customer send the old/broken device back after the new one is received.
- Used Devices -
Inevitably there will be returns of "used" looking devices. Plan to either let them pile up here in our warehouse, or send orders instructing us to send out a used address. We try our best to refurb devices by adding back originial parts, removing markings, etc, but there is an extent as to how much we can do.
- Handling Errors -
When our server can not accept your order, we will return "error-<description>" in the SOAP Request "status" field (the "request_number" field will also be empty). It is highly recommended that you have an easy way for your users to fix the errored data and re-submit the SOAP request easily.
|