Please visit our new TrackAbout Knowledge Base at https://supportkb.trackabout.com for the most-up-to-date documentation on TrackAbout and TrackAbout Mobile.
Difference between revisions of "Proof Of Delivery Service"
Lsilverman (talk | contribs) |
Lsilverman (talk | contribs) |
||
| Line 32: | Line 32: | ||
* 'Bill To' address of the order | * 'Bill To' address of the order | ||
* 'Ship To' address of the order | * 'Ship To' address of the order | ||
| − | * Document Number of the order(the same as the Invoice Number provided as a parameter) | + | * Document Number of the order (the same as the Invoice Number provided as a parameter) |
* Customer Number of the customer that placed the order | * Customer Number of the customer that placed the order | ||
* Date on which the order was entered | * Date on which the order was entered | ||
| Line 48: | Line 48: | ||
** Total quantity of the item that was actually shipped | ** Total quantity of the item that was actually shipped | ||
** Total quantity of the item that was actually returned | ** Total quantity of the item that was actually returned | ||
| − | |||
=== Usage === | === Usage === | ||
Revision as of 17:50, 10 February 2010
Overview
This web service allows you to generate a document representing the details of an order for a provided order/invoice number.
Service Protocol
TrackAbout has chosen to implement and architect this web service using what is typically referred to as REST style architecture. This is a resource oriented architecture that uses standard HTTP actions (i.e. GET, POST, DELETE, etc...) to manipulate resources exposed as URLs. Standard HTTP Status Codes are used for success and error codes.
More information on REST architecture can be found at the following resources:
Template:Web Service Authentication
Report Parameters
The parameters for the report are provided via query string values. See the #Usage section below for more information on creating the query string. All parameters must have a valid value provided or the web service will return an error code.
| Friendly Name | Query String Name | Description |
|---|---|---|
| Invoice Number | invoice | This number is sometimes referred to as the Invoice Number, Document Number, or Order Number. The value provided for this will be used to locate the order/delivery/return data within the TrackAbout database to generate the report. |
Validations and Restrictions
The following validations are applicable to the parameters provided to this report. If one or more of these validations fail the web service will return an HTTP error code with a message indicating why validation failed.
- If the provided Invoice Number could not be matched to order and delivery/return data, the report will not be run and a validation error will be returned instead.
Report Output
The resulting report data will be rendered into a PDF document that will be returned to the caller. The following data will be included in the document:
- 'Sold By' address of the order
- 'Ship From' address of the order
- 'Bill To' address of the order
- 'Ship To' address of the order
- Document Number of the order (the same as the Invoice Number provided as a parameter)
- Customer Number of the customer that placed the order
- Date on which the order was entered
- Date on which the order was shipped
- Shipment method used for the order
- Name of the person who placed the order
- Name of the person who entered the order
- Payment terms of the order
- PO Number of the order
- Line items representing the original products ordered and actual quantities shipped / returned:
- Line Number of the order as it was originally submitted to TrackAbout
- Product Code of the item that was ordered/shipped/returned
- Product Description of the item that was ordered/shipped/returned
- Total quantity of the item that was originally ordered
- Total quantity of the item that was actually shipped
- Total quantity of the item that was actually returned
Usage
- Web Service URL: https://www.trackabout.com/ws/ProofOfDelivery.asmx
- Allowed HTTP Actions: GET
- Input: All parameters are provided in the query string. When creating the query string, use the query string key values specified in the #Report Parameters section above for the corresponding parameter. Note: Be sure to properly URL Encode each parameter value. More information on URL Encoding: Wikipedia: URL Encoding
Full Example URL for Invoice Number = ABC123
https://www.trackabout.com/ws/ProofOfDelivery.asmx?invoice=ABC123
- Output: The resulting report data will be rendered into a PDF file and be returned as binary data in the HTTP response. A 'Content-Disposition' HTTP header will be added with the value 'attachment; filename=<generatedFileName>' where <generatedFileName> will be a unique file name with a sequence number generated from the current system time appended to it.