Update order

patch

https://api.fulflld.com/v1/orders/{id}/{internalId}

Path Params

string

required

Given orderId during order creation

internalId

string

required

Unique identifier of your order. This is used when executing other operations such as update

Body Params

Request body

externalId

string

A unique friendly ID that is displayed in the Order Card for easy identification for the user

status

string

enum

Desired status of the order

Allowed:

order

object

pickupDetails

object

dropoffDetails

object

deliveryRequirements

object

pickupRequirements

object

etaDateTime

date-time

ETA for the driver to reach the destination

dropoffAttachments

array of uris

An array of URLs pointing to POD (Proof of Delivery) images attached at the time of drop-off completion.

dropoffAttachments

externalAssignee

object

timezone

string

enum

Timezone for the order, must be one of the supported timezones

smsNotification

boolean

Whether to send SMS notification to the user for this order, default is true

Responses

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Bad Request

403Forbidden

500Internal Server Error