masstack

V1
V2
API Overview Resources Schemas

Commercial Structure

Operations related to commercial structure

Parameters

Name In Type Required Description
Authorization header string true Bearer token

Request example

1
2
3
4
5


curl -X GET https://dealers.masstack.com/v2/commercial-structure \
  -H "Accept: application/json" \
  -H "Authorization: string"

Responses

Code Meaning Description Schema
200 OK List of commercial structures successfully obtained [CommercialStructureResponse]
400 Bad Request Bad Request ApiErrorResponse
401 Unauthorized Unauthorized ApiErrorResponse
404 Not Found Not Found ApiErrorResponse
500 Internal Server Error Internal Error ApiErrorResponse

200 - instance of CommercialStructureResponse

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

[
  {
    "id": "aeb857a4-a1b2-4148-b733-9af8a9e13339",
    "subchannel_code": "AC",
    "subchannel_name": "Atención al Cliente",
    "channel_name": "string",
    "superchannel_name": "string",
    "masterchannel_name": "No exclusivo",
    "masterchannel_type": "string"
  }
]
Name Type Required Description
id string true Commercial structure id
subchannel_code string true Subchannel code
subchannel_name string true Subchannel name
channel_name string false Channel name
superchannel_name string false Superchannel name
masterchannel_name string true Masterchannel name
masterchannel_type string false Masterchannel type

Parameters

Name In Type Required Description
Authorization header string true Bearer token
body body CommercialStructureRequest true Commercial Structure request body

Request body - instance of CommercialStructureRequest

1
2
3
4
5
6
7
8

{
  "subchannel_code": "AC",
  "subchannel_name": "Atención al Cliente",
  "channel_name": "No exclusivo",
  "superchannel_name": "El supercanal",
  "masterchannel_name": "No exclusivo",
  "masterchannel_type": "El mastercanal"
}
Name Type Required Description
subchannel_code string true Subchannel code
subchannel_name string true Subchannel name
channel_name string¦null true Channel name
superchannel_name string¦null true Superchannel name
masterchannel_name string true MasterChannel name
masterchannel_type string¦null true MasterChannel type

Request example

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


curl -X POST https://dealers.masstack.com/v2/commercial-structure \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: string" \
 --data-raw "{
  'subchannel_code': 'AC',
  'subchannel_name': 'Atención al Cliente',
  'channel_name': 'No exclusivo',
  'superchannel_name': 'El supercanal',
  'masterchannel_name': 'No exclusivo',
  'masterchannel_type': 'El mastercanal'
}"

Responses

Code Meaning Description Schema
201 Created Successfully create a commercial structure None
400 Bad Request Bad Request ApiErrorResponse
401 Unauthorized Unauthorized ApiErrorResponse
404 Not Found BadRequest ApiErrorResponse
409 Conflict Conflict ApiErrorResponse
500 Internal Server Error Internal Error ApiErrorResponse
503 Service Unavailable Service Unavailable ApiErrorResponse
504 Gateway Time-out Gateway Timeout ApiErrorResponse

Parameters

Name In Type Required Description
id path string true Unique identifier of the commercial structure
Authorization header string true Bearer token

Request example

1
2
3
4
5


curl -X GET https://dealers.masstack.com/v2/commercial-structure/{id} \
  -H "Accept: application/json" \
  -H "Authorization: string"

Responses

Code Meaning Description Schema
200 OK The commercial structures successfully obtained CommercialStructureResponse
400 Bad Request Bad Request ApiErrorResponse
401 Unauthorized Unauthorized ApiErrorResponse
404 Not Found Not Found ApiErrorResponse
500 Internal Server Error Internal Error ApiErrorResponse

Parameters

Name In Type Required Description
id path string true Unique identifier of the commercial structure
Authorization header string true Bearer token
body body CommercialStructureRequest true Commercial Structure request body

Request body - instance of CommercialStructureRequest

1
2
3
4
5
6
7
8

{
  "subchannel_code": "AC",
  "subchannel_name": "Atención al Cliente",
  "channel_name": "No exclusivo",
  "superchannel_name": "El supercanal",
  "masterchannel_name": "No exclusivo",
  "masterchannel_type": "El mastercanal"
}
Name Type Required Description
subchannel_code string true Subchannel code
subchannel_name string true Subchannel name
channel_name string¦null true Channel name
superchannel_name string¦null true Superchannel name
masterchannel_name string true MasterChannel name
masterchannel_type string¦null true MasterChannel type

Request example

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


curl -X PUT https://dealers.masstack.com/v2/commercial-structure/{id} \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: string" \
 --data-raw "{
  'subchannel_code': 'AC',
  'subchannel_name': 'Atención al Cliente',
  'channel_name': 'No exclusivo',
  'superchannel_name': 'El supercanal',
  'masterchannel_name': 'No exclusivo',
  'masterchannel_type': 'El mastercanal'
}"

Responses

Code Meaning Description Schema
204 No Content Successfully updated the commercial structure None
400 Bad Request Bad Request ApiErrorResponse
401 Unauthorized Unauthorized ApiErrorResponse
404 Not Found Not Found ApiErrorResponse
500 Internal Server Error Internal Error ApiErrorResponse

Parameters

Name In Type Required Description
id path string true Unique identifier of the commercial structure
Authorization header string true Bearer token

Request example

1
2
3
4
5


curl -X DELETE https://dealers.masstack.com/v2/commercial-structure/{id} \
  -H "Accept: application/json" \
  -H "Authorization: string"

Responses

Code Meaning Description Schema
204 No Content Successfully deleted the commercial structure None
400 Bad Request Bad Request ApiErrorResponse
401 Unauthorized Unauthorized ApiErrorResponse
404 Not Found Not Found ApiErrorResponse
500 Internal Server Error Internal Error ApiErrorResponse

Endpoints

Default

    Loads

      Actors

        Dealers

          Custom Information

            Commercial Structure

              Brands