Update delivery
POST {{kroger-baseUrl}}/courier/deliveries/:delivery_id
Provides access to update a delivery status. The action
parameter
is required in the body for each update.
The payload parameter is only required
with the following actions:
* CONFIRM
* CONFIRM_EDITING
* CANCEL
* EN_ROUTE_TO_PICK_UP
Request Body
{"action"=>"<string>", "payload"=>{"cancellationNote"=>"<string>", "driver"=>{"firstName"=>"<string>", "lastName"=>"<string>", "vehicle"=>{"licensePlate"=>"<string>", "year"=>"<string>", "model"=>"<string>", "make"=>"<string>"}}, "dropoffEta"=>{"timezone"=>"<string>", "value"=>"<string>"}, "pickupEta"=>{"timezone"=>"<string>", "value"=>"<string>"}, "trackingUrl"=>"<string>"}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
"\u003celement\u003e\n \u003cdata\u003e\n \u003ccreatedAt\u003e\n \u003ctimezone\u003e(string)\u003c/timezone\u003e\n \u003cvalue\u003e(string)\u003c/value\u003e\n\u003c/createdAt\u003e\n \u003cid\u003e(string)\u003c/id\u003e\n \u003cspec\u003e\n \u003cbeginDate\u003e\n \u003ctimezone\u003e(string)\u003c/timezone\u003e\n \u003cvalue\u003e(string)\u003c/value\u003e\n\u003c/beginDate\u003e\n \u003cdropoff\u003e\n \u003ccontact\u003e\n \u003cemailAddress\u003e(string)\u003c/emailAddress\u003e\n \u003cfirstName\u003e(string)\u003c/firstName\u003e\n \u003clastName\u003e(string)\u003c/lastName\u003e\n \u003cphone\u003e\n \u003cnumber\u003e(string)\u003c/number\u003eundefined\n\u003c/phone\u003e\n\u003c/contact\u003e\n \u003caddress\u003e\n \u003cline1\u003e(string)\u003c/line1\u003e\n \u003cline2\u003e(string)\u003c/line2\u003e\n \u003ccountry\u003e(string)\u003c/country\u003e\n \u003clocality\u003e(string)\u003c/locality\u003e\n \u003cname\u003e(string)\u003c/name\u003e\n \u003cpostalCode\u003e(string)\u003c/postalCode\u003e\n \u003cregion\u003e(string)\u003c/region\u003e\n\u003c/address\u003eundefined\n \u003cspecialInstructions\u003e(string)\u003c/specialInstructions\u003e\n\u003c/dropoff\u003e\n \u003cendDate\u003e\n \u003ctimezone\u003e(string)\u003c/timezone\u003e\n \u003cvalue\u003e(string)\u003c/value\u003e\n\u003c/endDate\u003eundefined\n \u003corderNo\u003e(string)\u003c/orderNo\u003e\n \u003corderItems\u003e\n \u003cunit\u003e(string)\u003c/unit\u003eundefined\n\u003c/orderItems\u003e\n \u003corderItems\u003e\n \u003cunit\u003e(string)\u003c/unit\u003eundefined\n\u003c/orderItems\u003e\n \u003cpickup\u003e\n \u003ccontact\u003e\n \u003ccompanyName\u003e(string)\u003c/companyName\u003e\n \u003cemailAddress\u003e(string)\u003c/emailAddress\u003e\n \u003cphone\u003e\n \u003cnumber\u003e(string)\u003c/number\u003eundefined\n\u003c/phone\u003e\n\u003c/contact\u003e\n \u003caddress\u003e\n \u003cline1\u003e(string)\u003c/line1\u003e\n \u003cline2\u003e(string)\u003c/line2\u003e\n \u003ccountry\u003e(string)\u003c/country\u003e\n \u003clocality\u003e(string)\u003c/locality\u003e\n \u003cname\u003e(string)\u003c/name\u003e\n \u003cpostalCode\u003e(string)\u003c/postalCode\u003e\n \u003cregion\u003e(string)\u003c/region\u003e\n\u003c/address\u003e\n \u003cspecialInstructions\u003e(string)\u003c/specialInstructions\u003e\n \u003clocationId\u003e(string)\u003c/locationId\u003e\n\u003c/pickup\u003e\n\u003c/spec\u003e\n \u003cstatus\u003e\n \u003ccancellationNote\u003e(string)\u003c/cancellationNote\u003e\n \u003ccourierName\u003e(string)\u003c/courierName\u003e\n \u003cstate\u003e(string)\u003c/state\u003e\n \u003cdriver\u003e\n \u003cfirstName\u003e(string)\u003c/firstName\u003e\n \u003clastName\u003e(string)\u003c/lastName\u003e\n \u003cvehicle\u003e\n \u003clicensePlate\u003e(string)\u003c/licensePlate\u003e\n \u003cyear\u003e(string)\u003c/year\u003e\n \u003cmodel\u003e(string)\u003c/model\u003e\n \u003cmake\u003e(string)\u003c/make\u003e\n\u003c/vehicle\u003e\n\u003c/driver\u003e\n \u003cdropoffEta\u003e\n \u003ctimezone\u003e(string)\u003c/timezone\u003e\n \u003cvalue\u003e(string)\u003c/value\u003e\n\u003c/dropoffEta\u003e\n \u003cpickupEta\u003e\n \u003ctimezone\u003e(string)\u003c/timezone\u003e\n \u003cvalue\u003e(string)\u003c/value\u003e\n\u003c/pickupEta\u003e\n \u003ctrackingUrl\u003e(string)\u003c/trackingUrl\u003e\n\u003c/status\u003e\n \u003cmodifiedAt\u003e\n \u003ctimezone\u003e(string)\u003c/timezone\u003e\n \u003cvalue\u003e(string)\u003c/value\u003e\n\u003c/modifiedAt\u003e\n\u003c/data\u003e\n \u003cmeta\u003e\n \u003cfilter\u003e(string)\u003c/filter\u003e\n\u003c/meta\u003e\n\u003c/element\u003e"