Search deliveries

post

https://developer.api.us.walmart.com/api-proxy/service/supplychain/transportation/v1/daas/deliveries/search

This request searches for specific deliveries.

Example

This request specifies the only required parameter, the clientId, in this case for clientId of 2.
This returns all deliveries associated with clientId of 2.

POST {baseURL}/deliveries/search

Request body:

{ "clientId": "2"
}

This request specifies clientId of 2 and also returns 75 deliveries for each page, rather than the default 20.

{baseURL}/deliveries/search?pageSize=75

Request body:

{ "clientId": "2"
}

This request restricts the search from clientId of 2 but to deliveryStatus of DELIVERED.

POST {baseURL}/deliveries/search

Request body:

{ "clientId": "2", "deliveryStatus": "DELIVERED"
}

This request restricts the search based on the customer's first name and from among either of two pickup points.

POST {baseURL}/deliveries/search

Request body:

{ "clientId": "2", "customerFirstName" : "Jordan", "pickupPointId": [ "101979", "101387" ]
}

This request searches for delivery orders created between within a date range, in UNIX time seconds or milliseconds.

POST {baseURL}/deliveries/search

Request body:

{ "clientId" : "2", "deliveryCreateStartDate" : 1707858284942, "deliveryCreateEndDate" : 1718312684942
}

Time	Status	User Agent
Retrieving recent requests…

The externalOrderId is a value specified by the client at the time the order is placed.
This allows the client to customize the order number to be consistent with their own numbering system.
The externalOrderId may be different than the orderId, which is a value assigned by Walmart GoLocal at the time the order is placed.
Regardless, the externalOrderId and orderId refer to the same delivery order.

Examples:
465-RMN-TU
9003299567-001
1551250927
10208877499-208925547882099

deliveryStatus

string

Specifies the status of the delivery.

Valid values are:

Value	Meaning
ARRIVED_AT_DROPOFF	The delivery driver confirmed arrival at the drop-off location.
ARRIVED_AT_PICKUP	The delivery driver confirmed arrival at the pickup location.
ARRIVED_AT_RETURN	The delivery driver arrived at the pickup point to return the items that could not be delivered to the location.
CANCEL_REQUESTED	A cancellation has been requested, but has not been confirmed; the Walmart GoLocal system is processing the request.
CANCELLED	The delivery has a confirmed cancellation. This concludes the delivery order.
DELIVERED	The delivery driver dropped off the items at the drop-off location.
DELIVERY_REQUEST_FAILED	The delivery request failed. The delivery process concludes.
DELIVERY_REQUESTED	The client requested delivery from Walmart GoLocal, and the next step is to search for, and assign, a delivery driver.
DISPATCHED	The delivery driver picked up the delivery items and is ready to proceed to the drop-off location.
DRIVER_ASSIGNED	The delivery is assigned to a delivery driver, and the delivery driver confirmed availability to deliver.
DRIVER_CANCELLED	The delivery request was canceled by the driver. This must occur after DRIVER_ASSIGNED.
DRIVER_DROPPED	The assigned delivery driver dropped the trip as a delivery; that specific delivery driver will not complete the trip.
ENROUTE_TO_DROPOFF	The delivery driver picked up the delivery items and is on the way to the drop-off location.
ENROUTE_TO_PICKUP	The delivery driver is on the way to the pickup point.
ENROUTE_TO_RETURN	The delivery driver is unable to drop off items and is returning the items to the pickup point.
RETURNED	The delivery driver returned items at the return location. This concludes the delivery order.
UPDATE_FAILED	The delivery order failed to update the delivery details.
UPDATE_REQUESTED	A delivery order update has been requested, but has not yet been confirmed.
UPDATED	The delivery is confirmed to have been updated.
WALMART_CANCELLED	The delivery was canceled by Walmart GoLocal.

Example: DELIVERED

customerFirstName

string

Specifies the first name of the customer who placed the delivery request.

This is an optional input field.

Example: John

customerLastName

string

Specifies the last name of the customer who placed the delivery request.

This is an optional input field.

Example: Doe

driverFirstName

string

Specifies the first name of the delivery driver.

This is an optional input field.

Examples: Jane

driverLastName

string

Specifies the last name of the delivery driver.

This is an optional input field.

Examples: Doe

deliveryCompletionDayRange

int32

≥ 1

Specifies deliveries completed within the last number of specified days.

To return deliveries completed within a range of days, include both deliveryCompletionDayRange and deliveryCreationDayRange.

This is an optional input field.

Example: 1

deliveryCreationDayRange

int32

≥ 1

Specifies deliveries created within the last number of specified days.

To return deliveries completed within a range of days, include both deliveryCompletionDayRange and deliveryCreationDayRange.

This is an optional input field.

Example: 1

clientId

array

Specifies the client identifier associated with the client.

Example: 2

clientId

pickupPointId

array

