integration/profile/get - Equotix One API

This returns the list of channel profiles available in the Equotix One account.

Request

Body Params application/json

domain

string

required

The domain you are assigned to authenticate your Equotix One account.

api_key

string

required

The email address assigned to the user account in your Equotix One.

auth_timestamp

integer

required

The unix timestamp used to sign this API request.

auth_signature

string

required

The calculated signature for this API request.

channel_profile_id

integer

optional

The channel profile ID to search for specifically.

filter_type

string

optional

Filter the type of profiles to return based on its channel type. Accepts "equotixpos", "lazada", "opencart", "shopee", "shopify", "tiktok".

filter_channel_id

integer

optional

Filter the list of profiles to return based on its channel ID.

filter_date_modified

string

optional

Filter the list of profiles modified after the spcified date.

page

integer

optional

Page number of the results.

sort

string

optional

Accepts "name", "type", "date_modified"

order

string

optional

The direction for the ordering of the results. Accepts "ASC", "DESC"

limit

integer

optional

The number of results per page. Accepts 1 to 100.

Example

{
  "domain": "string",
  "api_key": "string",
  "auth_timestamp": 0,
  "auth_signature": "string",
  "channel_profile_id": 0,
  "filter_type": "string",
  "filter_channel_id": 0,
  "filter_date_modified": "string",
  "page": 0,
  "sort": "string",
  "order": "string",
  "limit": 0
}

Responses

🟢200Success

application/json

Body

error

array[string]

optional

Returns only if there is an error.

total

integer

optional

The total number of results available if there is no error.

profiles

array [object {7}]

optional

The list of profiles available if there is no error.

channel_profile_id

integer

required

The channel profile ID.

type

string

required

The type of the profile dependent on its channel.

name

string

required

The name of the profile.

configuration

object

required

The configurations saved for the profile. Data varies according to the channel type.

title

string

required

The listing title set for the profile.

description

string

required

The listing description text set for the profile.

date_modified

string

required

The date time the profile was last modified.

Example

{
  "error": [
    "string"
  ],
  "total": 0,
  "profiles": [
    {
      "channel_profile_id": 0,
      "type": "string",
      "name": "string",
      "configuration": {},
      "title": "string",
      "description": "string",
      "date_modified": "string"
    }
  ]
}