V2
Schemas
ApiError
|
|
| 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
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| errors | [ApiError] | false | none |
DealerBrandInsertRequest
|
|
| 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
|
|
| 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 |
| 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
|
|
| 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 |
| 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
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| billing_dealer_id | integer(int32) | true | Id of the dealer that bill |
CommercialStructureRequest
|
|
| 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
|
|
| 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
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | true | Name of the custom information variable |
| description | string | true | Description of the custom information variable |
DealerResponseV2
|
|
| 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
|
|
| 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
|
|
| 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
|
|
| 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
|
|
| 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 |
| 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
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | true | Contact name |
| 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
|
|
| 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
|
|
| 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
|
|
| 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
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| actorTypes | [string] | false | List of actor types |
ActorsResponse
|
|
| 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
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| types | [string] | true | List of actor types |
BillingOfDealerResponse
|
|
| 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
|
|
| 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
|
|
| 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
|
|
| 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
|
|
| 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
|
|
| 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
|
|
| 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
|
|
| 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
|
|
| 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
|
|
| 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
|
|
| 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
|
|
| 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
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| message | string | false | none |
FixGeocodingDealer
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| dealer_id | integer(int32) | true | The dealerId to identify a specific dealer |
FixGeocodingResponse
|
|
| 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
|
|
| 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 |
| 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
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | true | Name of the custom information variable |
| description | string | true | Description of the custom information variable |
DealerUpdateRequest
|
|
| 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
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| name | string | true | Contact name |
| 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
|
|
| 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
|
|
| 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
|
|
| 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 |