Dealer

Get dealer identifier

This service receives external system code and dealer code in that system and returns dealerId asociated to mas-dealers.

GET /dealers/id

Parameters

Name	In	Type	Required	Description
system	query	string	true	‘none’
code	query	string	true	‘none’

Request example

1
2
3
4



curl -X GET https://dealers.masstack.com/v1/dealers/id?system='string'&code='string'?system=string&code=string \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	Successful response. Dealer has been found.	[DealerAccessResponse]
401	Unauthorized	Unauthorized	string
404	Not Found	Custom information not found	ApiErrorResponse

200 - instance of DealerAccessResponse

Custom schema example

1
2
3
4
5
6
7


[
  {
    "dealerId": 0,
    "startDate": "2020-05-21T12:00:00Z",
    "endDate": "2020-05-21T12:00:00Z"
  }
]

Name	Type	Required	Description
dealerId	integer	false	none
startDate	string	false	none
endDate	string	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
dealerId	integer	false	none
startDate	string	false	none
endDate	string	false	none

404 - instance of ApiErrorResponse

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "errors": [
    {
      "code": "NOT_FOUND",
      "title": "Error message",
      "ref": "some_ref",
      "details": "Detailed error message"
    }
  ]
}

Name	Type	Required	Description
restErrors	[ApiError]	false	none

Get information from received dealer and hierarchy up.

This service receives dealerId and returns dealer detail and the hierarchy up.

GET /dealers/{dealer_id}

Parameters

Name	In	Type	Required	Description
dealer_id	path	integer	true	‘none’

Request example

1
2
3
4



curl -X GET https://dealers.masstack.com/v1/dealers/{dealer_id} \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	Successful response. Dealer has been found and the hierarchy up is returned.	[DealerInHierarchyResponse]
401	Unauthorized	Unauthorized	string

200 - instance of DealerInHierarchyResponse

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39


[
  {
    "dealerCode": "string",
    "dealerId": 0,
    "commercialName": "string",
    "mainChannelCode": "string",
    "subchannelCode": "string",
    "level": 0,
    "parentCode": "string",
    "internalManager": "string",
    "externalManager": "string",
    "storeType": "string",
    "commissioningSection": "string",
    "companyType": "string",
    "documentType": "string",
    "documentNumber": "string",
    "companyName": "string",
    "status": "string",
    "address": "string",
    "city": "string",
    "province": "string",
    "country": "string",
    "postalCode": "string",
    "contactInformation": [
      {
        "contactName": "string",
        "contactEmail": "string",
        "contactPhone": "string",
        "contactPurposes": [
          "PUBLIC"
        ]
      }
    ],
    "segment": "string",
    "ine": "string",
    "storeDelivery": false,
    "deviceReturn": false
  }
]

Name	Type	Required	Description
dealerCode	string	false	none
dealerId	integer	false	none
commercialName	string	false	none
mainChannelCode	string	false	none
subchannelCode	string	false	none
level	integer	false	none
parentCode	string	false	none
internalManager	string	false	none
externalManager	string	false	none
storeType	string	false	none
commissioningSection	string	false	none
companyType	string	false	none
documentType	string	false	none
documentNumber	string	false	none
companyName	string	false	none
status	string	false	none
address	string	false	none
city	string	false	none
province	string	false	none
country	string	false	none
postalCode	string	false	none
contactInformation	[ContactInformation]	false	none
segment	string	false	none
ine	string	false	none
storeDelivery	boolean	false	none
deviceReturn	boolean	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
dealerCode	string	false	none
dealerId	integer	false	none
commercialName	string	false	none
mainChannelCode	string	false	none
subchannelCode	string	false	none
level	integer	false	none
parentCode	string	false	none
internalManager	string	false	none
externalManager	string	false	none
storeType	string	false	none
commissioningSection	string	false	none
companyType	string	false	none
documentType	string	false	none
documentNumber	string	false	none
companyName	string	false	none
status	string	false	none
address	string	false	none
city	string	false	none
province	string	false	none
country	string	false	none
postalCode	string	false	none
contactInformation	[ContactInformation]	false	none
segment	string	false	none
ine	string	false	none
storeDelivery	boolean	false	none
deviceReturn	boolean	false	none

