Upsert Pickup Location
POST
/locations
Create/Update Location Endpoint
externalLocationId does not exist, Flype will create a new location.externalLocationId already exists, Flype will update the existing location (no duplicate created).Why use Locations
External Location ID
externalLocationId (recommended).If not provided, Flype will generate a location ID and return it in the response. Save this ID and reuse it for future requests (e.g.,
/rates, PlaceBulk).Location activation (Flype-controlled)
A location will not become active/usable until it is approved and marked active by Flype internally.
Update behavior
externalLocationId already exists in Flype, the request will update the existing location (upsert behavior) instead of creating a duplicate.Request
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location '/locations' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"externalLocationId": "STORE_123",
"name": "Store Name - Downtown",
"address": {
"street1": "233 West 52nd streeet",
"street2": "Building 3",
"city": "New York",
"postalCode": "10101",
"country": "United States"
},
"contact": {
"name": "Pickup Desk",
"phone": "+1501234567"
},
"notes": "Back door pickup"
}'Response Response Example
200 - Created location success
{
"status": "success",
"data": {
"externalLocationId": "STORE_123",
"created": true
}
}