Get Alternate Locations

Use this API to get the list of nearby pickup locations. Customers can use these to hold the packages in case they are unavailable at the delivery address or don't want to have home deliveries. These locations can be access points, lockers, grocery stores etc..

Body Params
string

Location Id for which the order is being placed, see Create Location.

deliveryAddress
object
required

Delivery Address Details

packages
array of objects

Package Details

packages
string

Type of order. Options are delivery/ in-store-pickup/ curbside/ shipping.

matchProviderTags
array of strings

Alternate locations for providers matching at least one tag from the requested tags are returned.

matchProviderTags
Responses

Language
Credentials
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json