Sign in

v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Sales Channel

List sales channels V2

Returns a collection with all sales channels.

get/api/v2/salesChannels

Query parameters

numberstring required

Page number should be an integer greater than or equal to 1

sizestring required

Page size should usually be an integer between 10 and 50.

key'id' | 'name' | 'moduleName' required

Field to filter by.

op'equals' | 'notEquals' | 'in' | 'notIn' | 'contains' | 'notContains' | 'startsWith' | 'endsWith' required

Operator to use for filtering.

Response

A list of sales channels that the individual customer has integrated with Xentral.

Example response

{
  "data": [
    {
      "id": "1301",
      "uuid": "a00fd11e-3a67-433b-83c0-4e815fd4a0e1",
      "project": {
        "id": "1"
      },
      "moduleName": "shopify",
      "name": "Test Shopify #1",
      "stockExport": true,
      "productExport": true,
      "active": true,
      "preventDeletion": true,
      "hideFromOverview": true,
      "isMigratedToConnect": true,
      "createdAt": "2023-01-01T00:00:00Z",
      "updatedAt": "2023-01-02T00:00:00Z"
    }
  ],
  "extra": {
    "totalCount": 1,
    "page": {
      "number": 1,
      "size": 10
    }
  }
}