Go to home page
Docs API Reference

Sales Channel Memberships

A Membership to a Sales Channel .

Sales Channel Membership Model

Attributes

  • id

    string

    The unique identifier of the Sales Channel Membership.

  • salesChannelId

    string

    The id of the Sales Channel the Membership belongs to.

  • merchantId

    string

    The id of the Merchant the Membership is scoped to.

  • accountId

    string

    The Account that owns the Merchant .

  • test

    boolean

    true if the Sales Channel Membership is for testing purposes only. This is based on the Sales Channel .

  • createdAt

    timestamp

    When the Sales Channel Membership was created.

  • createdBy

    crn

    The User or API Key that created the Sales Channel Membership.

  • updatedAt

    timestamp

    When the Sales Channel Membership was updated.

  • updatedBy

    crn

    The User or API Key that updated the Sales Channel Membership.

  • status

    string

    The current status of the Sales Channel Membership. Supported values are created, provisioning, active, suspending and deactivated.

Create Sales Channel Membership experimental

This endpoint allows you to create an Sales Channel Membership .

Attributes

  • salesChannelId

    string required

    The id of the Sales Channel the Membership belongs to.

  • merchantId

    string required

    The id of the Merchant the Membership is scoped to.

Errors

Request
curl -X POST \
 https://service.centrapay.com/api/sales-channel-memberships \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>' \
 -d '
{
 "salesChannelId": "sc_8nJwSXau7vL5S9rXo3CaCy",
 "merchantId": "SRqGn945cofvBFumd1NMYA"
}
'
Response
{
  "id": "scm_5DuWxSsYueGn5KiNME5EAU",
  "accountId": "3xxehZLwMvzAqQyDxNpRSs",
  "createdAt": "2025-04-24T04:32:55.083Z",
  "createdBy": "crn::user:b5fdc893-160d-414f-9da8-c2d38c6480c0",
  "merchantId": "SRqGn945cofvBFumd1NMYA",
  "salesChannelId": "sc_8nJwSXau7vL5S9rXo3CaCy",
  "test": true,
  "updatedAt": "2025-04-24T04:32:55.083Z",
  "updatedBy": "crn::user:b5fdc893-160d-414f-9da8-c2d38c6480c0",
  "status": "created"
}