This document contains a definition of the Consignor Shipment Server, which uses a standard definition of a shipment object, transported using REST and serialized using JSON.
NOTE: Shipment Server does not handle printing of the labels of any kind on the client side. Developer has to implement a solution that fits their environment.
Printing from a Web browser
If information about how to implement client printing from a web browser is needed; I recommend to search on Google for that information as it depends on what would fit your solution.
Using an ActiveX control or / and Java script could be a solution.
Printing from a Windows application
An easy way to print from a windows application is to use the Zebra label printers own language EPL or ZPL (in this case you need a zebra printer or a printer that supports it).
When storing the label type EPL / ZPL E.G. in a file or use it from a stream, you can send it to the printer by using "move" or "copy" file to a shared printer.
Printing PNG and PDF in windows it could be done through a print dialog or automated with E.G a process using Win32API or using unmanaged code with winspool.drv and Marshaling,
to mention a few.
Submitted shipments are kept in the database for 90 days, which means that each night shipments older than 90 days are deleted. This is done to keep the database as compact as possible and to ensure high performance.
The shipment data would be visible / available in the Consignor Portal.
Accessing the Web Service
The connection is done through a HTTPS secure connection on the standard port for secure connections, 443.
Each customer using the Shipment Server has a key that is set at the Actor level. This key must be passed in all the requests. Failure to include the key would result in the failure of the request.
The webserver is accessed using REST, so it uses standard HTTPS method using POST for all methods. The POST variables can be encoded as multipart/form-data or urlencoded.
Numeric fields with a value of 0 (zero) are not included in the JSON string exported by the web service, a value of
0 (zero) being the default.
Empty strings are not included in the JSON string exported by the web service.
Dates and Timestamps are formatted in the ISO 8601 standard. An example of a date is: 2012-06-27 and for a timestamp: 2012-06-27T10:25
Some fields are sent as enums, meaning that they are sent as an integer value, but the value has a certain meaning. See the Appendix section for complete list of the possible values for these fields.