APIMatic Adyen APIs
Sign Up to APIMatic
HomeSDKsAPI ReferenceContext Plugin
ManagementAccountAccount store level

Get a list of stores

GET
/merchants/{merchantId}/stores

Returns a list of stores for the merchant account identified in the path. The list is grouped into pages as defined by the query parameters.

To make this request, your API credential must have one of the following roles:

  • Management API—Stores read
  • Management API—Stores read and write

In the live environment, requests to this endpoint are subject to rate limits.

Authorization

AuthorizationBasic <token>

In: header

Path Parameters

merchantId*string

The unique identifier of the merchant account.

Query Parameters

pageNumber?integer

The number of the page to fetch.

Formatint32
pageSize?integer

The number of items to have on a page, maximum 100. The default is 10 items on a page.

Formatint32
reference?string

The reference of the store.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/merchants/string/stores"

Example response when getting a list of stores for a merchant account

{  "_links": {    "first": {      "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_ID/stores?pageNumber=1&pageSize=1"    },    "last": {      "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_ID/stores?pageNumber=2&pageSize=1"    },    "next": {      "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_ID/stores?pageNumber=2&pageSize=1"    },    "self": {      "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT_ID/stores?pageNumber=1&pageSize=1"    }  },  "itemsTotal": 2,  "pagesTotal": 1,  "data": [    {      "id": "ST322LJ223223K5F4SQNR9XL5",      "address": {        "city": "Springfield",        "country": "US",        "line1": "200 Main Street",        "line2": "Building 5A",        "line3": "Suite 3",        "postalCode": "20250",        "stateOrProvince": "NY"      },      "description": "City centre store",      "merchantId": "YOUR_MERCHANT_ACCOUNT_ID",      "phoneNumber": "+13123456789",      "reference": "Springfield Shop",      "status": "active",      "_links": {        "self": {          "href": "https://management-test.adyen.com/v1/stores/ST322LJ223223K5F4SQNR9XL5"        }      }    },    {      "id": "ST322LJ223223K5F4SQNR9XL6",      "address": {        "city": "North Madison",        "country": "US",        "line1": "1492 Townline Road",        "line2": "Rowland Business Park",        "postalCode": "20577",        "stateOrProvince": "NY"      },      "description": "West location",      "merchantId": "YOUR_MERCHANT_ACCOUNT_ID",      "phoneNumber": "+1211992213193020",      "reference": "Second Madison store",      "status": "active",      "_links": {        "self": {          "href": "https://management-test.adyen.com/v1/stores/ST322LJ223223K5F4SQNR9XL6"        }      }    }  ]}

Request to activate a merchant account POST

Sends a request to activate the merchant account identified in the path. You get the result of the activation asynchronously through a [`merchant.updated`](https://docs.adyen.com/api-explorer/ManagementNotification/latest/post/merchant.updated) webhook. Once the merchant account is activated, you can start using it to accept payments and payouts. Use this endpoint if your integration requires it, such as Adyen for Platforms Manage. Your Adyen contact will set up your access. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Accounts read and write

Create a store POST

Creates a store for the merchant account identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Stores read and write In the live environment, requests to this endpoint are subject to [rate limits](https://docs.adyen.com/point-of-sale/automating-terminal-management#rate-limits-in-the-live-environment).