masstack

V1
V2
API Overview Resources Schemas

Subchannel

Contain all the operations related to subchannel.

Parameters

Name In Type Required Description
x-retool-groups header string false ‘none’

Request example

1
2
3
4
5


curl -X GET https://dealers.masstack.com/v1/subchannels \
  -H "Accept: application/json" \
  -H "x-retool-groups: tester, campaignTester"

Responses

Code Meaning Description Schema
200 OK List of subchannel [Subchannel]
204 No Content No content. None
400 Bad Request Bad request ApiErrorResponse
401 Unauthorized Unauthorized string
500 Internal Server Error Internal Server Error ApiErrorResponse

200 - instance of Subchannel

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

[
  {
    "id": 123,
    "code": "MS",
    "name": "MasSubchannel",
    "mainChannel": {
      "id": 12345,
      "code": "M",
      "name": "Mas",
      "channelType": "myChannelType"
    },
    "sellType": "mySellType",
    "subchannelGroup": "mySubchannelGroup"
  }
]
Name Type Required Description
id integer false none
code string false none
name string false none
mainChannel Channel false A subchannel
sellType string false none
subchannelGroup string false none

400 - instance of ApiErrorResponse

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
  "errors": [
    {
      "code": "BAD_REQUEST",
      "title": "Error message",
      "ref": "some_ref",
      "details": "Detailed error message"
    }
  ]
}
Name Type Required Description
restErrors [ApiError] false none

401 - JsonObject

Custom schema example

1
2
3
4
5
6

{
  "code": "0003",
  "status": "UNAUTHORIZED",
  "message": "Unauthorized",
  "detailMsg": "Audience not found to access URI /example-uri"
}
Name Type Required Description
restErrors [ApiError] false none

500 - instance of ApiErrorResponse

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
  "errors": [
    {
      "code": "INTERNAL_SERVER_ERROR",
      "title": "Error message",
      "ref": "some_ref",
      "details": "Detailed error message"
    }
  ]
}
Name Type Required Description
restErrors [ApiError] false none

Endpoints

Default

    Dealer

      Fiscal data

        Custom information

          Campaign

            Subchannel

              Store

                Iam

                  Request