CareTend APIs

Updates a delivery ticket by the specified unique identifier with the request body sent in.

patch
https://integrationhub.wellsky.io/commands/v4/deliverytickets/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required
Defaults to null

The unique identifier of a Delivery Ticket to update.

Query Params
string

The requested API version

Body Params

The properties and information available to have updated on a DeliveryTicket.

int64 | null
≥ 1

The unique identifier of the Company

date-time | null

The tickets target delivery date in UTC.

date-time | null

The promised delivery date in UTC.
This value will be required if StartPromisedTime or EndPromisedTime are provided.
To clear the promised date, send DateTime.MinValue (0001-01-01T00:00:00Z).

date-time | null

The earliest time of day for delivery on the PromisedDate in UTC.
Any date information will be ignored.
To clear the start promised time, send DateTime.MinValue (0001-01-01T00:00:00Z).

date-time | null

The latest time of day for delivery on the PromisedDate in UTC.
Any date information will be ignored.
To clear the end promised time, send DateTime.MinValue (0001-01-01T00:00:00Z).

boolean | null

Flag to override the dates.

string | null

Delivery instructions for the delivery ticket.

string | null

One delivery instructions for the delivery ticket.

string | null

Footer statement for the delivery. It is a lookup value as well as free text will try to find the footer statement in lookups.
In case there is no matching footer statement in lookups will consider that value as free text footer statement.
First footer will be default from the list.
To clear the footer statement, send an empty string "".

int64 | null
≥ 1

Unique identifier for the patient address id.
Primary address of the patient will be default.

string | null

Lookup value for delivery reason. Default delivery reason from the program options.

string | null

Customer purchase order number.

string | null

Lookup value for shipping method.

int64 | null
≥ 0

Unique identifier for the driver (Employee id). Driver is a employee who have make deliveries option checked.
To clear the driver assignment, send 0.

boolean | null

Flag to mark delivery ticket as signature required for delivery verification.

string | null

Lookup value for service type. This should be selected only when we have shipping method because it depends on shipping method.
Value marked as default from the list filtered based on shipping method. Some examples below.

string | null

Lookup value for package type. This should be selected only when we have shipping method because it depends on shipping method.
Value marked as default from the list filtered based on shipping method.

int32 | null
≥ 1

Number of packages expected to be delivered.

string | null

Note for the delivery ticket.

string | null

The Delivery Tickets confirmation number

string | null

The name of the tickets status to set it to.

string | null

The name of the tickets delivery status to set it to. Some examples found below.

Headers
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

Updated 3 months ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?