Partial update from dealerId.

This service receives dealerId and body with fields to update.

PATCH /dealers/{dealer_id}

Parameters

Name	In	Type	Required	Description
dealer_id	path	integer	true	‘none’
body	body	object	false	‘none’

Request body - JsonObject

1

{}

None

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27



curl -X PATCH https://dealers.masstack.com/v1/dealers/{dealer_id} \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'code': 'string',
  'commercialName': 'string',
  'level': 0,
  'status': 'string',
  'parentCode': 'string',
  'subchannel': 'string',
  'commissioningSection': 'string',
  'storeType': 'string',
  'address': 'string',
  'city': 'string',
  'province': 'string',
  'postalCode': 'string',
  'country': 'string',
  'startDate': '2019-08-24T14:15:22Z',
  'endDate': '2019-08-24T14:15:22Z',
  'internalManagerId': 0,
  'externalManagerId': 0,
  'fiscalDataId': 0,
  'storeDelivery': false,
  'deviceReturn': false
}" 

Responses

Code	Meaning	Description	Schema
200	OK	Successful response. Dealer has been updated.	None
400	Bad Request	Bad request	ApiErrorResponse
401	Unauthorized	Unauthorized	string
404	Not Found	Custom information not found	ApiErrorResponse

Set a dealer as cancelled or inactive

This service receives the id of a dealer and a cancellation status (cancelled or inactive), and sets it as the dealer's status, setting as well the end date for itself and all his brands. This operation is also performed for all the hierarchy under the dealer.

DELETE /dealers/{dealer_id}

Parameters

Name	In	Type	Required	Description
dealer_id	path	integer	true	‘none’
cancellationStatus	query	string	true	‘none’
cancellationDate	query	string	false	‘none’

Enumerated Values

Property	Values
cancellationStatus	one of [CANC, INAC]

Request example

1
2
3
4



curl -X DELETE https://dealers.masstack.com/v1/dealers/{dealer_id}?cancellationStatus='CANC'&cancellationDate='string'?cancellationStatus=CANC \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
201	Created	Successful response. Everything has been removed.	string
401	Unauthorized	Unauthorized	string
404	Not Found	Custom information not found	ApiErrorResponse

Get information from received dealers and hierarchy up.

This service receives multiple dealerId (ids) and returns dealer details and the hierarchy up.

GET /dealers

Parameters

Name	In	Type	Required	Description
ids	query	string	true	‘none’

Request example

1
2
3
4



curl -X GET https://dealers.masstack.com/v1/dealers?ids='string'?ids=string \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	Successful response.	[DealerHierarchyResponse]
401	Unauthorized	Unauthorized	string

200 - instance of DealerHierarchyResponse

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44


[
  {
    "id": 0,
    "hierarchy": [
      {
        "dealerCode": "string",
        "dealerId": 0,
        "commercialName": "string",
        "mainChannelCode": "string",
        "subchannelCode": "string",
        "level": 0,
        "parentCode": "string",
        "internalManager": "string",
        "externalManager": "string",
        "storeType": "string",
        "commissioningSection": "string",
        "companyType": "string",
        "documentType": "string",
        "documentNumber": "string",
        "companyName": "string",
        "status": "string",
        "address": "string",
        "city": "string",
        "province": "string",
        "country": "string",
        "postalCode": "string",
        "contactInformation": [
          {
            "contactName": "string",
            "contactEmail": "string",
            "contactPhone": "string",
            "contactPurposes": [
              "PUBLIC"
            ]
          }
        ],
        "segment": "string",
        "ine": "string",
        "storeDelivery": false,
        "deviceReturn": false
      }
    ]
  }
]

Name	Type	Required	Description
id	integer	false	none
hierarchy	[DealerInHierarchyResponse]	false	[Dealer hierarchy response ok]

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
id	integer	false	none
hierarchy	[DealerInHierarchyResponse]	false	[Dealer hierarchy response ok]

Create a new dealer and hierarchy up.

.

POST /dealers

Parameters

Name	In	Type	Required	Description
body	body	DealerRequest	true	‘none’

Request body - instance of DealerRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24


