API Overview Resources Schemas

Schemas

ApiError

1
2
3
4
5
6


{
  "code": "string",
  "title": "string",
  "ref": "string",
  "details": "string"
}

Name	Type	Required	Description
code	string	true	code of the error
title	string	true	title of the error
ref	string	true	ref of the error
details	string	true	details of the error

ApiErrorResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "restErrors": [
    {
      "code": "string",
      "title": "string",
      "ref": "string",
      "details": "string"
    }
  ]
}

Name	Type	Required	Description
restErrors	[ApiError]	false	none

ContactRequest

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


{
  "name": "string",
  "email": "test@test.es",
  "phoneNumber": "987654321",
  "purposes": [
    {
      "id": 0
    }
  ],
  "dealers": [
    {
      "id": 0
    }
  ]
}

Name	Type	Required	Description
name	string	false	none
email	string	false	none
phoneNumber	string	false	none
purposes	[IntegerList]	false	none
dealers	[IntegerList]	false	none

ContactResponse

 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


{
  "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": "string",
      "endDate": "string",
      "userCreated": "string",
      "userUpdated": "string",
      "creationDate": "string",
      "updateDate": "string",
      "channelType": "string",
      "channelCode": "string",
      "channelName": "string",
      "sellType": "string",
      "subchannelGroup": "string",
      "segment": "string",
      "ine": "string",
      "migratedFromDealerId": 0,
      "migratedFromDealerCode": "string",
      "migratedToDealerId": 0,
      "migratedToDealerCode": "string",
      "storeDelivery": true,
      "deviceReturn": true
    }
  ]
}

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	[SimpleDealerResponse]	false	none

IntegerList

1
2
3


{
  "id": 0
}

Name	Type	Required	Description
id	integer	false	none

PurposeResponse

1
2
3
4


{
  "id": 0,
  "name": "string"
}

Name	Type	Required	Description
id	integer	false	none
name	string	false	none

SimpleDealerResponse

 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


{
  "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": "string",
  "endDate": "string",
  "userCreated": "string",
  "userUpdated": "string",
  "creationDate": "string",
  "updateDate": "string",
  "channelType": "string",
  "channelCode": "string",
  "channelName": "string",
  "sellType": "string",
  "subchannelGroup": "string",
  "segment": "string",
  "ine": "string",
  "migratedFromDealerId": 0,
  "migratedFromDealerCode": "string",
  "migratedToDealerId": 0,
  "migratedToDealerCode": "string",
  "storeDelivery": true,
  "deviceReturn": true
}

Name	Type	Required	Description
id	integer	false	none
code	string	false	none
commercialName	string	false	none
level	integer	false	none
levelDescription	string	false	none
status	string	false	none
parentId	integer	false	none
parentCode	string	false	none
subchannelCode	string	false	none
internalManagerFullName	string	false	none
externalManagerFullName	string	false	none
internalManagerCode	string	false	none
externalManagerCode	string	false	none
commissioningSection	string	false	none
storeType	string	false	none
address	string	false	none
city	string	false	none
province	string	false	none
country	string	false	none
postalCode	string	false	none
startDate	string	false	none
endDate	string	false	none
userCreated	string	false	none
userUpdated	string	false	none
creationDate	string	false	none
updateDate	string	false	none
channelType	string	false	none
channelCode	string	false	none
channelName	string	false	none
sellType	string	false	none
subchannelGroup	string	false	none
segment	string	false	none
ine	string	false	none
migratedFromDealerId	integer	false	none
migratedFromDealerCode	string	false	none
migratedToDealerId	integer	false	none
migratedToDealerCode	string	false	none
storeDelivery	boolean	false	none
deviceReturn	boolean	false	none

DealerResponse

 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


{
  "dealerId": 0,
  "migratedFromDealerId": 0,
  "migratedToDealerId": 0,
  "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"
}

Name	Type	Required	Description
dealerId	integer	false	none
migratedFromDealerId	integer	false	none
migratedToDealerId	integer	false	none

