integration/channel/get - Equotix One API

This returns the list of channels available for 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_id

integer

optional

The channel ID to search for specifically.

filter_type

string

optional

Filter the type of channels to return. Accepts "equotixpos", "lazada", "opencart", "shopee", "shopify", "tiktok".

filter_status

integer

optional

Filter the status of channels to return. "1" for enabled, "0" for disabled.

filter_date_modified

string

optional

Filter the list of channels modified after the spcified date time.

page

integer

optional

Page number of the results.

sort

string

optional

The key for the ordering of the results. Accepts "name", "type", "date_added", "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_id": 0,
    "filter_type": "string",
    "filter_status": 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.

channels

array [object {8}]

optional

The list of channels available if there is no error.

channel_id

integer

required

The channel ID.

type

string

required

The channel type.

name

string

required

The name of the channel.

configuration

object

required

The configurations saved for the channel. Varies according to the type of channel.

date_added

string

required

The date time the channel was created.

date_modified

string

required

The date time the channel was last modified.

date_active

string

required

The date time the channel was last active.

status

integer

required

The status of the channel.

Example

{
    "error": [
        "string"
    ],
    "total": 0,
    "channels": [
        {
            "channel_id": 0,
            "type": "string",
            "name": "string",
            "configuration": {},
            "date_added": "string",
            "date_modified": "string",
            "date_active": "string",
            "status": 0
        }
    ]
}