{
  "code": "string",
  "commercialName": "string",
  "level": 0,
  "statusCode": "string",
  "parentCode": "string",
  "subchannel": "string",
  "internalManager": 0,
  "externalManager": 0,
  "commissioningSection": "string",
  "storeType": "string",
  "fiscalDataId": 0,
  "startDate": "2020-05-21T12:00:00Z",
  "endDate": "2020-05-21T12:00:00Z",
  "segment": "string",
  "ine": "string",
  "storeDelivery": false,
  "deviceReturn": false,
  "address": "C/Ocaña 9",
  "city": "Madrid",
  "province": "Madrid",
  "postalCode": 28011,
  "country": "ES"
}

None

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29



curl -X POST https://dealers.masstack.com/v1/dealers \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'code': 'string',
  'commercialName': 'string',
  'level': 0,
  'statusCode': 'string',
  'parentCode': 'string',
  'subchannel': 'string',
  'internalManager': 0,
  'externalManager': 0,
  'commissioningSection': 'string',
  'storeType': 'string',
  'fiscalDataId': 0,
  'startDate': '2020-05-21T12:00:00Z',
  'endDate': '2020-05-21T12:00:00Z',
  'segment': 'string',
  'ine': 'string',
  'storeDelivery': false,
  'deviceReturn': false,
  'address': 'C/Ocaña 9',
  'city': 'Madrid',
  'province': 'Madrid',
  'postalCode': 28011,
  'country': 'ES'
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Successful response.	DealerResponse
400	Bad Request	Bad request	ApiErrorResponse
401	Unauthorized	Unauthorized	string

Create a new accounting-system information of a dealer

This operation creates a dealer's accounting-system with the information received.

POST /dealers/accounting-system

Parameters

Name	In	Type	Required	Description
body	body	DealerAccountingSystemPostRequest	true	‘none’

Request body - instance of DealerAccountingSystemPostRequest

1
2
3
4
5
6


{
  "dealerId": 1234,
  "systemId": 1,
  "dealerCode": "string",
  "example": null
}

Name	Type	Required	Description
dealerId	integer	false	none
systemId	integer	false	none
dealerCode	string	false	none
example	any	false	none

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11



curl -X POST https://dealers.masstack.com/v1/dealers/accounting-system \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'dealerId': 1234,
  'systemId': 1,
  'dealerCode': 'string',
  'example': null
}" 

Responses

Code	Meaning	Description	Schema
204	No Content	Successful response.	None
401	Unauthorized	Unauthorized	string
404	Not Found	Custom information not found	ApiErrorResponse

Delete accounting-system information of a dealer

This service receives a dealer accounting system id and deletes it.

DELETE /dealers/accounting-system/{dealer_accounting_system_id}

Parameters

Name	In	Type	Required	Description
dealerAccSysId	path	integer	true	‘none’

Request example

1
2
3
4



curl -X DELETE https://dealers.masstack.com/v1/dealers/accounting-system/{dealer_accounting_system_id} \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
204	No Content	Successful response.	None
401	Unauthorized	Unauthorized	string
404	Not Found	Custom information not found	ApiErrorResponse

Get accounting system information from specified dealer

This service receive a dealer Id and returns the accounting system information

GET /dealers/{dealer_id}/accounting-system

Parameters

Name	In	Type	Required	Description
dealer_id	path	integer	true	‘none’

Request example

1
2
3
4



curl -X GET https://dealers.masstack.com/v1/dealers/{dealer_id}/accounting-system \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	Successful response.	[DealerAccountingSystemResponse]
401	Unauthorized	Unauthorized	string
404	Not Found	Custom information not found	ApiErrorResponse

Updates the accounting-system information of a dealer

This operation updates the dealer's accounting-system with the information received.

PATCH /dealers/{dealer_id}/accounting-system

Parameters

Name	In	Type	Required	Description
dealer_id	path	integer	true	‘none’
body	body	DealerAccountingSystemRequest	true	‘none’

Request body - instance of DealerAccountingSystemRequest

1
2
3
4


{
  "systemId": 1,
  "dealerCode": "it's called dealerCode but it's the system's username"
}

Name	Type	Required	Description
systemId	integer	false	none
dealerCode	string	false	none

Request example

