OnTime REST API
OnTime REST API / REST Endpoints Resource Group / api/order/updateStatus (Post)
In This Topic
    Postapi/order/updateStatus
    In This Topic

    Resource Path: /sites/{company-id}/api/order/updateStatus

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

    Description
    Updates the current status of an existing Order.
    Parameters
    NameDescriptionData Type
    The unique identifier of the Order as a Guid.string
    The tracking number assigned to the Order as a String.string
    The new label assigned to the status update as a String.string
    The new status of an Order as a pre-defined String, or as a pre-defined Integer. Available Values: [None, Dispatched, AssignedInRoute, Delivered, Cancelled, CancelledBillable, Assigned, Stored, UnassignedStored, Quoted]string
    The exact date that the status change occurred as a Date.string
    Request

    The request body is of type object.

    A comprehensive Status object containing the details of the status update.
    200 Response

    The response body is of type object.

    Returns true if the Order's status was successfully updated. Otherwise, returns false.
    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