Sales Channels

User Sales Channels


Description

This endpoint retrieves the list of User Channels.

HTTP Method

get


URL

/api/usersaleschannels/{includeIactive}/{languageID}

Path Parameters

Name Type
includeInactive

required <boolean>

Default value : false
languageID

required <integer>

Default value : 1


Query Parameters

Name Type
api-version optional <string>


Response

[
  {
    "ID": 0,
    "Name": "string",
    "IsActive": true,
    "DisplayOrder": 0,
    "SalesChannelLevel2s": [
      {
        "ID": 0,
        "Name": "string",
        "IsActive": true,
        "DisplayOrder": 0
      }
    ]
  }
]

Example

[
  {
    "ID": 101,
    "Name": "North America Sales",
    "IsActive": true,
    "DisplayOrder": 1,
    "SalesChannelLevel2s": [
      {
        "ID": 201,
        "Name": "Enterprise",
        "IsActive": true,
        "DisplayOrder": 1
      },
      {
        "ID": 202,
        "Name": "SMB",
        "IsActive": true,
        "DisplayOrder": 2
      }
    ]
  },
  {
    "ID": 102,
    "Name": "Europe Sales",
    "IsActive": true,
    "DisplayOrder": 2,
    "SalesChannelLevel2s": [
      {
        "ID": 203,
        "Name": "Retail",
        "IsActive": true,
        "DisplayOrder": 1
      },
      {
        "ID": 204,
        "Name": "Wholesale",
        "IsActive": true,
        "DisplayOrder": 2
      }
    ]
  }
]

Success Response

Code: 200 OK




Customer Sales Channels


Description

This endpoint retrieves the list of Customer Channels.

HTTP Method

get


URL

/api/customersaleschannels/{includeIactive}/{languageID}

Path Parameters

Name Type
includeInactive

required <boolean>

Default value : false
languageID

required <integer>

Default value : 1


Query Parameters

Name Type
api-version optional <string>


Response

[
  {
    "ID": 0,
    "Name": "string",
    "IsActive": true,
    "DisplayOrder": 0,
    "SalesChannelLevel2s": [
      {
        "ID": 0,
        "Name": "string",
        "IsActive": true,
        "DisplayOrder": 0
      }
    ]
  }
]

Example

[

    {
        "ID": 1,
        "Name": "Global",
        "IsActive": true,
        "DisplayOrder": 2,
        "SalesChannelLevel2s": [
            {
                "ID": 14,
                "Name": "Africa",
                "IsActive": true,
                "DisplayOrder": 2
            },
            {
                "ID": 1,
                "Name": "Americas Group",
                "IsActive": true,
                "DisplayOrder": 2
            },
            {
                "ID": 2,
                "Name": "Asia Pacific",
                "IsActive": true,
                "DisplayOrder": 2
            },
            {
                "ID": 4,
                "Name": "Europe/Middle East/Africa",
                "IsActive": true,
                "DisplayOrder": 2
            },
            {
                "ID": 3,
                "Name": "Greater China",
                "IsActive": true,
                "DisplayOrder": 2
            },
            {
                "ID": 5,
                "Name": "World Wide",
                "IsActive": true,
                "DisplayOrder": 2
            }
        ]
    }
]

Success Response

Code: 200 OK