Sign in
General

Get the stores of an account

Returns a list of stores associated with a company account or a merchant account, including the status of each store.

From January 1, 2025 POS Terminal Management API is deprecated and support stops on April 1, 2025. To automate the management of your terminal fleet, use our Management API.

post/getStoresUnderAccount

Request body

companyAccountstring required

The company account. If you only specify this parameter, the response includes the stores of all merchant accounts that are associated with the company account.

merchantAccountstring

The merchant account. With this parameter, the response only includes the stores of the specified merchant account.

Response

OK - the request has succeeded.

Changes

Changed in 3 of the 16 revisions of this API.92

  • v19c22824cacf11See the full diff
    • ○

      endpoint deprecated

      endpoint-deprecated

  • v16c089164bff11See the full diff
    • ○

      the endpoint scheme security BasicAuth was added to the API

      api-security-added

  • v1a1d5aadcf2a39See the full diff
    • ▲

      the request's body type/format changed from / to object/

      request-body-type-changed

    • ▲

      the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • ▲

      the response's body type/format changed from / to object/ for status 400

      response-body-type-changed

    • ▲

      the response's body type/format changed from / to object/ for status 401

      response-body-type-changed

    • ▲

      the response's body type/format changed from / to object/ for status 403

      response-body-type-changed

    • ▲

      the response's body type/format changed from / to object/ for status 422

      response-body-type-changed

    • ▲

      the response's body type/format changed from / to object/ for status 500

      response-body-type-changed

    • ▲

      the stores/items/ response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • ▲

      the stores/items/address response's property type/format changed from / to object/ for status 200

      response-property-type-changed