1
2
3
4
5
6
7
8
9



curl -X PATCH https://dealers.masstack.com/v1/dealers/{dealer_id}/accounting-system \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'systemId': 1,
  'dealerCode': 'it's called dealerCode but it's the system's username'
}" 

Responses

Code	Meaning	Description	Schema
204	No Content	Successful response.	None
401	Unauthorized	Unauthorized	string
404	Not Found	Custom information not found	ApiErrorResponse

Get full information from specified dealer.

This service receives a dealer Id and returns its generic info.

GET /dealers/full-info/{dealer_id}

Parameters

Name	In	Type	Required	Description
dealer_id	path	integer	true	‘none’

Request example

1
2
3
4



curl -X GET https://dealers.masstack.com/v1/dealers/full-info/{dealer_id} \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	Successful response.	DealerFullInfoResponse
401	Unauthorized	Unauthorized	string
404	Not Found	Custom information not found	ApiErrorResponse

Retrieve the list of dealers by the filter indicated.

This operation only returns the information necessary to identify each dealer in the list, to know who his parent is and to which sub-channel he belongs. This operation does not provide the detail of a dealer. A search filter can be defined in this operation. If the filter is not defined, it returns the last 100 updated or modified dealers sorted by date.

GET /dealers/simple-list

Parameters

Name	In	Type	Required	Description
name	query	string	false	Filters code, commercialName, dealerCode(dealerAccountingSystem), postalCode, province, documentNumber or companyName.
validAt	query	string	false	Filters by valid at the specified date

Request example

1
2
3
4



curl -X GET https://dealers.masstack.com/v1/dealers/simple-list?name='string'&validAt='2020-11-02T00:00:00%2B01:00' \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	Successful response.	[SummarizedDealerInfo]
401	Unauthorized	Unauthorized	string

Get list of the contacts of dealer.

This service receives dealerId and returns a contact list of that dealer.

GET /dealers/{dealer_id}/contacts

Parameters

Name	In	Type	Required	Description
dealer_id	path	integer	true	‘none’

Request example

1
2
3
4



curl -X GET https://dealers.masstack.com/v1/dealers/{dealer_id}/contacts \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	Successful response.	[ContactResponse1]
401	Unauthorized	Unauthorized	string
404	Not Found	Custom information not found	ApiErrorResponse

200 - instance of ContactResponse1

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57


[
  {
    "id": 0,
    "name": "string",
    "email": "test@test.es",
    "phoneNumber": "987654321",
    "purposes": [
      {
        "id": 0,
        "name": "string"
      }
    ],
    "dealers": [
      {
        "id": 0,
        "code": "string",
        "commercialName": "string",
        "level": 0,
        "levelDescription": "string",
        "status": "string",
        "parentId": 0,
        "parentCode": "string",
        "subchannelCode": "string",
        "internalManagerFullName": "string",
        "externalManagerFullName": "string",
        "internalManagerCode": "string",
        "externalManagerCode": "string",
        "commissioningSection": "string",
        "storeType": "string",
        "address": "string",
        "city": "string",
        "province": "string",
        "country": "string",
        "postalCode": "string",
        "startDate": "2020-05-21T12:00:00Z",
        "endDate": "2020-05-21T12:00:00Z",
        "userCreated": "string",
        "userUpdated": "string",
        "creationDate": "2020-05-21T12:00:00Z",
        "updateDate": "2020-05-21T12:00:00Z",
        "channelType": "string",
        "sellType": "string",
        "subchannelGroup": "string",
        "segment": "string",
        "ine": "string",
        "migratedFromDealerId": 0,
        "migratedToDealerId": 0,
        "migratedFromDealerCode": "string",
        "migratedToDealerCode": "string",
        "storeDelivery": false,
        "deviceReturn": false,
        "documentType": "string",
        "documentNumber": "string"
      }
    ]
  }
]

Name	Type	Required	Description
id	integer	false	none
name	string	false	none
email	string	false	none
phoneNumber	string	false	none
purposes	[PurposeResponse]	false	none
dealers	[SimpleDealerResponse1]	false	[Dealer generic info simplified object.]

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
id	integer	false	none
name	string	false	none
email	string	false	none
phoneNumber	string	false	none
purposes	[PurposeResponse]	false	none
dealers	[SimpleDealerResponse1]	false	[Dealer generic info simplified object.]

