younifyd
Menu

List Stores

List stores

GET/v1/applications/{applicationId}/stores

Use it in a workflow

  1. Add a step and choose the Talon.One connector.
  2. Pick the List Stores action (under management).
  3. Fill in the fields below, then reference the result from later steps as {{listStores.response.data}}.

Request

Path parameters

applicationIdinteger (int64)required

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

Query parameters

pageSizeinteger (int64)

The number of items in the response.

Default 1000

skipinteger (int64)

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

Returns 200 with an object. Read it in later steps with {{listStores.response.data.<field>}}.

hasMoreboolean
totalResultSizeinteger (int64)
dataarray<object>
idinteger (int64)required

The internal ID of this entity.

createdstring (date-time)required

The time this entity was created.

namestringrequired

The name of the store.

descriptionstringrequired

The description of the store.

attributesobject

The attributes of the store.

integrationIdstring (string)required

The integration ID of the store. You choose this ID when you create a store. **Note**: You cannot edit the `integrationId` after the store has been created.

applicationIdinteger (int64)required

The ID of the Application that owns this entity.

updatedstring (date-time)required

Timestamp of the most recent update on this entity.

linkedCampaignIdsarray<integer (int64)>

A list of IDs of the campaigns that are linked with current store.

json
{
  "data": [
    {
      "linkedCampaignIds": [
        4,
        6,
        8
      ],
      "created": {},
      "name": "South US store",
      "description": "This is the description of the store in south US.",
      "integrationId": "STORE-001",
      "attributes": {
        "country": "USA",
        "code": 1234
      },
      "id": 6,
      "applicationId": 322,
      "updated": {}
    }
  ],
  "hasMore": false,
  "totalResultSize": 1
}

Need more? See the Talon.One guide for connection setup and behaviour shared by every action.