Update Order

patch

https://v3.api.hypertrack.com/orders/{order_handle}

Update information for an order identified by the order handle

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

order_handle

string

required

Query Params

type

string | null

Defaults to null

Type of the order which can be drop or pick

type_index

integer | null

Defaults to null

Integer representing the pick or drop order index when having a pick/drop scenario

fulfillment_attempt

integer | null

Defaults to null

The attempt number for fulfilling the order

Body Params

metadata

object | null

attachments

array | null

Defaults to null

Attachments for this order

attachments

destination

Destination of the order. This field can only be updated before tracking is started for an order.

scheduled_at

string | null

Defaults to null

Schedule time by which order needs to be fulfilled. This field can only be updated before tracking is started for an order.

scheduled_after

string | null

Defaults to null

Schedule time after which the worker needs to fulfill order (similar to slot start). This field can only be updated before tracking is started for an order.

expected_service_time

integer | null

Defaults to null

Specified in seconds.

product_type

array of strings | null

Defaults to null

Array of string representing skills required to fulfill the order

product_type

type

string | null

enum

Defaults to null

Type of Order

Allowed:

type_index

integer | null

Defaults to null

Type index of the order, used in pick/drop scenario

capacity_used

integer | null

Defaults to null

Volumetric units which is to be occupied by the order

ops_group_handle

string | null

Defaults to null

Unique Handle of Ops Group to which order needs to be reassigned

timesheets

array of objects | null

Defaults to null

Only used when the order is in standalone closeout mode; forwarded as-is to closeout-copilot.

timesheets

worker_locations

array of objects | null

Defaults to null

Only used when the order is in standalone closeout mode; forwarded as-is to closeout-copilot.

worker_locations

messages

array of objects | null

Defaults to null

Only used when the order is in standalone closeout mode; forwarded as-is to closeout-copilot.

messages

facility_name

string | null

Defaults to null

Only used when the order is in standalone closeout mode; forwarded as-is to closeout-copilot.

Responses

200Successful response

401Authentication error

404Not found

422Validation error