OnTime REST API
OnTime REST API / REST Endpoints Resource Group / api/orders (Get)
In This Topic
    Getapi/orders
    In This Topic

    Resource Path: /sites/{company-id}/api/orders

    Uri: https://secure.ontime360.com/sites/{company-id}/api/orders

    Description
    Finds and returns unique identifiers for all Orders that match a given criteria.
    Parameters
    NameDescriptionData Type
    The name of the Customer assigned to an Order as a String.string
    The unique identifier of the collection Location assigned to an Order as a Guid.string
    The exact date that an Order was made as a Datestring
    The inclusive lower-bound of a Payment date as a Date.string
    The inclusive upper-bound of a Payment date as a Date.string
    The unique identifier of the delivery Location assigned to an Order as a Guid.string
    The unique identifier of the User currently assigned to an Order as a Guid.string
    The incoming tracking number of an Order as a String.string
    The outgoing tracking number of an Order as a String.string
    The purchase order number of an Order as a String.string
    The reference number of an Order as a String.string
    The status of an Order as a pre-defined String, or as a pre-defined Integer.


    Status Values:
    0 - None
    1 - Dispatched
    2 - AssignedInRoute
    3 - Delivered
    4 - Cancelled
    5 - CancelledBillable
    6 - Assigned
    7 - Stored
    8 - UnassignedStored
    9 - Quoted

    Available Values: [None, Dispatched, AssignedInRoute, Delivered, Cancelled, CancelledBillable, Assigned, Stored, UnassignedStored, Quoted]
    string
    The tracking number of the orders.string
    200 Response

    The response body is of type Array[].

    An array of unique Guid identifiers assigned to matching Order objects.
    Fault Responses
    FaultDescription
    Request was improperly formatted, contained invalid data, or contained incorrect values. See response body for more information.
    Authorization key is invalid or no longer exists.
    Authorization key does not have permission to perform this action, or does not have permission to access the requested data. See response body for more information.
    See Also