Warning
WARNING: The TrackAbout MetaWiki has been deprecated and is no longer being updated.

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 "RESTful Proof of Delivery API"

From TrackAbout MetaWiki
Jump to navigation Jump to search
(Add minimum field requirements)
 
m (Yrobinet moved page RESTful Point of Delivery API to RESTful Proof of Delivery API: Renaming for SEO purposes)
 
(2 intermediate revisions by 2 users not shown)
Line 12: Line 12:
 
* Route - same route for that truck for all time
 
* Route - same route for that truck for all time
 
** Determines in which mobile units the order appears.
 
** Determines in which mobile units the order appears.
** If the config, <code>Location and Route are Optional for Point of Delivery</code>, is set to True and Point of Delivery is enabled, every device will use Point of Delivery whether or not it is assigned to a truck and route. If set to False only devices assigned to a truck and route will use Point of Delivery; devices that are not assigned will use standard delivery.
+
** If the config, <code>LocationAndRouteAreOptionalForPaperlessDelivery</code>, is set to True and Proof of Delivery is enabled <code>(IsPaperlessDeliveryFeatureEnabled)</code>, every device will use Proof of Delivery whether or not it is assigned to a truck and route. If set to False only devices assigned to a truck and route will use Proof of Delivery; devices that are not assigned will use standard delivery.
* Truck’s Location Id
 
** Determines in which mobile units the order appears.
 
* Trip - minimum of one trip per route/truck each day.
 
** Best to change the name daily. You could make the date part of the name and change that.
 
** Puts orders into groups by Trip Number
 
** Can be the entire route or a subset of the route.
 
** Preferable to bring it over with the Order during Integration. Can use the Make a Trip page, which is cumbersome.
 
 
* Order Date
 
* Order Date
 
* Planned Delivery Date - needs to be today or in the future.
 
* Planned Delivery Date - needs to be today or in the future.

Latest revision as of 18:49, 17 November 2015

Pre-Delivery (Pending) Orders API

Minimum Field Requirements

  • Order #
    • Order # may be optional.
    • If using POST /orders/pending/batch, then orderNumber is required.
    • If using PUT /orders/pending/{OrderNumber}, orderNumber can be an element in the file OR orderNumber can be in the url string. To see this, go to PUT /orders/pending/{OrderNumber}, type a number in the OrderNumber field, and tap, Send Request. A Request URL will appear, with the number you entered in that URL.
  • Customer Id
  • Location
    • Determines what routes can be used
  • Route - same route for that truck for all time
    • Determines in which mobile units the order appears.
    • If the config, LocationAndRouteAreOptionalForPaperlessDelivery, is set to True and Proof of Delivery is enabled (IsPaperlessDeliveryFeatureEnabled), every device will use Proof of Delivery whether or not it is assigned to a truck and route. If set to False only devices assigned to a truck and route will use Proof of Delivery; devices that are not assigned will use standard delivery.
  • Order Date
  • Planned Delivery Date - needs to be today or in the future.
    • Future orders will not show up on the handheld until the day of delivery, although an override can be set if needed
  • Order Line Items. The minimum requirements are:
    • accountingLineNumber (an integer)
    • productCode
    • quantityToDeliver
    • quantityToReturn
  • Billing codes currently are not required to be sent over with the Orders.
    • However, if delivering an asset for which its classification is unknown, you will be required to select a Billing Code from a list when classifying the asset, pending fix of D-02717.
    • Therefore, at least one Billing Code needs to be established.
    • We recommend “T” (Handhelds only show one letter.)