Imported data
| Resource | Description |
|---|---|
| Loads | Operations related to loads xlxs files |
| Actors | Operations related to actors |
| Dealers | Operations related to dealers |
| Custom Information | Operations related to custom information |
| Commercial Structure | Operations related to commercial structure |
| Accoutning systems | |
| Brands | |
| Stores |
| Resource | Description |
|---|---|
| Loads | Operations related to loads xlxs files |
| Actors | Operations related to actors |
| Dealers | Operations related to dealers |
| Custom Information | Operations related to custom information |
| Commercial Structure | Operations related to commercial structure |
| Accoutning systems | |
| Brands | |
| Stores |
Bulk loads endpoint for dealers creation
QUERY PARAMETERS
Flag to ignore errors
HEADER PARAMETERS
Bearer token
Body with the XLXS file to process
{}| Property | Type | Description | Constraints | Default |
|---|
OK Successfully returned the order info
{
"message": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
message | string |
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service Unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Gateway Timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://dealers.masstack.com/v2/loads' \
-H 'Authorization: string' \
-H 'Content-Type: application/octet-stream' \
-H 'Accept: application/json' \
--data-raw '{}'Get actor by query params
QUERY PARAMETERS
Actor code
Actor email
Full name or partials of it of the actors to search
Actor type
Actor parent id
Limit of results in the response
Offset applied to results for pagination
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.
HEADER PARAMETERS
Bearer token
Return successfully the actor information
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
offset | integer (int32) | Offset used to paginate in conjunction with limit | ||||||||||||||||||||||||||||||||||||||||||||||||||||
limit | integer (int32) | Max number of results of the response | ||||||||||||||||||||||||||||||||||||||||||||||||||||
total | integer (int32) | Total number of records | ||||||||||||||||||||||||||||||||||||||||||||||||||||
sort | string | The fields by which the results will be sorted. It can be a list of fields separated by commas | ||||||||||||||||||||||||||||||||||||||||||||||||||||
items* | object[] | List of items | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found BadRequest
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service Unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Gateway Timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/actors?code=123456&email=vvvv.ssss%40masorange.com&full_name=JOHn%20Do&parent_id=ac95e92c-277a-4115-9257-49de7279fdc2&limit=20&offset=0&sort=name%3Aasc%2Cid%3Adesc' \
-H 'Authorization: string' \
-H 'Accept: application/json'Create new actor
HEADER PARAMETERS
Bearer token
Body with the actor information
{
"code": "GTRW12341A",
"name": "Test Name",
"surname": "Surname Test",
"type": "EMPLOYEE",
"email": "test@masmovil.es",
"parent_id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code* | string | Code of the actor | minLength: 1 | |
name* | string | Name of the actor | minLength: 1 | |
surname | string | Surname of the actor msisdn | ||
type* | string
()
EMPLOYEEEXTERNAL_MANAGERHEADMANAGERCOORDINATORSUPERVISORTRAINERINTERNAL_POS_MANAGEREXTERNAL_POS_MANAGERTERRITORIALNATIONALKAM | Enumeration of possible actor types | minLength: 1 | |
email* | string (email) | Email of the actor | minLength: 1 | |
parent_id | string | parentId if exist | minLength: 1 |
Created Successfully create the actor
{
"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"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string | Id of the actor | ||
code* | string | Code of the actor | ||
name | string | Name of the actor | ||
surname | string | Surname of the actor | ||
type* | string
()
EMPLOYEEEXTERNAL_MANAGERHEADMANAGERCOORDINATORSUPERVISORTRAINERINTERNAL_POS_MANAGEREXTERNAL_POS_MANAGERTERRITORIALNATIONALKAM | Enumeration of possible actor types | ||
email* | string | Email of the actor | ||
parent_id | string | parentId if exist | ||
parent_code | string | parentCode if exist | ||
relation_type | string
()
DIRECT_AND_INDIRECTDIRECTINDIRECT | Enumeration of possible relations between actors and dealers |
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found BadRequest
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service Unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Gateway Timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://dealers.masstack.com/v2/actors' \
-H 'Authorization: string' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"code": "GTRW12341A",
"name": "Test Name",
"surname": "Surname Test",
"type": "EMPLOYEE",
"email": "test@masmovil.es",
"parent_id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a"
}'Get actor by id
PATH PARAMETERS
Actor id
HEADER PARAMETERS
Bearer token
OK Return successfully the actor information
{
"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"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string | Id of the actor | ||
code* | string | Code of the actor | ||
name | string | Name of the actor | ||
surname | string | Surname of the actor | ||
type* | string
()
EMPLOYEEEXTERNAL_MANAGERHEADMANAGERCOORDINATORSUPERVISORTRAINERINTERNAL_POS_MANAGEREXTERNAL_POS_MANAGERTERRITORIALNATIONALKAM | Enumeration of possible actor types | ||
email* | string | Email of the actor | ||
parent_id | string | parentId if exist | ||
parent_code | string | parentCode if exist | ||
relation_type | string
()
DIRECT_AND_INDIRECTDIRECTINDIRECT | Enumeration of possible relations between actors and dealers |
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service Unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Gateway Timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/actors/d39cb65f-1aa8-44fe-a3d8-d310e321331a' \
-H 'Authorization: string' \
-H 'Accept: application/json'Update an actor
PATH PARAMETERS
Actor id
HEADER PARAMETERS
Bearer token
Body with the actor information
{
"name": "Test Name",
"surname": "Surname Test",
"type": "EMPLOYEE",
"email": "test@masmovil.es",
"parent_id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
name* | string | Name of the actor | minLength: 1 | |
surname* | string | Surname of the actor msisdn | minLength: 1 | |
type* | string
()
EMPLOYEEEXTERNAL_MANAGERHEADMANAGERCOORDINATORSUPERVISORTRAINERINTERNAL_POS_MANAGEREXTERNAL_POS_MANAGERTERRITORIALNATIONALKAM | Enumeration of possible actor types | minLength: 1 | |
email* | string (email) | Email of the actor | minLength: 1 | |
parent_id* | string | null | parentId for the actor. null if none |
No Content Successfully update the actor
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found BadRequest
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service Unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Gateway Timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PUT 'https://dealers.masstack.com/v2/actors/d39cb65f-1aa8-44fe-a3d8-d310e321331a' \
-H 'Authorization: string' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"name": "Test Name",
"surname": "Surname Test",
"type": "EMPLOYEE",
"email": "test@masmovil.es",
"parent_id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a"
}'Delete actor by id
PATH PARAMETERS
Actor id
HEADER PARAMETERS
Bearer token
No Content Successfully delete the actor
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service Unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Gateway Timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://dealers.masstack.com/v2/actors/ac95e92c-277a-4115-9257-49de7279fdc2' \
-H 'Authorization: string' \
-H 'Accept: application/json'Get a list with all the actor types that the dealer system has
HEADER PARAMETERS
Bearer token
OK Return successfully the actor types
{
"types": [
"EMPLOYEE"
]
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
types* | string[] | List of actor types |
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service Unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Gateway Timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/actors/types' \
-H 'Authorization: string' \
-H 'Accept: application/json'Get dealers that have a relationship with an actor
PATH PARAMETERS
Actor id
QUERY PARAMETERS
Limit of results in the response
Offset applied to results for pagination
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.
The type of relation between the actors and the dealers. It can be one of the following values: * "DIRECT" * "INDIRECT" * "DIRECT_AND_INDIRECT"
Código del dealer
Nombre comercial del dealer
ID del nivel del dealer (V1 only, requires X-API-Version: 1 header)
Dealer's level
Código de estado del dealer (V1 only, requires X-API-Version: 1 header)
Dealer's status
Nombre del subcanal del dealer (V1 only, requires X-API-Version: 1 header)
Dealer's commercial structure
ID del dealer padre
Código del dealer padre
HEADER PARAMETERS
Bearer token
Return successfully the dealer list information. Returns DealersResponse (V1) when X-API-Version: 1 header is present, otherwise returns DealersResponseV2 (V2)
{
"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_code": "1",
"subchannel_name": "Atención al Cliente",
"relation_type": "DIRECT",
"parent_id": 54321,
"parent_code": "COD-P123"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
offset | integer (int32) | Offset used to paginate in conjunction with limit | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
limit | integer (int32) | Max number of results of the response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total | integer (int32) | Total number of records | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sort | string | The fields by which the results will be sorted. It can be a list of fields separated by commas | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items* | object[] | List of items | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
offset | integer (int32) | Offset used to paginate in conjunction with limit | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
limit | integer (int32) | Max number of results of the response | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total | integer (int32) | Total number of records | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sort | string | The fields by which the results will be sorted. It can be a list of fields separated by commas | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items* | object[] | List of items | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found BadRequest
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service Unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Gateway Timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/actors/ac95e92c-277a-4115-9257-49de7279fdc2/dealers?limit=20&offset=0&sort=name%3Aasc%2Cid%3Adesc&code=123456&commercial_name=Comercial%20S.A.&level_id=3&level=3&status_code=ACTIVE&status=ACTIVE&subchannel_name=Online&commercial_structure=Online&parent_id=ac95e92c-277a-4115-9257-49de7279fdc2&parent_code=PARENT123' \
-H 'Authorization: string' \
-H 'Accept: application/json'Get all brands for a dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
HEADER PARAMETERS
Bearer token
OK List of dealer brands successfully obtained
[
{
"brand": "yoigo",
"dealer_id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a",
"brand_code": "YG"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
brand* | string | Brand name | minLength: 1 | |
dealer_id* | string | The id of the dealer that has the brand and refers to | ||
brand_code* | string
()
GUPPYGLEMMLYLLVIEBAHALBTSWJIMBSTPMEKRTTCRC | Brand codes enumeration | minLength: 1 |
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/dealers/:id/brands' \
-H 'Authorization: string' \
-H 'Accept: application/json'Add a brand to a dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
HEADER PARAMETERS
Bearer token
Information of the brand to be added
{
"brandCode": "YG"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
brandCode* | string
()
GUPPYGLEMMLYLLVIEBAHALBTSWJIMBSTPMEKRTTCRC | Brand codes enumeration | minLength: 1 |
Created Brand successfully added to dealer
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "NOT_FOUND",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://dealers.masstack.com/v2/dealers/:id/brands' \
-H 'Authorization: string' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"brandCode": "YG"
}'Get billing relationship for a dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
HEADER PARAMETERS
Bearer token
OK Successfully return the billing information for the dealer
{
"dealer_id": 12344567,
"billing_dealer": {
"id": "aaa-bbb-ccc-111-ddd",
"code": "COD-123",
"commercial_name": "Testing Test SL",
"identity_document": {
"type": "NIF",
"value": "12345678Z",
"issuing_country": "ES"
}
}
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
dealer_id* | integer (int32) | Id of the dealer | ||||||||||||||||||||||||||||||||||||||||||||||||||||
billing_dealer* | object | Information of the billing of a dealer | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
dealer_id* | string | Id of the dealer. Uuid for V2 and id for V1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||
billing_dealer* | object | Information of the billing of a dealer | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service Unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Gateway Timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/dealers/:id/billing' \
-H 'Authorization: string' \
-H 'Accept: application/json'Create new billing relationship for a dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
HEADER PARAMETERS
Bearer token
Body with the dealer billing information
{
"billing_dealer_id": "string"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
billing_dealer_id* | string | Id of the dealer that bill. UUID for V2 or id for V1 |
Created Successfully create the billing information for the dealer
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found BadRequest
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service Unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Gateway Timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://dealers.masstack.com/v2/dealers/:id/billing' \
-H 'Authorization: string' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"billing_dealer_id": "string"
}'Delete billing relationship for a dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
HEADER PARAMETERS
Bearer token
No Content Successfully delete the billing information for the dealer
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service Unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Gateway Timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://dealers.masstack.com/v2/dealers/:id/billing' \
-H 'Authorization: string' \
-H 'Accept: application/json'Get dealers by code or by system and username
QUERY PARAMETERS
Dealer code
Accounting system code
Accounting system username
Dealer's level
Dealer's status
Dealer's commercial structure
Dealer's parent id
Dealer's parent code
Dealer's commercial name
Limit of results in the response
Offset applied to results for pagination
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.
HEADER PARAMETERS
Bearer token
OK Successfully return the dealer(s)
{
"offset": 0,
"limit": 10,
"total": 100,
"sort": "id:asc",
"items": [
{
"id": "abcd-1234-xyz",
"code": "COD-123",
"commercial_name": "Testing Test SL",
"level": 2,
"identity_document": {
"type": "NIF",
"value": "12345678Z",
"issuing_country": "ES"
},
"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"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
offset | integer (int32) | Offset used to paginate in conjunction with limit | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
limit | integer (int32) | Max number of results of the response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total | integer (int32) | Total number of records | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sort | string | The fields by which the results will be sorted. It can be a list of fields separated by commas | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items* | object[] | List of items | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found BadRequest
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service Unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Gateway Timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/dealers?code=DealerCode001&system=IAM&username=user%40masorange.es&level=3&status=Activo&commercial_structure=AC&parent_id=111-222-333-uuid&parent_code=PARENT_CODE_001&commercial_name=Mas%20Orange%20Store&limit=20&offset=0&sort=name%3Aasc%2Cid%3Adesc' \
-H 'Authorization: string' \
-H 'Accept: application/json'Create a new dealer
HEADER PARAMETERS
Bearer token
Body with the dealer information
{
"code": "ATC12345",
"level": 4,
"ine": "1234567890",
"segment": "RETAIL",
"status": "Activo",
"commercial_name": "Test Commercial Name",
"identity_document": {
"type": "NIF",
"value": "12345678Z",
"issuing_country": "ES"
},
"parent_id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a",
"commercial_structure_id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
code* | string | Code of the dealer | minLength: 1, maxLength: 100, pattern: ^\S+$ | |||||||||||||||||||||
level* | integer (int32) | Level of the dealer | min: 1, max: 4 | |||||||||||||||||||||
ine* | string | null | Ine code of the dealer | minLength: 1, maxLength: 100 | |||||||||||||||||||||
segment* | string | null
()
RESIDENCIALNEGOCIOSNONE | Segment of the dealer | ||||||||||||||||||||||
status* | string
()
BloqueadoPendienteBajaActivoInactivo | Enumeration of possible dealer statuses | minLength: 1 | |||||||||||||||||||||
commercial_name* | string | Commercial name of the dealer | minLength: 1, maxLength: 100 | |||||||||||||||||||||
identity_document | object | Legal identification information | ||||||||||||||||||||||
| ||||||||||||||||||||||||
parent_id* | string | null | The parentId of the dealer | minLength: 1 | |||||||||||||||||||||
commercial_structure_id* | string | The commercialStructureId of the dealer | minLength: 1 | |||||||||||||||||||||
Created Successfully create a dealer
{
"id": "abcd-1234-xyz",
"code": "COD-123",
"commercial_name": "Testing Test SL",
"level": 2,
"identity_document": {
"type": "NIF",
"value": "12345678Z",
"issuing_country": "ES"
},
"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"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Id of the dealer | ||||||||||||||||||||||
code* | string | Code of the dealer | ||||||||||||||||||||||
commercial_name* | string | CommercialName of the dealer | ||||||||||||||||||||||
level* | integer (int32) | Level of the dealer | ||||||||||||||||||||||
identity_document | object | Legal identification information | ||||||||||||||||||||||
| ||||||||||||||||||||||||
ine | string | INE of the dealer | ||||||||||||||||||||||
segment | string
()
RESIDENCIALNEGOCIOSNONE | Segment of the dealer | ||||||||||||||||||||||
parent_id | string | Id of the dealer's parent | ||||||||||||||||||||||
parent_code | string | Code of the dealer's parent | ||||||||||||||||||||||
commercial_structure_id* | string | Commercial structure id of the dealer | ||||||||||||||||||||||
commercial_structure_code | string | Commercial structure code of the dealer | ||||||||||||||||||||||
status* | string
()
BloqueadoPendienteBajaActivoInactivo | Enumeration of possible dealer statuses | ||||||||||||||||||||||
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found BadRequest
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service Unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Gateway Timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://dealers.masstack.com/v2/dealers' \
-H 'Authorization: string' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"code": "ATC12345",
"level": 4,
"ine": "1234567890",
"segment": "RETAIL",
"status": "Activo",
"commercial_name": "Test Commercial Name",
"identity_document": {
"type": "NIF",
"value": "12345678Z",
"issuing_country": "ES"
},
"parent_id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a",
"commercial_structure_id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a"
}'Get all the accounting systems for the dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
HEADER PARAMETERS
Bearer token
OK Successfully retrieved dealer's all accounting systems
[
{
"id": "e7b8f8e6-9c3b-4d2a-8f1e-2c3d4e5f6a7b",
"system": "IAM",
"username": "medias_puri@masmovil.com"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string | Dealer accounting_system entry id (unique identifier) | ||
system* | string
()
MYSIMQVANTELLUCERAHEOSIAMLEBARALYCAMOBILEVIRGINHEROEMBOUSCHAMANPORTAL DE COMPRASDIGO | Accounting system name | ||
username* | string | Username |
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/dealers/:id/accounting-systems' \
-H 'Authorization: string' \
-H 'Accept: application/json'Create a new accounting system for the dealer
PATH PARAMETERS
Dealer ID
HEADER PARAMETERS
Bearer token
Body with the dealer accounting system information
{
"username": "medias_puri@masmovil.com",
"system": "IAM"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
username* | string | Username | minLength: 1, maxLength: 100 | |
system* | string
()
MYSIMQVANTELLUCERAHEOSIAMLEBARALYCAMOBILEVIRGINHEROEMBOUSCHAMANPORTAL DE COMPRASDIGO | Accounting system identifier |
Created Successfully create a dealer accounting system
{
"id": "e7b8f8e6-9c3b-4d2a-8f1e-2c3d4e5f6a7b",
"system": "IAM",
"username": "medias_puri@masmovil.com"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string | Dealer accounting_system entry id (unique identifier) | ||
system* | string
()
MYSIMQVANTELLUCERAHEOSIAMLEBARALYCAMOBILEVIRGINHEROEMBOUSCHAMANPORTAL DE COMPRASDIGO | Accounting system name | ||
username* | string | Username |
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found BadRequest
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Server Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://dealers.masstack.com/v2/dealers/d39cb65f-1aa8-44fe-a3d8-d310e321331a/accounting-systems' \
-H 'Authorization: string' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"username": "medias_puri@masmovil.com",
"system": "IAM"
}'Create a new relationship between a dealer and an actor
PATH PARAMETERS
Actor id
Dealer id (can be numeric legacy ID or UUID)
HEADER PARAMETERS
Bearer token
Created Successfully created the dealer-actor relationship
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found BadRequest
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service Unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Gateway Timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://dealers.masstack.com/v2/dealers/:id_dealer/actors/d39cb65f-1aa8-44fe-a3d8-d310e321331a' \
-H 'Authorization: string' \
-H 'Accept: application/json'Delete actor relationship for a dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
Actor id
HEADER PARAMETERS
Bearer token
No Content Successfully delete the relationship with an actor for the dealer
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service Unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Gateway Timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://dealers.masstack.com/v2/dealers/:id_dealer/actors/d39cb65f-1aa8-44fe-a3d8-d310e321331a' \
-H 'Authorization: string' \
-H 'Accept: application/json'Get all contacts for a dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
HEADER PARAMETERS
Bearer token
OK List of contacts successfully obtained
[
{
"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]"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string | Unique contact ID (UUID) | ||
dealer_id* | string | Dealer ID to which the contact belongs | ||
name* | string | null | Contact name | ||
email* | string | null | Contact email | ||
phone_number* | string | null | Contact phoneNumber number | ||
purposes* | string | null[] | Contact purposes: [Gerencia, Comercial, Logística, Informes, Facturación, Incidencias, Público] |
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/dealers/:id/contacts' \
-H 'Authorization: string' \
-H 'Accept: application/json'Create a new contact for a dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
HEADER PARAMETERS
Bearer token
Information of the contact to be created
{
"name": "John Doe",
"email": "contactmail@example.es",
"phone_number": "600123456",
"purposes": "[Comercial, Facturación]"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
name* | string | Contact name | minLength: 1, maxLength: 100 | |
email* | string (email) | null | Contact email | minLength: 1, maxLength: 100, pattern: ^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*+@(?:[a-zA-Z0-9-]+\.)++[a-zA-Z]{2,}$ | |
phone_number* | string | null | Contact phoneNumber number | minLength: 1, maxLength: 100, pattern: ^(\+\d{1,3})?\d{9}$ | |
purposes* | string | null[] | Contact purposes: [Gerencia, Comercial, Logística, Informes, Facturación, Incidencias, Público] |
Created Contact successfully created
{
"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]"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string | Unique contact ID (UUID) | ||
dealer_id* | string | Dealer ID to which the contact belongs | ||
name* | string | null | Contact name | ||
email* | string | null | Contact email | ||
phone_number* | string | null | Contact phoneNumber number | ||
purposes* | string | null[] | Contact purposes: [Gerencia, Comercial, Logística, Informes, Facturación, Incidencias, Público] |
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "NOT_FOUND",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://dealers.masstack.com/v2/dealers/:id/contacts' \
-H 'Authorization: string' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"name": "John Doe",
"email": "contactmail@example.es",
"phone_number": "600123456",
"purposes": "[Comercial, Facturación]"
}'Retrieve all custom information variables assignations and values for the specified dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
HEADER PARAMETERS
Bearer token
OK List of custom information variable assignations successfully obtained
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
offset | integer (int32) | Offset used to paginate in conjunction with limit | ||||||||||||||||||||||||||||||||
limit | integer (int32) | Max number of results of the response | ||||||||||||||||||||||||||||||||
total | integer (int32) | Total number of records | ||||||||||||||||||||||||||||||||
sort | string | The fields by which the results will be sorted. It can be a list of fields separated by commas | ||||||||||||||||||||||||||||||||
items* | object[] | List of items | ||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/dealers/:id/custom-information' \
-H 'Authorization: string' \
-H 'Accept: application/json'Assign a custom information variable value to the dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
HEADER PARAMETERS
Bearer token
Custom information variable value assigned to the dealer
{
"field_id": "48f7917f-9d0f-43d3-95c8-f8038d4c954e",
"field_value": "Yes"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
field_id* | string | Id of the custom information variable definition | ||
field_value* | string | Value of the custom information variable | minLength: 1, maxLength: 100 |
Created Custom information assignation successfully created
{
"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"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string | Identifier of the dealer <-> custom information variable assignation relationship | ||
dealer_id* | string | Identifier of the dealer to whom the custom information variable value is assigned | ||
field_id* | string | Id of the custom information variable definition | ||
field_name* | string | Id of the custom information variable definition | ||
field_value* | string | Value for the custom information variable assigned to dealer |
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://dealers.masstack.com/v2/dealers/:id/custom-information' \
-H 'Authorization: string' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"field_id": "48f7917f-9d0f-43d3-95c8-f8038d4c954e",
"field_value": "Yes"
}'Get ticket config for a dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
HEADER PARAMETERS
Bearer token
OK Return successfully the ticket config information
{
"id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a",
"commercialName": "Test Commercial Name",
"address": "Test Address",
"city": "Test City",
"province": "Test Province",
"postalCode": "12345",
"country": "Test Country",
"dealerId": "aaa-bbb-ccc-111-ddd",
"printType": "A4",
"identity_document": {
"type": "NIF",
"value": "12345678Z",
"issuing_country": "ES"
}
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Id of the ticket config | ||||||||||||||||||||||
commercialName* | string | Commercial name of the ticket config | ||||||||||||||||||||||
address* | string | Address of the ticket config | ||||||||||||||||||||||
city* | string | City of the ticket config | ||||||||||||||||||||||
province* | string | Province of the ticket config | ||||||||||||||||||||||
postalCode* | string | Postal code of the ticket config | ||||||||||||||||||||||
country* | string | Country of the ticket config | ||||||||||||||||||||||
dealerId* | string | Dealer uuid related to the ticket config | ||||||||||||||||||||||
printType | string | Print type of the ticket config | ||||||||||||||||||||||
identity_document | object | Legal identification information | ||||||||||||||||||||||
| ||||||||||||||||||||||||
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service Unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Gateway Timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/dealers/:id/ticket-config' \
-H 'Authorization: string' \
-H 'Accept: application/json'Create ticket config for a dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
HEADER PARAMETERS
Bearer token
Body with the dealer ticket config information
{
"commercialName": "Test Commercial Name",
"address": "Test Address",
"city": "Test City",
"province": "Test Province",
"postalCode": "12345",
"country": "Test Country",
"printType": "A4",
"identity_document": {
"type": "NIF",
"value": "12345678Z",
"issuing_country": "ES"
}
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
commercialName | string | Commercial name of the ticket config | ||||||||||||||||||||||
address | string | Address of the ticket config | ||||||||||||||||||||||
city | string | City of the ticket config | ||||||||||||||||||||||
province | string | Province of the ticket config | ||||||||||||||||||||||
postalCode | string | Postal code of the ticket config | ||||||||||||||||||||||
country | string | Country of the ticket config | ||||||||||||||||||||||
printType | string | Print type of the ticket config | ||||||||||||||||||||||
identity_document | object | Legal identification information | ||||||||||||||||||||||
| ||||||||||||||||||||||||
Created Successfully create the ticket config for the dealer
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service Unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Gateway Timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://dealers.masstack.com/v2/dealers/:id/ticket-config' \
-H 'Authorization: string' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"commercialName": "Test Commercial Name",
"address": "Test Address",
"city": "Test City",
"province": "Test Province",
"postalCode": "12345",
"country": "Test Country",
"printType": "A4",
"identity_document": {
"type": "NIF",
"value": "12345678Z",
"issuing_country": "ES"
}
}'Update ticket config for a dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
HEADER PARAMETERS
Bearer token
Body with the dealer ticket config information
{
"commercialName": "Test Commercial Name",
"address": "Test Address",
"city": "Test City",
"province": "Test Province",
"postalCode": "12345",
"country": "Test Country",
"printType": "A4",
"identity_document": {
"type": "NIF",
"value": "12345678Z",
"issuing_country": "ES"
}
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
commercialName* | string | Commercial name of the ticket config | ||||||||||||||||||||||
address* | string | Address of the ticket config | ||||||||||||||||||||||
city* | string | City of the ticket config | ||||||||||||||||||||||
province* | string | Province of the ticket config | ||||||||||||||||||||||
postalCode* | string | Postal code of the ticket config | ||||||||||||||||||||||
country* | string | Country of the ticket config | ||||||||||||||||||||||
printType* | string | Print type of the ticket config | ||||||||||||||||||||||
identity_document | object | Legal identification information | ||||||||||||||||||||||
| ||||||||||||||||||||||||
No Content Successfully update the dealer's ticket config
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service Unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Gateway Timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PUT 'https://dealers.masstack.com/v2/dealers/:id/ticket-config' \
-H 'Authorization: string' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"commercialName": "Test Commercial Name",
"address": "Test Address",
"city": "Test City",
"province": "Test Province",
"postalCode": "12345",
"country": "Test Country",
"printType": "A4",
"identity_document": {
"type": "NIF",
"value": "12345678Z",
"issuing_country": "ES"
}
}'Delete ticket config for a dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
HEADER PARAMETERS
Bearer token
No Content Successfully delete the dealer's ticket config
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service Unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Gateway Timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://dealers.masstack.com/v2/dealers/:id/ticket-config' \
-H 'Authorization: string' \
-H 'Accept: application/json'Get the accounting system for the dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
Dealer accounting system ID
HEADER PARAMETERS
Bearer token
OK Successfully retrieved dealer accounting system
{
"id": "e7b8f8e6-9c3b-4d2a-8f1e-2c3d4e5f6a7b",
"system": "IAM",
"username": "medias_puri@masmovil.com"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string | Dealer accounting_system entry id (unique identifier) | ||
system* | string
()
MYSIMQVANTELLUCERAHEOSIAMLEBARALYCAMOBILEVIRGINHEROEMBOUSCHAMANPORTAL DE COMPRASDIGO | Accounting system name | ||
username* | string | Username |
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/dealers/:id/accounting-systems/6ad1bea4-2b9d-4b4f-9755-c9e9ce908987' \
-H 'Authorization: string' \
-H 'Accept: application/json'Update an accounting system for the dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
Dealer accounting system ID
HEADER PARAMETERS
Bearer token
Body with the dealer accounting system information
{
"system": "IAM",
"username": "medias_puri@masmovil.com"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
system* | string
()
MYSIMQVANTELLUCERAHEOSIAMLEBARALYCAMOBILEVIRGINHEROEMBOUSCHAMANPORTAL DE COMPRASDIGO | Accounting system identifier | ||
username* | string | Username | minLength: 1, maxLength: 100 |
No Content Accounting system successfully updated
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PUT 'https://dealers.masstack.com/v2/dealers/:id/accounting-systems/6ad1bea4-2b9d-4b4f-9755-c9e9ce908987' \
-H 'Authorization: string' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"system": "IAM",
"username": "medias_puri@masmovil.com"
}'Delete a specific accounting system account of a dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
Dealer accounting system ID
HEADER PARAMETERS
Bearer token
No Content Accounting system successfully deleted
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://dealers.masstack.com/v2/dealers/:id/accounting-systems/6ad1bea4-2b9d-4b4f-9755-c9e9ce908987' \
-H 'Authorization: string' \
-H 'Accept: application/json'Get address for a specific dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
HEADER PARAMETERS
Bearer token
OK Successfully returned the dealer's address
{
"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"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string | Dealer Address entry id (unique identifier) | ||
dealer_id* | string | Dealer id (unique identifier) | ||
address* | string | Street address | ||
city* | string | City | ||
province* | string | Province | ||
postal_code* | string | Postal code | ||
country* | string | Country | ||
location | string | Geographic coordinates |
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "NOT_FOUND"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/dealers/:id/address' \
-H 'Authorization: string' \
-H 'Accept: application/json'Upsert address for a specific dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
HEADER PARAMETERS
Bearer token
Información de la dirección del dealer
{
"address": "Calle Gran Vía 28",
"city": "Madrid",
"province": "Madrid",
"country": "España",
"postal_code": "28013"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
address* | string | Street address | minLength: 1, maxLength: 100 | |
city* | string | City | minLength: 1, maxLength: 100 | |
province* | string | Province | minLength: 1, maxLength: 100 | |
country* | string | Country | minLength: 1, maxLength: 100 | |
postal_code* | string | Postal code | minLength: 1, maxLength: 10 |
OK Address correctly created or updated
{
"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"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string | Dealer Address entry id (unique identifier) | ||
dealer_id* | string | Dealer id (unique identifier) | ||
address* | string | Street address | ||
city* | string | City | ||
province* | string | Province | ||
postal_code* | string | Postal code | ||
country* | string | Country | ||
location | string | Geographic coordinates |
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "NOT_FOUND"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PUT 'https://dealers.masstack.com/v2/dealers/:id/address' \
-H 'Authorization: string' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"address": "Calle Gran Vía 28",
"city": "Madrid",
"province": "Madrid",
"country": "España",
"postal_code": "28013"
}'Delete the address of a specific dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
HEADER PARAMETERS
Bearer token
No Content Successfully deleted the dealer's address
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "NOT_FOUND"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://dealers.masstack.com/v2/dealers/:id/address' \
-H 'Authorization: string' \
-H 'Accept: application/json'Delete a brand from a dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
Brand name
HEADER PARAMETERS
Bearer token
No Content Brand successfully deleted from dealer
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://dealers.masstack.com/v2/dealers/:id/brands/YG' \
-H 'Authorization: string' \
-H 'Accept: application/json'Get a specific contact for a dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
Contact ID
HEADER PARAMETERS
Bearer token
OK Contact successfully obtained
{
"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]"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string | Unique contact ID (UUID) | ||
dealer_id* | string | Dealer ID to which the contact belongs | ||
name* | string | null | Contact name | ||
email* | string | null | Contact email | ||
phone_number* | string | null | Contact phoneNumber number | ||
purposes* | string | null[] | Contact purposes: [Gerencia, Comercial, Logística, Informes, Facturación, Incidencias, Público] |
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/dealers/:id/contacts/6ad1bea4-2b9d-4b4f-9755-c9e9ce908987' \
-H 'Authorization: string' \
-H 'Accept: application/json'Update a specific contact for a dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
Contact ID
HEADER PARAMETERS
Bearer token
Information of the contact to update
{
"name": "John Doe",
"email": "contactmail@example.es",
"phone_number": "600123456",
"purposes": "[Comercial, Facturación]"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
name* | string | Contact name | minLength: 1, maxLength: 100 | |
email* | string (email) | null | Contact email | minLength: 1, maxLength: 100, pattern: ^[a-zA-Z0-9_+&*-]+(?:\.[a-zA-Z0-9_+&*-]+)*+@(?:[a-zA-Z0-9-]+\.)++[a-zA-Z]{2,}$ | |
phone_number* | string | null | Contact phoneNumber number | minLength: 1, maxLength: 100, pattern: ^(\+\d{1,3})?\d{9}$ | |
purposes* | string | null[] | Contact purposes: [Gerencia, Comercial, Logística, Informes, Facturación, Incidencias, Público] |
No Content Contact successfully updated
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PUT 'https://dealers.masstack.com/v2/dealers/:id/contacts/6ad1bea4-2b9d-4b4f-9755-c9e9ce908987' \
-H 'Authorization: string' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"name": "John Doe",
"email": "contactmail@example.es",
"phone_number": "600123456",
"purposes": "[Comercial, Facturación]"
}'Delete a specific contact for a dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
Contact ID
HEADER PARAMETERS
Bearer token
No Content Contact successfully deleted
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://dealers.masstack.com/v2/dealers/:id/contacts/6ad1bea4-2b9d-4b4f-9755-c9e9ce908987' \
-H 'Authorization: string' \
-H 'Accept: application/json'Gets the value of a custom information variable assignation of an specified dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
Identifier of the custom information variable
HEADER PARAMETERS
Bearer token
OK Dealer Custom Information variable value successfully obtained
{
"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"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string | Identifier of the dealer <-> custom information variable assignation relationship | ||
dealer_id* | string | Identifier of the dealer to whom the custom information variable value is assigned | ||
field_id* | string | Id of the custom information variable definition | ||
field_name* | string | Id of the custom information variable definition | ||
field_value* | string | Value for the custom information variable assigned to dealer |
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/dealers/:id/custom-information/ec08f90d-8deb-4f6e-931b-0d8f47ca3e2a' \
-H 'Authorization: string' \
-H 'Accept: application/json'Updates the value of a custom information variable assignation for an specified dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
Identifier of the custom information variable
HEADER PARAMETERS
Bearer token
No Content Dealer Custom Information variable value successfully updated
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PUT 'https://dealers.masstack.com/v2/dealers/:id/custom-information/ec08f90d-8deb-4f6e-931b-0d8f47ca3e2a' \
-H 'Authorization: string' \
-H 'Accept: application/json'Deletes the custom information variable assignation of an specified dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
Identifier of the custom information variable
HEADER PARAMETERS
Bearer token
OK Dealer Custom Information variable value successfully obtained
{
"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"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string | Identifier of the dealer <-> custom information variable assignation relationship | ||
dealer_id* | string | Identifier of the dealer to whom the custom information variable value is assigned | ||
field_id* | string | Id of the custom information variable definition | ||
field_name* | string | Id of the custom information variable definition | ||
field_value* | string | Value for the custom information variable assigned to dealer |
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://dealers.masstack.com/v2/dealers/:id/custom-information/ec08f90d-8deb-4f6e-931b-0d8f47ca3e2a' \
-H 'Authorization: string' \
-H 'Accept: application/json'Get store capability for a specific dealer
PATH PARAMETERS
Dealer ID
HEADER PARAMETERS
Bearer token
OK Successfully retrieved dealer store capability
{
"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"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string | The id of the store capability. It is generated automatically when creating a new record | ||
dealer_id* | string | The id of the dealer that store capability refers to | ||
store_delivery* | boolean | Indicates if the store has delivery capability, if it can delivery products | ||
device_return* | boolean | Indicates if the store has device return capability, if it can receive devices returns | ||
sim_duplicate* | boolean | Indicates if the store has sim duplicate capability, if it can manage sim duplicates | ||
store_type* | string | Type of the store |
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Server Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/dealers/d39cb65f-1aa8-44fe-a3d8-d310e321331a/store-capability' \
-H 'Authorization: string' \
-H 'Accept: application/json'Create or update, sets the store capability for a specific dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
HEADER PARAMETERS
Bearer token
Dealer's store capability data to set
{
"store_delivery": true,
"device_return": true,
"sim_duplicate": true,
"store_type": "BASIC"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
store_delivery* | boolean | Indicates if the store has delivery capability, if it can delivery products | ||
device_return* | boolean | Indicates if the store has device return capability, if it can receive devices returns | ||
sim_duplicate* | boolean | Indicates if the store has sim duplicate capability, if it can manage sim duplicates | ||
store_type* | string | null | Type of the store | minLength: 1 |
OK Store capability data successfully set (upserted)
{
"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"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string | The id of the store capability. It is generated automatically when creating a new record | ||
dealer_id* | string | The id of the dealer that store capability refers to | ||
store_delivery* | boolean | Indicates if the store has delivery capability, if it can delivery products | ||
device_return* | boolean | Indicates if the store has device return capability, if it can receive devices returns | ||
sim_duplicate* | boolean | Indicates if the store has sim duplicate capability, if it can manage sim duplicates | ||
store_type* | string | Type of the store |
Bad Request Invalid request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal server error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PUT 'https://dealers.masstack.com/v2/dealers/:id/store-capability' \
-H 'Authorization: string' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"store_delivery": true,
"device_return": true,
"sim_duplicate": true,
"store_type": "BASIC"
}'Delete store capability for a specific dealer
PATH PARAMETERS
Dealer ID
HEADER PARAMETERS
Bearer token
No Content Successfully deleted dealer store capability, no content returned
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Server Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://dealers.masstack.com/v2/dealers/d39cb65f-1aa8-44fe-a3d8-d310e321331a/store-capability' \
-H 'Authorization: string' \
-H 'Accept: application/json'Returns a list of actors that have a relationship with the specified dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
QUERY PARAMETERS
Actor code
Actor email
Actor name
Tipo de actor
ID del actor padre
Código del actor padre
Nombre completo del actor
Limit of results in the response
Offset applied to results for pagination
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.
The type of relation between the actors and the dealers. It can be one of the following values: * "DIRECT" * "INDIRECT" * "DIRECT_AND_INDIRECT"
HEADER PARAMETERS
Bearer token
Return successfully the actors information
{
"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"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
offset | integer (int32) | Offset used to paginate in conjunction with limit | ||||||||||||||||||||||||||||||||||||||||||||||||||||
limit | integer (int32) | Max number of results of the response | ||||||||||||||||||||||||||||||||||||||||||||||||||||
total | integer (int32) | Total number of records | ||||||||||||||||||||||||||||||||||||||||||||||||||||
sort | string | The fields by which the results will be sorted. It can be a list of fields separated by commas | ||||||||||||||||||||||||||||||||||||||||||||||||||||
items* | object[] | List of items | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found BadRequest
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service Unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Gateway Timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/dealers/:id/actors?code=aaa-bbb-111-ccc-ddd&email=vvvv.ssss%40masorange.com&name=Actor%20name&type=dealer&parent_id=98765&parent_code=parent-abc-123&full_name=Juan%20P%C3%A9rez&limit=20&offset=0&sort=name%3Aasc%2Cid%3Adesc' \
-H 'Authorization: string' \
-H 'Accept: application/json'Get a single dealer by exact dealer code match. Only returns active dealers
PATH PARAMETERS
Dealer code
HEADER PARAMETERS
Bearer token
OK Successfully returned the dealer information
{
"id": "abcd-1234-xyz",
"code": "COD-123",
"commercial_name": "Testing Test SL",
"level": 2,
"identity_document": {
"type": "NIF",
"value": "12345678Z",
"issuing_country": "ES"
},
"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"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Id of the dealer | ||||||||||||||||||||||
code* | string | Code of the dealer | ||||||||||||||||||||||
commercial_name* | string | CommercialName of the dealer | ||||||||||||||||||||||
level* | integer (int32) | Level of the dealer | ||||||||||||||||||||||
identity_document | object | Legal identification information | ||||||||||||||||||||||
| ||||||||||||||||||||||||
ine | string | INE of the dealer | ||||||||||||||||||||||
segment | string
()
RESIDENCIALNEGOCIOSNONE | Segment of the dealer | ||||||||||||||||||||||
parent_id | string | Id of the dealer's parent | ||||||||||||||||||||||
parent_code | string | Code of the dealer's parent | ||||||||||||||||||||||
commercial_structure_id* | string | Commercial structure id of the dealer | ||||||||||||||||||||||
commercial_structure_code | string | Commercial structure code of the dealer | ||||||||||||||||||||||
status* | string
()
BloqueadoPendienteBajaActivoInactivo | Enumeration of possible dealer statuses | ||||||||||||||||||||||
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "NOT_FOUND",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Server Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service Unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Gateway Timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/dealers/by-code/:code' \
-H 'Authorization: string' \
-H 'Accept: application/json'Get dealer by id
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
HEADER PARAMETERS
Bearer token
OK Return successfully the dealer information
{
"id": "abcd-1234-xyz",
"code": "COD-123",
"commercial_name": "Testing Test SL",
"level": 2,
"identity_document": {
"type": "NIF",
"value": "12345678Z",
"issuing_country": "ES"
},
"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"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id* | string | Id of the dealer | ||||||||||||||||||||||
code* | string | Code of the dealer | ||||||||||||||||||||||
commercial_name* | string | CommercialName of the dealer | ||||||||||||||||||||||
level* | integer (int32) | Level of the dealer | ||||||||||||||||||||||
identity_document | object | Legal identification information | ||||||||||||||||||||||
| ||||||||||||||||||||||||
ine | string | INE of the dealer | ||||||||||||||||||||||
segment | string
()
RESIDENCIALNEGOCIOSNONE | Segment of the dealer | ||||||||||||||||||||||
parent_id | string | Id of the dealer's parent | ||||||||||||||||||||||
parent_code | string | Code of the dealer's parent | ||||||||||||||||||||||
commercial_structure_id* | string | Commercial structure id of the dealer | ||||||||||||||||||||||
commercial_structure_code | string | Commercial structure code of the dealer | ||||||||||||||||||||||
status* | string
()
BloqueadoPendienteBajaActivoInactivo | Enumeration of possible dealer statuses | ||||||||||||||||||||||
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service Unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Gateway Timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/dealers/:id' \
-H 'Authorization: string' \
-H 'Accept: application/json'Update dealer by id
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
HEADER PARAMETERS
Bearer token
Body with the dealer information
{
"level": 4,
"ine": "1234567890",
"segment": "RETAIL",
"status": "Activo",
"commercial_name": "Test Commercial Name",
"identity_document": {
"type": "NIF",
"value": "12345678Z",
"issuing_country": "ES"
},
"parent_id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a",
"commercial_structure_id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
level* | integer (int32) | Level of the dealer | min: 1, max: 4 | |||||||||||||||||||||
ine* | string | null | Ine code of the dealer | minLength: 1, maxLength: 100 | |||||||||||||||||||||
segment* | string | null
()
RESIDENCIALNEGOCIOSNONE | Segment of the dealer | ||||||||||||||||||||||
status* | string
()
BloqueadoPendienteBajaActivoInactivo | Enumeration of possible dealer statuses | minLength: 1 | |||||||||||||||||||||
commercial_name* | string | Commercial name of the dealer | minLength: 1, maxLength: 100 | |||||||||||||||||||||
identity_document | object | Legal identification information | ||||||||||||||||||||||
| ||||||||||||||||||||||||
parent_id* | string | null | The parentId of the dealer | minLength: 1 | |||||||||||||||||||||
commercial_structure_id* | string | The commercialStructureId of the dealer | minLength: 1 | |||||||||||||||||||||
No Content Successfully updated the dealer
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service Unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Gateway Timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PUT 'https://dealers.masstack.com/v2/dealers/:id' \
-H 'Authorization: string' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"level": 4,
"ine": "1234567890",
"segment": "RETAIL",
"status": "Activo",
"commercial_name": "Test Commercial Name",
"identity_document": {
"type": "NIF",
"value": "12345678Z",
"issuing_country": "ES"
},
"parent_id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a",
"commercial_structure_id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a"
}'Get dealers by billing, obtain all the dealers that have a relation with the queried billing dealer
PATH PARAMETERS
Dealer id (can be numeric legacy ID or UUID)
QUERY PARAMETERS
Limit of results in the response
Offset applied to results for pagination
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.
HEADER PARAMETERS
Bearer token
OK Successfully return the list of the dealers that have a relation with the queried billing dealer
{
"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_code": "1",
"subchannel_name": "Atención al Cliente",
"relation_type": "DIRECT",
"parent_id": 54321,
"parent_code": "COD-P123"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
offset | integer (int32) | Offset used to paginate in conjunction with limit | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
limit | integer (int32) | Max number of results of the response | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total | integer (int32) | Total number of records | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sort | string | The fields by which the results will be sorted. It can be a list of fields separated by commas | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
items* | object[] | List of items | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service Unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Gateway Timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/dealers/billing/:id?limit=20&offset=0&sort=name%3Aasc%2Cid%3Adesc' \
-H 'Authorization: string' \
-H 'Accept: application/json'Fix geocoding data for all dealers that have it wrongly setup
HEADER PARAMETERS
Bearer token
Created Successfully processed the fix geocoding request
{
"modified_dealers_ids": [
{
"dealer_id": 0
}
],
"not_modified_dealers_ids": [
{
"dealer_id": 0
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
modified_dealers_ids* | object[] | The list of the dealers that were modified | ||||||||||||
Array items:
| ||||||||||||||
not_modified_dealers_ids* | object[] | The list of the dealers that were NOT modified | ||||||||||||
Array items:
| ||||||||||||||
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service Unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Gateway Timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://dealers.masstack.com/v2/dealers/fix-geocoding' \
-H 'Authorization: string' \
-H 'Accept: application/json'Endpoint to list custom information variable definitions
QUERY PARAMETERS
Limit of results in the response
Offset applied to results for pagination
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.
HEADER PARAMETERS
Bearer token
OK Successfully returned the list of custom information variable definitions
{
"offset": 0,
"limit": 10,
"total": 100,
"sort": "id:asc",
"items": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Funnel",
"description": "Funnel Access"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
offset | integer (int32) | Offset used to paginate in conjunction with limit | ||||||||||||||||||||||
limit | integer (int32) | Max number of results of the response | ||||||||||||||||||||||
total | integer (int32) | Total number of records | ||||||||||||||||||||||
sort | string | The fields by which the results will be sorted. It can be a list of fields separated by commas | ||||||||||||||||||||||
items* | object[] | List of items | ||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/custom-information?limit=20&offset=0&sort=name%3Aasc%2Cid%3Adesc' \
-H 'Authorization: string' \
-H 'Accept: application/json'Endpoint to create a custom information variable definition
HEADER PARAMETERS
Bearer token
Custom information variable definition creation request
{
"name": "Funnel",
"description": "Funnel Access"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
name* | string | Name of the custom information variable | minLength: 1, maxLength: 100 | |
description* | string | Description of the custom information variable | minLength: 10, maxLength: 100 |
Created Successfully created
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Funnel",
"description": "Funnel Access"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string | Identifier of the custom information variable | ||
name* | string | Name of the custom information variable | ||
description* | string | null | Description of the custom information variable |
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://dealers.masstack.com/v2/custom-information' \
-H 'Authorization: string' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"name": "Funnel",
"description": "Funnel Access"
}'Endpoint to get a custom information variable definition
PATH PARAMETERS
Custom information variable definition ID
HEADER PARAMETERS
Bearer token
OK Successfully returned the custom information variable definition
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Funnel",
"description": "Funnel Access"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string | Identifier of the custom information variable | ||
name* | string | Name of the custom information variable | ||
description* | string | null | Description of the custom information variable |
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/custom-information/e7b8f8e6-9c3b-4d2a-8f1e-2c3d4e5f6a7b' \
-H 'Authorization: string' \
-H 'Accept: application/json'Endpoint to update a custom information variable definition
PATH PARAMETERS
Custom information variable definition ID
HEADER PARAMETERS
Bearer token
Custom information variable definition update request
{
"name": "Funnel",
"description": "Funnel Access"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
name* | string | Name of the custom information variable | minLength: 1, maxLength: 100 | |
description* | string | Description of the custom information variable | minLength: 10, maxLength: 100 |
No Content Successfully updated
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PUT 'https://dealers.masstack.com/v2/custom-information/e7b8f8e6-9c3b-4d2a-8f1e-2c3d4e5f6a7b' \
-H 'Authorization: string' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"name": "Funnel",
"description": "Funnel Access"
}'Endpoint to delete a custom information variable definition
PATH PARAMETERS
Custom information variable definition ID
HEADER PARAMETERS
Bearer token
No Content Successfully deleted
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://dealers.masstack.com/v2/custom-information/e7b8f8e6-9c3b-4d2a-8f1e-2c3d4e5f6a7b' \
-H 'Authorization: string' \
-H 'Accept: application/json'Get all commercial structures
HEADER PARAMETERS
Bearer token
OK List of commercial structures successfully obtained
[
{
"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"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string | Commercial structure id | minLength: 1 | |
subchannel_code* | string | Subchannel code | minLength: 1 | |
subchannel_name* | string | Subchannel name | minLength: 1 | |
channel_name | string | Channel name | minLength: 1 | |
superchannel_name | string | Superchannel name | minLength: 1 | |
masterchannel_name* | string | Masterchannel name | minLength: 1 | |
masterchannel_type | string | Masterchannel type | minLength: 1 |
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/commercial-structures' \
-H 'Authorization: string' \
-H 'Accept: application/json'Create a new commercial structure in the system
HEADER PARAMETERS
Bearer token
Commercial Structure request body
{
"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"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
subchannel_code* | string | Subchannel code | minLength: 1, maxLength: 10 | |
subchannel_name* | string | Subchannel name | minLength: 1, maxLength: 100 | |
channel_name* | string | Channel name | minLength: 1, maxLength: 100 | |
superchannel_name* | string | Superchannel name | minLength: 1, maxLength: 100 | |
masterchannel_name* | string | MasterChannel name | minLength: 1, maxLength: 100 | |
masterchannel_type* | string | MasterChannel type | minLength: 1, maxLength: 100 |
Created Successfully create a commercial structure
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found BadRequest
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service Unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Gateway Timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://dealers.masstack.com/v2/commercial-structures' \
-H 'Authorization: string' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"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"
}'Get a commercial structures by id
PATH PARAMETERS
Unique identifier of the commercial structure
HEADER PARAMETERS
Bearer token
OK The commercial structures successfully obtained
{
"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"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string | Commercial structure id | minLength: 1 | |
subchannel_code* | string | Subchannel code | minLength: 1 | |
subchannel_name* | string | Subchannel name | minLength: 1 | |
channel_name | string | Channel name | minLength: 1 | |
superchannel_name | string | Superchannel name | minLength: 1 | |
masterchannel_name* | string | Masterchannel name | minLength: 1 | |
masterchannel_type | string | Masterchannel type | minLength: 1 |
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/commercial-structures/e7b8f8e6-9c3b-4d2a-8f1e-2c3d4e5f6a7b' \
-H 'Authorization: string' \
-H 'Accept: application/json'Update an existing commercial structure in the system
PATH PARAMETERS
Unique identifier of the commercial structure
HEADER PARAMETERS
Bearer token
Commercial Structure request body
{
"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"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
subchannel_code* | string | Subchannel code | minLength: 1, maxLength: 10 | |
subchannel_name* | string | Subchannel name | minLength: 1, maxLength: 100 | |
channel_name* | string | Channel name | minLength: 1, maxLength: 100 | |
superchannel_name* | string | Superchannel name | minLength: 1, maxLength: 100 | |
masterchannel_name* | string | MasterChannel name | minLength: 1, maxLength: 100 | |
masterchannel_type* | string | MasterChannel type | minLength: 1, maxLength: 100 |
No Content Successfully updated the commercial structure
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PUT 'https://dealers.masstack.com/v2/commercial-structures/e7b8f8e6-9c3b-4d2a-8f1e-2c3d4e5f6a7b' \
-H 'Authorization: string' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"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"
}'Delete an existing commercial structure in the system
PATH PARAMETERS
Unique identifier of the commercial structure
HEADER PARAMETERS
Bearer token
No Content Successfully deleted the commercial structure
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://dealers.masstack.com/v2/commercial-structures/e7b8f8e6-9c3b-4d2a-8f1e-2c3d4e5f6a7b' \
-H 'Authorization: string' \
-H 'Accept: application/json'Get all available accounting systems to operate
HEADER PARAMETERS
Bearer token
OK List of accounting systems successfully obtained
[
{
"offset": 0,
"limit": 10,
"total": 100,
"sort": "id:asc",
"items": [
{
"id": "c74d4aac-6853-4a94-a5ae-d9369b0da443",
"code": "MYS",
"description": "MYSIM"
}
]
}
]| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
offset | integer (int32) | Offset used to paginate in conjunction with limit | ||||||||||||||||||||||
limit | integer (int32) | Max number of results of the response | ||||||||||||||||||||||
total | integer (int32) | Total number of records | ||||||||||||||||||||||
sort | string | The fields by which the results will be sorted. It can be a list of fields separated by commas | ||||||||||||||||||||||
items* | object[] | List of items | ||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/accounting-systems' \
-H 'Authorization: string' \
-H 'Accept: application/json'Create a new accounting system
HEADER PARAMETERS
Bearer token
The data with which we want to create the accounting system
{
"code": "MYS",
"description": "MYSIM"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code* | string | Code of the accounting system | minLength: 1 | |
description* | string | Description of the accounting system | minLength: 1 |
Created Successfully create an accounting system
{
"id": "c74d4aac-6853-4a94-a5ae-d9369b0da443",
"code": "MYS",
"description": "MYSIM"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string | Accounting system ID | minLength: 36, maxLength: 36 | |
code* | string | Accounting system code | minLength: 1 | |
description* | string | Accounting system name | minLength: 1 |
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "UNAUTHORIZED",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found BadRequest
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Conflict Conflict
{
"errors": [
{
"code": "CONFLICT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "INTERNAL_SERVER_ERROR",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Service Unavailable Service Unavailable
{
"errors": [
{
"code": "SERVICE_UNAVAILABLE",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Gateway Timeout
{
"errors": [
{
"code": "GATEWAY_TIMEOUT",
"title": "Error message",
"ref": "some_ref",
"details": "Detailed error message"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X POST 'https://dealers.masstack.com/v2/accounting-systems' \
-H 'Authorization: string' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"code": "MYS",
"description": "MYSIM"
}'Get the accounting system for the given id
PATH PARAMETERS
Unique identifier of the commercial structure
HEADER PARAMETERS
Bearer token
OK The accounting system if found
{
"id": "c74d4aac-6853-4a94-a5ae-d9369b0da443",
"code": "MYS",
"description": "MYSIM"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string | Accounting system ID | minLength: 36, maxLength: 36 | |
code* | string | Accounting system code | minLength: 1 | |
description* | string | Accounting system name | minLength: 1 |
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/accounting-systems/e7b8f8e6-9c3b-4d2a-8f1e-2c3d4e5f6a7b' \
-H 'Authorization: string' \
-H 'Accept: application/json'Update the accounting system for the given id
PATH PARAMETERS
Unique identifier of the commercial structure
HEADER PARAMETERS
Bearer token
The data with which we want to create the accounting system
{
"code": "MYS",
"description": "MYSIM"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code* | string | Code of the accounting system | minLength: 1 | |
description* | string | Description of the accounting system | minLength: 1 |
OK The updated accounting system
{
"id": "c74d4aac-6853-4a94-a5ae-d9369b0da443",
"code": "MYS",
"description": "MYSIM"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id* | string | Accounting system ID | minLength: 36, maxLength: 36 | |
code* | string | Accounting system code | minLength: 1 | |
description* | string | Accounting system name | minLength: 1 |
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X PUT 'https://dealers.masstack.com/v2/accounting-systems/e7b8f8e6-9c3b-4d2a-8f1e-2c3d4e5f6a7b' \
-H 'Authorization: string' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"code": "MYS",
"description": "MYSIM"
}'Delete the accounting system for the given id
PATH PARAMETERS
Unique identifier of the commercial structure
HEADER PARAMETERS
Bearer token
No Content Successfully deleted the accounting system
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X DELETE 'https://dealers.masstack.com/v2/accounting-systems/e7b8f8e6-9c3b-4d2a-8f1e-2c3d4e5f6a7b' \
-H 'Authorization: string' \
-H 'Accept: application/json'Get all available brands to operate
HEADER PARAMETERS
Bearer token
OK List of brands successfully obtained
[
{
"code": "YG",
"brand": "yoigo"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code* | string
()
GUPPYGLEMMLYLLVIEBAHALBTSWJIMBSTPMEKRTTCRC | Brand codes enumeration | minLength: 1 | |
brand* | string | Brand name | minLength: 1 |
Bad Request Bad Request
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Not Found Not Found
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/brands' \
-H 'Authorization: string' \
-H 'Accept: application/json'Get a list of stores near a given postal code, filtered by criteria and sorted by distance. Returns stores with their capabilities, contacts, and brands.
QUERY PARAMETERS
Postal code for location-based search
Brand codes to filter stores (repeatable parameter)
Filter by store delivery capability
Filter by device return capability
Filter by subchannel code
Limit of results in the response
HEADER PARAMETERS
Bearer token
OK List of stores successfully obtained
[
{
"dealer_id": "d39cb65f-1aa8-44fe-a3d8-d310e321331a",
"dealer_code": "ST0001",
"commercial_name": "Tienda Gran Via",
"distance_km": 1.234,
"address_info": {
"address": "Gran Via 28",
"city": "Madrid",
"province": "Madrid",
"postal_code": "28013",
"country": "España",
"location": {
"latitude": 40.4199,
"longitude": -3.7065
}
},
"public_contacts": [
{
"name": "Atención tienda",
"phone_number": "900000000",
"email": "tienda@ejemplo.es"
}
],
"store_capability": {
"store_delivery": true,
"device_return": true,
"sim_duplicate": false,
"store_type": "BASIC"
},
"brands": [
{
"brand": "yoigo",
"brand_code": "YG"
}
],
"subchannel_code": "RETAIL"
}
]| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
dealer_id* | string | Unique identifier of the dealer | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
dealer_code* | string | Dealer code | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_name* | string | Commercial name of the store | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
distance_km* | number (double) | Distance from search location in kilometers | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
address_info | object | Store address information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
public_contacts | object[] | Public contact information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
store_capability | object | Store capability information | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
brands | object[] | Brands available at the store | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subchannel_code | string | Commercial subchannel code | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Bad Request
{
"errors": [
{
"code": "BAD_REQUEST",
"title": "Invalid postal code",
"ref": "postal_code",
"details": "The provided postal code is not valid"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Unauthorized Unauthorized
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Internal Server Error Internal Error
{
"errors": [
{
"code": "string",
"title": "string",
"ref": "string",
"details": "string"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
errors | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
curl -X GET 'https://dealers.masstack.com/v2/stores?postal_code=28013&brand_code=%5B%22YG%22%2C%22MM%22%5D&store_delivery=true&device_return=true&subchannel=RETAIL&limit=10' \
-H 'Authorization: string' \
-H 'Accept: application/json'