Connection

Version 1.0

The Channel Entity represents specific platforms or services within our system, closely associated with the Connection Entity. Channels serve as endpoints for data exchange and integration with external platforms such as Shopify and Amazon. They encapsulate key details, including Channel Name, Type and URLs. Multiple channels can be linked to a single connection, enhancing our platform's capability to seamlessly interact with diverse e-commerce systems. This strategic integration amplifies flexibility and extends our global reach.

# Endpoints
POST
/v1/channels# Create a single channel
GET
/v1/channels# Retrieve all channels
GET
/v1/channels/123456789# Retrieve a single channel
PATCH
/v1/channels/123456789# Update a single channel
DELETE
/v1/channels/123456789# Delete a single channel

Channel Entity

  • Name
    id
    Type
    string
    Required
    Description

    Every channel is assigned a unique identifier - an unsigned 64-bit integer known as the Channel ID. This specific number is exclusive and distinct across the entire Qooly platform, ensuring unparalleled uniqueness for each channel.

  • Name
    connection_id
    Type
    foreignId
    Required
    Description

    This serves as a unique, distinct identifier for the connection associated with the channel. It references the Connection ID in Qooly's system.

  • Name
    locale_id
    Type
    string
    Required
    Description

    This property indicates the locale or region associated with the channel.

  • Name
    status
    Type
    varchar(16)
    Default: DRAFT
    Description

    This property indicates the status of the channel.

    DraftThe channel is in draft mode. This is the default status for new channels.
    EnabledThe channel is enabled. This means that the channel is available for use.
    DisabledThe channel is disabled. This means that the channel is not available for use.
    ArchivedThe channel is archived for future reference.
  • Name
    code
    Type
    varchar(64)
    Description

    This property indicates the code of the channel.

  • Name
    name
    Type
    varchar(255)
    Required
    Description

    This property indicates the name of the channel.

  • Name
    config
    Type
    json
    Description

    This property stores configuration details for the channel in JSON format.

The Channel resource

JSON
{
  "id": "123456789",
  "connection_id": "987654321",
  "locale_id": "en_US",
  "status": "DRAFT",
  "code": "CHAN123",
  "name": "Sample Channel",
  "config": {
    "property1": "value1",
    "property2": "value2"
  }
}

Create a single channel

This endpoint allows you to create a single channel associated with a connection.

Required Fields

  • Name
    connection_id
    Type
    foreignId
    Required
    Description
  • Name
    locale_id
    Type
    string
    Required
    Description
  • Name
    status
    Type
    varchar(16)
    Default: DRAFT
    Description
    DraftThe channel is in draft mode. This is the default status for new channels.
    EnabledThe channel is enabled. This means that the channel is available for use.
    DisabledThe channel is disabled. This means that the channel is not available for use.
    ArchivedThe channel is archived for future reference.
  • Name
    code
    Type
    varchar(64)
    Required
    Description
  • Name
    name
    Type
    varchar(255)
    Required
    Description
  • Name
    config
    Type
    json
    Description

Examples

Create a single channel

POST
/v1/channels
curl --request POST \
  --url https://api.qooly.io/v1/channels \
  --header 'Content-Type: application/json' \
  --data '{
    "connection_id": "987654321",
    "locale_id": "en_US",
    "status": "DRAFT",
    "code": "CHAN123",
    "name": "Sample Channel",
    "config": {
      "property1": "value1",
      "property2": "value2"
    }
  }'

Create a single channel

POST
/v1/channels
curl --request POST \
  --url https://api.qooly.io/v1/channels \
  --header 'Content-Type: application/json' \
  --data '{
    "connection_id": "987654321",
    "locale_id": "en_US",
    "status": "DRAFT",
    "code": "CHAN456",
    "name": "Sample Channel"
  }'

Create a single channel

POST
/v1/channels
curl --request POST \
  --url https://api.qooly.io/v1/channels \
  --header 'Content-Type: application/json' \
  --data '{
    "connection_id": "987654321",
    "locale_id": "en_US",
    "status": "DRAFT",
    "code": "CHAN123",
    "name": "Sample Channel",
    "config": {
      "property1": "value1",
      "property2": "value2"
    }
  }'
