XML Shipping Interface

From AOB Help
Jump to: navigation, search

We support a simple XML interface for shipping and order processing purposes. This interface is used by our shipping partners to better streamline your shipping processes.

Contents

Basics

<AOB>
  <auth>
    <username>your AOB username</username>
    <password>your AOB password</password>
  </auth>
  { request blocks } ...
</AOB>

get_orders

  • The get_orders Request block:
<get_orders>
 <ship_list> ship list code </ship_list>
</get_orders>

  • This will give you the list of order IDs that are in the given ship list.
The ship lists are:
'N' (New List)
'H' (Hold List)
'A' (Aux Hold List)
Or a number corresponding to the list number you have setup in your AOB account (1-99).

get_order

  • The get_order Request block:
<get_order>
 <order_id> the order ID from the get_orders call </order_id>
</get_order>

  • This takes a single argument of order_id and will return all available information on the order in question in XML format.

ship_order

  • The ship_order call:
<ship_order>
  <order_id>..</order_id>
  <action>(ship|cancel)</action>
  <email>(1|0)</email>
  <dc>..</dc>
  <actual_postage>..</actual_postage>
  <mail_class>..</mail_class>
  <carrier>..</carrier> 
</ship_order>

  • This will attempt to process an order, queue to update the confirmation on the venue, and mark the order with the supplied tracking information on AOB.
  • The mail_class is the standard endicia mail class:
FIRST
PRIORITY
PRIORITYEXPRESS
STANDARDPOST
MEDIAMAIL
BOUNDPRINTEDMATTER
INTLFIRST
INTLPRIORITY
INTLPRIORITYEXPRESS
  • Carrier should be the standardized abbreviation for your mail carrier:
usps
ups
fedex
dhl
dhl_global

update_order

  • The update_order call:
<update_order>
 <order_id>..</order_id>
 <aob_comments>..</aob_comments>
</update_order>

  • This will update certain fields on your orders. It was actually added for a special circumstance so only updating the aob_comments is currently implemented
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox