TAtalon
Stores

List stores

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

List all stores for a specific Application.

get/v1/applications/{applicationId}/stores

Request

Path parameters

applicationIdinteger required

The ID of the Application. It is displayed in your Talon.One deployment URL.

Query parameters

pageSizeinteger

The number of items in the response.

skipinteger

The number of items to skip when paging through large result sets.

sortstring

The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with -.

Note: You may not be able to use all fields for sorting. This is due to performance limitations.

withTotalResultSizeboolean

When this flag is set, the result includes the total number of results for this query. This might decrease performance on large data sets.

  • When true: totalResultSize contains the total number of results for this query.
  • When false: Only hasMore is returned, and it is set to true when there are more results than shown on the page.
campaignIdnumber

Filter results by campaign ID.

namestring

The name of the store.

integrationIdstring

The integration ID of the store.

querystring

Filter results by name or integrationId.

Response

OK

hasMoreboolean
totalResultSizeinteger

Example response

{
  "totalResultSize": 1,
  "data": [
    {
      "id": 6,
      "created": "2020-02-07T08:15:22Z",
      "name": "South US store",
      "description": "This is the description of the store in south US.",
      "attributes": {
        "country": "USA",
        "code": 1234
      },
      "integrationId": "STORE-001",
      "applicationId": 322,
      "updated": "2021-09-23T10:12:42Z",
      "linkedCampaignIds": [
        4,
        6,
        8
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.