API Reference

List MAP policies

get
https://api-sandbox.buyingfreedom.app/api/map-policies

Gets a list of MAP policies from a brand.

Use this endpoint to browse, search, or organize MAP policies.

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

Field to sort by. To sort in descending order, add "-" in the beginning. Allowed values:

  • id
  • company_id
  • map_policy_type_id
  • title
  • published
  • start_date
  • end_date
  • created_at
  • updated_at
  • deleted_at

Defaults to company_id and created_at.

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:

  • title
  • contact_email
  • published
  • map_policy_type_id
  • start_date
  • advertising_applications
  • allow_international_shipments
  • allow_free_shipping
  • allow_sub_distribution
  • allow_drop_shipping
  • company_id
  • account_id
  • all

Use a specific field to get more policy information.

string

Filters results by soft-deleted records. Allowed values:

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

Default is without.

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?