SprintShip API Documentation

Parameters

No Parameters


  {
  "userNameOrEmailAddress": "string",
  "password": "string",
  "twoFactorVerificationCode": "string",
  "rememberClient": true,
  "twoFactorRememberClientToken": "string",
  "singleSignIn": true,
  "returnUrl": "string",
  "captchaResponse": "string",
  "external": {
    "tenant": "string",
    "mobileClient": {
      "osName": "string",
      "osVersion": "string",
      "deviceModel": "string",
      "appVersion": 0,
      "driverStatus": "string"
    }
  }
}

AuthenticateModel {

userNameOrEmailAddress*

string
maxLength: 256

password*

string
maxLength: 32

twoFactorVerificationCode

string
nullable: true

rememberClient

boolean

twoFactorRememberClientToken

string
nullable: true

singleSignIn

boolean
nullable: true

returnUrl

string
nullable: true

captchaResponse

string
nullable: true

external

{

tenant

string
nullable: true

mobileClient

{

osName	string nullable: true
osVersion	string nullable: true
deviceModel	string nullable: true
appVersion	integer($int32)
driverStatus	string nullable: true

}

Responses

Code Description Links

200

Success


  {
  "accessToken": "string",
  "encryptedAccessToken": "string",
  "expireInSeconds": 0,
  "shouldResetPassword": true,
  "passwordResetCode": "string",
  "userId": 0,
  "requiresTwoFactorVerification": true,
  "twoFactorAuthProviders": [
    "string"
  ],
  "twoFactorRememberClientToken": "string",
  "returnUrl": "string",
  "refreshToken": "string",
  "refreshTokenExpireInSeconds": 0
}

AuthenticateResultModel{

accessToken	string nullable: true
encryptedAccessToken	string nullable: true
expireInSeconds	integer($int32)
shouldResetPassword	boolean
passwordResetCode	string nullable: true
userId	integer($int64)
requiresTwoFactorVerification	boolean
twoFactorAuthProviders	[ nullable: true string]
twoFactorRememberClientToken	string nullable: true
returnUrl	string nullable: true
refreshToken	string nullable: true
refreshTokenExpireInSeconds	integer($int32)

}

No Links

This API requires authentication made on behalf of the user. Authenticated requests require the user to capture the accessToken from the Authenticate API. These tokens are unique to a user and should be stored securely. Access tokens may expire at any time in the future.

Parameters

Name	Description
Id integer (query)
Name string (query)
CurrentPage integer (query)
MaxResultCount integer (query)
Sorting string (query)
SkipCount integer (query)

Responses

Code Description Links

200

Returns the package types.


{
  "totalCount": 0,
  "items": [
    {
      "id": 0,
      "name": "string",
      "price": 0,
      "code": "string",
      "color": "string",
      "isHiddenPackages": "string",
      "sortOrder": 0,
      "total": 0,
      "sku": "string",
      "description": "string"
    }
  ]
}

PagedResultDtoOfShippingPackageListDto {

totalCount

integer($int32)

items

[
nullable: true

ShippingPackageListDtoShippingPackageListDto{

id	integer($int32)
name	string nullable: true
price	number($double)
code	string nullable: true
color	string nullable: true
isHiddenPackages	string nullable: true
sortOrder	integer($int32)
total	integer($int32)
sku	string nullable: true
description	string nullable: true

}]

}

No Links

400 If query has a bad format or has unknown fields. No Links

500 Something wrong occurs with this operation. No Links

This API requires authentication made on behalf of the user. Authenticated requests require the user to capture the accessToken from the Authenticate API. These tokens are unique to a user and should be stored securely. Access tokens may expire at any time in the future.

Parameters

Name	Description
Id integer (query)
Name string (query)
Sorting string (query)
MaxResultCount integer (query)
SkipCount integer (query)

Responses

Code Description Links

200

Returns the tag types..


{
  "totalCount": 0,
  "items": [
    {
      "id": 0,
      "name": "string",
      "code": "string"
    }
  ]
}

PagedResultDtoOfTagTypeListDto {

totalCount

integer($int32)

items

[
nullable: true

TagTypeListDtoTagTypeListDto{

id	integer($int32)
name	string maxLength: 32 nullable: true
code	string nullable: true

}]

}

No Links

400 If query has a bad format or has unknown fields. No Links

500 Something wrong occurs with this operation. No Links

This API requires authentication made on behalf of the user. Authenticated requests require the user to capture the accessToken from the Authenticate API. These tokens are unique to a user and should be stored securely. Access tokens may expire at any time in the future.

Parameters

No Parameters


  {
  "locationId": 0,
  "tenantId": 0,
  "userId": 0,
  "tags": [
    {
      "tagCode": "string",
      "value": "string"
    }
  ],
  "trackingIdentifier": "string",
  "note": "string",
  "packages": [
    {
      "packageCode": "string",
      "quantity": 0,
      "packageName": "string",
      "description": "string",
      "sku": "string",
      "price": 0
    }
  ],
  "destinationEtaStart": "2021-02-15T09:00:16.249Z",
  "destinationEtaEnd": "2021-02-15T09:00:16.249Z",
  "destinationContactId": 0,
  "destinationFirstName": "string",
  "destinationLastName": "string",
  "destinationEmail": "string",
  "destinationPhone": "string",
  "destinationAddressLine1": "string",
  "destinationAddressLine2": "string",
  "destinationPostalCodeId": 0,
  "destinationPostalCode": "string",
  "destinationCountry": "string",
  "destinationCity": "string",
  "destinationState": "string",
  "destinationGeocodeId": 0,
  "destinationLat": 0,
  "destinationLng": 0,
  "destinationAddressTypeId": 0,
  "pickUpEtaStart": "2021-02-15T09:00:16.249Z",
  "pickUpEtaEnd": "2021-02-15T09:00:16.249Z",
  "pickUpContactId": 0,
  "pickUpFirstName": "string",
  "pickUpLastName": "string",
  "pickUpEmail": "string",
  "pickUpPhone": "string",
  "pickUpAddressLine1": "string",
  "pickUpAddressLine2": "string",
  "pickUpPostalCodeId": 0,
  "pickUpPostalCode": "string",
  "pickUpCountry": "string",
  "pickUpCity": "string",
  "pickUpState": "string",
  "pickUpGeocodeId": 0,
  "pickUpLat": 0,
  "pickUpLng": 0,
  "pickUpAddressTypeId": 0,
  "orderSourceId": 0,
  "orderSourceCode": "string"
}

CreateOrderApiInput {

locationId

integer($int32)
nullable: true

tenantId

integer($int32)
nullable: true

userId

integer($int64)
nullable: true

Responses

Code Description Links

200

Returns a newly created order with its corresponding packageId and trackingIdentifier.


{
  "packageIds": [
    0
  ],
  "trackingIdentifier": "string",
  "message": "string"
}

CreateOrderApiResult {

packageIds	[ nullable: true integer($int32)]
trackingIdentifier	string nullable: true
message	string nullable: true

}

No Links

400 If query has a bad format or has unknown fields. No Links

500 Something wrong occurs with this operation. No Links

This API requires authentication made on behalf of the user. Authenticated requests require the user to capture the accessToken from the Authenticate API. These tokens are unique to a user and should be stored securely. Access tokens may expire at any time in the future.

Parameters

No Parameters

A unique Tracking Number from the CreateOrder API.


  {
  "trackingIdentifier": "string"
}

GetLabelInput {

trackingIdentifier	string nullable: true

}

Responses

Code Description Links

200

Returns the ZPL value for the order label.


{
  "zpl": "string"
}

ZplResult {

zpl	string nullable: true

}

No Links

400 If query has a bad format or has unknown fields. No Links

500 Something wrong occurs with this operation. No Links

Parameters

No Parameters

A unique Tracking Number from the CreateOrder API.


{
  "confirmationNumber": [
    "string"
  ],
  "specialInstructions": "string"
}

CancelOrderInputDto {

confirmationNumber	[ nullable: true string]
specialInstructions	string nullable: true

}

Responses

Code Description Links

200

Success


[
  {
    "orderId": 0,
    "message": "string"
  }
]

CancelOrderResultDto {

orderId	integer($int32) nullable: true
message	string nullable: true

}

No Links

This API requires authentication made on behalf of the user. Authenticated requests require the user to capture the accessToken from the Authenticate API. These tokens are unique to a user and should be stored securely. Access tokens may expire at any time in the future.

Parameters

Name	Description
OrderId integer (query)
TrackingIdentifier string (query)
TimeZoneInfo string (query)
OrderNumber string (query)
DeliveryDateFrom string (query)
DeliveryDateTo string (query)

Responses

Code Description Links

200

Success


[
  {
    "id": 0,
    "note": "string",
    "createdDate": "2021-02-15T09:51:31.935Z",
    "modifiedDate": "2021-02-15T09:51:31.935Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "proximityValue": "string",
    "proximityLong": 0,
    "proximityLat": 0,
    "proximityGeocodeId": 0,
    "proximity": {
      "id": 0,
      "orderId": 0,
      "order": {
        "id": 0,
        "tenantId": 0,
        "user": {
          "name": "string",
          "surname": "string",
          "userName": "string",
          "emailAddress": "string",
          "phoneNumber": "string",
          "lockOutEndDateUtc": "2021-02-15T09:51:31.935Z",
          "profilePictureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "isEmailConfirmed": true,
          "roles": [
            {
              "roleId": 0,
              "roleName": "string"
            }
          ],
          "isActive": true,
          "creationTime": "2021-02-15T09:51:31.935Z",
          "preferences": "string",
          "hasBackgroundImage": true,
          "id": 0
        },
        "pickupDetail": {
          "id": 0,
          "contact": {
            "contact": {
              "firstName": "string",
              "lastName": "string",
              "address": {
                "id": 0,
                "addressLine1": "string",
                "addressLine2": "string",
                "addressType": {
                  "id": 0,
                  "name": "string",
                  "color": "string",
                  "icon": "string"
                },
                "postalCode": {
                  "id": 0,
                  "country": "string",
                  "city": "string",
                  "state": "string",
                  "value": "string"
                },
                "geocode": {
                  "id": 0,
                  "latitude": 0,
                  "longitude": 0
                },
                "formattedAddress": "string"
              },
              "id": 0
            },
            "id": 0,
            "tenantId": 0,
            "user": {
              "id": 0,
              "name": "string",
              "surname": "string",
              "emailAddress": "string",
              "phoneNumber": "string",
              "userName": "string",
              "isEmailConfirmed": true,
              "isActive": true
            },
            "address": {
              "id": 0,
              "addressLine1": "string",
              "addressLine2": "string",
              "addressType": {
                "id": 0,
                "name": "string",
                "color": "string",
                "icon": "string"
              },
              "postalCode": {
                "id": 0,
                "country": "string",
                "city": "string",
                "state": "string",
                "value": "string"
              },
              "geocode": {
                "id": 0,
                "latitude": 0,
                "longitude": 0
              },
              "formattedAddress": "string"
            },
            "firstName": "string",
            "lastName": "string",
            "company": {
              "id": 0,
              "name": "string",
              "accountNo": "string"
            },
            "emails": {
              "id": 0,
              "contactId": 0,
              "value": "string"
            },
            "phones": {
              "id": 0,
              "contactId": 0,
              "value": "string"
            },
            "companies": {
              "name": "string",
              "contact": {
                "firstName": "string",
                "lastName": "string",
                "address": {
                  "addressLine1": "string",
                  "addressLine2": "string",
                  "postalCode": {
                    "country": "string",
                    "city": "string",
                    "state": "string",
                    "value": "string"
                  },
                  "geocode": {
                    "id": 0,
                    "latitude": 0,
                    "longitude": 0
                  }
                }
              },
              "accountNo": "string"
            }
          },
          "etaStart": "2021-02-15T09:51:31.935Z",
          "etaEnd": "2021-02-15T09:51:31.935Z"
        },
        "deliveryDetail": {
          "id": 0,
          "contact": {
            "contact": {
              "firstName": "string",
              "lastName": "string",
              "address": {
                "id": 0,
                "addressLine1": "string",
                "addressLine2": "string",
                "addressType": {
                  "id": 0,
                  "name": "string",
                  "color": "string",
                  "icon": "string"
                },
                "postalCode": {
                  "id": 0,
                  "country": "string",
                  "city": "string",
                  "state": "string",
                  "value": "string"
                },
                "geocode": {
                  "id": 0,
                  "latitude": 0,
                  "longitude": 0
                },
                "formattedAddress": "string"
              },
              "id": 0
            },
            "id": 0,
            "tenantId": 0,
            "user": {
              "id": 0,
              "name": "string",
              "surname": "string",
              "emailAddress": "string",
              "phoneNumber": "string",
              "userName": "string",
              "isEmailConfirmed": true,
              "isActive": true
            },
            "address": {
              "id": 0,
              "addressLine1": "string",
              "addressLine2": "string",
              "addressType": {
                "id": 0,
                "name": "string",
                "color": "string",
                "icon": "string"
              },
              "postalCode": {
                "id": 0,
                "country": "string",
                "city": "string",
                "state": "string",
                "value": "string"
              },
              "geocode": {
                "id": 0,
                "latitude": 0,
                "longitude": 0
              },
              "formattedAddress": "string"
            },
            "firstName": "string",
            "lastName": "string",
            "company": {
              "id": 0,
              "name": "string",
              "accountNo": "string"
            },
            "emails": {
              "id": 0,
              "contactId": 0,
              "value": "string"
            },
            "phones": {
              "id": 0,
              "contactId": 0,
              "value": "string"
            },
            "companies": {
              "name": "string",
              "contact": {
                "firstName": "string",
                "lastName": "string",
                "address": {
                  "addressLine1": "string",
                  "addressLine2": "string",
                  "postalCode": {
                    "country": "string",
                    "city": "string",
                    "state": "string",
                    "value": "string"
                  },
                  "geocode": {
                    "id": 0,
                    "latitude": 0,
                    "longitude": 0
                  }
                }
              },
              "accountNo": "string"
            }
          },
          "etaStart": "2021-02-15T09:51:31.935Z",
          "etaEnd": "2021-02-15T09:51:31.935Z"
        },
        "location": {
          "id": 0,
          "tenantId": 0,
          "contactId": 0,
          "contact": {
            "contact": {
              "firstName": "string",
              "lastName": "string",
              "address": {
                "id": 0,
                "addressLine1": "string",
                "addressLine2": "string",
                "addressType": {
                  "id": 0,
                  "name": "string",
                  "color": "string",
                  "icon": "string"
                },
                "postalCode": {
                  "id": 0,
                  "country": "string",
                  "city": "string",
                  "state": "string",
                  "value": "string"
                },
                "geocode": {
                  "id": 0,
                  "latitude": 0,
                  "longitude": 0
                },
                "formattedAddress": "string"
              },
              "id": 0
            },
            "id": 0,
            "tenantId": 0,
            "user": {
              "id": 0,
              "name": "string",
              "surname": "string",
              "emailAddress": "string",
              "phoneNumber": "string",
              "userName": "string",
              "isEmailConfirmed": true,
              "isActive": true
            },
            "address": {
              "id": 0,
              "addressLine1": "string",
              "addressLine2": "string",
              "addressType": {
                "id": 0,
                "name": "string",
                "color": "string",
                "icon": "string"
              },
              "postalCode": {
                "id": 0,
                "country": "string",
                "city": "string",
                "state": "string",
                "value": "string"
              },
              "geocode": {
                "id": 0,
                "latitude": 0,
                "longitude": 0
              },
              "formattedAddress": "string"
            },
            "firstName": "string",
            "lastName": "string",
            "company": {
              "id": 0,
              "name": "string",
              "accountNo": "string"
            },
            "emails": {
              "id": 0,
              "contactId": 0,
              "value": "string"
            },
            "phones": {
              "id": 0,
              "contactId": 0,
              "value": "string"
            },
            "companies": {
              "name": "string",
              "contact": {
                "firstName": "string",
                "lastName": "string",
                "address": {
                  "addressLine1": "string",
                  "addressLine2": "string",
                  "postalCode": {
                    "country": "string",
                    "city": "string",
                    "state": "string",
                    "value": "string"
                  },
                  "geocode": {
                    "id": 0,
                    "latitude": 0,
                    "longitude": 0
                  }
                }
              },
              "accountNo": "string"
            }
          },
          "timeZoneId": 0,
          "timeZone": {
            "id": 0,
            "value": "string",
            "offset": "string"
          },
          "userId": 0,
          "name": "string",
          "minutesPerMile": 0,
          "leadTime": 0,
          "etaRoundUp": 0,
          "goBackTimeWindow": 0,
          "minutesPerStop": 0,
          "loadLimit": 0,
          "distanceAdjustment": [
            {
              "maxDistance": 0,
              "multiplier": 0
            }
          ],
          "trafficAdjustment": [
            {
              "trafficStartTime": "string",
              "trafficEndTime": "string",
              "multiplier": 0
            }
          ],
          "inActive": true,
          "postalCodeRegEx": "string",
          "driverInactiveThreshold": 0
        },
        "route": {
          "tenantId": 0,
          "vehicleId": 0,
          "locationId": 0,
          "routeTemplateId": 0,
          "vehicle": {
            "id": 0,
            "name": "string",
            "licenseNumber": "string",
            "tenantId": 0,
            "userId": 0,
            "user": {
              "name": "string",
              "surname": "string",
              "userName": "string",
              "emailAddress": "string",
              "phoneNumber": "string",
              "lockOutEndDateUtc": "2021-02-15T09:51:31.935Z",
              "profilePictureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "isEmailConfirmed": true,
              "roles": [
                {
                  "roleId": 0,
                  "roleName": "string"
                }
              ],
              "isActive": true,
              "creationTime": "2021-02-15T09:51:31.935Z",
              "preferences": "string",
              "hasBackgroundImage": true,
              "id": 0
            },
            "users": {
              "userId": 0,
              "fullName": "string"
            }
          },
          "location": {
            "id": 0,
            "name": "string",
            "contactId": 0,
            "minutesPerMile": 0,
            "minutesPerStop": 0,
            "tenantId": 0,
            "timeZoneId": 0,
            "userId": 0
          },
          "routeTemplate": {
            "tenantId": 0,
            "locationId": 0,
            "routeTemplateTypeId": 0,
            "name": "string",
            "startTime": "string",
            "endTime": "string",
            "defaultUserId": 0,
            "location": {
              "id": 0,
              "name": "string",
              "contactId": 0,
              "minutesPerMile": 0,
              "minutesPerStop": 0,
              "tenantId": 0,
              "timeZoneId": 0,
              "userId": 0
            },
            "lastModificationTime": "2021-02-15T09:51:31.936Z",
            "lastModifierUserId": 0,
            "creationTime": "2021-02-15T09:51:31.936Z",
            "creatorUserId": 0,
            "id": 0
          },
          "loadDate": "2021-02-15T09:51:31.936Z",
          "completion": "2021-02-15T09:51:31.936Z",
          "departure": "2021-02-15T09:51:31.936Z",
          "locked": true,
          "orders": [
            null
          ],
          "vehicleName": "string",
          "lastModificationTime": "2021-02-15T09:51:31.936Z",
          "lastModifierUserId": 0,
          "creationTime": "2021-02-15T09:51:31.936Z",
          "creatorUserId": 0,
          "id": 0
        },
        "note": {
          "id": 0,
          "content": "string"
        },
        "orderStatus": {
          "time": "2021-02-15T09:51:31.936Z",
          "user": {
            "name": "string",
            "surname": "string",
            "userName": "string",
            "emailAddress": "string",
            "phoneNumber": "string",
            "lockOutEndDateUtc": "2021-02-15T09:51:31.936Z",
            "profilePictureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "isEmailConfirmed": true,
            "roles": [
              {
                "roleId": 0,
                "roleName": "string"
              }
            ],
            "isActive": true,
            "creationTime": "2021-02-15T09:51:31.936Z",
            "preferences": "string",
            "hasBackgroundImage": true,
            "id": 0
          },
          "geocode": {
            "id": 0,
            "latitude": 0,
            "longitude": 0
          },
          "orderStatusType": {
            "id": 0,
            "tenantId": 0,
            "code": "string",
            "description": "string",
            "name": "string",
            "color": "string",
            "icon": "string",
            "inactive": true,
            "visible": true,
            "parentId": 0,
            "sortOrder": 0
          },
          "orderStatusDescription": {
            "id": 0,
            "tenantId": 0,
            "description": "string",
            "code": "string",
            "name": "string",
            "color": "string",
            "icon": "string",
            "inactive": true,
            "visible": true,
            "parentId": 0,
            "sortOrder": 0,
            "orderStatusTypeId": 0
          },
          "note": {
            "id": 0,
            "content": "string"
          },
          "stringTime": "string",
          "orderType": "string",
          "etaString": "string",
          "eta": "2021-02-15T09:51:31.936Z",
          "lastModificationTime": "2021-02-15T09:51:31.936Z",
          "lastModifierUserId": 0,
          "creationTime": "2021-02-15T09:51:31.936Z",
          "creatorUserId": 0,
          "id": 0
        },
        "orderPackages": [
          {
            "orderId": 0,
            "packageId": 0,
            "package": {
              "id": 0,
              "name": "string",
              "price": 0,
              "code": "string",
              "color": "string",
              "isHiddenPackages": "string",
              "sortOrder": 0,
              "total": 0,
              "sku": "string",
              "description": "string"
            },
            "quantity": 0,
            "creationTime": "2021-02-15T09:51:31.936Z",
            "creatorUserId": 0,
            "id": 0
          }
        ],
        "orderTags": [
          {
            "tag": {
              "tenantId": 0,
              "tagType": {
                "id": 0,
                "name": "string",
                "code": "string"
              },
              "name": "string",
              "lastModificationTime": "2021-02-15T09:51:31.936Z",
              "lastModifierUserId": 0,
              "creationTime": "2021-02-15T09:51:31.936Z",
              "creatorUserId": 0,
              "id": 0
            },
            "tagId": 0,
            "orderId": 0,
            "lastModificationTime": "2021-02-15T09:51:31.936Z",
            "lastModifierUserId": 0,
            "creationTime": "2021-02-15T09:51:31.936Z",
            "creatorUserId": 0,
            "id": 0
          }
        ],
        "orderStatusCollection": [
          {
            "time": "2021-02-15T09:51:31.936Z",
            "user": {
              "name": "string",
              "surname": "string",
              "userName": "string",
              "emailAddress": "string",
              "phoneNumber": "string",
              "lockOutEndDateUtc": "2021-02-15T09:51:31.936Z",
              "profilePictureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "isEmailConfirmed": true,
              "roles": [
                {
                  "roleId": 0,
                  "roleName": "string"
                }
              ],
              "isActive": true,
              "creationTime": "2021-02-15T09:51:31.936Z",
              "preferences": "string",
              "hasBackgroundImage": true,
              "id": 0
            },
            "geocode": {
              "id": 0,
              "latitude": 0,
              "longitude": 0
            },
            "orderStatusType": {
              "id": 0,
              "tenantId": 0,
              "code": "string",
              "description": "string",
              "name": "string",
              "color": "string",
              "icon": "string",
              "inactive": true,
              "visible": true,
              "parentId": 0,
              "sortOrder": 0
            },
            "orderStatusDescription": {
              "id": 0,
              "tenantId": 0,
              "description": "string",
              "code": "string",
              "name": "string",
              "color": "string",
              "icon": "string",
              "inactive": true,
              "visible": true,
              "parentId": 0,
              "sortOrder": 0,
              "orderStatusTypeId": 0
            },
            "note": {
              "id": 0,
              "content": "string"
            },
            "stringTime": "string",
            "orderType": "string",
            "etaString": "string",
            "eta": "2021-02-15T09:51:31.936Z",
            "lastModificationTime": "2021-02-15T09:51:31.936Z",
            "lastModifierUserId": 0,
            "creationTime": "2021-02-15T09:51:31.936Z",
            "creatorUserId": 0,
            "id": 0
          }
        ],
        "creationTime": "2021-02-15T09:51:31.936Z",
        "routeScheduleDetail": {
          "routeCode": "string",
          "estimatedTimeOfArrival": "2021-02-15T09:51:31.936Z",
          "cutOff": "2021-02-15T09:51:31.936Z",
          "automatic": true,
          "willCall": true,
          "isActive": true,
          "oorRate": 0,
          "effectivityDate": "2021-02-15T09:51:31.936Z",
          "routeScheduleId": 0,
          "routeTypeId": 0,
          "routeTemplateTypeId": {},
          "orders": [
            null
          ],
          "id": 0
        },
        "orderType": {
          "code": "string",
          "description": "string",
          "isActive": true,
          "color": "string",
          "textColor": "string",
          "sortOrder": 0,
          "id": 0
        },
        "pickupEtaStart": "2021-02-15T09:51:31.936Z",
        "deliveryEtaEnd": "2021-02-15T09:51:31.936Z"
      },
      "geocode": {
        "id": 0,
        "latitude": 0,
        "longitude": 0
      },
      "geoCodeId": 0,
      "value": "string",
      "creationTime": "2021-02-15T09:51:31.936Z",
      "lastModificationTime": "2021-02-15T09:51:31.936Z",
      "modifiedByName": "string",
      "modifiedBySurname": "string",
      "isAccepted": true
    },
    "pickUpId": 0,
    "pickupAddressId": 0,
    "pickupContactId": 0,
    "pickupPostalCodeId": 0,
    "pickupFirstName": "string",
    "pickupLastName": "string",
    "pickupTime": "2021-02-15T09:51:31.936Z",
    "pickupAddressLine1": "string",
    "pickupAddressLine2": "string",
    "pickupCountry": "string",
    "pickupCity": "string",
    "pickupState": "string",
    "pickupPostal": "string",
    "pickupLat": 0,
    "pickupLong": 0,
    "pickUpCompanyName": "string",
    "pickUpEmail": "string",
    "pickUpPhone": "string",
    "pickupAddressType": "string",
    "deliveryId": 0,
    "deliveryAddressId": 0,
    "deliveryContactId": 0,
    "deliveryPostalCodeId": 0,
    "deliveryCompanyName": "string",
    "deliveryFirstName": "string",
    "deliveryLastName": "string",
    "deliveryTime": "2021-02-15T09:51:31.936Z",
    "deliveryAddressLine1": "string",
    "deliveryAddressLine2": "string",
    "deliveryCountry": "string",
    "deliveryCity": "string",
    "deliveryState": "string",
    "deliveryPostal": "string",
    "deliveryLat": 0,
    "deliveryLong": 0,
    "accountNo": "string",
    "proximityAcceptedBy": "string",
    "orderPackages": [
      {
        "orderId": 0,
        "packageId": 0,
        "package": {
          "id": 0,
          "name": "string",
          "price": 0,
          "code": "string",
          "color": "string",
          "isHiddenPackages": "string",
          "sortOrder": 0,
          "total": 0,
          "sku": "string",
          "description": "string"
        },
        "quantity": 0,
        "creationTime": "2021-02-15T09:51:31.936Z",
        "creatorUserId": 0,
        "id": 0
      }
    ],
    "orderTags": [
      {
        "tag": {
          "tenantId": 0,
          "tagType": {
            "id": 0,
            "name": "string",
            "code": "string"
          },
          "name": "string",
          "lastModificationTime": "2021-02-15T09:51:31.936Z",
          "lastModifierUserId": 0,
          "creationTime": "2021-02-15T09:51:31.936Z",
          "creatorUserId": 0,
          "id": 0
        },
        "tagId": 0,
        "orderId": 0,
        "lastModificationTime": "2021-02-15T09:51:31.936Z",
        "lastModifierUserId": 0,
        "creationTime": "2021-02-15T09:51:31.936Z",
        "creatorUserId": 0,
        "id": 0
      }
    ],
    "routeId": 0,
    "location": "string",
    "locationId": 0,
    "orderTypeId": 0,
    "orderType": "string",
    "pickupFormatAddress": "string",
    "deliverFormatAddress": "string",
    "deliveryEmail": "string",
    "deliveryPhone": "string",
    "pickupDetailsId": 0,
    "deliveryDetailsId": 0,
    "deliverAddressType": "string",
    "statusId": 0,
    "statusDescription": "string",
    "orderStatuses": [
      {
        "status": "string",
        "time": "string",
        "creator": "string",
        "sortOrder": 0,
        "orderStatusTypeId": 0
      }
    ]
  }
]

GetOrderDetailsView {

id

integer($int32)

note

string
nullable: true

createdDate

string($date-time)
nullable: true

modifiedDate

string($date-time)
nullable: true

createdBy

string
nullable: true

modifiedBy

string
nullable: true

proximityValue

string
nullable: true

proximityLong

number($double)
nullable: true

proximityLat

number($double)
nullable: true

proximityGeocodeId

integer($int32)

proximity

{

id

integer($int32)

orderId

integer($int32)
nullable: true

order

{

id

integer($int32)

tenantId

integer($int32)

user

{

name

string
nullable: true

surname

string
nullable: true

userName

string
nullable: true

emailAddress

string
nullable: true

phoneNumber

string
nullable: true

lockOutEndDateUtc

string($date-time)
nullable: true

profilePictureId

string($uuid)
nullable: true

isEmailConfirmed

boolean

roles

[
nullable: true

/swagger/v1/swagger.json#/components/schemas/UserListRoleDtoUserListRoleDto{

roleId	integer($int32)
roleName	string nullable: true

}]

isActive

boolean

creationTime

string($date-time)

preferences

string
nullable: true

hasBackgroundImage

boolean

id

integer($int64)

}

pickupDetail

{

id

integer($int32)

contact

{

contact

{

firstName

string
nullable: true

lastName

string
nullable: true

address

{

id

integer($int32)

addressLine1

string
nullable: true

addressLine2

string
nullable: true

addressType

{

id	integer($int32)
name	string nullable: true
color	string nullable: true
icon	string nullable: true

}

postalCode

{

id	integer($int32)
country	string nullable: true
city	string nullable: true
state	string nullable: true
value	string nullable: true

}

geocode

{

id	integer($int32)
latitude	number($double)
longitude	number($double)

}

formattedAddress

string
nullable: true

}

id

integer($int32)

}

id

integer($int32)

tenantId

integer($int32)

user

{

id	integer($int64)
name	string nullable: true
surname	string nullable: true
emailAddress	string nullable: true
phoneNumber	string nullable: true
userName	string nullable: true
isEmailConfirmed	boolean
isActive	boolean

}

address

{

id

integer($int32)

addressLine1

string
nullable: true

addressLine2

string
nullable: true

addressType

{

id	integer($int32)
name	string nullable: true
color	string nullable: true
icon	string nullable: true

}

postalCode

{

id	integer($int32)
country	string nullable: true
city	string nullable: true
state	string nullable: true
value	string nullable: true

}

geocode

{

id	integer($int32)
latitude	number($double)
longitude	number($double)

}

formattedAddress

string
nullable: true

}

firstName

string
nullable: true

lastName

string
nullable: true

company

{

id	integer($int32)
name	string nullable: true
accountNo	string nullable: true

}

emails

{

id	integer($int32)
contactId	integer($int32)
value	string nullable: true

}

phones

{

id	integer($int32)
contactId	integer($int32)
value	string nullable: true

}

companies

{

name	string nullable: true
contact	{...}
accountNo	string nullable: true

}

etaStart

string($date-time)

etaEnd

string($date-time)

}

deliveryDetail

{

id

integer($int32)

contact

{

contact

{

firstName

string
nullable: true

lastName

string
nullable: true

address

{

id

integer($int32)

addressLine1

string
nullable: true

addressLine2

string
nullable: true

addressType

{

id	integer($int32)
name	string nullable: true
color	string nullable: true
icon	string nullable: true

}

postalCode

{

id	integer($int32)
country	string nullable: true
city	string nullable: true
state	string nullable: true
value	string nullable: true

}

geocode

{

id	integer($int32)
latitude	number($double)
longitude	number($double)

}

formattedAddress

string
nullable: true

}

id

integer($int32)

}

id

integer($int32)

tenantId

integer($int32)

user

{

id	integer($int64)
name	string nullable: true
surname	string nullable: true
emailAddress	string nullable: true
phoneNumber	string nullable: true
userName	string nullable: true
isEmailConfirmed	boolean
isActive	boolean

}

address

{

id

integer($int32)

addressLine1

string
nullable: true

addressLine2

string
nullable: true

addressType

{

id	integer($int32)
name	string nullable: true
color	string nullable: true
icon	string nullable: true

}

postalCode

{

id	integer($int32)
country	string nullable: true
city	string nullable: true
state	string nullable: true
value	string nullable: true

}

geocode

{

id	integer($int32)
latitude	number($double)
longitude	number($double)

}

formattedAddress

string
nullable: true

}

firstName

string
nullable: true

lastName

string
nullable: true

company

{

id	integer($int32)
name	string nullable: true
accountNo	string nullable: true

}

emails

{

id	integer($int32)
contactId	integer($int32)
value	string nullable: true

}

phones

{

id	integer($int32)
contactId	integer($int32)
value	string nullable: true

}

companies

{

name

string
nullable: true

contact

{

firstName

string
nullable: true

lastName

string
nullable: true

address

{

addressLine1

string
nullable: true

addressLine2

string
nullable: true

postalCode

{

country	string nullable: true
city	string nullable: true
state	string nullable: true
value	string nullable: true

}

geocode

{

id	integer($int32)
latitude	number($double)
longitude	number($double)

}

accountNo

string
nullable: true

}

etaStart

string($date-time)

etaEnd

string($date-time)

}

location

{

id

integer($int32)

tenantId

integer($int32)

contactId

integer($int32)

contact

{

contact

{

firstName

string
nullable: true

lastName

string
nullable: true

address

{

id

integer($int32)

addressLine1

string
nullable: true

addressLine2

string
nullable: true

addressType

{

id	integer($int32)
name	string nullable: true
color	string nullable: true
icon	string nullable: true

}

postalCode

{

id	integer($int32)
country	string nullable: true
city	string nullable: true
state	string nullable: true
value	string nullable: true

}

geocode

{

id	integer($int32)
latitude	number($double)
longitude	number($double)

}

formattedAddress

string
nullable: true

}

id

integer($int32)

}

id

integer($int32)

tenantId

integer($int32)

user

{

id	integer($int64)
name	string nullable: true
surname	string nullable: true
emailAddress	string nullable: true
phoneNumber	string nullable: true
userName	string nullable: true
isEmailConfirmed	boolean
isActive	boolean

}

address

{

id

integer($int32)

addressLine1

string
nullable: true

addressLine2

string
nullable: true

addressType

{

id	integer($int32)
name	string nullable: true
color	string nullable: true
icon	string nullable: true

}

postalCode

{

id	integer($int32)
country	string nullable: true
city	string nullable: true
state	string nullable: true
value	string nullable: true

}

geocode

{

id	integer($int32)
latitude	number($double)
longitude	number($double)

}

formattedAddress

string
nullable: true

}

firstName

string
nullable: true

lastName

string
nullable: true

company

{

id	integer($int32)
name	string nullable: true
accountNo	string nullable: true

}

emails

{

id	integer($int32)
contactId	integer($int32)
value	string nullable: true

}

phones

{

id	integer($int32)
contactId	integer($int32)
value	string nullable: true

}

companies

{

name

string
nullable: true

contact

{

firstName

string
nullable: true

lastName

string
nullable: true

address

{

addressLine1

string
nullable: true

addressLine2

string
nullable: true

postalCode

{

country	string nullable: true
city	string nullable: true
state	string nullable: true
value	string nullable: true

}

geocode

{

id	integer($int32)
latitude	number($double)
longitude	number($double)

}

accountNo

string
nullable: true

}

timeZoneId

integer($int32)

timeZone

{

id	integer($int32)
value	string maxLength: 100 nullable: true
offset	string nullable: true

}

userId

integer($int64)

name

string
nullable: true

minutesPerMile

number($double)

leadTime

integer($int32)
nullable: true

etaRoundUp

integer($int32)
nullable: true

goBackTimeWindow

integer($int32)
nullable: true

minutesPerStop

number($double)

loadLimit

integer($int32)
nullable: true

distanceAdjustment

[
nullable: true

/swagger/v1/swagger.json#/components/schemas/DistanceInputApiDistanceInputApi{

maxDistance	number($double)
multiplier	number($double)

}]

trafficAdjustment

[
nullable: true

/swagger/v1/swagger.json#/components/schemas/TrafficInputApiTrafficInputApi{

trafficStartTime	string nullable: true
trafficEndTime	string nullable: true
multiplier	number($double)

}]

inActive

boolean

postalCodeRegEx

string
nullable: true

driverInactiveThreshold

integer($int32)
nullable: true

}

route

{

tenantId

integer($int32)

vehicleId

integer($int32)
nullable: true

locationId

integer($int32)

routeTemplateId

integer($int32)

vehicle

{

id

integer($int32)

name

string
nullable: true

licenseNumber

string
nullable: true

tenantId

integer($int32)

userId

integer($int32)

user

{

name

string
nullable: true

surname

string
nullable: true

userName

string
nullable: true

emailAddress

string
nullable: true

phoneNumber

string
nullable: true

lockOutEndDateUtc

string($date-time)
nullable: true

profilePictureId

string($uuid)
nullable: true

isEmailConfirmed

boolean

roles

[
nullable: true

/swagger/v1/swagger.json#/components/schemas/UserListRoleDtoUserListRoleDto{

roleId	integer($int32)
roleName	string nullable: true

}]

isActive

boolean

creationTime

string($date-time)

preferences

string
nullable: true

hasBackgroundImage

boolean

id

integer($int64)

}

users

{

userId	integer($int64)
fullName	string nullable: true

}

location

{

id	integer($int32)
name	string nullable: true
contactId	integer($int32)
minutesPerMile	number($double)
minutesPerStop	number($double)
tenantId	integer($int32)
timeZoneId	integer($int32)
userId	integer($int32)

}

routeTemplate

{

tenantId

integer($int32)

locationId

integer($int32)

routeTemplateTypeId

integer($int32)

name

string
nullable: true

startTime

string
nullable: true

endTime

string
nullable: true

defaultUserId

integer($int32)
nullable: true

location

{

id	integer($int32)
name	string nullable: true
contactId	integer($int32)
minutesPerMile	number($double)
minutesPerStop	number($double)
tenantId	integer($int32)
timeZoneId	integer($int32)
userId	integer($int32)

}

lastModificationTime

string($date-time)
nullable: true

lastModifierUserId

integer($int64)
nullable: true

creationTime

string($date-time)

creatorUserId

integer($int64)
nullable: true

id

integer($int32)

}

loadDate

string($date-time)

completion

string($date-time)
nullable: true

departure

string($date-time)
nullable: true

locked

boolean

orders

[
nullable: true

{

}]

vehicleName

string
nullable: true

lastModificationTime

string($date-time)
nullable: true

lastModifierUserId

integer($int64)
nullable: true

creationTime

string($date-time)

creatorUserId

integer($int64)
nullable: true

id

integer($int32)

}

note

{

id	integer($int32) nullable: true
content	string nullable: true

}

orderStatus

{

time

string($date-time)

user

{

name

string
nullable: true

surname

string
nullable: true

userName

string
nullable: true

emailAddress

string
nullable: true

phoneNumber

string
nullable: true

lockOutEndDateUtc

string($date-time)
nullable: true

profilePictureId

string($uuid)
nullable: true

isEmailConfirmed

boolean

roles

[
nullable: true

/swagger/v1/swagger.json#/components/schemas/UserListRoleDtoUserListRoleDto{

roleId	integer($int32)
roleName	string nullable: true

}]

isActive

boolean

creationTime

string($date-time)

preferences

string
nullable: true

hasBackgroundImage

boolean

id

integer($int64)

}

order

{

}

geocode

{

id	integer($int32)
latitude	number($double)
longitude	number($double)

}

orderStatusType

{

id	integer($int32)
tenantId	integer($int32)
code*	string maxLength: 32
description*	string maxLength: 255
name	string nullable: true
color	string nullable: true
icon	string nullable: true
inactive	boolean
visible	boolean
parentId	integer($int32) nullable: true
sortOrder	integer($int32)

}

orderStatusDescription

{

id

integer($int32)

tenantId

integer($int32)

description*

string
maxLength: 255

code

string
nullable: true

name

string
nullable: true

color

string
nullable: true

icon

string
nullable: true

inactive

boolean

visible

boolean

parentId

integer($int32)
nullable: true

sortOrder

integer($int32)

orderStatusTypeId

integer($int32)

parent

{

}

note

{

id	integer($int32) nullable: true
content	string nullable: true

}

stringTime

string
nullable: true

orderType

string
nullable: true

etaString

string
nullable: true

eta

string($date-time)

lastModificationTime

string($date-time)
nullable: true

lastModifierUserId

integer($int64)
nullable: true

creationTime

string($date-time)

creatorUserId

integer($int64)
nullable: true

id

integer($int32)

}

orderPackages

[
nullable: true

/swagger/v1/swagger.json#/components/schemas/OrderPackageListDtoOrderPackageListDto{

orderId

integer($int32)

packageId

integer($int32)

package

{

id	integer($int32)
name	string nullable: true
price	number($double)
code	string nullable: true
color	string nullable: true
isHiddenPackages	string nullable: true
sortOrder	integer($int32)
total	integer($int32)
sku	string nullable: true
description	string nullable: true

}

quantity

integer($int32)

creationTime

string($date-time)

creatorUserId

integer($int64)
nullable: true

id

integer($int32)

}]

orderTags

[
nullable: true

/swagger/v1/swagger.json#/components/schemas/OrderTagListDtoOrderTagListDto{

tag

{

tenantId

integer($int32)

tagType

{

id	integer($int32)
name	string maxLength: 32 nullable: true
code	string nullable: true

}

name

string
nullable: true

lastModificationTime

string($date-time)
nullable: true

lastModifierUserId

integer($int64)
nullable: true

creationTime

string($date-time)

creatorUserId

integer($int64)
nullable: true

id

integer($int32)

}

tagId

integer($int32)

orderId

integer($int32)

lastModificationTime

string($date-time)
nullable: true

lastModifierUserId

integer($int64)
nullable: true

creationTime

string($date-time)

creatorUserId

integer($int64)
nullable: true

id

integer($int32)

}]

orderStatusCollection

[
nullable: true

/swagger/v1/swagger.json#/components/schemas/OrderStatusListDtoOrderStatusListDto{

time

string($date-time)

user

{

name

string
nullable: true

surname

string
nullable: true

userName

string
nullable: true

emailAddress

string
nullable: true

phoneNumber

string
nullable: true

lockOutEndDateUtc

string($date-time)
nullable: true

profilePictureId

string($uuid)
nullable: true

isEmailConfirmed

boolean

roles

[
nullable: true

/swagger/v1/swagger.json#/components/schemas/UserListRoleDtoUserListRoleDto{

roleId	integer($int32)
roleName	string nullable: true

}]

isActive

boolean

creationTime

string($date-time)

preferences

string
nullable: true

hasBackgroundImage

boolean

id

integer($int64)

}

order

{

}

geocode

{

id	integer($int32)
latitude	number($double)
longitude	number($double)

}

orderStatusType

{

id	integer($int32)
tenantId	integer($int32)
code*	string maxLength: 32
description*	string maxLength: 255
name	string nullable: true
color	string nullable: true
icon	string nullable: true
inactive	boolean
visible	boolean
parentId	integer($int32) nullable: true
sortOrder	integer($int32)

}

orderStatusDescription

{

id

integer($int32)

tenantId

integer($int32)

description*

string
maxLength: 255

code

string
nullable: true

name

string
nullable: true

color

string
nullable: true

icon

string
nullable: true

inactive

boolean

visible

boolean

parentId

integer($int32)
nullable: true

sortOrder

integer($int32)

orderStatusTypeId

integer($int32)

parent

{

}

note

{

id	integer($int32) nullable: true
content	string nullable: true

}

stringTime

string
nullable: true

orderType

string
nullable: true

etaString

string
nullable: true

eta

string($date-time)

lastModificationTime

string($date-time)
nullable: true

lastModifierUserId

integer($int64)
nullable: true

creationTime

string($date-time)

creatorUserId

integer($int64)
nullable: true

id

integer($int32)

}]

proximityCode

{

}

creationTime

string($date-time)

routeScheduleDetail

{

routeCode

string
nullable: true

estimatedTimeOfArrival

string($date-time)

cutOff

string($date-time)

automatic

boolean

willCall

boolean

isActive

boolean

oorRate

number($double)
nullable: true

effectivityDate

string($date-time)
nullable: true

routeScheduleId

integer($int32)

routeTypeId

integer($int32)

routeTemplateTypeId

{

}

orders

[
nullable: true

{

}]

id

integer($int32)

}

orderType

{

code	string nullable: true
description	string nullable: true
isActive	boolean
color	string nullable: true
textColor	string nullable: true
sortOrder	integer($int32)
id	integer($int32)

}

pickupEtaStart

string($date-time)

deliveryEtaEnd

string($date-time)

}

geocode

{

id	integer($int32)
latitude	number($double)
longitude	number($double)

}

geoCodeId

integer($int32)
nullable: true

value

string
nullable: true

creationTime

string($date-time)

lastModificationTime

string($date-time)
nullable: true

modifiedByName

string
nullable: true

modifiedBySurname

string
nullable: true

isAccepted

boolean

}

pickUpId

integer($int32)

pickupAddressId

integer($int32)
nullable: true

pickupContactId

integer($int32)

pickupPostalCodeId

integer($int32)

pickupFirstName

string
nullable: true

pickupLastName

string
nullable: true

pickupTime

string($date-time)

pickupAddressLine1

string
nullable: true

pickupAddressLine2

string
nullable: true

pickupCountry

string
nullable: true

pickupCity

string
nullable: true

pickupState

string
nullable: true

pickupPostal

string
nullable: true

pickupLat

number($double)

pickupLong

number($double)

pickUpCompanyName

string
nullable: true

pickUpEmail

string
nullable: true

pickUpPhone

string
nullable: true

pickupAddressType

string
nullable: true

deliveryId

integer($int32)

deliveryAddressId

integer($int32)
nullable: true

deliveryContactId

integer($int32)

deliveryPostalCodeId

integer($int32)

deliveryCompanyName

string
nullable: true

deliveryFirstName

string
nullable: true

deliveryLastName

string
nullable: true

deliveryTime

string($date-time)
nullable: true

deliveryAddressLine1

string
nullable: true

deliveryAddressLine2

string
nullable: true

deliveryCountry

string
nullable: true

deliveryCity

string
nullable: true

deliveryState

string
nullable: true

deliveryPostal

string
nullable: true

deliveryLat

number($double)
nullable: true

deliveryLong

number($double)
nullable: true

accountNo

string
nullable: true

proximityAcceptedBy

string
nullable: true

orderPackages

[
nullable: true

/swagger/v1/swagger.json#/components/schemas/OrderPackageListDtoOrderPackageListDto{

orderId

integer($int32)

packageId

integer($int32)

package

{

id	integer($int32)
name	string nullable: true
price	number($double)
code	string nullable: true
color	string nullable: true
isHiddenPackages	string nullable: true
sortOrder	integer($int32)
total	integer($int32)
sku	string nullable: true
description	string nullable: true

}

quantity

integer($int32)

creationTime

string($date-time)

creatorUserId

integer($int64)
nullable: true

id

integer($int32)

}]

orderTags

[
nullable: true

/swagger/v1/swagger.json#/components/schemas/OrderTagListDtoOrderTagListDto{

tag

{

tenantId

integer($int32)

tagType

{

id	integer($int32)
name	string maxLength: 32 nullable: true
code	string nullable: true

}

name

string
nullable: true

lastModificationTime

string($date-time)
nullable: true

lastModifierUserId

integer($int64)
nullable: true

creationTime

string($date-time)

creatorUserId

integer($int64)
nullable: true

id

integer($int32)

}

tagId

integer($int32)

orderId

integer($int32)

lastModificationTime

string($date-time)
nullable: true

lastModifierUserId

integer($int64)
nullable: true

creationTime

string($date-time)

creatorUserId

integer($int64)
nullable: true

id

integer($int32)

}]

routeId

integer($int32)
nullable: true

location

string
nullable: true

locationId

integer($int32)

orderTypeId

integer($int32)
nullable: true

orderType

string
nullable: true

pickupFormatAddress

string
nullable: true

deliverFormatAddress

string
nullable: true

deliveryEmail

string
nullable: true

deliveryPhone

string
nullable: true

pickupDetailsId

integer($int32)

deliveryDetailsId

integer($int32)

deliverAddressType

string
nullable: true

statusId

integer($int32)
nullable: true

statusDescription

string
nullable: true

orderStatuses

[
nullable: true

/swagger/v1/swagger.json#/components/schemas/OrderStatusResOrderStatusRes{

status	string nullable: true
time	string nullable: true
creator	string nullable: true
sortOrder	integer($int32)
orderStatusTypeId	integer($int32)

}]

}

No Links

400 If query has a bad format or has unknown fields. No Links

500 Something wrong occurs with this operation. No Links

Parameters

Name	Description
id integer (query)
locationId integer (query)

Responses

Code Description Links

200

Success


{
  "items": [
    {
      "id": 0,
      "routeCode": "string",
      "estimatedTimeOfArrival": "string",
      "mondayETATime": "string",
      "tuesdayETATime": "string",
      "wednesdayETATime": "string",
      "thursdayETATime": "string",
      "fridayETATime": "string",
      "saturdayETATime": "string",
      "sundayETATime": "string",
      "displayMondayETATime": "2021-02-15T14:27:20.534Z",
      "displayTuesdayETATime": "2021-02-15T14:27:20.534Z",
      "displayWednesdayETATime": "2021-02-15T14:27:20.534Z",
      "displayThursdayETATime": "2021-02-15T14:27:20.534Z",
      "displayFridayETATime": "2021-02-15T14:27:20.534Z",
      "displaySaturdayETATime": "2021-02-15T14:27:20.534Z",
      "displaySundayETATime": "2021-02-15T14:27:20.534Z",
      "cutOff": "string",
      "mondayCutOffTime": "string",
      "tuesdayCutOffTime": "string",
      "wednesdayCutOffTime": "string",
      "thursdayCutOffTime": "string",
      "fridayCutOffTime": "string",
      "saturdayCutOffTime": "string",
      "sundayCutOffTime": "string",
      "displayMondayCutOffTime": "2021-02-15T14:27:20.534Z",
      "displayTuesdayCutOffTime": "2021-02-15T14:27:20.534Z",
      "displayWednesdayCutOffTime": "2021-02-15T14:27:20.534Z",
      "displayThursdayCutOffTime": "2021-02-15T14:27:20.534Z",
      "displayFridayCutOffTime": "2021-02-15T14:27:20.534Z",
      "displaySaturdayCutOffTime": "2021-02-15T14:27:20.534Z",
      "displaySundayCutOffTime": "2021-02-15T14:27:20.534Z",
      "displayMondayLTA": "2021-02-15T14:27:20.534Z",
      "displayTuesdayLTA": "2021-02-15T14:27:20.534Z",
      "displayWednesdayLTA": "2021-02-15T14:27:20.534Z",
      "displayThursdayLTA": "2021-02-15T14:27:20.534Z",
      "displayFridayLTA": "2021-02-15T14:27:20.534Z",
      "displaySaturdayLTA": "2021-02-15T14:27:20.534Z",
      "displaySundayLTA": "2021-02-15T14:27:20.535Z",
      "mondayLTA": "string",
      "tuesdayLTA": "string",
      "wednesdayLTA": "string",
      "thursdayLTA": "string",
      "fridayLTA": "string",
      "saturdayLTA": "string",
      "sundayLTA": "string",
      "mondayIsAuto": 0,
      "tuesdayIsAuto": 0,
      "wednesdayIsAuto": 0,
      "thursdayIsAuto": 0,
      "fridayIsAuto": 0,
      "saturdayIsAuto": 0,
      "sundayIsAuto": 0,
      "etaTime": "string",
      "cutOffTime": "string",
      "today": "2021-02-15T14:27:20.535Z",
      "displayEta": "2021-02-15T14:27:20.535Z",
      "displayCutOff": "2021-02-15T14:27:20.535Z",
      "serviceTime": 0,
      "timeWindowEnd": 0,
      "timeWindowStart": 0,
      "automatic": true,
      "willCall": true,
      "oorRate": 0,
      "effectivityDate": "2021-02-15T14:27:20.535Z",
      "routeTypeId": 0,
      "routeTypeName": "string",
      "isActive": true,
      "etaLocked": true,
      "etaLockedByUserId": 0,
      "etaLockedByUser": "string",
      "locationId": 0,
      "routeTemplateId": 0,
      "location": "string",
      "dateEtaLocked": "2021-02-15T14:27:20.535Z",
      "dateEtaLockedString": "string",
      "creationTime": "2021-02-15T14:27:20.535Z",
      "creationTimeString": "string",
      "creator": "string",
      "lastModificationTime": "2021-02-15T14:27:20.535Z",
      "lastModificationTimeString": "string",
      "lastModifierUser": "string",
      "clinicId": 0,
      "scheduleSetting": [
        {
          "code": "string",
          "value": "string"
        }
      ],
      "lastModifierUserId": 0,
      "creatorUserId": 0
    }
  ]
}

ListResultDtoOfGetClinicScheduleDto {

items

[
nullable: true

/swagger/v1/swagger.json#/components/schemas/GetClinicScheduleDtoGetClinicScheduleDto{

id

integer($int32)

routeCode

string
nullable: true

estimatedTimeOfArrival

string
nullable: true

mondayETATime

string
nullable: true

tuesdayETATime

string
nullable: true

wednesdayETATime

string
nullable: true

thursdayETATime

string
nullable: true

fridayETATime

string
nullable: true

saturdayETATime

string
nullable: true

sundayETATime

string
nullable: true

displayMondayETATime

string($date-time)
nullable: true

displayTuesdayETATime

string($date-time)
nullable: true

displayWednesdayETATime

string($date-time)
nullable: true

displayThursdayETATime

string($date-time)
nullable: true

displayFridayETATime

string($date-time)
nullable: true

displaySaturdayETATime

string($date-time)
nullable: true

displaySundayETATime

string($date-time)
nullable: true

cutOff

string
nullable: true

mondayCutOffTime

string
nullable: true

tuesdayCutOffTime

string
nullable: true

wednesdayCutOffTime

string
nullable: true

thursdayCutOffTime

string
nullable: true

fridayCutOffTime

string
nullable: true

saturdayCutOffTime

string
nullable: true

sundayCutOffTime

string
nullable: true

displayMondayCutOffTime

string($date-time)
nullable: true

displayTuesdayCutOffTime

string($date-time)
nullable: true

displayWednesdayCutOffTime

string($date-time)
nullable: true

displayThursdayCutOffTime

string($date-time)
nullable: true

displayFridayCutOffTime

string($date-time)
nullable: true

displaySaturdayCutOffTime

string($date-time)
nullable: true

displaySundayCutOffTime

string($date-time)
nullable: true

displayMondayLTA

string($date-time)
nullable: true

displayTuesdayLTA

string($date-time)
nullable: true

displayWednesdayLTA

string($date-time)
nullable: true

displayThursdayLTA

string($date-time)
nullable: true

displayFridayLTA

string($date-time)
nullable: true

displaySaturdayLTA

string($date-time)
nullable: true

displaySundayLTA

string($date-time)
nullable: true

mondayLTA

string
nullable: true

tuesdayLTA

string
nullable: true

wednesdayLTA

string
nullable: true

thursdayLTA

string
nullable: true

fridayLTA

string
nullable: true

saturdayLTA

string
nullable: true

sundayLTA

string
nullable: true

mondayIsAuto

integer($int32)
nullable: true

tuesdayIsAuto

integer($int32)
nullable: true

wednesdayIsAuto

integer($int32)
nullable: true

thursdayIsAuto

integer($int32)
nullable: true

fridayIsAuto

integer($int32)
nullable: true

saturdayIsAuto

integer($int32)
nullable: true

sundayIsAuto

integer($int32)
nullable: true

etaTime

string
nullable: true

cutOffTime

string
nullable: true

today

string($date-time)

displayEta

string($date-time)

displayCutOff

string($date-time)

serviceTime

integer($int32)

timeWindowEnd

integer($int32)
nullable: true

timeWindowStart

integer($int32)

automatic

boolean

willCall

boolean

oorRate

number($double)
nullable: true

effectivityDate

string($date-time)
nullable: true

routeTypeId

integer($int32)

routeTypeName

string
nullable: true

isActive

boolean

etaLocked

boolean

etaLockedByUserId

integer($int64)
nullable: true

etaLockedByUser

string
nullable: true

locationId

integer($int32)
nullable: true

routeTemplateId

integer($int32)
nullable: true

location

string
nullable: true

dateEtaLocked

string($date-time)
nullable: true

dateEtaLockedString

string
nullable: true

creationTime

string($date-time)

creationTimeString

string
nullable: true

creator

string
nullable: true

lastModificationTime

string($date-time)
nullable: true

lastModificationTimeString

string
nullable: true

lastModifierUser

string
nullable: true

clinicId

integer($int32)
nullable: true

scheduleSetting

[
nullable: true

/swagger/v1/swagger.json#/components/schemas/GetRouteScheduleSettingsItemDtoGetRouteScheduleSettingsItemDto{

code	string nullable: true
value	string nullable: true

}]

lastModifierUserId

integer($int64)
nullable: true

creatorUserId

integer($int64)
nullable: true

}]

}

No Links

400 If query has a bad format or has unknown fields. No Links

500 Something wrong occurs with this operation. No Links

POST ​/api​/TokenAuth​/Authenticate

Parameters

Responses

GET ​/api/services/app/ShippingPackage/GetPackageTypes

Parameters

Responses

GET ​/api​/services​/app​/TagType​/GetTagTypes Standard Edition Only

Parameters

Responses

POST ​/api​/services​/app​/Order​/CreateOrder

Parameters

Responses

POST ​/api​/services​/app​/Order​/CreateLabel Laboratory Edition Only

Parameters

Responses

POST ​/api​/services​/app​/Order​/CancelOrder

Parameters

Responses

GET ​/api​/services​/app​/Order​/TrackOrder

Parameters

Responses

GET ​/api​/services​/app​/Clinics​/GetClinicSchedule Laboratory Edition Only

Parameters

Responses