OnTime REST API
In This Topic
    OnTime REST API
    In This Topic
    Description

    This page contains the definitions for all of the endpoints that are available in the OnTime REST API. These endpoints are added to the end of the Customer Web Port Uri for the account that is being accessed. If you do not know the Customer Web Portal Uri for the account that you are working with, please contact the account administrator to obtain this Uri. The following is an example of a Uri for the OnTime REST API.

    URI
    Copy Code
    https://your-customer-web-portal-url/api/contact/post

     

    REST Endpoints
    Post/api/contact/post
    Create or update a contact. Note: if the parameter ID is not specified, then this function will create a new contact.
    Get/api/contacts/{id}
    Query the database for a contact object.
    Get/api/contacts/authenticate
    Authenticates a customer's contact.
    Post/api/customer/post
    Create or update a customer. Note: if the parameter ID is not specified, then this function will create a new customer.
    Get/api/customers
    Query the database for a list of customer indentifiers.
    Get/api/customers/{id}
    Query the database for a customer object.
    Get/api/customers/authenticate
    Authenticates a customer.
    Post/api/department/post
    Create or update a department. Note: if the parameter ID is not specified, then this function will create a new department.
    Get/api/departments/{id}
    Query the database for a department object.
    Get/api/fileAttachments
    Query the database for a list of file attachment indentifiers for an order.
    Get/api/fileAttachments/{id}
    Query the database for a file attachment object.
    Post/api/invoice/post
    Create or update an invoice. Note: if the parameter ID is not specified, then this function will create a new invoice.
    Get/api/invoices
    Query the database for a list of invoice indentifiers.
    Get/api/invoices/{id}
    Query the database for an invoice object.
    Post/api/item/post
    Create or update an item. Note: if the parameter ID is not specified, then this function will create a new item.
    Get/api/items/{id}
    Query the database for an item object.
    Post/api/location/post
    Create or update a location. Note: if the parameter ID is not specified, then this function will create a new location.
    Get/api/locations
    Query the database for a list of location indentifiers.
    Get/api/locations/{id}
    Query the database for a location object.
    Post/api/order/codRequirement
    Update an order's cod requirement.
    Delete/api/order/fileAttachment/delete/{id}
    Deletes a file attachment for an order.
    Post/api/order/fileAttachment/post/{orderID}
    Uploads a file attachment for an order
    Post/api/order/getTotalCost
    Get a price quote for an order. This function does not submit an order.
    Post/api/order/post
    Create or update a order. Note: if the parameter ID is not specified, then this function will create a new order.
    Get/api/order/report
    Generate a report as a pdf or png. Report types: BOL (Bill of Lading), SL (Shipping Label), WB (Waybill).
    Get/api/order/signature
    Query the database for the signature associated with an order object.
    Post/api/order/signatureRequirement
    Update an order's signature requirement.
    Get/api/order/updatePrices/{id}
    Updates the prices of an order object.
    Post/api/order/updateStatus
    Update an order's status.
    Get/api/orders
    Query the database for a list of order indentifiers.
    Get/api/orders/{id}
    Query the database for an order object.
    Get/api/orderStatusChanges/{orderID}
    Query the database for a list of status changes associated with an order.
    Post/api/payment/post
    Create or update a payment. Note: if the parameter ID is not specified, then this function will create a new payment.
    Get/api/payments
    Query the database for a list of payment indentifiers.
    Get/api/payments/{id}
    Query the database for a payment object.
    Get/api/priceModifiers/{id}
    Query the database for a price modifier object.
    Get/api/priceModifiersByName/{name}
    Query the database for a price modifier object by name.
    Get/api/priceSets/{id}
    Query the database for a price set object.
    Get/api/priceSetsByName/{name}
    Query the database for a price set object by name.
    Get/api/statuses/{id}
    Query the database for the status of an order.
    Get/api/user/availability/{userID}
    Query the database for the availability of a user.
    Get/api/user/position
    Query the database for a list of positions of a user.
    Get/api/user/position/{userID}
    Query the database for the current position of a user.
    Post/api/user/updateAvailability
    Updates the user's availability
    Post/api/user/updatePosition
    Updatea user's position.
    Post/api/userMiscCompensation/post
    Create or update a user miscellaneous compensation. Note: if the parameter ID is not specified, then this function will create a new user miscellaneous compensation.
    Get/api/userMiscCompensations/{id}
    Query the database for a user miscellaneous compensation object.
    Get/api/users
    Query the database for a list of user identifiers.
    Get/api/users/{id}
    Query the database for a user object.
    Get/api/users/authenticate
    Authenticates a user.
    Post/api/userSession/post
    Create or update a user session. Note: if the parameter ID is not specified, then this function will create a new user session.
    Get/api/userSessions
    Query the database for a list of user session identifiers.
    Get/api/userSessions/{id}
    Query the database for a user session object.
    Post/api/vehicle/post
    Create or update a vehicle. Note: if the parameter ID is not specified, then this function will create a new vehicle.
    Get/api/vehicles
    Query the database for a list of vehicle identifiers.
    Get/api/vehicles/{id}
    Query the database for a vehicle object.
    Post/api/zone/post
    Create or update a zone. Note: if the parameter ID is not specified, then this function will create a new zone.
    Get/api/zones
    Query the database for a list of zone identifiers.
    Get/api/zones/{id}
    Query the database for a zone object.
    Json Schemas
    Contains properties of a customer contact in an OnTime account for use in the OnTime Online API.
    Contains properties of a customer contact in an OnTime account.
    Contains properties of a customer in an OnTime account for use in the OnTime Online API.
    Contains properties of a customer department in an OnTime account for use in the OnTime Online API.
    Contains properties of a customer department in an OnTime account.
    Contains properties of a customer in an OnTime account.
    An enumeration of Order base price types.
    Contains properties of an invoice in an OnTime account for use in the OnTime Online API.
    Contains properties of an invoice in an OnTime account.
    Contains properties of an item in an order in an OnTime account for use in the OnTime Online API.
    Contains properties of an item in an order in an OnTime account.
    Contains properties of a location in an OnTime account for use in the OnTime Online API.
    Contains properties of a zone in an OnTime account for use in the OnTime Online API.
    Contains properties of a zone in an OnTime account.
    Contains properties of a location in an OnTime account.
    Contains properties of an order in an OnTime account for use in the OnTime Online API.
    Contains properties of a time window for an order in an OnTime account for use in the OnTime Online API.
    Contains properties of a time window for an order in an OnTime account.
    Contains properties of an order status in an OnTime account for use in the OnTime Online API.
    Contains properties of an order status in an OnTime account.
    Contains properties of a user defined field for an order in an OnTime account for use in the OnTime Online API.
    Contains properties of a user defined field for an order in an OnTime account.
    Contains properties of a user misc compensation in an OnTime account for use in the OnTime Online API.
    Contains properties of a user misc compensation in an OnTime account.
    An enumeration of user roles.
    An enumeration of types of compensation
    Contains properties of a vehicle type in an OnTime account for use in the OnTime Online API.
    Contains properties of a vehicle type in an OnTime account.
    Contains properties of a price modifier in an OnTime account for use in the OnTime Online API.
    Contains properties of a price modifier in an OnTime account.
    An enumeration of PriceModifier types.
    An enumeration of input fields.
    Contains properties of an order in an OnTime account.
    An enumeration of Order statuses.
    Contains properties of a file attachment for an order in an OnTime account for use in the OnTime Online API.
    Contains properties of file attachment for an order in an OnTime account.
    Contains properties of a payment in an OnTime account for use in the OnTime Online API.
    Contains properties of a payment in an OnTime account.
    Contains properties of a user's availability for a user in an OnTime account for use in the OnTime Online API.
    Contains properties of a user's availability for a user in an OnTime account.
    Contains properties of a user session for a user in an OnTime account for use in the OnTime Online API.
    Contains properties of a user session for a user in an OnTime account.
    An enumeration of user login types.
    Contains properties of a vehicle in an OnTime account for use in the OnTime Online API.
    Contains properties of a vehicle in an OnTime account.
    An enumeration of Order signature types.
    Contains properties of a price set in an OnTime account for use in the OnTime Online API.
    Contains properties of a price set in an OnTime account.
    Contains properties of a user in an OnTime account for use in the OnTime Online API.
    Contains properties of a user in an OnTime account.
    Contains properties of a user's position for a user in an OnTime account for use in the OnTime Online API.
    Contains properties of a user's position for a user in an OnTime account for use in the OnTime Online API.