Specifies an array of objects with a list of pickup details.

This is an array of either pickupPointId or externalPickupPointId.
For example, for one item:

"pickupDetails": [ { "externalPickupPointId": "107730" }
]

For multiple items:

"pickupDetails": [ { "externalPickupPointId": "107730" }, { "externalPickupPointId": "307429" }
]

At least one entry but no more than 10 are required for either pickupPointId or externalPickupPointId.
However, there cannot be entries both; use one or the other.

Examples:

101979

101979, 342345

pickupPointId

externalPickupPointId

string

Specifies an external pickup point ID defined by the client.

The external pickup point ID is the client-specified identifier for each pickup point.
This value may be different than the pickup points ID.
This is an optional input field.

Examples:

4969

StoreNo15

deliveryStartDate

integer

Specifies the timestamp (in Unix timestamp format seconds or milliseconds) of the start of planned delivery start date.

To return deliveries completed within a range of timestamps, include both deliveryEndDate and deliveryStartDate.

This is an optional input field.

Example: 1582552800

deliveryEndDate

integer

Specifies the timestamp (in Unix timestamp format seconds or milliseconds) of the end of planned delivery start date.

To return deliveries completed within a range of timestamps, include both deliveryEndDate and deliveryStartDate.

This is an optional input field.

Example: 1582552800

orderCreateStartDate

integer

Specifies the timestamp (in Unix timestamp format seconds or milliseconds) of the start of order`s creation date.

To return orders created within a range of timestamps, include both orderCreateEndDate and orderCreateStartDate.

If orderCreateStartDate is provided, orderCreateEndDate is required.

This is an optional input field.

Example: 1662846514

orderCreateEndDate

integer

Specifies the timestamp (in Unix timestamp format seconds or milliseconds) of the end of order`s creation date.

To return orders created within a range of timestamps, include both orderCreateEndDate and orderCreateStartDate.

If orderCreateEndDate is provided, then orderCreateStartDate is required.

This is an optional input field.

Example: 1662853714

deliveryCreateStartDate

integer

Specifies the timestamp (in Unix timestamp format seconds or milliseconds) when the delivery creation started.

To return deliveries created within a range of timestamps, include both deliveryCreateEndDate and deliveryCreateStartDate.

This is an optional input field.

Example: 1663188523

deliveryCreateEndDate

integer

Specifies the timestamp (in Unix timestamp format seconds or milliseconds) when the delivery creation ended.

To return deliveries created within a range of timestamps, include both deliveryCreateEndDate and deliveryCreateStartDate.

This is an optional input field.

Example: 1663188682

customerPhoneNumber

string

Specifies the phone number of the customer who placed the delivery request.

This is an optional input field.

The phone number may be in any of the following formats.

Examples:

4085551234

408 5551234

(408) 5551234

(408) 555-1234

14085551234

driverPhoneNumber

string

Specifies the phone number of the delivery driver.

Filtering with this parameter supports partial matching.
No wildcard characters are needed.
A partial match finds the string ending with this value and any characters before.
For example, specifying 408 matches 4065551408.
It will not match 4065554081.

This is an optional input field.

The phone number may be in any of the following formats.

Examples:

1234567689

123 4567689

(123) 4567689

(123) 456 -7689

11233567688

routeId

string

Specifies the name of the route or path suggested for the delivery.

Walmart GoLocal uses the routeId parameter only if the system batches orders.

This is an optional input field.

Example: 2534572931

batchId

uuid

length between 36 and 36

Specifies a batch identifier for the delivery.

This value is used to return all associated deliveries.

The batchId field is returned in the response body once Walmart GoLocal batches that delivery with other deliveries.
Implement your system design and operational processes keeping this in mind.

This is an optional input field.

Examples: 3bebc016-0093-4f31-ba22-8d319c7f26f6

Headers

Authorization

string

required

Specifies the literal value for Bearer \<authenticationToken\>.

The authenticationToken is an access token representing a user’s valid authorization and authentication permissions.
See Authentication for additional information.

Example: Bearer eyJraWQiOiI1N…yLTQ4MjctOGUz

WM_CONSUMER.ID

uuid

required

length between 36 and 36

Specifies the value for <consumer_id>.

This is the Client Consumer ID for the OAuth2 client credentials.
See the Walmart Client Center's Walmart administrator, client administrator, or development management for this value.

Example: 685f74bf-b8ca-447d-8338-966di751443f

WM_QOS.CORRELATION_ID

string

Specifies the request log identifier.

This optional header can be any value.
Walmart GoLocal uses this value to log requests and error situations.

Examples:

2398

685f74bf-b8ca-447d-8338-966dd751445f

Responses

404

Not Found. The requested resource was not found on the server.

405

Method Not Allowed. The target resource doesn't support this method.

200OK. The request was successful, and the server returned the requested data.

400Bad Request. The request was malformed or invalid.