Get the stores of an account

post /getStoresUnderAccount

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

Endpoint destination URL
Click to copy

Request parameters

companyAccount string 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.

merchantAccount string

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

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show more Show less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Request
  • Click to copy
  • Response
  • Click to copy