JSON
{
  "id": "123456789",
  "connection_id": "987654321",
  "locale_id": "en_US",
  "status": "DRAFT",
  "code": "CHAN123",
  "name": "Sample Channel",
  "config": {
    "property1": "value1",
    "property2": "value2"
  },
  "created_at": "2024-01-08T09:45:00Z",
  "created_by": "789012345",
}

Retrieve all channels

This endpoint allows you to retrieve all channels associated with connections.

Examples

Retrieve all channels

GET
/v1/channels
curl --request GET \
  --url https://api.qooly.io/v1/channels

Retrieve all channels

GET
/v1/channels
curl --request GET \
  --url https://api.qooly.io/v1/channels
JSON
[
  {
    "id": "123456789",
    "connection_id": "987654321",
    "locale_id": "en_US",
    "status": "DRAFT",
    "code": "CHAN123",
    "name": "Sample Channel 1",
    "config": {
      "property1": "value1",
      "property2": "value2"
    },
    "created_at": "2024-01-08T09:45:00Z",
    "created_by": "789012345",
  },
  {
    "id": "234567890",
    "connection_id": "876543210",
    "locale_id": "en_GB",
    "status": "ENABLED",
    "code": "CHAN456",
    "name": "Sample Channel 2",
    "config": {
      "property1": "value1",
      "property2": "value2"
    },
    "created_at": "2024-01-09T11:30:00Z",
    "created_by": "123456789",
  }
]

Retrieve a single channel

This endpoint allows you to retrieve a single channel associated with a connection.

Required Parameters

  • Name
    id
    Type
    string
    Required
    Description

    The unique identifier for the channel.

Examples

Retrieve a single channel

GET
/v1/channels/123456789
curl --request GET \
  --url https://api.qooly.io/v1/channels/123456789

Retrieve a single channel

GET
/v1/channels/123456789
curl --request GET \
  --url https://api.qooly.io/v1/channels/123456789
JSON
{
  "id": "123456789",
  "connection_id": "987654321",
  "locale_id": "en_US",
  "status": "DRAFT",
  "code": "CHAN123",
  "name": "Sample Channel",
  "config": {
    "property1": "value1",
    "property2": "value2"
  },
  "created_at": "2024-01-08T09:45:00Z",
  "created_by": "789012345",
}

Update a single channel

This endpoint allows you to update a single channel associated with a connection.

Required Parameters

  • Name
    id
    Type
    string
    Required
    Description

    The unique identifier for the channel.

Examples

Update a single channel

PATCH
/v1/channels/123456789
curl --request PATCH \
  --url https://api.qooly.io/v1/channels/123456789 \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Updated Channel Name",
    "config": {
      "property1": "newChannelValue1",
      "property2": "newChannelValue2"
    }
  }'

Update a single channel

PATCH
/v1/channels/123456789
curl --request PATCH \
  --url https://api.qooly.io/v1/channels/123456789 \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Updated Channel Name"
  }'
JSON
{
  "id": "123456789",
  "connection_id": "987654321",
  "locale_id": "en_US",
  "status": "DRAFT",
  "code": "CHAN123",
  "name": "Updated Channel Name",
  "config": {
    "property1": "newChannelValue1",
    "property2": "newChannelValue2"
  },
  "created_at": "2024-01-08T09:45:00Z",
  "created_by": "789012345",
}

Delete a single channel

This endpoint allows you to delete a single channel associated with a connection.

Required Parameters

  • Name
    id
    Type
    string
    Required
    Description

    The unique identifier for the channel.

Examples

Delete a single channel

DELETE
/v1/channels/123456789
curl --request DELETE \
  --url https://api.qooly.io/v1/channels/123456789

Delete a single channel

DELETE
/v1/channels/123456789
curl --request DELETE \
  --url https://api.qooly.io/v1/channels/123456789
JSON
{}