API Reference

List brands

get
https://api-sandbox.buyingfreedom.app/api/store-locator/brands

Gets a list of brands using the store locator feature of BFG.

This list can be used to guide you in selecting which brands are available and you want to register in a brand's store locator. Each brand entry includes an account_id that can be used to register a store under that brand using the POST /api/store-locator/register endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Specifies the field to sort by. Allowed values:

  • id
  • title
  • upc
integer

Page number for pagination. Must be a positive integer.

integer

Number of results on a page. Defaults to 10.

string

Filters results by a specific field. Allowed values:

  • account_id
  • name
  • all
string

Filters results by soft-deleted records. Allowed values:

  • only — inactive records
  • with — all records, both active and inactive
  • any other value — active records

Use a specific field to get more brand information.

Responses

Updated 11 months ago

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

Updated 11 months ago

Did this page help you?