404 - instance of ApiErrorResponse

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "errors": [
    {
      "code": "NOT_FOUND",
      "title": "Error message",
      "ref": "some_ref",
      "details": "Detailed error message"
    }
  ]
}

Name	Type	Required	Description
restErrors	[ApiError]	false	none

Delete a dealer's contact

This service receives dealerId and contactId and delete this relationship.

DELETE /dealers/{dealer_id}/contacts/{contact_id}

Parameters

Name	In	Type	Required	Description
dealer_id	path	integer	true	‘none’
contact_id	path	integer	true	‘none’

Request example

1
2
3
4



curl -X DELETE https://dealers.masstack.com/v1/dealers/{dealer_id}/contacts/{contact_id} \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
204	No Content	Successful response.	None
401	Unauthorized	Unauthorized	string
404	Not Found	Custom information not found	ApiErrorResponse

Create a dealer's contact

This service receives dealerId and contactId and create this relationship.

POST /dealers/contacts

Parameters

Name	In	Type	Required	Description
body	body	DealerContact	true	‘none’

Request body - instance of DealerContact

1
2
3
4


{
  "contactId": 154,
  "dealerId": 130
}

Name	Type	Required	Description
contactId	integer	false	none
dealerId	integer	false	none

Request example

1
2
3
4
5
6
7
8
9



curl -X POST https://dealers.masstack.com/v1/dealers/contacts \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'contactId': 154,
  'dealerId': 130
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Successful response.	None
401	Unauthorized	Unauthorized	string
404	Not Found	Custom information not found	ApiErrorResponse

Migrate a dealer.

Migrate a dealer

POST /dealers/{dealer_id}/migration

Parameters

Name	In	Type	Required	Description
dealer_id	path	integer	true	‘none’
body	body	DealerMigrationRequest	true	‘none’

Request body - instance of DealerMigrationRequest

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


{
  "migrationDate": "2020-05-21T12:00:00Z",
  "copyGenericInfo": true,
  "copyContactInfo": true,
  "copyFiscalData": true,
  "copyAccountingSystems": true,
  "copyCustomInfo": true,
  "migratedSalesBase": true,
  "code": "string",
  "commercialName": "string",
  "level": 0,
  "subchannel": "string",
  "parentCode": "string"
}

Name	Type	Required	Description
migrationDate	string	false	none
copyGenericInfo	boolean	false	none
copyContactInfo	boolean	false	none
copyFiscalData	boolean	false	none
copyAccountingSystems	boolean	false	none
copyCustomInfo	boolean	false	none
migratedSalesBase	boolean	false	none

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19



curl -X POST https://dealers.masstack.com/v1/dealers/{dealer_id}/migration \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'migrationDate': '2020-05-21T12:00:00Z',
  'copyGenericInfo': true,
  'copyContactInfo': true,
  'copyFiscalData': true,
  'copyAccountingSystems': true,
  'copyCustomInfo': true,
  'migratedSalesBase': true,
  'code': 'string',
  'commercialName': 'string',
  'level': 0,
  'subchannel': 'string',
  'parentCode': 'string'
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Successful migration.	DealerMigrationResponse
400	Bad Request	Bad request	ApiErrorResponse
401	Unauthorized	Unauthorized	string
500	Internal Server Error	Internal Server Error	ApiErrorResponse

Check whether a dealer is migratable.

Check whether a dealer is migratable

GET /dealers/{dealer_id}/migration

Parameters

Name	In	Type	Required	Description
dealer_id	path	integer	true	‘none’

Request example

1
2
3
4



curl -X GET https://dealers.masstack.com/v1/dealers/{dealer_id}/migration \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	The dealer is valid for migration.	None
400	Bad Request	Bad request	ApiErrorResponse
401	Unauthorized	Unauthorized	string
500	Internal Server Error	Internal Server Error	ApiErrorResponse

Get custom information from received dealer.

This service receives dealerId and returns dealer custom information.

GET /dealers/{dealer_id}/custom-information

Parameters

