TAtalon
Stores

Create store

[!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.

Create a new store in a specific Application.

post/v1/applications/{applicationId}/stores

Request

Path parameters

applicationIdinteger required

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

Request body

namestring required

The name of the store.

descriptionstring required

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.

Example request

{
  "name": "South US store",
  "description": "This is the description of the store in south US.",
  "attributes": {
    "country": "USA",
    "code": 1234
  },
  "integrationId": "STORE-001"
}

Response

Created

idinteger required

The internal ID of this entity.

createdstring date-time required

The time this entity was created.

namestring required

The name of the store.

descriptionstring required

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 required

The ID of the Application that owns this entity.

updatedstring date-time required

Timestamp of the most recent update on this entity.

linkedCampaignIdsinteger[]

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

Example response

{
  "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.