PUT <baseURL>/deliveries/{deliveryId}/update
This request updates the delivery information, such as the destination location address, or the customer's name.
Use this request after the customer has booked the delivery but needs to update or to change delivery information details.
These details include the customer’s name or phone number, delivery time slots, pickup or address location, or the order line items.
At least one parameter sent must be different than the existing one.
In other words, if at least one of the parameters is different than its existing value, the request will succeed.
If there are no changes, the request will fail and the delivery information remains unchanged.
One or more parameters may be sent in the request.
With a successful request, all parameters sent will replace their existing values.
For that reason, Walmart GoLocal recommends sending only the parameters to change to ovoid unintentional changes.
Although any parameter can be changed, many of them have limitations and restrictions that otherwise must still be followed.
Any unallowed changes will fail the request.
See the Book Delivery request for specific parameter information.
The following items cannot be changed after Walmart GoLocal assigns a delivery driver to the delivery:
- The pickup address
- The drop-off address
- The drop-off coordinates if they are of type CUSTOMER_PINDROP
- The customer's phone number
The following items cannot be changed after Walmart GoLocal dispatches the order from the pickup point:
- The delivery time slots details
- The order line items
- The scan details
- The customer's name
- Pickup instructions
- Property details (propertyType, locationPreference and/or gateCode)
Property Type and Location Preference Validation
For property type and location preference values, the following combinations are allowed:
| Enum of locationPreference | HOUSE | APARTMENT | BUSINESS | OTHER | null |
|---|---|---|---|---|---|
| FRONT_DOOR | Optional | Optional | Optional | Optional | Not Allowed |
| BACK_DOOR | Optional | Not Allowed | Not Allowed | Optional | Not Allowed |
| SIDE_PORCH | Optional | Not Allowed | Not Allowed | Optional | Not Allowed |
| BUILDING_RECEPTION | Not Allowed | Optional | Optional | Optional | Not Allowed |
| MAILROOM_OR_PROPERTY_STAFF | Not Allowed | Optional | Optional | Optional | Not Allowed |
| GARAGE_DOOR | Optional | Not Allowed | Not Allowed | Optional | Not Allowed |
| NO_PREFERENCE | Optional | Optional | Optional | Optional | Not Allowed |
Example
This request changes the customer's first name to Fiona and with the deliveryId of 6c34ee66-dd03-42a0-8aa1-ddddeb03d28d:
PUT {baseURL}/deliveries/6c34ee66-dd03-42a0-8aa1-ddddeb03d28d/update
Request body:
{ "deliveries": { "clientId": "49304", "externalOrderId": "10208877499-208925547882099", "deliveryMethod": "SCHEDULED_DELIVERY", "orderPickupReadyTime": "2024-09-06T19:00:00.000Z", "requestedMinDeliverySlotTime": "2024-09-06T19:00:00.000Z", "requestedMaxDeliverySlotTime": "2024-09-06T21:00:00.000Z", "customer": { "firstName": "John", "lastName": "Doe", "email": "[email protected]", "phone": { "countryCode": "1", "number": "(650) 8375000" } }, "addOnServices": { "returnable": true, "attendedDelivery": true, "proofOfDelivery": true, "capturePhotoProof": true, "isDropOffOTPRequired": false, "captureSignatureProof": false, "chainOfCustody": true }, "pickupDetails": { "pickupPointId": "101979", "externalPickupPointId": "969" }, "instructions": [ { "instructionText": "Ring bell when arriving.", "instructionType": "CUSTOMER" } ], "deliveryDetails": { "address": { "line1": "853 W California Ave", "line2": "Apt 10", "city": "Sunnyvale", "state": "CA", "zipCode": "94086", "countryCode": "US" }, "latLong": { "type": "CUSTOMER_PINDROP", "lat": 37.12345, "lng": -122.12345 }, "propertyDetails": { "gateCode": "C-1278", "propertyType": "BUSINESS", "locationPreference": "BUILDING_RECEPTION" } }, "scanDetails": [ { "scanDetail": [ { "scanId": "W1321433777-1" } ], "scanType": "CODE128" } ], "orderManifest": { "summary": { "totalItems": 4, "orderSize": "S", "dimensions": [ { "length": 25, "width": 5.25, "height": 4.25, "unitOfMeasure": "IN" } ], "totalValueOfItems": { "currencyAmount": 86.59, "currencyUnit": "USD" }, "totalOrderWeight": { "measurementValue": 20, "unitOfMeasure": "OZ" }, "specialHandlingAttributes": { "hasHazmatItems": false, "hasAlcoholItems": false, "hasFragileItems": false, "hasPharmacyItems": false } }, "itemDetails": [ { "itemId": "string", "itemDescription": "Milk Shake", "dimensions": { "length": 3.75, "width": 4.25, "height": 6, "unitOfMeasure": "IN" }, "quantity": 4, "itemWeight": { "measurementValue": 5, "unitOfMeasure": "OZ" }, "itemTotal": { "currencyAmount": 36.45, "currencyUnit": "USD" } } ] } } }
Response body:
{ "deliveries": { "deliveryId": "607ef162-17d7-4a32-92c0-5e0262d12345", "externalOrderId": "10208877499-208925547882099" }
}
See Also
To book a delivery, see POST /deliveries.
To cancel a delivery, see PUT /deliveries/{deliveryId}/cancel.