Name	In	Type	Required	Description
dealer_id	path	integer	true	‘none’

Request example

1
2
3
4



curl -X GET https://dealers.masstack.com/v1/dealers/{dealer_id}/custom-information \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	Successful response. Dealer has been found and the hierarchy up is returned.	[DealerCustomInfoResponse]
401	Unauthorized	Unauthorized	string
404	Not Found	Custom information not found	ApiErrorResponse

200 - instance of DealerCustomInfoResponse

Custom schema example

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


[
  {
    "id": 0,
    "fieldName": "string",
    "userCreated": "string",
    "userUpdated": "string",
    "creationDate": "2020-05-21T12:00:00Z",
    "updateDate": "2020-05-21T12:00:00Z",
    "fieldId": 0,
    "dealerId": 0,
    "fieldValue": "string"
  }
]

Name	Type	Required	Description
id	integer	false	none
fieldName	string	false	none
userCreated	string	false	none
userUpdated	string	false	none
creationDate	string	false	none
updateDate	string	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
id	integer	false	none
fieldName	string	false	none
userCreated	string	false	none
userUpdated	string	false	none
creationDate	string	false	none
updateDate	string	false	none

404 - instance of ApiErrorResponse

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "errors": [
    {
      "code": "NOT_FOUND",
      "title": "Error message",
      "ref": "some_ref",
      "details": "Detailed error message"
    }
  ]
}

Name	Type	Required	Description
restErrors	[ApiError]	false	none

Create a new custom information from received dealer.

.

POST /dealers/custom-information

Parameters

Name	In	Type	Required	Description
body	body	DealerCustomInfoRequest	true	‘none’

Request body - instance of DealerCustomInfoRequest

1
2
3
4
5


{
  "fieldId": 0,
  "dealerId": 0,
  "fieldValue": "string"
}

Name	Type	Required	Description
fieldId	integer	false	none
dealerId	integer	false	none
fieldValue	string	false	none

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10



curl -X POST https://dealers.masstack.com/v1/dealers/custom-information \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'fieldId': 0,
  'dealerId': 0,
  'fieldValue': 'string'
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Successful response.	None
400	Bad Request	Bad request	ApiErrorResponse
401	Unauthorized	Unauthorized	string

Update custom information from received dealer and customInfo.

This service receives dealerId and body with fields to update.

PATCH /dealers/{dealer_id}/custom-information/{custom_info_id}

Parameters

Name	In	Type	Required	Description
dealer_id	path	integer	true	‘none’
custom_info_id	path	integer	true	‘none’
body	body	object	false	‘none’

Request body - JsonObject

1

{}

None

Request example

1
2
3
4
5
6
7
8



curl -X PATCH https://dealers.masstack.com/v1/dealers/{dealer_id}/custom-information/{custom_info_id} \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'fieldValue': 'string'
}" 

Responses

Code	Meaning	Description	Schema
200	OK	Successful response. Dealer has been updated.	None
400	Bad Request	Bad request	ApiErrorResponse
401	Unauthorized	Unauthorized	string
404	Not Found	Custom information not found	ApiErrorResponse

Delete custom information from received dealer.

.

DELETE /dealers/{dealer_id}/custom-information/{custom_info_id}

Parameters

Name	In	Type	Required	Description
dealer_id	path	integer	true	‘none’
custom_info_id	path	integer	true	‘none’

Request example

1
2
3
4



curl -X DELETE https://dealers.masstack.com/v1/dealers/{dealer_id}/custom-information/{custom_info_id} \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
204	No Content	Successful response. Everything has been removed.	None
401	Unauthorized	Unauthorized	string
404	Not Found	Custom information not found	ApiErrorResponse

Children dealers.

Obtain all children of a dealer.

GET /dealers/{dealer_id}/children

Parameters

Name	In	Type	Required	Description
dealer_id	path	integer	true	‘none’

Request example

1
2
3
4



curl -X GET https://dealers.masstack.com/v1/dealers/{dealer_id}/children \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	Successful response.	[FiscalDataAssociatedDealer]
400	Bad Request	Bad request	ApiErrorResponse
401	Unauthorized	Unauthorized	string
500	Internal Server Error	Internal Server Error	ApiErrorResponse

