Register a store

post

https://api-sandbox.buyingfreedom.app/api/store-locator/register

Registers a store under a brand to appear in its store locator.

A store may be linked to a federal firearms license (FFL) and include other information such as the store’s name, contact details, and address.
To register a store, provide at minimum a store name and address or FFL record.

When registration is successful, the API response will include the store account_id, which is a unique identifier for the store. The store
account_id is required in other operations, such as the PUT api/product-inventories/{upc_code} endpoint.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

brand_account_id

string

required

The account_id retrieved from the GET /api/store-locator/brands endpoint. This parameter identifies the brand the store is listed under.

ffl_license_number

string | null

A 15-character number consisting of 14 digits and one letter, divided into six sections.

ffl_license_number has the following conditions:

If an FFL record is found, the store's address information from the FFL database of BFG will replace the address information provided in the request.
If no FFL record is found, the store’s address will be taken from the API request. If that address doesn’t match any record in the BFG database, the system will search Google for the address and save the results.

If you know a store has a FFL recorded in BFG, it's recommended to provide it in the request to ensure the most accurate information is used.

name

string

required

The name of your store. Maximum 255 characters.

logo

file | null

Your company logo. Must be a valid image file. Maximum file size is 2 MB.

phone

string | null

Phone number of your store. Maximum 25 characters.

string | null

Email address of your store. Must be a valid email address. Maximum 255 characters.

website

string | null

Website URL of your store.

store_pickup

boolean | null

Tags your store for store pickup.

online_shopping

boolean | null

Tags your store for online shopping.

address_1

string

required

The address of your store. If you do not have a ffl_license_number, address_1 becomes required. Maximum 255 characters.

address_2

string | null

Additional field for specifying the address.

address_3

string | null

Additional field for specifying the address.

city

string | null

The city of your store.

state

string | null

The state of your store. Must be a valid two-letter U.S. state abbreviation.

postal_code

string | null

The ZIP code of your store. Must be a valid US ZIP code (5 digits or ZIP+4 format).

country

string | null

The country of your store.

Responses

200

401Unauthenticated

403Unauthorized access

404Not found

422Unprocessable entity