Upsert Pickup Location

Upsert Pickup Location - Create or update a pickup location

Use this endpoint to create or update a pickup location in Flype.

A pickup location can represent a store, warehouse, fulfillment center, or 3PL facility where Flype collects shipments.

Upsert behavior

If externalLocationId does not exist, Flype will create a new pickup location.
If externalLocationId already exists, Flype will update the existing pickup location instead of creating a duplicate.

Why use pickup locations

Reduces repeated address entry.
Reduces pickup address errors.
Enables faster order creation by referencing a saved location.
Supports consistent pickup routing and reporting.

Merchant and pickup location note

The externalLocationId identifies the physical pickup origin. It may be shared by multiple merchants when several merchants use the same warehouse, store, or 3PL facility.

The customer-facing merchant or brand name should be provided when creating shipments if Flype cannot uniquely determine it from the authenticated account and pickup location.

Location activation

New or updated pickup locations may require Flype approval before they become active and usable for rates or shipment creation.

Important notes

This endpoint creates or updates pickup locations only.
This endpoint does not create shipments.
Save the returned externalLocationId and reuse it for Rates and Create Bulk Orders.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

externalLocationId providedWithout externalLocationId

{
  "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"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

application/json

Bodyapplication/json

Examples

Created location successLocation already exist

{
  "status": "success",
  "data": {
    "externalLocationId": "STORE_123",
    "created": true
  }
}