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
{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "ref": "string",
      "details": "string"
    }
  ]
}
Name Type Required Description
errors [ApiError] false none

DealerBrandInsertRequest

1
2
3
{
  "brandCode": "YG"
}
Name Type Required Description
brandCode string true Brand codes enumeration
Property Values
brandCode one of [GU, PP, YG, LE, MM, LY, LL, VI, EB, AH, AL, BT, SW, JI, MB, ST, PM]

ActorResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a",
  "code": "jjhags123-a1",
  "name": "Test Name",
  "surname": "Test Surname",
  "type": "EMPLOYEE",
  "email": "test@masmovil.es",
  "parent_id": "DEAL-1233",
  "parent_code": "DEAL-6370",
  "relation_type": "DIRECT"
}
Name Type Required Description
id string true Id of the actor
code string true Code of the actor
name string false Name of the actor
surname string false Surname of the actor
type string true Enumeration of possible actor types
email string true Email of the actor
parent_id string false parentId if exist
parent_code string false parentCode if exist
relation_type string false Enumeration of possible relations between actors and dealers
Property Values
type one of [EMPLOYEE, EXTERNAL_MANAGER, HEAD, MANAGER, COORDINATOR, SUPERVISOR, TRAINER, INTERNAL_POS_MANAGER, EXTERNAL_POS_MANAGER, TERRITORIAL, NATIONAL]
relation_type one of [DIRECT_AND_INDIRECT, DIRECT, INDIRECT]

ActorInsertRequest

1
2
3
4
5
6
7
8
{
  "code": "GTRW12341A",
  "name": "Test Name",
  "surname": "Surname Test",
  "type": "EMPLOYEE",
  "email": "test@masmovil.es",
  "parent_id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a"
}
Name Type Required Description
code string true Code of the actor
name string true Name of the actor
surname string false Surname of the actor msisdn
type string true Enumeration of possible actor types
email string(email) true Email of the actor
parent_id string false parentId if exist
Property Values
type one of [EMPLOYEE, EXTERNAL_MANAGER, HEAD, MANAGER, COORDINATOR, SUPERVISOR, TRAINER, INTERNAL_POS_MANAGER, EXTERNAL_POS_MANAGER, TERRITORIAL, NATIONAL]

DealerBillingRequest

1
2
3
{
  "billing_dealer_id": 123456
}
Name Type Required Description
billing_dealer_id integer(int32) true Id of the dealer that bill

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

CustomInformationResponse

1
2
3
4
5
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Funnel",
  "description": "Funnel Access"
}
Name Type Required Description
id string true Identifier of the custom information variable
name string true Name of the custom information variable
description string¦null true Description of the custom information variable

CustomInformationInsertionRequest

1
2
3
4
{
  "name": "Funnel",
  "description": "Funnel Access"
}
Name Type Required Description
name string true Name of the custom information variable
description string true Description of the custom information variable

DealerResponseV2

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "id": "abcd-1234-xyz",
  "code": "COD-123",
  "commercial_name": "Testing Test SL",
  "level": 2,
  "document_type": "NIF",
  "document_value": "12345678Z",
  "ine": "123456789012345",
  "segment": "RESIDENCIAL",
  "parent_id": "abcd-1234-xyz",
  "parent_code": "COD-123",
  "commercial_structure_id": "abcd-1234-xyz",
  "commercial_structure_code": "AC",
  "status": "Activo"
}
Name Type Required Description
id string true Id of the dealer
code string true Code of the dealer
commercial_name string true CommercialName of the dealer
level integer(int32) true Level of the dealer
document_type string false Document type of the dealer
document_value string false Document value of the dealer
ine string false INE of the dealer
segment string false Segment of the dealer
parent_id string false Id of the dealer’s parent
parent_code string false Code of the dealer’s parent
commercial_structure_id string true Commercial structure id of the dealer
commercial_structure_code string false Commercial structure code of the dealer
status string true Enumeration of possible dealer statuses
Property Values
document_type one of [NIF, NIE]
segment one of [RESIDENTIAL, BUSINESS]
status one of [Bloqueado, Pendiente, Baja, Activo, Inactivo, ]

DealerInsertRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "code": "ATC12345",
  "level": 4,
  "ine": "1234567890",
  "segment": "RETAIL",
  "status": "Activo",
  "commercial_name": "Test Commercial Name",
  "document_type": "NIF",
  "document_value": "12345678A",
  "parent_id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a",
  "commercial_structure_id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a"
}
Name Type Required Description
code string true Code of the dealer
level integer(int32) true Level of the dealer
ine string¦null true Ine code of the dealer
segment string¦null true Segment of the dealer
status string true Enumeration of possible dealer statuses
commercial_name string true Commercial name of the dealer
document_type string¦null true Document type of the dealer
document_value string¦null true Document value of the dealer
parent_id string¦null true The parentId of the dealer
commercial_structure_id string true The commercialStructureId of the dealer
Property Values
segment one of [RESIDENTIAL, BUSINESS]
status one of [Bloqueado, Pendiente, Baja, Activo, Inactivo, ]
document_type one of [NIF, NIE]

DealerAccountingSystemResponse

1
2
3
4
5
{
  "id": "e7b8f8e6-9c3b-4d2a-8f1e-2c3d4e5f6a7b",
  "system": "IAM",
  "username": "medias_puri@masmovil.com"
}
Name Type Required Description
id string true Dealer accounting_system entry id (unique identifier)
system string true Accounting system name
username string true Username
Property Values
system one of [MYSIM, QVANTEL, LUCERA, HEOS, IAM, LEBARA, LYCAMOBILE, VIRGIN, HERO, EMBOU, SCHAMAN, PORTAL DE COMPRAS, DIGO]

DealerAccountingSystemInsertRequest

1
2
3
4
{
  "username": "medias_puri@masmovil.com",
  "system": "IAM"
}
Name Type Required Description
username string true Username
system string true Accounting system identifier
Property Values
system one of [MYSIM, QVANTEL, LUCERA, HEOS, IAM, LEBARA, LYCAMOBILE, VIRGIN, HERO, EMBOU, SCHAMAN, PORTAL DE COMPRAS, DIGO]

DealerContactResponse

1
2
3
4
5
6
7
8
{
  "id": "e7b8f8e6-9c3b-4d2a-8f1e-2c3d4e5f6a7b",
  "dealer_id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a",
  "name": "John Doe",
  "email": "contactmail@example.es",
  "phone_number": "string",
  "purposes": "[Comercial, Facturación]"
}
Name Type Required Description
id string true Unique contact ID (UUID)
dealer_id string true Dealer ID to which the contact belongs
name string¦null true Contact name
email string¦null true Contact email
phone_number string¦null true Contact phoneNumber number
purposes [string]¦null true Contact purposes: [Gerencia, Comercial, Logística, Informes, Facturación, Incidencias, Público]

DealerContactInsertRequest

1
2
3
4
5
6
{
  "name": "John Doe",
  "email": "contactmail@example.es",
  "phone_number": "600123456",
  "purposes": "[Comercial, Facturación]"
}
Name Type Required Description
name string true Contact name
email string(email)¦null true Contact email
phone_number string¦null true Contact phoneNumber number
purposes [string]¦null true Contact purposes: [Gerencia, Comercial, Logística, Informes, Facturación, Incidencias, Público]

DealerCustomInformationResponse

1
2
3
4
5
6
7
{
  "id": "7944a62c-98fc-40e6-a914-d49479eeb53f",
  "dealer_id": "123e4567-e89b-12d3-a456-426614174000",
  "field_id": "48f7917f-9d0f-43d3-95c8-f8038d4c954e",
  "field_name": "@Funnel",
  "field_value": "Yes"
}
Name Type Required Description
id string true Identifier of the dealer <-> custom information variable assignation relationship
dealer_id string true Identifier of the dealer to whom the custom information variable value is assigned
field_id string true Id of the custom information variable definition
field_name string true Id of the custom information variable definition
field_value string true Value for the custom information variable assigned to dealer

DealerCustomInformationInsertionRequest

1
2
3
4
{
  "field_id": "48f7917f-9d0f-43d3-95c8-f8038d4c954e",
  "field_value": "Yes"
}
Name Type Required Description
field_id string true Id of the custom information variable definition
field_value string true Value of the custom information variable

TicketConfigInsertRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "commercialName": "Test Commercial Name",
  "address": "Test Address",
  "city": "Test City",
  "province": "Test Province",
  "postalCode": "12345",
  "country": "Test Country",
  "documentType": "NIF",
  "documentNumber": "12345678A",
  "printType": "A4"
}
Name Type Required Description
commercialName string false Commercial name of the ticket config
address string false Address of the ticket config
city string false City of the ticket config
province string false Province of the ticket config
postalCode string false Postal code of the ticket config
country string false Country of the ticket config
documentType string false Document type of the ticket config
documentNumber string false Document number of the ticket config
printType string false Print type of the ticket config

ActorTypeListApiModelRequest

1
2
3
4
5
{
  "actorTypes": [
    "EMPLOYEE"
  ]
}
Name Type Required Description
actorTypes [string] false List of actor types

ActorsResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
{
  "offset": 0,
  "limit": 10,
  "total": 100,
  "sort": "id:asc",
  "items": [
    {
      "id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a",
      "code": "jjhags123-a1",
      "name": "Test Name",
      "surname": "Test Surname",
      "type": "EMPLOYEE",
      "email": "test@masmovil.es",
      "parent_id": "DEAL-1233",
      "parent_code": "DEAL-6370",
      "relation_type": "DIRECT"
    }
  ]
}
Name Type Required Description
offset integer(int32) false Offset used to paginate in conjunction with limit
limit integer(int32) false Max number of results of the response
total integer(int32) false Total number of records
sort string false The fields by which the results will be sorted. It can be a list of fields separated by commas
items [ActorResponse] true List of items

ActorTypeResponse

1
2
3
4
5
{
  "types": [
    "EMPLOYEE"
  ]
}
Name Type Required Description
types [string] true List of actor types

BillingOfDealerResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "dealer_id": 12344567,
  "billing_dealer": {
    "id": 12344567,
    "code": "COD-123",
    "commercial_name": "Testing Test SL",
    "document_type": "DNI",
    "document_number": "12345678A"
  }
}
Name Type Required Description
dealer_id integer(int32) true Id of the dealer
billing_dealer BillingResponse true Information of the billing of a dealer

BillingResponse

1
2
3
4
5
6
7
{
  "id": 12344567,
  "code": "COD-123",
  "commercial_name": "Testing Test SL",
  "document_type": "DNI",
  "document_number": "12345678A"
}
Name Type Required Description
id integer(int32) true Id of the dealer
code string true Code of the dealer
commercial_name string true CommercialName of the dealer
document_type string true Type of the document
document_number string true Number of the document

BrandResponse

1
2
3
4
{
  "code": "YG",
  "brand": "yoigo"
}
Name Type Required Description
code string true Brand codes enumeration
brand string true Brand name
Property Values
code one of [GU, PP, YG, LE, MM, LY, LL, VI, EB, AH, AL, BT, SW, JI, MB, ST, PM]

CommercialStructureResponse

1
2
3
4
5
6
7
8
9
{
  "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

CustomInformationPaginatedResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "offset": 0,
  "limit": 10,
  "total": 100,
  "sort": "id:asc",
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Funnel",
      "description": "Funnel Access"
    }
  ]
}
Name Type Required Description
offset integer(int32) false Offset used to paginate in conjunction with limit
limit integer(int32) false Max number of results of the response
total integer(int32) false Total number of records
sort string false The fields by which the results will be sorted. It can be a list of fields separated by commas
items [CustomInformationResponse] true List of items

DealerAddressResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "id": "e7b8f8e6-9c3b-4d2a-8f1e-2c3d4e5f6a7b",
  "dealer_id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a",
  "address": "Calle Gran Vía 28",
  "city": "Madrid",
  "province": "Madrid",
  "postal_code": "28013",
  "country": "España",
  "location": "40.4199,-3.7065"
}
Name Type Required Description
id string true Dealer Address entry id (unique identifier)
dealer_id string true Dealer id (unique identifier)
address string true Street address
city string true City
province string true Province
postal_code string true Postal code
country string true Country
location string false Geographic coordinates

DealerBrandResponse

1
2
3
4
5
{
  "brand": "yoigo",
  "dealer_id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a",
  "brand_code": "YG"
}
Name Type Required Description
brand string true Brand name
dealer_id string true The id of the dealer that has the brand and refers to
brand_code string true Brand codes enumeration
Property Values
brand_code one of [GU, PP, YG, LE, MM, LY, LL, VI, EB, AH, AL, BT, SW, JI, MB, ST, PM]

DealerCustomInformationPaginatedResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
{
  "offset": 0,
  "limit": 10,
  "total": 100,
  "sort": "id:asc",
  "items": [
    {
      "id": "7944a62c-98fc-40e6-a914-d49479eeb53f",
      "dealer_id": "123e4567-e89b-12d3-a456-426614174000",
      "field_id": "48f7917f-9d0f-43d3-95c8-f8038d4c954e",
      "field_name": "@Funnel",
      "field_value": "Yes"
    }
  ]
}
Name Type Required Description
offset integer(int32) false Offset used to paginate in conjunction with limit
limit integer(int32) false Max number of results of the response
total integer(int32) false Total number of records
sort string false The fields by which the results will be sorted. It can be a list of fields separated by commas
items [DealerCustomInformationResponse] true List of items

DealerStoreCapabilityResponse

1
2
3
4
5
6
7
8
{
  "id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a",
  "dealer_id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a",
  "store_delivery": true,
  "device_return": true,
  "sim_duplicate": true,
  "store_type": "BASIC"
}
Name Type Required Description
id string false The id of the store capability. It is generated automatically when creating a new record
dealer_id string true The id of the dealer that store capability refers to
store_delivery boolean true Indicates if the store has delivery capability, if it can delivery products
device_return boolean true Indicates if the store has device return capability, if it can receive devices returns
sim_duplicate boolean true Indicates if the store has sim duplicate capability, if it can manage sim duplicates
store_type string true Type of the store

TicketConfigResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a",
  "commercialName": "Test Commercial Name",
  "address": "Test Address",
  "city": "Test City",
  "province": "Test Province",
  "postalCode": "12345",
  "country": "Test Country",
  "documentType": "NIF",
  "documentNumber": "12345678A",
  "dealerId": 1234,
  "printType": "A4"
}
Name Type Required Description
id string true Id of the ticket config
commercialName string true Commercial name of the ticket config
address string true Address of the ticket config
city string true City of the ticket config
province string true Province of the ticket config
postalCode string true Postal code of the ticket config
country string true Country of the ticket config
documentType string true Document type of the ticket config
documentNumber string true Document number of the ticket config
dealerId integer(int32) true Dealer id related to the ticket config
printType string false Print type of the ticket config

DealerResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "id": 12344567,
  "code": "COD-123",
  "commercial_name": "Testing Test SL",
  "level_id": 2,
  "status_code": "ACTIVO",
  "subchannel_id": "1",
  "subchannel_name": "Atención al Cliente",
  "relation_type": "DIRECT",
  "parent_id": 54321,
  "parent_code": "COD-P123"
}
Name Type Required Description
id integer(int32) true Id of the dealer
code string true Code of the dealer
commercial_name string true CommercialName of the dealer
level_id integer(int32) true Level of the dealer
status_code string true Status of the dealer
subchannel_id string true Subchannel of the dealer
subchannel_name string false Subchannel name of dealer’s referenced subchannel_id
relation_type string false Enumeration of possible relations between actors and dealers
parent_id integer(int32) false Id of the parent dealer
parent_code string false Code of the parent dealer
Property Values
relation_type one of [DIRECT_AND_INDIRECT, DIRECT, INDIRECT]

DealersResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
{
  "offset": 0,
  "limit": 10,
  "total": 100,
  "sort": "id:asc",
  "items": [
    {
      "id": 12344567,
      "code": "COD-123",
      "commercial_name": "Testing Test SL",
      "level_id": 2,
      "status_code": "ACTIVO",
      "subchannel_id": "1",
      "subchannel_name": "Atención al Cliente",
      "relation_type": "DIRECT",
      "parent_id": 54321,
      "parent_code": "COD-P123"
    }
  ]
}
Name Type Required Description
offset integer(int32) false Offset used to paginate in conjunction with limit
limit integer(int32) false Max number of results of the response
total integer(int32) false Total number of records
sort string false The fields by which the results will be sorted. It can be a list of fields separated by commas
items [DealerResponse] true List of items

LoadsResponse

1
2
3
{
  "message": "string"
}
Name Type Required Description
message string false none

FixGeocodingDealer

1
2
3
{
  "dealer_id": 0
}
Name Type Required Description
dealer_id integer(int32) true The dealerId to identify a specific dealer

FixGeocodingResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "modified_dealers_ids": [
    {
      "dealer_id": 0
    }
  ],
  "not_modified_dealers_ids": [
    {
      "dealer_id": 0
    }
  ]
}
Name Type Required Description
modified_dealers_ids [FixGeocodingDealer] true The list of the dealers that were modified
not_modified_dealers_ids [FixGeocodingDealer] true The list of the dealers that were NOT modified

ActorUpdateRequest

1
2
3
4
5
6
7
{
  "name": "Test Name",
  "surname": "Surname Test",
  "type": "EMPLOYEE",
  "email": "test@masmovil.es",
  "parent_id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a"
}
Name Type Required Description
name string true Name of the actor
surname string true Surname of the actor msisdn
type string true Enumeration of possible actor types
email string(email) true Email of the actor
parent_id string¦null true parentId for the actor. null if none
Property Values
type one of [EMPLOYEE, EXTERNAL_MANAGER, HEAD, MANAGER, COORDINATOR, SUPERVISOR, TRAINER, INTERNAL_POS_MANAGER, EXTERNAL_POS_MANAGER, TERRITORIAL, NATIONAL]

CustomInformationUpdateRequest

1
2
3
4
{
  "name": "Funnel",
  "description": "Funnel Access"
}
Name Type Required Description
name string true Name of the custom information variable
description string true Description of the custom information variable

DealerUpdateRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "level": 4,
  "ine": "1234567890",
  "segment": "RETAIL",
  "status": "Activo",
  "commercial_name": "Test Commercial Name",
  "document_type": "NIF",
  "document_value": "12345678A",
  "parent_id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a",
  "commercial_structure_id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a"
}
Name Type Required Description
level integer(int32) true Level of the dealer
ine string¦null true Ine code of the dealer
segment string¦null true Segment of the dealer
status string true Enumeration of possible dealer statuses
commercial_name string true Commercial name of the dealer
document_type string¦null true Document type of the dealer
document_value string¦null true Document value of the dealer
parent_id string¦null true The parentId of the dealer
commercial_structure_id string true The commercialStructureId of the dealer
Property Values
segment one of [RESIDENTIAL, BUSINESS]
status one of [Bloqueado, Pendiente, Baja, Activo, Inactivo, ]
document_type one of [NIF, NIE]

DealerContactUpdateRequest

1
2
3
4
5
6
{
  "name": "John Doe",
  "email": "contactmail@example.es",
  "phone_number": "600123456",
  "purposes": "[Comercial, Facturación]"
}
Name Type Required Description
name string true Contact name
email string(email)¦null true Contact email
phone_number string¦null true Contact phoneNumber number
purposes [string]¦null true Contact purposes: [Gerencia, Comercial, Logística, Informes, Facturación, Incidencias, Público]

TicketConfigUpdateRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "commercialName": "Test Commercial Name",
  "address": "Test Address",
  "city": "Test City",
  "province": "Test Province",
  "postalCode": "12345",
  "country": "Test Country",
  "documentType": "NIF",
  "documentNumber": "12345678A",
  "printType": "A4"
}
Name Type Required Description
commercialName string true Commercial name of the ticket config
address string true Address of the ticket config
city string true City of the ticket config
province string true Province of the ticket config
postalCode string true Postal code of the ticket config
country string true Country of the ticket config
documentType string true Document type of the ticket config
documentNumber string true Document number of the ticket config
printType string true Print type of the ticket config

DealerAddressCreateUpdateRequest

1
2
3
4
5
6
7
{
  "address": "Calle Gran Vía 28",
  "city": "Madrid",
  "province": "Madrid",
  "country": "España",
  "postal_code": "28013"
}
Name Type Required Description
address string true Street address
city string true City
province string true Province
country string true Country
postal_code string true Postal code

DealerStoreCapabilityCreateUpdateRequest

1
2
3
4
5
6
{
  "store_delivery": true,
  "device_return": true,
  "sim_duplicate": true,
  "store_type": "BASIC"
}
Name Type Required Description
store_delivery boolean true Indicates if the store has delivery capability, if it can delivery products
device_return boolean true Indicates if the store has device return capability, if it can receive devices returns
sim_duplicate boolean true Indicates if the store has sim duplicate capability, if it can manage sim duplicates
store_type string¦null true Type of the store