RESTful Web Services Reference Guide External Publication 3
Table of Contents
1 Audience, Scope, and Purpose.......................................................................................................... 5
2 Web Services Overview..................................................................................................................... 5
2.1 Description ................................................................................................................................ 5
2.1.1 Prerequisites ..................................................................................................................... 5
2.1.2 Result Formats .................................................................................................................. 5
2.2 REst API Method Summary ....................................................................................................... 5
2.3 Header Information .................................................................................................................. 6
3 Create Shipment ............................................................................................................................... 6
3.1 Shipment Summary ................................................................................................................... 6
3.2 Shipment Request XML/JSON ................................................................................................... 6
3.3 Shipment Data Elements-Schema Information ........................................................................ 7
3.4 Shipment Response ................................................................................................................... 9
3.5 Shipment Response Data Elements-Schema Information ...................................................... 10
3.5.1 Shipment Responses .......................................................... Error! Bookmark not defined.
4 Cancel Pickup .................................................................................................................................. 10
4.1 Cancel Pickup Summary .......................................................................................................... 10
4.2 Cancel Pickup Request XML/JSON .......................................................................................... 11
4.3 Cancel Pickup Data Elements-Schema Information ................................................................ 11
4.4 Cancel Pickup Response XML/JSON ........................................................................................ 11
4.5 Cancel Pickup Response Data Elements-Schema Information ............................................... 11
5 Get Label Image .............................................................................................................................. 11
5.1 Create Label Summary ............................................................................................................ 11
5.2 Get Label Request XML/JSON ................................................................................................. 11
5.3 Get Label Response XML/JSON ............................................................................................... 12
5.4 Get Label Response Properties ............................................................................................... 12
6 Request Pickup (without Label Creation) ....................................................................................... 12
6.1 Request Pickup Summary ....................................................................................................... 12
6.2 Request Pickup Request XML/JSON ........................................................................................ 12
6.3 Request Pickup Data Elements-Schema Information ............................................................. 13
6.4 Request Pickup Response XML/JSON ..................................................................................... 13
6.5 Request Pickup Data Elements-Schema Information ............................................................. 13
6.6 Request Pickup Response Properties ......................................... Error! Bookmark not defined.
