Update a store

Updates store settings with some restrictions. The following fields are immutable and cannot be updated:

  • name
  • friendly_name
  • address fields (e.g., address_1, address_2, address_3, city, state, postal_code, country)
  • phone
  • ffl_license_number
  • email
  • website
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of the account.

Body Params
string | null
string
required

The name of the store. This field is required in the request but is immutable - any changes will be ignored. Must match the current store name.

string | null

Must not be greater than 255 characters.

file

The company logo. Must be a valid image file. Maximum file size: 2 MB.

string | null

Must not be greater than 25 characters.

string | null

Must be a valid email address. Must not be greater than 255 characters.

string | null

Must not be greater than 255 characters.

boolean

Indicates whether the store offers store pickup.

boolean

Indicates whether the store offers online shopping.

integer

The low stock threshold for inventory alerts.

string | null

Must not be greater than 255 characters.

string | null

Must not be greater than 255 characters.

string | null

Must not be greater than 255 characters.

string | null

Must not be greater than 60 characters.

string | null

Must not be greater than 30 characters.

string | null

Must not be greater than 255 characters.

string | null

Must not be greater than 255 characters.

boolean

Indicates whether the store is at a residential address.

boolean

Whether the store uses FFL services.

string | null

The manufacturer account number. Maximum length: 255 characters.

string | null

The product URL. Must be a valid URL. Maximum length: 255 characters.

string | null

The brand URL. Must be a valid URL. Maximum length: 255 characters.

boolean

Whether brand terms have been signed.

file | null

Brand terms file upload. Must be a PDF file

store_tags
array of strings

Array of store tags.

store_tags
store_types
array of strings

Array of store types.

store_types
boolean | null

Whether the store appears in the store locator.

boolean | null

Whether to show stock availability for this store.

boolean | null

Whether to show the store's website.

boolean | null

Whether the store is promoted.

Responses

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