Show source

Channel

The channel resource is the entry point of the discovery flow and the place where sales are published. The most important property of this resource is the embedded list of sales. Events are also embedded in order to represent a sale.

Retrieve a channel

Retrieve the details and sales of a channel using a channel reference. This resource does not require authentication.

Field name

Type

Description

title

I18N

Title of the channel.

type

String

The type of the channel. Can be online for regular online sales, or secondary for resales and transfers.

uid

String

A machine readable id for this channel, used in communication with the API.

cognito_settings

Cognito settings

Optional authorization settings for this channel.

merchant

Merchant

A custom merchant object inside the channel.

consumer_fields

Consumer field

List of required and optional consumer fields.

Embedded resources

  • Sale (list).

  • shop:theme: The theme for this channel. See Theme.

  • shop:event: A list of events with sales on this channel. See Event.

  • shop:sale: A list of sales in this channel. Sales are under development and will be documented when the schema is stable.

  • shop:customer_service: Customer service for this channel. See Customer service.

Merchant

An object describing the custom merchant inside the channel.

Field name

Type

Description

tracking_tags

List of Tracking tag item

A list of tracking tag items.

Example

[GET] https://shopping-api.paylogic.com/channels/447d53590f5f43a2a453a751606eecb9

{
  "_links": {
    "self": {
      "href": "https://shopping-api.paylogic.com/channels/447d53590f5f43a2a453a751606eecb9"
    },
    "profile": {
      "href": "https://shopping-api-docs.paylogic.com/documentation/channel.html",
      "type": "text/html"
    },
    "curies": [
      {
        "href": "https://shopping-api-docs.paylogic.com/documentation/{rel}.html",
        "type": "text/html",
        "name": "shop",
        "templated": true
      }
    ]
  },
  "item_count": 1,
  "type": "online",
  "title": {
    "fr": "",
    "en": "Online sales",
    "nl": "Online verkoop",
    "pt": "",
    "de": "",
    "tr": "",
    "es": ""
  },
  "uid": "447d53590f5f43a2a453a751606eecb9",
  "_embedded": {
    "shop:theme": [],
    "shop:sale": [
      {
        "_links": {
          "self": {
            "href": "https://shopping-api.paylogic.com/sale?point_of_sale_id=19&event_id=1"
          },
          "event": {
            "href": "https://shopping-api.paylogic.com/events/e2e5bcb79a7f498ba62731242e83a4bf"
          }
        },
        "start_date": "2020-03-01T15:06:35Z",
        "end_date": "2020-04-22T14:06:35Z"
      }
    ],
    "shop:event": [
      {
        "_links": {
          "self": {
            "href": "https://shopping-api.paylogic.com/events/e2e5bcb79a7f498ba62731242e83a4bf"
          }
        },
        "title": {
          "fr": "",
          "en": "Event 0",
          "nl": "Evenement 0",
          "pt": "",
          "de": "",
          "tr": "",
          "es": ""
        },
        "subtitle": {
          "fr": "",
          "en": "",
          "nl": "",
          "pt": "",
          "de": "",
          "tr": "",
          "es": ""
        }
      }
    ],
    "shop:customer_service": {
      "_links": {
        "shop:url": {
          "href": "https://customerservice.paylogic.com/"
        },
        "curies": [
          {
            "href": "https://shopping-api-docs.paylogic.com/documentation/{rel}.html",
            "type": "text/html",
            "name": "shop",
            "templated": True
          }
        ]
      },
      "email": "customerservice@paylogic.nl"
    }
  },
  "cognito_settings": {
    "account_name": "Paylogic",
    "aws_pool_id": "eu-west-1_m41YL71ix",
    "aws_region": "eu-west-1",
    "frontend_app_client_id": "5f0emslqeceitf584lm28jr6li",
    "aws_cognito_domain": "https://paylogic-dev.auth.eu-west-1.amazoncognito.com",
    "paylogic_app_client_id": "paylogic",
    "auth_base_url": "https://auth.paylogic.com/"
  },
  "merchant": {
    "tracking_tags": [
      {
        "name": "gtmContainerId",
        "is_eu_cookie_law": false,
        "value": "GTM-XXXXXX"
      },
      {
        "name": "setoptin",
        "is_eu_cookie_law": true,
        "value": "1"
      }
    ]
  }
}
Consumer Bill