Route Object
  • 1 Minute to read
  • PDF

Route Object

  • PDF

Article Summary

Route Object

 

 

WarehouseName

 

Description: The name of the Warehouse where this route exists.

Data Type: String

Data Length: 100

Required: Yes

 

 

 

RouteNumber

 

Description: A number to uniquely identify the route.

Data Type: Number

 

 

 

RouteDestination

 

Description: A brief description of the route.

Data Type: String

Data Length: 50

Required: Yes

Note: Displayed on the web console. This field is not required to be unique, but it is advised. Can default to an empty string.

 

 

 

ActiveIndicator

 

Description: A Boolean value indicating whether the route is active.

Data Type: Boolean

Values: true, false

Required: Yes

 

 

 

RouteCutOffTime

 

Description: A number between 1 and 24 to indicate the cutoff hour for the route.

Data Type: Number

Note: If not value is provided a default will be used.

 

 

 

DeliveryDay

 

1 – Monday

2 – Tuesday

3 – Wednesday

4 – Thursday

5 – Friday

6 – Saturday

7 – Sunday

Required: Yes

 

 

 

StagingArea

 

Description: The staging area to associate with the route.

Data Type: String

Data Length: 50

Required: Yes

Note: If not value is provided the warehouse default staging area will be used.

 

 

 

Example 

 

[    

    {

         "WarehouseName": "Appolis DC",

         "RouteNumber": 9999,

         "RouteDescription": "Monday's Route",

         "RouteCutoffTime": 17,

         "ActiveIndicator": true,

         "DeliveryDay": 1,

         "StagingArea": "Default Route"

     }

]

 



What's Next