DealerAccessResponse

1
2
3
4
5


{
  "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

DealerInHierarchyResponse

 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


{
  "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

DealerHierarchyResponse

 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


{
  "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]

ContactInformation

1
2
3
4
5
6
7
8


{
  "contactName": "string",
  "contactEmail": "string",
  "contactPhone": "string",
  "contactPurposes": [
    "PUBLIC"
  ]
}

Name	Type	Required	Description
contactName	string	false	none
contactEmail	string	false	none
contactPhone	string	false	none
contactPurposes	[string]	false	none

DealerChangeStatusRequest

1
2
3


{
  "status": "Activo"
}

Name	Type	Required	Description
status	string	false	none

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

CampaignChangeStatusRequest

1
2
3


{
  "status": "ACTIVATED"
}

Name	Type	Required	Description
status	string	false	none

Property	Values
status	one of [ACTIVATED, DEACTIVATED]

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

DealerBase

 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"
}

Name	Type	Required	Description
code	string	false	none
commercialName	string	false	none
level	integer	false	none
statusCode	string	false	none
parentCode	string	false	none
subchannel	string	false	none
internalManager	integer	false	none
externalManager	integer	false	none
commissioningSection	string	false	none
storeType	string	false	none
fiscalDataId	integer	false	none
startDate	string	false	none
endDate	string	false	none
segment	string	false	none
ine	string	false	none
storeDelivery	boolean	false	none
deviceReturn	boolean	false	none

LevelBase

1
2
3
4


{
  "id": 0,
  "hierarchicalLevel": 0
}

Name	Type	Required	Description
id	integer	false	none
hierarchicalLevel	integer	false	none

SubchannelBase

1
2
3
4


{
  "id": 0,
  "code": "string"
}

Name	Type	Required	Description
id	integer	false	none
code	string	false	none

ManagerBase

1
2
3
4


{
  "id": 0,
  "code": "string"
}

Name	Type	Required	Description
id	integer	false	none
code	string	false	none

InternalManager

1
2
3
4


{
  "id": 0,
  "code": "string"
}

None

ExternalManager

1
2
3
4


{
  "id": 0,
  "code": "string"
}

None

DealerFullInfoResponse

 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
58
59
60
61
62


{
  "genericInfo": {
    "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"
  },
  "fiscalDataInfo": {
    "id": 0,
    "companyType": "AUTÓNOMO",
    "companyName": "FOO S.L.",
    "documentType": "NIF",
    "documentNumber": "1234567X",
    "address": "C/Ocaña 9",
    "city": "Madrid",
    "province": "Madrid",
    "postalCode": 28011,
    "country": "ES"
  },
  "billingInfo": {
    "dealerId": 0,
    "code": "string",
    "commercialName": "string",
    "documentType": "string",
    "documentNumber": "string"
  }
}

Name	Type	Required	Description
genericInfo	SimpleDealerResponse1	false	Dealer generic info simplified object.
fiscalDataInfo	FiscalData	false	none
billingInfo	BillingInfo	false	Billing info object.

BillingInfo

1
2
3
4
5
6
7


{
  "dealerId": 0,
  "code": "string",
  "commercialName": "string",
  "documentType": "string",
  "documentNumber": "string"
}

Name	Type	Required	Description
dealerId	integer	false	none
code	string	false	none
commercialName	string	false	none
documentType	string	false	none
documentNumber	string	false	none

SimpleDealerResponse1

 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


{
  "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
code	string	false	none
commercialName	string	false	none
level	integer	false	none
levelDescription	string	false	none
status	string	false	none
parentId	integer	false	none
parentCode	string	false	none
subchannelCode	string	false	none
internalManagerFullName	string	false	none
externalManagerFullName	string	false	none
internalManagerCode	string	false	none
externalManagerCode	string	false	none
commissioningSection	string	false	none
storeType	string	false	none
address	string	false	none
city	string	false	none
province	string	false	none
country	string	false	none
postalCode	string	false	none
startDate	string	false	none
endDate	string	false	none
userCreated	string	false	none
userUpdated	string	false	none
creationDate	string	false	none
updateDate	string	false	none
channelType	string	false	none
sellType	string	false	none
subchannelGroup	string	false	none
segment	string	false	none
ine	string	false	none
migratedFromDealerId	integer	false	none
migratedToDealerId	integer	false	none
migratedFromDealerCode	string	false	none
migratedToDealerCode	string	false	none
storeDelivery	boolean	false	none
deviceReturn	boolean	false	none
documentType	string	false	none
documentNumber	string	false	none

SummarizedDealerInfo

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "id": 0,
  "code": "string",
  "commercialName": "string",
  "level": 0,
  "status": "string",
  "parentCode": "string",
  "subchannelCode": "string",
  "email": "string"
}

Name	Type	Required	Description
id	integer	false	none
code	string	false	none
commercialName	string	false	none
level	integer	false	none
status	string	false	none
parentCode	string	false	none
subchannelCode	string	false	none
email	string	false	none

ListDealerResponse

 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


{
  "id": 0,
  "code": "string",
  "commercialName": "string",
  "level": 0,
  "status": "string",
  "parentId": 0,
  "parentCode": "string",
  "subchannelCode": "string",
  "internalManagerFullName": "string",
  "externalManagerFullName": "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"
}

Name	Type	Required	Description
id	integer	false	none
code	string	false	none
commercialName	string	false	none
level	integer	false	none
status	string	false	none
parentId	integer	false	none
parentCode	string	false	none
subchannelCode	string	false	none
internalManagerFullName	string	false	none
externalManagerFullName	string	false	none
commissioningSection	string	false	none
storeType	string	false	none
address	string	false	none
city	string	false	none
province	string	false	none
country	string	false	none
postalCode	string	false	none
startDate	string	false	none
endDate	string	false	none
userCreated	string	false	none
userUpdated	string	false	none
creationDate	string	false	none
updateDate	string	false	none
channelType	string	false	none
sellType	string	false	none
subchannelGroup	string	false	none
segment	string	false	none
ine	string	false	none

DealerSimpleList

1
2
3
4
5
6
7
8
9


{
  "id": 0,
  "code": "string",
  "commercialName": "string",
  "level": 0,
  "parentCode": "string",
  "subchannelCode": "string",
  "status": "string"
}

Name	Type	Required	Description
id	integer	false	none
code	string	false	none
commercialName	string	false	none
level	integer	false	none
parentCode	string	false	none
subchannelCode	string	false	none
status	string	false	none

DealerSimpleListResponse

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


[
  {
    "id": 0,
    "code": "string",
    "commercialName": "string",
    "level": 0,
    "status": "string",
    "parentCode": "string",
    "subchannelCode": "string",
    "email": "string"
  }
]

Name	Type	Required	Description
anonymous	[SummarizedDealerInfo]	false	[Summarized dealer info.]

ContactResponse1

 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


{
  "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.]

DealerContact

1
2
3
4


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

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

CompanyBase

1
2
3
4


{
  "companyType": "AUTÓNOMO",
  "companyName": "FOO S.L."
}

Name	Type	Required	Description
companyType	string	false	none
companyName	string	false	none

Property	Values
companyType	one of [AUTÓNOMO, EMPRESA]

Document

1
2
3
4


{
  "documentType": "NIF",
  "documentNumber": "1234567X"
}

Name	Type	Required	Description
documentType	string	false	none
documentNumber	string	false	none

Property	Values
documentType	one of [NIF, CIF, NIE]

Address

1
2
3
4
5
6
7


{
  "address": "C/Ocaña 9",
  "city": "Madrid",
  "province": "Madrid",
  "postalCode": 28011,
  "country": "ES"
}

Name	Type	Required	Description
address	string	false	none
city	string	false	none
province	string	false	none
postalCode	string	false	none
country	string	false	none

Property	Values
country	one of [ES, PT, AD, PE, CO, MA]

FiscalDataAssociatedDealer

1
2
3
4
5
6
7


{
  "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

FiscalData

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


{
  "id": 0,
  "companyType": "AUTÓNOMO",
  "companyName": "FOO S.L.",
  "documentType": "NIF",
  "documentNumber": "1234567X",
  "address": "C/Ocaña 9",
  "city": "Madrid",
  "province": "Madrid",
  "postalCode": 28011,
  "country": "ES"
}

Name	Type	Required	Description
id	integer	false	none

Name	Type	Required	Description
anonymous	CompanyBase	false	none

Name	Type	Required	Description
anonymous	Document	false	none

Name	Type	Required	Description
anonymous	Address	false	none

FiscalDataPost

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


{
  "id": 0,
  "companyType": "AUTÓNOMO",
  "companyName": "FOO S.L.",
  "documentType": "NIF",
  "documentNumber": "1234567X",
  "address": "C/Ocaña 9",
  "city": "Madrid",
  "province": "Madrid",
  "postalCode": 28011,
  "country": "ES"
}

None

FiscalDataDetail

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


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

Name	Type	Required	Description
dealers	[FiscalDataAssociatedDealer]	false	none

FiscalDataPatch

1
2
3
4
5
6
7
8


{
  "companyName": "FOO S.L.",
  "address": "C/Ocaña 9",
  "city": "Madrid",
  "province": "Madrid",
  "postalCode": 28011,
  "country": "ES"
}

Name	Type	Required	Description
companyName	string	false	none

DealerTarget

1
2
3
4
5
6
7


{
  "code": "string",
  "commercialName": "string",
  "level": 0,
  "subchannel": "string",
  "parentCode": "string"
}

Name	Type	Required	Description
code	string	true	none
commercialName	string	false	none
level	integer	false	none
subchannel	string	true	none
parentCode	string	false	none

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

DealerMigrationResponse

 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


{
  "dealerId": 0,
  "migratedFromDealerId": 0,
  "migratedToDealerId": 0,
  "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

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

DealerCustomInfoResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "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

CustomInfoBase

1
2
3
4
5


{
  "fieldName": "string",
  "fieldDescription": "string",
  "fieldType": "string"
}

Name	Type	Required	Description
fieldName	string	false	none
fieldDescription	string	false	none
fieldType	string	false	none

CustomInfoRequest

1
2
3
4
5


{
  "fieldName": "string",
  "fieldDescription": "string",
  "fieldType": "string"
}

None

CustomInfoResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "id": 0,
  "values": "string",
  "userCreated": "string",
  "userUpdated": "string",
  "creationDate": "2020-05-21T12:00:00Z",
  "updateDate": "2020-05-21T12:00:00Z",
  "fieldName": "string",
  "fieldDescription": "string",
  "fieldType": "string"
}

Name	Type	Required	Description
id	integer	false	none
values	string	false	none
userCreated	string	false	none
userUpdated	string	false	none
creationDate	string	false	none
updateDate	string	false	none

CommercialProfiles

1

"perfil_comercial.ecare"

Name	Type	Required	Description
anonymous	string	false	commercial profile.

CampaignUser

 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


{
  "id": 12345,
  "code": "CDRDealer",
  "commercialName": "Agent",
  "subchannel": "ATC",
  "systemAccounts": [
    {
      "id": 12345,
      "account": "CDRDealer",
      "accountingSystem": {
        "id": 12345,
        "code": "IAM",
        "description": "System of MM"
      }
    }
  ],
  "campaign": {
    "id": 12345,
    "name": "campaign",
    "commercialProfile": "Commercial profile",
    "active": true,
    "subchannels": [
      {
        "id": 123,
        "code": "MS",
        "name": "MasSubchannel",
        "mainChannel": {
          "id": 12345,
          "code": "M",
          "name": "Mas",
          "channelType": "myChannelType"
        },
        "sellType": "mySellType",
        "subchannelGroup": "mySubchannelGroup"
      }
    ],
    "conditions": null
  }
}

Name	Type	Required	Description
id	integer	true	none
code	string	true	none
commercialName	string	false	none
subchannel	string	false	none
systemAccounts	[SystemAccount]	false	[A Dealer’s system account]
campaign	object	false	A commercial campaign
» id	integer	false	none
» name	string	false	none
» commercialProfile	string	false	none
» active	boolean	false	none
» subchannels	[Subchannel]	false	[A subchannel]
» conditions	any	false	none

SystemAccount

1
2
3
4
5
6
7
8
9


{
  "id": 12345,
  "account": "CDRDealer",
  "accountingSystem": {
    "id": 12345,
    "code": "IAM",
    "description": "System of MM"
  }
}

Name	Type	Required	Description
id	integer	false	none
account	string	false	none
accountingSystem	AccountingSystem	false	An accounting system

Subchannel

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


{
  "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

Channel

1
2
3
4
5
6


{
  "id": 12345,
  "code": "M",
  "name": "Mas",
  "channelType": "myChannelType"
}

Name	Type	Required	Description
id	integer	false	none
code	string	false	none
name	string	false	none
channelType	string	false	none

Campaign

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


{
  "id": 12345,
  "name": "campaign",
  "commercialProfile": "Commercial profile",
  "active": true,
  "subchannels": [
    {
      "id": 123,
      "code": "MS",
      "name": "MasSubchannel"
    }
  ],
  "conditions": [
    {
      "id": 123,
      "concept": "SEGMENT",
      "operator": "EQ",
      "values": "RESIDENCIAL",
      "type": "String"
    }
  ]
}

Name	Type	Required	Description
id	integer	false	none
name	string	false	none
commercialProfile	string	false	none
active	boolean	false	none
subchannels	[SubchannelSummary]	false	[SubchannelSummary]
conditions	[CampaignRules]	false	[CampaignRules]

AccountingSystem

1
2
3
4
5


{
  "id": 12345,
  "code": "IAM",
  "description": "System of MM"
}

Name	Type	Required	Description
id	integer	false	none
code	string	false	none
description	string	false	none

DealerAccountingSystemResponseList

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


[
  {
    "id": 21234,
    "dealerId": 1234,
    "systemId": 1,
    "systemCode": "IAM",
    "systemDescription": "IAM System",
    "dealerCode": "TEST_DEALER"
  }
]

Name	Type	Required	Description
anonymous	[DealerAccountingSystemResponse]	false	[A dealer accounting system]

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

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

DealerAccountingSystemResponse

1
2
3
4
5
6
7
8


{
  "id": 21234,
  "dealerId": 1234,
  "systemId": 1,
  "systemCode": "IAM",
  "systemDescription": "IAM System",
  "dealerCode": "TEST_DEALER"
}

Name	Type	Required	Description
id	integer	false	none
dealerId	integer	false	none
systemId	integer	false	none
systemCode	string	false	none
systemDescription	string	false	none
dealerCode	string	false	none

ChangeCampaignRequest

1
2
3
4
5
6
7


{
  "campaignId": 123,
  "requestId": 123,
  "dealerId": [
    154
  ]
}

Name	Type	Required	Description
campaignId	integer	false	none
requestId	integer	false	none
dealerId	[DealerId]	false	none

CampaignRequest

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


{
  "name": "campaign",
  "commercialProfile": "Commercial profile",
  "subchannels": [
    "MS"
  ],
  "conditions": [
    {
      "id": 123,
      "concept": "SEGMENT",
      "operator": "EQ",
      "values": "RESIDENCIAL",
      "type": "String"
    }
  ]
}

Name	Type	Required	Description
name	string	true	none
commercialProfile	string	true	none
subchannels	[string]	true	none
conditions	[CampaignRules]	false	[CampaignRules]

DealerId

1

154

Name	Type	Required	Description
anonymous	integer	false	none

SubchannelSummary

1
2
3
4
5


{
  "id": 123,
  "code": "MS",
  "name": "MasSubchannel"
}

Name	Type	Required	Description
id	integer	false	none
code	string	false	none
name	string	false	none

CampaignRules

1
2
3
4
5
6
7


{
  "id": 123,
  "concept": "SEGMENT",
  "operator": "EQ",
  "values": "RESIDENCIAL",
  "type": "String"
}

Name	Type	Required	Description
id	integer	false	none
concept	string	false	none
operator	string	false	none
values	string	false	none
type	string	false	none

CampaignSearchRequest

1
2
3
4
5
6
7
8
9


{
  "active": true,
  "subchannels": [
    "MS1"
  ],
  "dealers": [
    1
  ]
}

Name	Type	Required	Description
active	boolean	false	none
subchannels	[string]	false	none
dealers	[integer]	false	none

Store

 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


{
  "dealerCode": "string",
  "commercialName": "string",
  "addressInfo": {
    "address": "C/Ocaña 9",
    "city": "Madrid",
    "province": "Madrid",
    "postalCode": 28011,
    "country": "ES"
  },
  "phoneNumber": "string",
  "email": "string",
  "location": {
    "latitude": 40.4124967,
    "longitude": -3.8706208
  },
  "distance": 330.15,
  "storeDelivery": false,
  "deviceReturn": false,
  "brands": [
    {
      "code": "MM",
      "description": "masmovil"
    }
  ],
  "customInformation": [
    {
      "fieldId": 0,
      "dealerId": 0,
      "fieldValue": "string"
    }
  ]
}

Name	Type	Required	Description
dealerCode	string	false	none
commercialName	string	false	none
addressInfo	Address	false	none
phoneNumber	string	false	none
email	string	false	none
location	Location	false	none
distance	number(double)	false	none
storeDelivery	boolean	false	none
deviceReturn	boolean	false	none
brands	[Brand]	false	none
customInformation	[DealerCustomInfoRequest]	false	[Dealer custom-info.]

Location

1
2
3
4


{
  "latitude": 40.4124967,
  "longitude": -3.8706208
}

Name	Type	Required	Description
latitude	number(double)	false	none
longitude	number(double)	false	none

Brand

1
2
3
4


{
  "code": "MM",
  "description": "masmovil"
}

Name	Type	Required	Description
code	string	false	none
description	string	false	none

DealerBrandResponse

1
2
3
4
5
6
7


{
  "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

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

DealerWithCustomFieldValueResponse

1
2
3
4
5
6


{
  "dealerId": 123,
  "dealerCode": "testCode",
  "dealerCommercialName": "testCommercialName",
  "fieldValue": "testfieldValue"
}

Name	Type	Required	Description
dealerId	integer	false	none
dealerCode	string	false	none
dealerCommercialName	string	false	none
fieldValue	string	false	none

GenericError

1
2
3
4
5
6


{
  "message": "string",
  "code": "string",
  "status": "string",
  "detailMsg": "string"
}

Name	Type	Required	Description
message	string	false	none
code	string	false	none
status	string	false	none
detailMsg	string	false	none

ManagerBase1

1
2
3
4


{
  "id": 0,
  "code": "t.test"
}

Name	Type	Required	Description
id	integer	false	none
code	string	false	none

ManagerResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


{
  "name": "Test",
  "surname": "Test",
  "type": "INT",
  "parent": {
    "id": 0,
    "code": "t.test"
  },
  "id": 0,
  "code": "t.test"
}

Name	Type	Required	Description
name	string	false	none
surname	string	false	none
type	string	false	INT -> Interno EXT -> Externo
parent	ManagerBase1	false	Contact generic info simplified object.

Property	Values
type	one of [INT, EXT]

RequestResponse

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


{
  "id": 0,
  "dealerId": 0,
  "dealerCode": "string",
  "platform": "JIRA",
  "status": "PENDING",
  "userCreated": "string",
  "creationDate": "2020-05-21T12:00:00Z",
  "requestDetails": {
    "email": "string",
    "orgUnit": "string",
    "salesRole": "string",
    "commercialProfile": [
      "string"
    ],
    "simReplacement": true,
    "eSIMReplacement": true
  }
}

Name	Type	Required	Description
id	integer	false	none
dealerId	integer	true	none
dealerCode	string	false	none
platform	string	true	none
status	string	true	none
userCreated	string	false	none
creationDate	string	false	none
requestDetails	object	false	none
» email	string	false	none
» orgUnit	string	false	none
» salesRole	string	false	none
» commercialProfile	[string]	false	none
» simReplacement	boolean	false	none
» eSIMReplacement	boolean	false	none

Property	Values
platform	one of [JIRA, IAM]
status	one of [PENDING, CREATED, REJECTED, COMPLETED, ERROR]

RequestsRequest

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


{
  "dealerId": 0,
  "platform": "JIRA",
  "issue": "string",
  "requestType": "DEALER_CREATION",
  "status": "PENDING",
  "requestDetail": {
    "email": "string",
    "pass": "string",
    "recoveryPhone": "string",
    "orgUnitId": 0,
    "orgUnit": "string",
    "salesRole": "string",
    "commercialProfile": [
      "string"
    ],
    "SIMReplacement": true,
    "eSIMReplacement": true
  }
}

Name	Type	Required	Description
dealerId	integer	true	none
platform	string	true	none
issue	string	false	none
requestType	string	true	none
status	string	true	none
requestDetail	any	false	none

Name	Type	Required	Description
» anonymous	RequestDetailIamCreateDealer	false	none

Name	Type	Required	Description
» anonymous	RequestDetailIamChangeCampaign	false	none

Property	Values
platform	one of [JIRA, IAM]
requestType	one of [DEALER_CREATION]
status	one of [PENDING, CREATED, REJECTED, COMPLETED, ERROR]

RequestDetailIamCreateDealer

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


{
  "email": "string",
  "pass": "string",
  "recoveryPhone": "string",
  "orgUnitId": 0,
  "orgUnit": "string",
  "salesRole": "string",
  "commercialProfile": [
    "string"
  ],
  "SIMReplacement": true,
  "eSIMReplacement": true
}

Name	Type	Required	Description
email	string	false	none
pass	string	false	none
recoveryPhone	string	false	none
orgUnitId	integer	false	none
orgUnit	string	false	none
salesRole	string	false	none
commercialProfile	[string]	false	none
SIMReplacement	boolean	false	none
eSIMReplacement	boolean	false	none

RequestDetailIamChangeCampaign

1
2
3
4
5
6


{
  "campaignId": 0,
  "dealerIds": [
    0
  ]
}

Name	Type	Required	Description
campaignId	integer	false	none
dealerIds	[integer]	false	none

RequestModificationBody

1
2
3
4


{
  "status": "PENDING",
  "comment": "string"
}

Name	Type	Required	Description
status	string	false	none
comment	string	false	none

Property	Values
status	one of [PENDING, CREATED, REJECTED, COMPLETED, ERROR]

RequestCreatedResponse

1
2
3
4
5
6
7
8
9


{
  "id": 0,
  "dealerId": 0,
  "platform": "JIRA",
  "issue": "string",
  "requestType": "string",
  "comment": "string",
  "status": "PENDING"
}

Name	Type	Required	Description
id	integer	false	none
dealerId	integer	false	none
platform	string	false	none
issue	string	false	none
requestType	string	false	none
comment	string	false	none
status	string	false	none

Property	Values
platform	one of [JIRA, IAM]
status	one of [PENDING, CREATED, REJECTED, COMPLETED, ERROR]