200 - instance of FiscalDataAssociatedDealer

Custom schema example

1
2
3
4
5
6
7
8
9


[
  {
    "id": "string",
    "code": "string",
    "commercialName": "string",
    "level": 0,
    "subChannelCode": "string"
  }
]

Name	Type	Required	Description
id	string	false	none
code	string	false	none
commercialName	string	false	none
level	integer	false	none
subChannelCode	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

Block Dealer and offspring.

Block dealer and offspring

POST /dealers/{dealer_id}/block

Parameters

Name	In	Type	Required	Description
dealer_id	path	integer	true	‘none’

Request example

1
2
3
4



curl -X POST https://dealers.masstack.com/v1/dealers/{dealer_id}/block \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	No content.	None
400	Bad Request	Bad request	ApiErrorResponse
401	Unauthorized	Unauthorized	string
500	Internal Server Error	Internal Server Error	ApiErrorResponse

Change the status of a dealer

This endpoint currently only makes status changes to 'Active'. That is, it is used to activate or reactivate a dealer.

POST /dealers/{dealer_id}/change-status

Parameters

Name	In	Type	Required	Description
dealer_id	path	integer	true	‘none’
body	body	DealerChangeStatusRequest	false	‘none’

Request body - instance of DealerChangeStatusRequest

1
2
3


{
  "status": "Activo"
}

Name	Type	Required	Description
status	string	false	none

Property	Values
status	one of [Activo, Bloqueado, Baja, Inactivo, Pendiente]

Request example

1
2
3
4
5
6
7
8



curl -X POST https://dealers.masstack.com/v1/dealers/{dealer_id}/change-status \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'status': 'Activo'
}" 

Responses

Code	Meaning	Description	Schema
200	OK	No content.	None
400	Bad Request	Bad request	ApiErrorResponse
401	Unauthorized	Unauthorized	string
500	Internal Server Error	Internal Server Error	ApiErrorResponse

Get the brands of a dealer_id

This service returns a list of all the brands of a dealer

GET /dealers/{dealer_id}/brands

Parameters

Name	In	Type	Required	Description
dealer_id	path	integer	true	‘none’

Request example

1
2
3
4



curl -X GET https://dealers.masstack.com/v1/dealers/{dealer_id}/brands \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	Successful response.	[DealerBrandResponse]
400	Bad Request	Bad request	ApiErrorResponse
401	Unauthorized	Unauthorized	string
404	Not Found	Custom information not found	ApiErrorResponse

200 - instance of DealerBrandResponse

Custom schema example

1
2
3
4
5
6
7
8
9


[
  {
    "id": 12,
    "dealerId": 13,
    "brandId": 123,
    "brandCode": "MM",
    "brandDescription": "MasMovil"
  }
]

Name	Type	Required	Description
id	integer	false	none
dealerId	integer	false	none
brandId	integer	false	none
brandCode	string	false	none
brandDescription	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

404 - instance of ApiErrorResponse

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "errors": [
    {
      "code": "NOT_FOUND",
      "title": "Error message",
      "ref": "some_ref",
      "details": "Detailed error message"
    }
  ]
}

Name	Type	Required	Description
restErrors	[ApiError]	false	none

Update the brands

This service update a list of brands of a dealer

PATCH /dealers/{dealer_id}/brands

Parameters

Name	In	Type	Required	Description
dealer_id	path	integer	true	‘none’
body	body	DealerBrandRequest	false	‘none’

Request body - instance of DealerBrandRequest

1
2
3
4
5


{
  "id": 12,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z"
}

Name	Type	Required	Description
id	integer	false	none
startDate	string(date-time)	false	none
endDate	string(date-time)	false	none

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10



curl -X PATCH https://dealers.masstack.com/v1/dealers/{dealer_id}/brands \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'id': 12,
  'startDate': '2019-08-24T14:15:22Z',
  'endDate': '2019-08-24T14:15:22Z'
}" 

Responses

Code	Meaning	Description	Schema
200	OK	Successful response. Brand has been updated.	None
400	Bad Request	Bad request	ApiErrorResponse
401	Unauthorized	Unauthorized	string
404	Not Found	Custom information not found	ApiErrorResponse