V2
Dealers
Operations related to dealers
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| Authorization | header | string | true | Bearer token |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | List of dealer brands successfully obtained | [DealerBrandResponse] |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 404 | Not Found | Not Found | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
200 - instance of DealerBrandResponse
Custom schema example
|
|
| 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] |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| Authorization | header | string | true | Bearer token |
| body | body | DealerBrandInsertRequest | true | Information of the brand to be added |
Request body - instance of 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] |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Brand successfully added to dealer | None |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 404 | Not Found | Not Found | ApiErrorResponse |
| 409 | Conflict | Conflict | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| Authorization | header | string | true | Bearer token |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successfully return the billing information for the dealer | BillingOfDealerResponse |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 409 | Conflict | Conflict | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
| 503 | Service Unavailable | Service Unavailable | ApiErrorResponse |
| 504 | Gateway Time-out | Gateway Timeout | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| Authorization | header | string | true | Bearer token |
| body | body | DealerBillingRequest | true | Body with the dealer billing information |
Request body - instance of DealerBillingRequest
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| billing_dealer_id | integer(int32) | true | Id of the dealer that bill |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Successfully create the billing information for the dealer | None |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 404 | Not Found | BadRequest | ApiErrorResponse |
| 409 | Conflict | Conflict | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
| 503 | Service Unavailable | Service Unavailable | ApiErrorResponse |
| 504 | Gateway Time-out | Gateway Timeout | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| Authorization | header | string | true | Bearer token |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Successfully delete the billing information for the dealer | None |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 409 | Conflict | Conflict | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
| 503 | Service Unavailable | Service Unavailable | ApiErrorResponse |
| 504 | Gateway Time-out | Gateway Timeout | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Authorization | header | string | true | Bearer token |
| code | query | string | false | Dealer code |
| system | query | string | false | Accounting system code |
| username | query | string | false | Accounting system username |
| limit | query | integer(int64) | false | Limit of results in the response |
| offset | query | integer(int64) | false | Offset applied to results for pagination |
| sort | query | string | false | The fields by which the results will be sorted. It can be a list of fields separated by commas. A suffix must be added: * “:asc” to indicate an ascending order. * “:desc” to indicate a descending order. |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successfully return the dealer(s) | Inline |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 404 | Not Found | BadRequest | ApiErrorResponse |
| 409 | Conflict | Conflict | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
| 503 | Service Unavailable | Service Unavailable | ApiErrorResponse |
| 504 | Gateway Time-out | Gateway Timeout | ApiErrorResponse |
200 - JsonObject
Custom schema example
|
|
None
400 - instance of ApiErrorResponse
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| errors | [ApiError] | false | none |
401 - instance of ApiErrorResponse
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| errors | [ApiError] | false | none |
404 - instance of ApiErrorResponse
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| errors | [ApiError] | false | none |
409 - instance of ApiErrorResponse
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| errors | [ApiError] | false | none |
500 - instance of ApiErrorResponse
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| errors | [ApiError] | false | none |
503 - instance of ApiErrorResponse
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| errors | [ApiError] | false | none |
504 - instance of ApiErrorResponse
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| errors | [ApiError] | false | none |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Authorization | header | string | true | Bearer token |
| body | body | DealerInsertRequest | true | Body with the dealer information |
Request body - instance of 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 [RESIDENCIAL, NEGOCIOS, NONE] |
| status | one of [Bloqueado, Pendiente, Baja, Activo, Inactivo, ] |
| document_type | one of [NIF, NIE, NONE] |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Successfully create a dealer | DealerResponseV2 |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 404 | Not Found | BadRequest | ApiErrorResponse |
| 409 | Conflict | Conflict | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
| 503 | Service Unavailable | Service Unavailable | ApiErrorResponse |
| 504 | Gateway Time-out | Gateway Timeout | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Authorization | header | string | true | Bearer token |
| id | path | string | true | Dealer ID |
| body | body | DealerAccountingSystemInsertRequest | true | Body with the dealer accounting system information |
Request body - instance of 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] |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Successfully create a dealer accounting system | DealerAccountingSystemResponse |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 404 | Not Found | BadRequest | ApiErrorResponse |
| 500 | Internal Server Error | Internal Server Error | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id_actor | path | string | true | Actor id |
| id_dealer | path | string | true | Dealer id |
| Authorization | header | string | true | Bearer token |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Successfully created the dealer-actor relationship | None |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 404 | Not Found | BadRequest | ApiErrorResponse |
| 409 | Conflict | Conflict | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
| 503 | Service Unavailable | Service Unavailable | ApiErrorResponse |
| 504 | Gateway Time-out | Gateway Timeout | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id_dealer | path | string | true | Dealer id |
| id_actor | path | string | true | Actor id |
| Authorization | header | string | true | Bearer token |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Successfully delete the relationship with an actor for the dealer | None |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 409 | Conflict | Conflict | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
| 503 | Service Unavailable | Service Unavailable | ApiErrorResponse |
| 504 | Gateway Time-out | Gateway Timeout | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| Authorization | header | string | true | Bearer token |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | List of contacts successfully obtained | [DealerContactResponse] |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 404 | Not Found | Not Found | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
200 - instance of DealerContactResponse
Custom schema example
|
|
| 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] |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| Authorization | header | string | true | Bearer token |
| body | body | DealerContactInsertRequest | true | Information of the contact to be created |
Request body - instance of 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] |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Contact successfully created | DealerContactResponse |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 404 | Not Found | Not Found | ApiErrorResponse |
| 409 | Conflict | Conflict | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| Authorization | header | string | true | Bearer token |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | List of custom information variable assignations successfully obtained | DealerCustomInformationPaginatedResponse |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 404 | Not Found | Not Found | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| Authorization | header | string | true | Bearer token |
| body | body | DealerCustomInformationInsertionRequest | true | Custom information variable value assigned to the dealer |
Request body - instance of 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 |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Custom information assignation successfully created | DealerCustomInformationResponse |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 404 | Not Found | Not Found | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| Authorization | header | string | true | Bearer token |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Return successfully the ticket config information | TicketConfigResponse |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 409 | Conflict | Conflict | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
| 503 | Service Unavailable | Service Unavailable | ApiErrorResponse |
| 504 | Gateway Time-out | Gateway Timeout | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| Authorization | header | string | true | Bearer token |
| body | body | TicketConfigUpdateRequest | true | Body with the dealer ticket config information |
Request body - instance of 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 |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Successfully update the dealer’s ticket config | None |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 409 | Conflict | Conflict | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
| 503 | Service Unavailable | Service Unavailable | ApiErrorResponse |
| 504 | Gateway Time-out | Gateway Timeout | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| Authorization | header | string | true | Bearer token |
| body | body | TicketConfigInsertRequest | true | Body with the dealer ticket config information |
Request body - instance of 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 |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Successfully create the ticket config for the dealer | None |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 409 | Conflict | Conflict | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
| 503 | Service Unavailable | Service Unavailable | ApiErrorResponse |
| 504 | Gateway Time-out | Gateway Timeout | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| Authorization | header | string | true | Bearer token |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Successfully delete the dealer’s ticket config | None |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 409 | Conflict | Conflict | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
| 503 | Service Unavailable | Service Unavailable | ApiErrorResponse |
| 504 | Gateway Time-out | Gateway Timeout | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| accounting_system_id | path | string | true | Dealer accounting system ID |
| Authorization | header | string | true | Bearer token |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successfully retrieved dealer accounting system | DealerAccountingSystemResponse |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 404 | Not Found | Not Found | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| accounting_system_id | path | string | true | Dealer accounting system ID |
| Authorization | header | string | true | Bearer token |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Accounting system successfully deleted | None |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 404 | Not Found | Not Found | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| Authorization | header | string | true | Bearer token |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successfully returned the dealer’s address | DealerAddressResponse |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 404 | Not Found | Not Found | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| Authorization | header | string | true | Bearer token |
| body | body | DealerAddressCreateUpdateRequest | true | Información de la dirección del dealer |
Request body - instance of 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 |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Address correctly created or updated | DealerAddressResponse |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 404 | Not Found | Not Found | ApiErrorResponse |
| 409 | Conflict | Conflict | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| Authorization | header | string | true | Bearer token |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Successfully deleted the dealer’s address | None |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 404 | Not Found | Not Found | ApiErrorResponse |
| 409 | Conflict | Conflict | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| brand_name | path | string | true | Brand name |
| Authorization | header | string | true | Bearer token |
Enumerated Values
| Property | Values |
|---|---|
| brand_name | one of [GU, PP, YG, LE, MM, LY, LL, VI, EB, AH, AL, BT, SW, JI, MB, ST, PM] |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Brand successfully deleted from dealer | None |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 404 | Not Found | Not Found | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| contact_id | path | string | true | Contact ID |
| Authorization | header | string | true | Bearer token |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Contact successfully obtained | DealerContactResponse |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 404 | Not Found | Not Found | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| contact_id | path | string | true | Contact ID |
| Authorization | header | string | true | Bearer token |
| body | body | DealerContactUpdateRequest | true | Information of the contact to update |
Request body - instance of 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] |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Contact successfully updated | None |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 404 | Not Found | Not Found | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| contact_id | path | string | true | Contact ID |
| Authorization | header | string | true | Bearer token |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Contact successfully deleted | None |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 404 | Not Found | Not Found | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| custom_information_id | path | string | true | Identifier of the custom information variable |
| Authorization | header | string | true | Bearer token |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Dealer Custom Information variable value successfully obtained | DealerCustomInformationResponse |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 404 | Not Found | Not Found | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| custom_information_id | path | string | true | Identifier of the custom information variable |
| Authorization | header | string | true | Bearer token |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Dealer Custom Information variable value successfully updated | None |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 404 | Not Found | Not Found | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| custom_information_id | path | string | true | Identifier of the custom information variable |
| Authorization | header | string | true | Bearer token |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Dealer Custom Information variable value successfully obtained | DealerCustomInformationResponse |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 404 | Not Found | Not Found | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| Authorization | header | string | true | Bearer token |
| body | body | DealerStoreCapabilityCreateUpdateRequest | true | Dealer’s store capability data to set |
Request body - instance of 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 |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Store capability data successfully set (upserted) | DealerStoreCapabilityResponse |
| 400 | Bad Request | Invalid request | ApiErrorResponse |
| 500 | Internal Server Error | Internal server error | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| Authorization | header | string | true | Bearer token |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successfully retrieved dealer’s all accounting systems | [DealerAccountingSystemResponse] |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 404 | Not Found | Not Found | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
200 - instance of DealerAccountingSystemResponse
Custom schema example
|
|
| 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] |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| Authorization | header | string | true | Bearer token |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Return successfully the dealer information | DealerResponseV2 |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 409 | Conflict | Conflict | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
| 503 | Service Unavailable | Service Unavailable | ApiErrorResponse |
| 504 | Gateway Time-out | Gateway Timeout | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| Authorization | header | string | true | Bearer token |
| body | body | DealerUpdateRequest | true | Body with the dealer information |
Request body - instance of 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 [RESIDENCIAL, NEGOCIOS, NONE] |
| status | one of [Bloqueado, Pendiente, Baja, Activo, Inactivo, ] |
| document_type | one of [NIF, NIE, NONE] |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 204 | No Content | Successfully updated the dealer | None |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 409 | Conflict | Conflict | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
| 503 | Service Unavailable | Service Unavailable | ApiErrorResponse |
| 504 | Gateway Time-out | Gateway Timeout | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| id | path | string | true | Dealer id |
| Authorization | header | string | true | Bearer token |
| limit | query | integer(int64) | false | Limit of results in the response |
| offset | query | integer(int64) | false | Offset applied to results for pagination |
| sort | query | string | false | The fields by which the results will be sorted. It can be a list of fields separated by commas. A suffix must be added: * “:asc” to indicate an ascending order. * “:desc” to indicate a descending order. |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | Successfully return the list of the dealers that have a relation with the queried billing dealer | DealersResponse |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 409 | Conflict | Conflict | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
| 503 | Service Unavailable | Service Unavailable | ApiErrorResponse |
| 504 | Gateway Time-out | Gateway Timeout | ApiErrorResponse |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| Authorization | header | string | true | Bearer token |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 201 | Created | Successfully processed the fix geocoding request | FixGeocodingResponse |
| 400 | Bad Request | Bad Request | ApiErrorResponse |
| 401 | Unauthorized | Unauthorized | ApiErrorResponse |
| 409 | Conflict | Conflict | ApiErrorResponse |
| 500 | Internal Server Error | Internal Error | ApiErrorResponse |
| 503 | Service Unavailable | Service Unavailable | ApiErrorResponse |
| 504 | Gateway Time-out | Gateway Timeout | ApiErrorResponse |
Endpoints
Default
Loads
Actors
Dealers
Custom Information
Commercial Structure
Brands