A route group defines grouping of collection of carrier routes. Total number of delivery points in a route group cannot exceed 5000.
NOTE: Available delivery_dates to limit customer date selection for possible delivery dates can be accessed via following API call:
https://api.4over.com/dates?eddm=true
Request:
POST /routegroups
{
"name": "{NAME}",
"description": "{DESCRIPTION}",
"address": "{ADDRESS}",
"city": "{CITY}",
"state": "{STATE}",
"zip": "{ZIP}",
"x_coordinate": "{X_COORDINATE}",
"y_coordinate": "{Y_COORDINATE}",
"distance": "{DISTANCE}",
"status": "{STATUS}",
"latitude": "{LATITUDE}",
"longitude": "{LONGITUDE}",
"param_type": "{PARAM_TYPE}",
"is_residential": "{IS_RESIDENTIAL}",
"delivery_date": "{DELIVERY_DATE}",
"parent_route_group": {
"route_group_uuid": "{ROUTE_GROUP_UUID}"
}
}
Response:
New Route Group
JSON
{
"route_group_uuid": "",
"name": "My New Route Group",
"description": "This is a sample route group",
"address": "1225 Los Angeles St",
"city": "Glendale",
"zip": "91202",
"x_coordinate": "",
"y_coordinate": "",
"param_type": "",
"latitude": "",
"longitude": "",
"is_residential": 1,
"user": {
"user_uuid": "9ba9665d-1766-49f8-b1ba-e2f457d6bf8b",
"first_name": "First",
"last_name": "Last",
"email": "user@email.com",
"user_notes": "Sample User",
"created_at": "2014-01-02 10:06:35-08",
"updated_at": "",
"deleted_at": "",
"organizations": "https://api.4over.com",
"logins": "https://api.4over.com",
"token": "d8e49f3738a1d38db775df763cb4533829e0fab1",
"timestamp": "0.95550300 1400192009",
"current_organization_uuid": "9ba9665d-1766-49f8-b1ba-e2f457d6bf8b"
},
"organization": {
"organization_uuid": "9ba9665d-1766-49f8-b1ba-e2f457d6bf8b",
"organization_name": "4over, Inc.",
"organization_description": "4over corporate",
"is_public_organization": true,
"users": "https://api.4over.com",
"job_code_prefix": "Z",
"created_at": "2013-09-29 22:11:43.194599-07",
"updated_at": "",
"deleted_at": ""
},
"delivery_date": "2013-10-25 22:11:43.194599-07",
"created_at": "2013-09-29 22:11:43.194599-07",
"updated_at": "2013-09-29 22:11:43.194599-07",
"deleted_at": ""
}