Imported data
AuthnTokenMasLogistics Bearer Token (JWT) MasLogistics Squad — mas_logistics@masmovil.com
| Recurso | Descripción |
|---|---|
| Direct Logistics | The aim of the operations is to provide information about the available products as well as control the process for the delivery of the goods to the end customer. |
| Reverse Logistics | The aim of the operations is to control the process for the return of products from consumption or end user points to the manufacturer or distributor for their recovery, repair, recycling or disposal. |
| Swap Logistics | The aim of the operations is to provide information about the available products as well as control the swap process. |
| Expeditions Logistics | The aim of the operations is to provide information about expeditions for both direct and reverse logistics processes. Expeditions represent the shipment tracking and status of orders and pickups. |
| External Logistic Operator | The aim of the operations is to provide logistic information about external logistic operator orders |
| Logistics Management | Endpoints for managing logistics configurations |
AuthnTokenMasLogistics Bearer Token (JWT) MasLogistics Squad — mas_logistics@masmovil.com
| Recurso | Descripción |
|---|---|
| Direct Logistics | The aim of the operations is to provide information about the available products as well as control the process for the delivery of the goods to the end customer. |
| Reverse Logistics | The aim of the operations is to control the process for the return of products from consumption or end user points to the manufacturer or distributor for their recovery, repair, recycling or disposal. |
| Swap Logistics | The aim of the operations is to provide information about the available products as well as control the swap process. |
| Expeditions Logistics | The aim of the operations is to provide information about expeditions for both direct and reverse logistics processes. Expeditions represent the shipment tracking and status of orders and pickups. |
| External Logistic Operator | The aim of the operations is to provide logistic information about external logistic operator orders |
| Logistics Management | Endpoints for managing logistics configurations |
Retrieve a reservation by its internal reservation ID
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
Internal reservation ID
OK Success
{
"reservation_id": "123456",
"reservation_id_external": "ext-123456",
"order_id": "E01ABC123DEF456G",
"order_id_crm": "109384632",
"product_reference": "P0000001",
"state": "CONFIRMED",
"tenant": "yoigo",
"duration": "180 seconds",
"valid_until": "2025-12-17T12:00:00Z",
"create_date": "2025-12-15T10:00:00Z",
"update_date": "2025-12-16T15:30:00Z"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
reservation_id | string | Internal reservation ID | ||
reservation_id_external | string | External reservation ID | ||
order_id | string | null | Internal order ID associated with the reservation | ||
order_id_crm | string | null | CRM order ID associated with the reservation | ||
product_reference | string | Product reference | ||
state | string
()
PENDINGCONFIRMEDCANCELLEDORDER_CREATED | Reservation state | ||
tenant | string | Tenant or organization | ||
duration | string | null | Duration of the reservation | ||
valid_until | string | null | Timestamp when the reservation expires | ||
create_date | string | Reservation creation timestamp | ||
update_date | string | Reservation last update timestamp |
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X GET 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/reservations/123456' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Update reservation status
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
Internal logistics reservation id
Information needed to change the status to a reservation to confirmed or cancelled.
{
"reservation_id": "123456",
"order_id": "134566",
"status": "CONFIRM",
"zip_code": "28912"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
reservation_id | string | Reservation Id | ||
order_id | string | Order Id (newOrder service) | minLength: 1 | |
status* | string
()
CONFIRMCANCEL | Reservation status | ||
zip_code | string | Postal code (Mandatory if the status is CONFIRM) | minLength: 5, maxLength: 5, pattern: [\d]{5} |
OK Success
{
"reservation_id": "123456",
"order_id": "134566",
"status": "CONFIRM",
"zip_code": "28912"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
reservation_id | string | Reservation Id | ||
order_id | string | Order Id (newOrder service) | minLength: 1 | |
status* | string
()
CONFIRMCANCEL | Reservation status | ||
zip_code | string | Postal code (Mandatory if the status is CONFIRM) | minLength: 5, maxLength: 5, pattern: [\d]{5} |
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X PUT 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/reservations/130' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"reservation_id": "123456",
"order_id": "134566",
"status": "CONFIRM",
"zip_code": "28912"
}'Create a new Reservation
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
Information needed to create a new Reservation
{
"data_sales": {
"agent": "RETEN001",
"channel": "TELE_SALE_CARE",
"type": "NEW_SALE",
"group": "POS"
},
"product_id": "RM58AV3N2"
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data_sales | object | Information related to sales associated with the order | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||
product_id* | string | Product identifier | |||||||||||||||||||||||||||
OK Success
{
"product_id": "P0000001",
"reservation_id": "250",
"total_duration_in_seconds": 180,
"valid_until": "2021-05-24T09:00:00Z"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
product_id | string | The product Id | ||
reservation_id | string | Reservation Id | ||
total_duration_in_seconds | number | The time in seconds that the reservation is available before expire. | ||
valid_until | string | The timestamp when the reservation will expire in ISO 8601 format and UTC |
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X POST 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/reservations' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"data_sales": {
"agent": "RETEN001",
"channel": "TELE_SALE_CARE",
"type": "NEW_SALE",
"group": "POS"
},
"product_id": "RM58AV3N2"
}'Get orders
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
QUERY PARAMETERS
Page size
Page number
Order id in MasLogistics domain
Order id in CRM domain
Order id in external domain
Subscription id
Business process
Delivery type
Client identity document id
Product identifier like IMEI, ICCID, Serial Number, etc.
The product reference
Product subscription device id
From order date in ISO 8601 format. Example: 2021-05-24T09:00:00Z
To order date in ISO 8601 format. Example: 2021-05-24T09:00:00Z
Sort value, multiple values allowed, separate with coma
OK Success
{
"page_size": 123,
"total_pages": 10,
"current_page": 1,
"total_elements": 3000,
"orders": [
{
"order": {
"reservation_id": "7d19cf38-a33d-42cd-8770-cea25db0b2e3",
"subscription_id": "2203846",
"work_order": "MYSIM_213563123",
"order_id": "E01ABC123DEF456G",
"order_id_crm": "109384632",
"order_id_external": "484543418",
"business_process": "PEDIDO",
"reason": "Extraordinary order, original order lost",
"convergent": true,
"language": "ES",
"delivery_type": "AGENCY"
},
"data_sales": {
"agent": "RETEN001",
"channel": "TELE_SALE_CARE",
"type": "NEW_SALE",
"group": "POS"
},
"client": {
"identity": {
"document_id": null,
"document_type": null
},
"contact_phone": {
"phone_number": null,
"prefix": null
},
"name": "Juan",
"surnames": [
null
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": null,
"street": null,
"number": null,
"additional_details": null,
"city": null,
"zip_code": null,
"province": null,
"country": null,
"bis": null,
"floor": null,
"block": null,
"stair": null,
"letter": null
}
},
"invoice": {
"address": {
"street_type": null,
"street": null,
"number": null,
"additional_details": null,
"city": null,
"zip_code": null,
"province": null,
"country": null,
"bis": null,
"floor": null,
"block": null,
"stair": null,
"letter": null
},
"client": {
"identity": null,
"contact_phone": null,
"name": null,
"surnames": null,
"email": null,
"commercial_name": null,
"address": null
},
"data_invoice": {
"base": null,
"tax_value": null,
"total_invoice": null,
"discount": null,
"payment_type": null,
"residual_value": null,
"initial_payment": null,
"fee": null
}
},
"shipping": {
"address": {
"street_type": null,
"street": null,
"number": null,
"additional_details": null,
"city": null,
"zip_code": null,
"province": null,
"country": null,
"bis": null,
"floor": null,
"block": null,
"stair": null,
"letter": null
},
"contact_data": {
"identity": null,
"contact_phone": null,
"name": null,
"surnames": null,
"email": null,
"commercial_name": null,
"address": null
},
"data_delivery": {
"courier_id": null,
"delivery_service": null,
"exclusive": null,
"verify_identity": null,
"retrieve_contract": null,
"group_by": null,
"secure_delivery": null,
"delivery_point_id": null,
"delivery_shop_name": null,
"delivery_type": null,
"ol_comments": null
}
}
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
page_size | integer | Page size | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_pages | integer | Total pages for page size | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
current_page | integer | Current page | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_elements | integer | Total element | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
orders | object[] | List of Orders | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X GET 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/orders?size=100&page=1&order_id=E1585NAHY276BR4&order_id_crm=MYSIM_103827&subscription_id=2203846&business_process=PEDIDO&identity_document_id=12345678Z&product_identifier=RM58AV3N2&product_code=P0000001&product_subscription_device_id=1123456789&from_order_date=2021-05-24T09%3A00%3A00Z&to_order_date=2021-05-25T09%3A00%3A00Z' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Create a new Order
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
Information needed to create a new Order
{
"order": {
"reservation_id": "7d19cf38-a33d-42cd-8770-cea25db0b2e3",
"subscription_id": "2203846",
"work_order": "MYSIM_213563123",
"order_id": "E01ABC123DEF456G",
"order_id_crm": "109384632",
"order_id_external": "484543418",
"business_process": "PEDIDO",
"reason": "Extraordinary order, original order lost",
"convergent": true,
"language": "ES",
"delivery_type": "AGENCY"
},
"data_sales": {
"agent": "RETEN001",
"channel": "TELE_SALE_CARE",
"type": "NEW_SALE",
"group": "POS"
},
"client": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"invoice": {
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
},
"client": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"data_invoice": {
"base": 100,
"tax_value": 21,
"total_invoice": 121,
"discount": 0,
"payment_type": 0,
"residual_value": 0,
"initial_payment": 0,
"fee": {
"amount": 12,
"duration": 12
}
}
},
"shipping": {
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
},
"contact_data": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"data_delivery": {
"courier_id": "CORREOS",
"delivery_service": "DELIVERY_24",
"exclusive": true,
"verify_identity": false,
"retrieve_contract": false,
"group_by": "string",
"secure_delivery": false,
"delivery_point_id": "SEUR-1234",
"delivery_shop_name": "Mas Life Plaza España",
"delivery_type": "AGENCY",
"ol_comments": "ONT password"
}
},
"products": [
{
"product_id": "40397",
"product_code": "RM58AV3N2",
"product_description": "Caja de voz Ad Hoc v3",
"product_type": "ROUTER",
"product_type_id": 16,
"product_unit_price": 16.5,
"icc_imei": "string",
"identifier": "string",
"quantity": 1,
"product_comments": "string",
"msisdn": "666666666",
"financed": true,
"subscription_device_id": "40397",
"remaining_payment": 20.5,
"invoiced": true,
"status": "CREATED"
}
],
"documentation": {
"letter_type": "WP",
"documents": [
{
"document_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"document_type": "CONTRACT",
"copies": 2,
"signable": true,
"signed": true
}
]
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
order* | object | Main order data, including ID and essential details | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data_sales | object | Information related to sales associated with the order | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client* | object | Object with client data | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice | object | Invoice information generated for the order | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shipping* | object | Shipping details, including address and delivery info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
products* | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
documentation | object | Info about the documentation related to the order | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OK Success
{
"order": {
"reservation_id": "7d19cf38-a33d-42cd-8770-cea25db0b2e3",
"subscription_id": "2203846",
"work_order": "MYSIM_213563123",
"order_id": "E01ABC123DEF456G",
"order_id_crm": "109384632",
"order_id_external": "484543418",
"business_process": "PEDIDO",
"reason": "Extraordinary order, original order lost",
"convergent": true,
"language": "ES",
"delivery_type": "AGENCY"
},
"data_sales": {
"agent": "RETEN001",
"channel": "TELE_SALE_CARE",
"type": "NEW_SALE",
"group": "POS"
},
"client": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"invoice": {
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
},
"client": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"data_invoice": {
"base": 100,
"tax_value": 21,
"total_invoice": 121,
"discount": 0,
"payment_type": 0,
"residual_value": 0,
"initial_payment": 0,
"fee": {
"amount": 12,
"duration": 12
}
}
},
"shipping": {
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
},
"contact_data": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"data_delivery": {
"courier_id": "CORREOS",
"delivery_service": "DELIVERY_24",
"exclusive": true,
"verify_identity": false,
"retrieve_contract": false,
"group_by": "string",
"secure_delivery": false,
"delivery_point_id": "SEUR-1234",
"delivery_shop_name": "Mas Life Plaza España",
"delivery_type": "AGENCY",
"ol_comments": "ONT password"
}
},
"products": [
{
"product_id": "40397",
"product_code": "RM58AV3N2",
"product_description": "Caja de voz Ad Hoc v3",
"product_type": "ROUTER",
"product_type_id": 16,
"product_unit_price": 16.5,
"icc_imei": "string",
"identifier": "string",
"quantity": 1,
"product_comments": "string",
"msisdn": "666666666",
"financed": true,
"subscription_device_id": "40397",
"remaining_payment": 20.5,
"invoiced": true,
"status": "CREATED"
}
],
"documentation": {
"letter_type": "WP",
"documents": [
{
"document_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"document_type": "CONTRACT",
"copies": 2,
"signable": true,
"signed": true
}
]
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
order* | object | Main order data, including ID and essential details | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data_sales | object | Information related to sales associated with the order | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client* | object | Object with client data | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice | object | Invoice information generated for the order | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shipping* | object | Shipping details, including address and delivery info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
products* | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
documentation | object | Info about the documentation related to the order | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X POST 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/orders' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"order": {
"reservation_id": "7d19cf38-a33d-42cd-8770-cea25db0b2e3",
"subscription_id": "2203846",
"work_order": "MYSIM_213563123",
"order_id": "E01ABC123DEF456G",
"order_id_crm": "109384632",
"order_id_external": "484543418",
"business_process": "PEDIDO",
"reason": "Extraordinary order, original order lost",
"convergent": true,
"language": "ES",
"delivery_type": "AGENCY"
},
"data_sales": {
"agent": "RETEN001",
"channel": "TELE_SALE_CARE",
"type": "NEW_SALE",
"group": "POS"
},
"client": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"invoice": {
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
},
"client": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"data_invoice": {
"base": 100,
"tax_value": 21,
"total_invoice": 121,
"discount": 0,
"payment_type": 0,
"residual_value": 0,
"initial_payment": 0,
"fee": {
"amount": 12,
"duration": 12
}
}
},
"shipping": {
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
},
"contact_data": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"data_delivery": {
"courier_id": "CORREOS",
"delivery_service": "DELIVERY_24",
"exclusive": true,
"verify_identity": false,
"retrieve_contract": false,
"group_by": "string",
"secure_delivery": false,
"delivery_point_id": "SEUR-1234",
"delivery_shop_name": "Mas Life Plaza España",
"delivery_type": "AGENCY",
"ol_comments": "ONT password"
}
},
"products": [
{
"product_id": "40397",
"product_code": "RM58AV3N2",
"product_description": "Caja de voz Ad Hoc v3",
"product_type": "ROUTER",
"product_type_id": 16,
"product_unit_price": 16.5,
"icc_imei": "string",
"identifier": "string",
"quantity": 1,
"product_comments": "string",
"msisdn": "666666666",
"financed": true,
"subscription_device_id": "40397",
"remaining_payment": 20.5,
"invoiced": true,
"status": "CREATED"
}
],
"documentation": {
"letter_type": "WP",
"documents": [
{
"document_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"document_type": "CONTRACT",
"copies": 2,
"signable": true,
"signed": true
}
]
}
}'Get an Order
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
Internal logistics order id
OK Success
{
"order": {
"reservation_id": "7d19cf38-a33d-42cd-8770-cea25db0b2e3",
"subscription_id": "2203846",
"work_order": "MYSIM_213563123",
"order_id": "E01ABC123DEF456G",
"order_id_crm": "109384632",
"order_id_external": "484543418",
"business_process": "PEDIDO",
"reason": "Extraordinary order, original order lost",
"convergent": true,
"language": "ES",
"delivery_type": "AGENCY"
},
"data_sales": {
"agent": "RETEN001",
"channel": "TELE_SALE_CARE",
"type": "NEW_SALE",
"group": "POS"
},
"client": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"invoice": {
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
},
"client": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"data_invoice": {
"base": 100,
"tax_value": 21,
"total_invoice": 121,
"discount": 0,
"payment_type": 0,
"residual_value": 0,
"initial_payment": 0,
"fee": {
"amount": 12,
"duration": 12
}
}
},
"shipping": {
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
},
"contact_data": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"data_delivery": {
"courier_id": "CORREOS",
"delivery_service": "DELIVERY_24",
"exclusive": true,
"verify_identity": false,
"retrieve_contract": false,
"group_by": "string",
"secure_delivery": false,
"delivery_point_id": "SEUR-1234",
"delivery_shop_name": "Mas Life Plaza España",
"delivery_type": "AGENCY",
"ol_comments": "ONT password"
}
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
order* | object | Main order data, including ID and essential details | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data_sales | object | Information related to sales associated with the order | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client* | object | Object with client data | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice | object | Invoice information generated for the order | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shipping* | object | Shipping details, including address and delivery info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X GET 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/orders/888888-A9293' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Request to get the products of an order
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
Internal logistics order id
QUERY PARAMETERS
Page size
Page number
OK Success
{
"page_size": 123,
"total_pages": 10,
"current_page": 1,
"total_elements": 3000,
"products": [
{
"product_id": "40397",
"product_code": "RM58AV3N2",
"product_description": "Caja de voz Ad Hoc v3",
"product_type": "ROUTER",
"product_type_id": 16,
"product_unit_price": 16.5,
"icc_imei": "string",
"identifier": "string",
"quantity": 1,
"product_comments": "string",
"msisdn": "666666666",
"financed": true,
"subscription_device_id": "40397",
"remaining_payment": 20.5,
"invoiced": true,
"status": "CREATED",
"associated_expedition": {
"expedition_id": "a13a4674f6547447ff1f8813f33b5a90f6616ec2514e3f6e162acc5b88e9cfcb-R0",
"current_status": {
"id": null,
"value": null,
"description": null,
"final": null,
"reshippable": null,
"reason_code": null,
"reason_description": null,
"timestamp": null
}
}
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
page_size | integer | Page size | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_pages | integer | Total pages for page size | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
current_page | integer | Current page | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_elements | integer | Total element | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
products | object[] | Info about the product with the expedition | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X GET 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/orders/888888-A9293/products?size=100&page=1' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Request to get one specific product of an order
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
Internal logistics order id
Product id, usually subscription_device_id
OK Success
{
"product_id": "40397",
"product_code": "RM58AV3N2",
"product_description": "Caja de voz Ad Hoc v3",
"product_type": "ROUTER",
"product_type_id": 16,
"product_unit_price": 16.5,
"icc_imei": "string",
"identifier": "string",
"quantity": 1,
"product_comments": "string",
"msisdn": "666666666",
"financed": true,
"subscription_device_id": "40397",
"remaining_payment": 20.5,
"invoiced": true,
"status": "CREATED",
"associated_expedition": {
"expedition_id": "a13a4674f6547447ff1f8813f33b5a90f6616ec2514e3f6e162acc5b88e9cfcb-R0",
"current_status": {
"id": "1",
"value": "DELIVERED",
"description": "Order delivered to the client",
"final": false,
"reshippable": false,
"reason_code": "",
"reason_description": "",
"timestamp": "2023-05-02 11:00:09"
}
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
product_id | string | The product id in MasLogistics domain, usually suscription_device_id. (Read only parameter, only for GET requests) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
product_code* | string | Product code | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
product_description | string | Product description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
product_type | string
()
STBTERMINALROUTERSIMGENERICSMART_TVSMARTHOME | The product type. It is mandatory when using generic product_code | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
product_type_id | integer | Product Type Id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
product_unit_price | number | Product Unit price | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
icc_imei | string | Product imei | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
identifier | string | The physical product identifier, usually SerialNumber/MAC/IMEI. (Read only parameter, only for GET requests) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
quantity | integer | Product quantity | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
product_comments | string | Product comments | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
msisdn | string | MSISDN associated | pattern: ^\d{9} | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
financed | boolean | Is product financed | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subscription_device_id* | string | Identifier of an internal order in mas stack | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
remaining_payment | number | Remaining payment amount to pay on delivery | max: 999.99 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoiced | boolean | If this value is false it indicates that the product is on lease if it is true it is on sale and we should have the data_invoice info. | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string
()
CREATEDDISCARDED | The status of the product. (Read only parameter, only for GET requests) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
associated_expedition | object | Associated expedition info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X GET 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/orders/888888-A9293/products/888888-A9293' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Request to get all documents of an order
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
Internal logistics order id
QUERY PARAMETERS
Page size
Page number
OK Success
{
"page_size": 123,
"total_pages": 10,
"current_page": 1,
"total_elements": 3000,
"documents": [
{
"document_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"document_type": "CONTRACT",
"copies": 2,
"signable": true,
"signed": true
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
page_size | integer | Page size | ||||||||||||||||||||||||||||||||
total_pages | integer | Total pages for page size | ||||||||||||||||||||||||||||||||
current_page | integer | Current page | ||||||||||||||||||||||||||||||||
total_elements | integer | Total element | ||||||||||||||||||||||||||||||||
documents | object[] | |||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X GET 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/orders/d290f1ee-6c54-4b01-90e6-d701748f0851/documents?size=100&page=1' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Request the complete information of a document of an order
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
Internal logistics order id
The public document id managed by mas-logistics
OK Success
{
"document_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"document_type": "CONTRACT",
"copies": 2,
"signable": true,
"signed": true,
"url": "https://storage.googleapis.com/mas-documents-prod/cbd2e693-d71a-4cee-8313-1972acc0394d"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
document_id | string | Public document id managed by mas-logistics, not the id managed by mas-documents | ||
document_type | string
()
CONTRACTINECCGGDELIVERY_NOTE | Document Type | ||
copies | integer | The number of copies that must be printed | ||
signable | boolean | Defines if the document is signable in the MasLogistics context using the signOrderDocuments operation | false | |
signed | boolean | Defines if the document is signed. If the document is not signable, this field will never be true | false | |
url | string | The public url to download the document |
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X GET 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/orders/d290f1ee-6c54-4b01-90e6-d701748f0851/documents/d290f1ee-6c54-4b01-90e6-d701748f0851' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Request to get all communications sent for an order
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
Internal logistics order id
QUERY PARAMETERS
Page size
Page number
OK Success
{
"page_size": 123,
"total_pages": 10,
"current_page": 1,
"total_elements": 3000,
"communications": [
{
"order_communication_id": "oc-123e4567-e89b-12d3-a456-426614174000",
"order_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"communication_id": "comm-789",
"trigger_communication_id": "trigger-123",
"external_communication_id": "ext-comm-456",
"template_id": "template-012",
"sent": true,
"reason": "order_created",
"event": "ORDER_CREATED",
"sent_at": "2023-11-25T10:30:00Z"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
page_size | integer | Page size | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_pages | integer | Total pages for page size | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
current_page | integer | Current page | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_elements | integer | Total element | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
communications | object[] | Communications sent for the order | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X GET 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/orders/d290f1ee-6c54-4b01-90e6-d701748f0851/communications?size=100&page=1' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Request to get one specific product of an order
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
Information needed to sign the documents
{
"order_ids": [
"6ea0ca52-e194-45e2-a4fd-6d93923682bd",
"8b243340-4b87-4b9b-bead-781698931477"
]
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
order_ids | string[] | Order ids to sign |
OK Success
{
"sign_id": "6ea0ca52-e194-45e2-a4fd-6d93923682bd",
"documents": [
{
"document_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"document_type": "CONTRACT",
"copies": 2,
"signable": true,
"signed": true
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sign_id | string | The sign id from MasDocuments | ||||||||||||||||||||||||||||||||
documents | object[] | |||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X POST 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/orders/documents/sign' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"order_ids": [
"6ea0ca52-e194-45e2-a4fd-6d93923682bd",
"8b243340-4b87-4b9b-bead-781698931477"
]
}'Request to cancel an order
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
Internal logistics order id
Information needed to create a cancellation request
{
"cancellation_request_id": "C0000001",
"reason": "DUPLICATE",
"products": [
{
"product_code": "RM58AV3N2",
"product_description": "Caja de voz Ad Hoc v3",
"product_type": "STB",
"product_type_id": 16,
"identifier": "822339400182",
"msisdn": "666666666",
"subscription_device_id": "40397"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
cancellation_request_id | string | The identifier of the cancellation request. (Read only parameter, only for GET requests) (Deprecated field, please remove linked logic) | ||||||||||||||||||||||||||||||||||||||||||
reason | string | The reason of the cancellation. | ||||||||||||||||||||||||||||||||||||||||||
products | object[] | The devices of the cancellation orders. (Deprecated soon, do not send in new integrations) | ||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||
OK Success
{
"cancellation_request_id": "C0000001",
"reason": "DUPLICATE",
"products": [
{
"product_code": "RM58AV3N2",
"product_description": "Caja de voz Ad Hoc v3",
"product_type": "STB",
"product_type_id": 16,
"identifier": "822339400182",
"msisdn": "666666666",
"subscription_device_id": "40397"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
cancellation_request_id | string | The identifier of the cancellation request. (Read only parameter, only for GET requests) (Deprecated field, please remove linked logic) | ||||||||||||||||||||||||||||||||||||||||||
reason | string | The reason of the cancellation. | ||||||||||||||||||||||||||||||||||||||||||
products | object[] | The devices of the cancellation orders. (Deprecated soon, do not send in new integrations) | ||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X POST 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/orders/888888-A9293/cancellation' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"cancellation_request_id": "C0000001",
"reason": "DUPLICATE",
"products": [
{
"product_code": "RM58AV3N2",
"product_description": "Caja de voz Ad Hoc v3",
"product_type": "STB",
"product_type_id": 16,
"identifier": "822339400182",
"msisdn": "666666666",
"subscription_device_id": "40397"
}
]
}'Notify delivery confirmation for an order
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
Internal logistics order id
Information needed to create a delivery confirmation request
{
"products": [
{
"product_code": "RM58AV3N2",
"product_description": "Caja de voz Ad Hoc v3",
"product_type": "STB",
"product_type_id": 16,
"identifier": "822339400182",
"msisdn": "666666666",
"subscription_device_id": "40397"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
products | object[] | |||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||
OK Success
{
"products": [
{
"product_code": "RM58AV3N2",
"product_description": "Caja de voz Ad Hoc v3",
"product_type": "STB",
"product_type_id": 16,
"identifier": "822339400182",
"msisdn": "666666666",
"subscription_device_id": "40397"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
products | object[] | |||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X POST 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/orders/888888-A9293/confirmDelivery' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"products": [
{
"product_code": "RM58AV3N2",
"product_description": "Caja de voz Ad Hoc v3",
"product_type": "STB",
"product_type_id": 16,
"identifier": "822339400182",
"msisdn": "666666666",
"subscription_device_id": "40397"
}
]
}'Get Stock OnLine
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
QUERY PARAMETERS
Sales channel identifier
Sales Type identifier
Product identifier
OK Success
{
"data": [
{
"warehouse_id": "50",
"product_id": "RM58AV3N2",
"available_quantity": 60
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
data | object[] | List of objects with stock information | ||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X GET 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/stock' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get pickups
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
QUERY PARAMETERS
Page size
Page number
Pickup id in MasLogistics domain
Order id in CRM domain
Order id in external domain
Subscription id
Business process
Delivery type
Client identity document id
Product identifier like IMEI, ICCID, Serial Number, etc.
The product reference
Product subscription device id
From order date in ISO 8601 format. Example: 2021-05-24T09:00:00Z
To order date in ISO 8601 format. Example: 2021-05-24T09:00:00Z
Sort value, multiple values allowed, separate with coma
OK Success
{
"page_size": 123,
"total_pages": 10,
"current_page": 1,
"total_elements": 3000,
"pickups": [
{
"order": {
"subscription_id": "2203846",
"pickup_id": "P0000001",
"order_id_external": "YG24011009607",
"order_id_crm": "4640528",
"language": "ES",
"business_process": "UNSUBSCRIPTION",
"reason": "Unsubscription",
"delivery_type": "AGENCY",
"access_reused": true,
"blocked": false
},
"data_sales": {
"agent": "RETEN001",
"channel": "TELE_SALE_CARE",
"type": "NEW_SALE",
"group": "POS"
},
"client": {
"identity": {
"document_id": null,
"document_type": null
},
"contact_phone": {
"phone_number": null,
"prefix": null
},
"name": "Juan",
"surnames": [
null
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": null,
"street": null,
"number": null,
"additional_details": null,
"city": null,
"zip_code": null,
"province": null,
"country": null,
"bis": null,
"floor": null,
"block": null,
"stair": null,
"letter": null
}
},
"shipping": {
"address": {
"street_type": null,
"street": null,
"number": null,
"additional_details": null,
"city": null,
"zip_code": null,
"province": null,
"country": null,
"bis": null,
"floor": null,
"block": null,
"stair": null,
"letter": null
},
"contact_data": {
"identity": null,
"contact_phone": null,
"name": null,
"surnames": null,
"email": null,
"commercial_name": null,
"address": null
},
"transport_data": {
"courier_id": null,
"delivery_service": null,
"exclusive": null,
"verify_identity": null,
"retrieve_contract": null,
"secure_delivery": null,
"delivery_point_id": null,
"delivery_shop_name": null,
"return_code": null,
"delivery_type": null
}
},
"products": [
{
"product_code": null,
"product_description": null,
"product_type": null,
"product_type_id": null,
"identifier": null,
"msisdn": null,
"subscription_device_id": null,
"technology": null,
"status": null
}
]
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
page_size | integer | Page size | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_pages | integer | Total pages for page size | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
current_page | integer | Current page | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_elements | integer | Total element | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pickups | object[] | List of Pickups | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X GET 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/pickups?size=100&page=1&pickup_id=R1585NAHY276BR4&order_id_crm=MYSIM_103827&subscription_id=2203846&business_process=UNSUBSCRIPTION&identity_document_id=12345678Z&product_identifier=RM58AV3N2&product_code=P0000001&product_subscription_device_id=1123456789&from_order_date=2021-05-24T09%3A00%3A00Z&to_order_date=2021-05-25T09%3A00%3A00Z' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Create a new pickup order
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
Information needed to create a new Order
{
"order": {
"subscription_id": "2203846",
"pickup_id": "P0000001",
"order_id_external": "YG24011009607",
"order_id_crm": "4640528",
"language": "ES",
"business_process": "UNSUBSCRIPTION",
"reason": "Unsubscription",
"delivery_type": "AGENCY",
"access_reused": true,
"blocked": false
},
"data_sales": {
"agent": "RETEN001",
"channel": "TELE_SALE_CARE",
"type": "NEW_SALE",
"group": "POS"
},
"client": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"shipping": {
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
},
"contact_data": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"transport_data": {
"courier_id": "CORREOS",
"delivery_service": "DELIVERY_24",
"exclusive": true,
"verify_identity": false,
"retrieve_contract": false,
"secure_delivery": false,
"delivery_point_id": "SEUR-1234",
"delivery_shop_name": "Mas Life Plaza España",
"return_code": "A1234",
"delivery_type": "AGENCY"
}
},
"products": [
{
"product_code": "RM58AV3N2",
"product_description": "Caja de voz Ad Hoc v3",
"product_type": "STB",
"product_type_id": 16,
"identifier": "822339400182",
"msisdn": "666666666",
"subscription_device_id": "40397",
"technology": "FTTH",
"status": "CREATED"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
order* | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data_sales | object | Information related to sales associated with the order | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client* | object | Object with client data | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shipping* | object | Shipping information for a pickup | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
products* | object[] | Info about the pickup Product | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OK Success
{
"order": {
"subscription_id": "2203846",
"pickup_id": "P0000001",
"order_id_external": "YG24011009607",
"order_id_crm": "4640528",
"language": "ES",
"business_process": "UNSUBSCRIPTION",
"reason": "Unsubscription",
"delivery_type": "AGENCY",
"access_reused": true,
"blocked": false
},
"data_sales": {
"agent": "RETEN001",
"channel": "TELE_SALE_CARE",
"type": "NEW_SALE",
"group": "POS"
},
"client": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"shipping": {
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
},
"contact_data": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"transport_data": {
"courier_id": "CORREOS",
"delivery_service": "DELIVERY_24",
"exclusive": true,
"verify_identity": false,
"retrieve_contract": false,
"secure_delivery": false,
"delivery_point_id": "SEUR-1234",
"delivery_shop_name": "Mas Life Plaza España",
"return_code": "A1234",
"delivery_type": "AGENCY"
}
},
"products": [
{
"product_code": "RM58AV3N2",
"product_description": "Caja de voz Ad Hoc v3",
"product_type": "STB",
"product_type_id": 16,
"identifier": "822339400182",
"msisdn": "666666666",
"subscription_device_id": "40397",
"technology": "FTTH",
"status": "CREATED"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
order* | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data_sales | object | Information related to sales associated with the order | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client* | object | Object with client data | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shipping* | object | Shipping information for a pickup | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
products* | object[] | Info about the pickup Product | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X POST 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/pickups' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"order": {
"subscription_id": "2203846",
"pickup_id": "P0000001",
"order_id_external": "YG24011009607",
"order_id_crm": "4640528",
"language": "ES",
"business_process": "UNSUBSCRIPTION",
"reason": "Unsubscription",
"delivery_type": "AGENCY",
"access_reused": true,
"blocked": false
},
"data_sales": {
"agent": "RETEN001",
"channel": "TELE_SALE_CARE",
"type": "NEW_SALE",
"group": "POS"
},
"client": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"shipping": {
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
},
"contact_data": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"transport_data": {
"courier_id": "CORREOS",
"delivery_service": "DELIVERY_24",
"exclusive": true,
"verify_identity": false,
"retrieve_contract": false,
"secure_delivery": false,
"delivery_point_id": "SEUR-1234",
"delivery_shop_name": "Mas Life Plaza España",
"return_code": "A1234",
"delivery_type": "AGENCY"
}
},
"products": [
{
"product_code": "RM58AV3N2",
"product_description": "Caja de voz Ad Hoc v3",
"product_type": "STB",
"product_type_id": 16,
"identifier": "822339400182",
"msisdn": "666666666",
"subscription_device_id": "40397",
"technology": "FTTH",
"status": "CREATED"
}
]
}'Get a new pickup order
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
Internal logistics pickup id
OK Success
{
"order": {
"subscription_id": "2203846",
"pickup_id": "P0000001",
"order_id_external": "YG24011009607",
"order_id_crm": "4640528",
"language": "ES",
"business_process": "UNSUBSCRIPTION",
"reason": "Unsubscription",
"delivery_type": "AGENCY",
"access_reused": true,
"blocked": false
},
"data_sales": {
"agent": "RETEN001",
"channel": "TELE_SALE_CARE",
"type": "NEW_SALE",
"group": "POS"
},
"client": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"shipping": {
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
},
"contact_data": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"transport_data": {
"courier_id": "CORREOS",
"delivery_service": "DELIVERY_24",
"exclusive": true,
"verify_identity": false,
"retrieve_contract": false,
"secure_delivery": false,
"delivery_point_id": "SEUR-1234",
"delivery_shop_name": "Mas Life Plaza España",
"return_code": "A1234",
"delivery_type": "AGENCY"
}
},
"products": [
{
"product_code": "RM58AV3N2",
"product_description": "Caja de voz Ad Hoc v3",
"product_type": "STB",
"product_type_id": 16,
"identifier": "822339400182",
"msisdn": "666666666",
"subscription_device_id": "40397",
"technology": "FTTH",
"status": "CREATED"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
order* | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data_sales | object | Information related to sales associated with the order | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client* | object | Object with client data | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shipping* | object | Shipping information for a pickup | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
products* | object[] | Info about the pickup Product | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X GET 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/pickups/888888-A9293' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Request to cancel a pickup
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
Internal logistics pickup id
Information needed to create a cancellation request
{
"reason": "DUPLICATE"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
reason | string | The reason of the cancellation. |
OK Success
{
"reason": "DUPLICATE"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
reason | string | The reason of the cancellation. |
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X POST 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/pickups/R010000001/cancellation' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"reason": "DUPLICATE"
}'Request to get the products of a pickup
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
Internal logistics pickup id
QUERY PARAMETERS
Page size
Page number
OK Success
{
"page_size": 123,
"total_pages": 10,
"current_page": 1,
"total_elements": 3000,
"products": [
{
"product_id": "40397",
"product_code": "RM58AV3N2",
"product_description": "Caja de voz Ad Hoc v3",
"product_type": "ROUTER",
"product_type_id": 16,
"product_unit_price": 16.5,
"icc_imei": "string",
"identifier": "string",
"quantity": 1,
"product_comments": "string",
"msisdn": "666666666",
"financed": true,
"subscription_device_id": "40397",
"remaining_payment": 20.5,
"invoiced": true,
"status": "CREATED",
"associated_expedition": {
"expedition_id": "a13a4674f6547447ff1f8813f33b5a90f6616ec2514e3f6e162acc5b88e9cfcb-R0",
"current_status": {
"id": null,
"value": null,
"description": null,
"final": null,
"reshippable": null,
"reason_code": null,
"reason_description": null,
"timestamp": null
}
}
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
page_size | integer | Page size | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_pages | integer | Total pages for page size | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
current_page | integer | Current page | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_elements | integer | Total element | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
products | object[] | Info about the product with the expedition | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X GET 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/pickups/888888-A9293/products?size=100&page=1' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Request to get one specific product of a pickup
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
Internal logistics pickup id
Product id, usually subscription_device_id
OK Success
{
"product_id": "40397",
"product_code": "RM58AV3N2",
"product_description": "Caja de voz Ad Hoc v3",
"product_type": "ROUTER",
"product_type_id": 16,
"product_unit_price": 16.5,
"icc_imei": "string",
"identifier": "string",
"quantity": 1,
"product_comments": "string",
"msisdn": "666666666",
"financed": true,
"subscription_device_id": "40397",
"remaining_payment": 20.5,
"invoiced": true,
"status": "CREATED",
"associated_expedition": {
"expedition_id": "a13a4674f6547447ff1f8813f33b5a90f6616ec2514e3f6e162acc5b88e9cfcb-R0",
"current_status": {
"id": "1",
"value": "DELIVERED",
"description": "Order delivered to the client",
"final": false,
"reshippable": false,
"reason_code": "",
"reason_description": "",
"timestamp": "2023-05-02 11:00:09"
}
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
product_id | string | The product id in MasLogistics domain, usually suscription_device_id. (Read only parameter, only for GET requests) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
product_code* | string | Product code | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
product_description | string | Product description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
product_type | string
()
STBTERMINALROUTERSIMGENERICSMART_TVSMARTHOME | The product type. It is mandatory when using generic product_code | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
product_type_id | integer | Product Type Id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
product_unit_price | number | Product Unit price | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
icc_imei | string | Product imei | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
identifier | string | The physical product identifier, usually SerialNumber/MAC/IMEI. (Read only parameter, only for GET requests) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
quantity | integer | Product quantity | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
product_comments | string | Product comments | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
msisdn | string | MSISDN associated | pattern: ^\d{9} | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
financed | boolean | Is product financed | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subscription_device_id* | string | Identifier of an internal order in mas stack | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
remaining_payment | number | Remaining payment amount to pay on delivery | max: 999.99 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoiced | boolean | If this value is false it indicates that the product is on lease if it is true it is on sale and we should have the data_invoice info. | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string
()
CREATEDDISCARDED | The status of the product. (Read only parameter, only for GET requests) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
associated_expedition | object | Associated expedition info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X GET 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/pickups/888888-A9293/products/888888-A9293' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Unblocks a previously blocked pickup and forwards it to the logistics operator if any products are in CREATED acceptance status
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
Internal logistics pickup id
OK Success
{
"order": {
"subscription_id": "2203846",
"pickup_id": "P0000001",
"order_id_external": "YG24011009607",
"order_id_crm": "4640528",
"language": "ES",
"business_process": "UNSUBSCRIPTION",
"reason": "Unsubscription",
"delivery_type": "AGENCY",
"access_reused": true,
"blocked": false
},
"data_sales": {
"agent": "RETEN001",
"channel": "TELE_SALE_CARE",
"type": "NEW_SALE",
"group": "POS"
},
"client": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"shipping": {
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
},
"contact_data": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"transport_data": {
"courier_id": "CORREOS",
"delivery_service": "DELIVERY_24",
"exclusive": true,
"verify_identity": false,
"retrieve_contract": false,
"secure_delivery": false,
"delivery_point_id": "SEUR-1234",
"delivery_shop_name": "Mas Life Plaza España",
"return_code": "A1234",
"delivery_type": "AGENCY"
}
},
"products": [
{
"product_code": "RM58AV3N2",
"product_description": "Caja de voz Ad Hoc v3",
"product_type": "STB",
"product_type_id": 16,
"identifier": "822339400182",
"msisdn": "666666666",
"subscription_device_id": "40397",
"technology": "FTTH",
"status": "CREATED"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
order* | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data_sales | object | Information related to sales associated with the order | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client* | object | Object with client data | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shipping* | object | Shipping information for a pickup | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
products* | object[] | Info about the pickup Product | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X POST 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/pickups/888888-A9293/unblock' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Request to get all communications sent for a pickup
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
Internal logistics pickup id
QUERY PARAMETERS
Page size
Page number
OK Success
{
"page_size": 123,
"total_pages": 10,
"current_page": 1,
"total_elements": 3000,
"communications": [
{
"order_communication_id": "oc-123e4567-e89b-12d3-a456-426614174000",
"order_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"communication_id": "comm-789",
"trigger_communication_id": "trigger-123",
"external_communication_id": "ext-comm-456",
"template_id": "template-012",
"sent": true,
"reason": "order_created",
"event": "ORDER_CREATED",
"sent_at": "2023-11-25T10:30:00Z"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
page_size | integer | Page size | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_pages | integer | Total pages for page size | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
current_page | integer | Current page | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_elements | integer | Total element | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
communications | object[] | Communications sent for the order | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X GET 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/pickups/888888-A9293/communications?size=100&page=1' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get swaps
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
QUERY PARAMETERS
Page size
Page number
Order id in MasLogistics domain
Business process
From order date in ISO 8601 format. Example: 2021-05-24T09:00:00Z
To order date in ISO 8601 format. Example: 2021-05-24T09:00:00Z
Sort value, multiple values allowed, separate with coma
OK Success
{
"page_size": 123,
"total_pages": 10,
"current_page": 1,
"total_elements": 3000,
"orders": [
{
"swap": {
"swap_id": "S01ABC123DEF456G",
"swap_id_crm": "4640528",
"subscription_id": "2203846",
"business_process": "SWAP",
"expedition_type": "SINGLE_EXPEDITION",
"reason": "Extraordinary swap due to bad condition product delivered",
"language": "ES"
},
"order": {
"order_id": "E01ABC123DEF456G",
"order_id_external": "484543418",
"business_process": "SWAP"
},
"pickup": {
"pickup_id": "R01ABC123DEF456G",
"order_id_external": "YG24011009607",
"business_process": "BREAKDOWN_PICKUP"
},
"client": {
"identity": {
"document_id": null,
"document_type": null
},
"contact_phone": {
"phone_number": null,
"prefix": null
},
"name": "Juan",
"surnames": [
null
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": null,
"street": null,
"number": null,
"additional_details": null,
"city": null,
"zip_code": null,
"province": null,
"country": null,
"bis": null,
"floor": null,
"block": null,
"stair": null,
"letter": null
}
},
"shipping": {
"delivery": {
"address": null,
"contact_data": null,
"data_delivery": null
},
"pickup": {
"address": null,
"contact_data": null,
"transport_data": null
}
}
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
page_size | integer | Page size | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_pages | integer | Total pages for page size | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
current_page | integer | Current page | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_elements | integer | Total element | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
orders | object[] | List of Swaps | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X GET 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/swaps?size=100&page=1&swap_id=E1585NAHY276BR4&business_process=SWAP&from_order_date=2021-05-24T09%3A00%3A00Z&to_order_date=2021-05-25T09%3A00%3A00Z' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Create a new swap
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
Information needed to create a new Order
{
"swap": {
"swap_id": "S01ABC123DEF456G",
"swap_id_crm": "4640528",
"subscription_id": "2203846",
"business_process": "SWAP",
"expedition_type": "SINGLE_EXPEDITION",
"reason": "Extraordinary swap due to bad condition product delivered",
"language": "ES"
},
"client": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"shipping": {
"delivery": {
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
},
"contact_data": {
"identity": {
"document_id": null,
"document_type": null
},
"contact_phone": {
"phone_number": null,
"prefix": null
},
"name": "Juan",
"surnames": [
null
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": null,
"street": null,
"number": null,
"additional_details": null,
"city": null,
"zip_code": null,
"province": null,
"country": null,
"bis": null,
"floor": null,
"block": null,
"stair": null,
"letter": null
}
},
"data_delivery": {
"courier_id": "CORREOS",
"delivery_service": "DELIVERY_24",
"exclusive": true,
"verify_identity": false,
"retrieve_contract": false,
"group_by": "string",
"secure_delivery": false,
"delivery_point_id": "SEUR-1234",
"delivery_shop_name": "Mas Life Plaza España",
"delivery_type": "AGENCY",
"ol_comments": "ONT password"
}
},
"pickup": {
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
},
"contact_data": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"transport_data": {
"courier_id": "CORREOS",
"delivery_service": "DELIVERY_24",
"exclusive": true,
"verify_identity": false,
"retrieve_contract": false,
"secure_delivery": false,
"delivery_point_id": "SEUR-1234",
"delivery_shop_name": "Mas Life Plaza España",
"return_code": "A1234",
"delivery_type": "AGENCY"
}
}
},
"products": {
"delivery": [
{
"product_id": "40397",
"product_code": "RM58AV3N2",
"product_description": "Caja de voz Ad Hoc v3",
"product_type": "ROUTER",
"product_type_id": 16,
"product_unit_price": 16.5,
"icc_imei": "string",
"identifier": "string",
"quantity": 1,
"product_comments": "string",
"msisdn": "666666666",
"financed": true,
"subscription_device_id": "40397",
"remaining_payment": 20.5,
"invoiced": true,
"status": "CREATED"
}
],
"pickup": [
{
"product_code": "RM58AV3N2",
"product_description": "Caja de voz Ad Hoc v3",
"product_type": "STB",
"product_type_id": 16,
"identifier": "822339400182",
"msisdn": "666666666",
"subscription_device_id": "40397",
"technology": "FTTH",
"status": "CREATED"
}
]
}
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
swap* | object | Main swap data, including ID and essential details | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client* | object | Object with client data | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shipping* | object | Shipping details, including address and delivery info | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
products* | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OK Success
{
"swap": {
"swap_id": "S01ABC123DEF456G",
"swap_id_crm": "4640528",
"subscription_id": "2203846",
"business_process": "SWAP",
"expedition_type": "SINGLE_EXPEDITION",
"reason": "Extraordinary swap due to bad condition product delivered",
"language": "ES"
},
"client": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"shipping": {
"delivery": {
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
},
"contact_data": {
"identity": {
"document_id": null,
"document_type": null
},
"contact_phone": {
"phone_number": null,
"prefix": null
},
"name": "Juan",
"surnames": [
null
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": null,
"street": null,
"number": null,
"additional_details": null,
"city": null,
"zip_code": null,
"province": null,
"country": null,
"bis": null,
"floor": null,
"block": null,
"stair": null,
"letter": null
}
},
"data_delivery": {
"courier_id": "CORREOS",
"delivery_service": "DELIVERY_24",
"exclusive": true,
"verify_identity": false,
"retrieve_contract": false,
"group_by": "string",
"secure_delivery": false,
"delivery_point_id": "SEUR-1234",
"delivery_shop_name": "Mas Life Plaza España",
"delivery_type": "AGENCY",
"ol_comments": "ONT password"
}
},
"pickup": {
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
},
"contact_data": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"transport_data": {
"courier_id": "CORREOS",
"delivery_service": "DELIVERY_24",
"exclusive": true,
"verify_identity": false,
"retrieve_contract": false,
"secure_delivery": false,
"delivery_point_id": "SEUR-1234",
"delivery_shop_name": "Mas Life Plaza España",
"return_code": "A1234",
"delivery_type": "AGENCY"
}
}
},
"products": {
"delivery": [
{
"product_id": "40397",
"product_code": "RM58AV3N2",
"product_description": "Caja de voz Ad Hoc v3",
"product_type": "ROUTER",
"product_type_id": 16,
"product_unit_price": 16.5,
"icc_imei": "string",
"identifier": "string",
"quantity": 1,
"product_comments": "string",
"msisdn": "666666666",
"financed": true,
"subscription_device_id": "40397",
"remaining_payment": 20.5,
"invoiced": true,
"status": "CREATED"
}
],
"pickup": [
{
"product_code": "RM58AV3N2",
"product_description": "Caja de voz Ad Hoc v3",
"product_type": "STB",
"product_type_id": 16,
"identifier": "822339400182",
"msisdn": "666666666",
"subscription_device_id": "40397",
"technology": "FTTH",
"status": "CREATED"
}
]
}
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
swap* | object | Main swap data, including ID and essential details | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client* | object | Object with client data | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shipping* | object | Shipping details, including address and delivery info | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
products* | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X POST 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/swaps' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"swap": {
"swap_id": "S01ABC123DEF456G",
"swap_id_crm": "4640528",
"subscription_id": "2203846",
"business_process": "SWAP",
"expedition_type": "SINGLE_EXPEDITION",
"reason": "Extraordinary swap due to bad condition product delivered",
"language": "ES"
},
"client": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"shipping": {
"delivery": {
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
},
"contact_data": {
"identity": {
"document_id": null,
"document_type": null
},
"contact_phone": {
"phone_number": null,
"prefix": null
},
"name": "Juan",
"surnames": [
null
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": null,
"street": null,
"number": null,
"additional_details": null,
"city": null,
"zip_code": null,
"province": null,
"country": null,
"bis": null,
"floor": null,
"block": null,
"stair": null,
"letter": null
}
},
"data_delivery": {
"courier_id": "CORREOS",
"delivery_service": "DELIVERY_24",
"exclusive": true,
"verify_identity": false,
"retrieve_contract": false,
"group_by": "string",
"secure_delivery": false,
"delivery_point_id": "SEUR-1234",
"delivery_shop_name": "Mas Life Plaza España",
"delivery_type": "AGENCY",
"ol_comments": "ONT password"
}
},
"pickup": {
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
},
"contact_data": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"transport_data": {
"courier_id": "CORREOS",
"delivery_service": "DELIVERY_24",
"exclusive": true,
"verify_identity": false,
"retrieve_contract": false,
"secure_delivery": false,
"delivery_point_id": "SEUR-1234",
"delivery_shop_name": "Mas Life Plaza España",
"return_code": "A1234",
"delivery_type": "AGENCY"
}
}
},
"products": {
"delivery": [
{
"product_id": "40397",
"product_code": "RM58AV3N2",
"product_description": "Caja de voz Ad Hoc v3",
"product_type": "ROUTER",
"product_type_id": 16,
"product_unit_price": 16.5,
"icc_imei": "string",
"identifier": "string",
"quantity": 1,
"product_comments": "string",
"msisdn": "666666666",
"financed": true,
"subscription_device_id": "40397",
"remaining_payment": 20.5,
"invoiced": true,
"status": "CREATED"
}
],
"pickup": [
{
"product_code": "RM58AV3N2",
"product_description": "Caja de voz Ad Hoc v3",
"product_type": "STB",
"product_type_id": 16,
"identifier": "822339400182",
"msisdn": "666666666",
"subscription_device_id": "40397",
"technology": "FTTH",
"status": "CREATED"
}
]
}
}'Get a swap
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
Internal logistics swap id
OK Success
{
"swap": {
"swap_id": "S01ABC123DEF456G",
"swap_id_crm": "4640528",
"subscription_id": "2203846",
"business_process": "SWAP",
"expedition_type": "SINGLE_EXPEDITION",
"reason": "Extraordinary swap due to bad condition product delivered",
"language": "ES"
},
"order": {
"order_id": "E01ABC123DEF456G",
"order_id_external": "484543418",
"business_process": "SWAP"
},
"pickup": {
"pickup_id": "R01ABC123DEF456G",
"order_id_external": "YG24011009607",
"business_process": "BREAKDOWN_PICKUP"
},
"client": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"shipping": {
"delivery": {
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
},
"contact_data": {
"identity": {
"document_id": null,
"document_type": null
},
"contact_phone": {
"phone_number": null,
"prefix": null
},
"name": "Juan",
"surnames": [
null
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": null,
"street": null,
"number": null,
"additional_details": null,
"city": null,
"zip_code": null,
"province": null,
"country": null,
"bis": null,
"floor": null,
"block": null,
"stair": null,
"letter": null
}
},
"data_delivery": {
"courier_id": "CORREOS",
"delivery_service": "DELIVERY_24",
"exclusive": true,
"verify_identity": false,
"retrieve_contract": false,
"group_by": "string",
"secure_delivery": false,
"delivery_point_id": "SEUR-1234",
"delivery_shop_name": "Mas Life Plaza España",
"delivery_type": "AGENCY",
"ol_comments": "ONT password"
}
},
"pickup": {
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
},
"contact_data": {
"identity": {
"document_id": "00000000A",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666666666",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "Pedro",
"address": {
"street_type": "Calle",
"street": "Mayor",
"number": "208",
"additional_details": "string",
"city": "Leganes",
"zip_code": "28912",
"province": "Madrid",
"country": "es",
"bis": "string",
"floor": "string",
"block": "string",
"stair": "string",
"letter": "string"
}
},
"transport_data": {
"courier_id": "CORREOS",
"delivery_service": "DELIVERY_24",
"exclusive": true,
"verify_identity": false,
"retrieve_contract": false,
"secure_delivery": false,
"delivery_point_id": "SEUR-1234",
"delivery_shop_name": "Mas Life Plaza España",
"return_code": "A1234",
"delivery_type": "AGENCY"
}
}
}
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
swap* | object | Main swap data, including ID and essential details | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
order | object | Main order data, including ID and essential details | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pickup | object | Pickup data, only available to swaps with expedition_type DOUBLE_EXPEDITION | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
client | object | Object with client data | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shipping | object | Shipping details, including address and delivery info | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X GET 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/swaps/S01ABC123DEF456G' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Request to get the products of a swap
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
Internal logistics swap id
QUERY PARAMETERS
Page size
Page number
OK Success
{
"page_size": 123,
"total_pages": 10,
"current_page": 1,
"total_elements": 3000,
"products": [
{
"product_id": "40397",
"product_code": "RM58AV3N2",
"product_description": "Caja de voz Ad Hoc v3",
"product_type": "ROUTER",
"product_type_id": 16,
"product_unit_price": 16.5,
"icc_imei": "string",
"identifier": "string",
"quantity": 1,
"product_comments": "string",
"msisdn": "666666666",
"financed": true,
"subscription_device_id": "40397",
"remaining_payment": 20.5,
"invoiced": true,
"status": "CREATED",
"associated_expedition": {
"expedition_id": "a13a4674f6547447ff1f8813f33b5a90f6616ec2514e3f6e162acc5b88e9cfcb-R0",
"current_status": {
"id": null,
"value": null,
"description": null,
"final": null,
"reshippable": null,
"reason_code": null,
"reason_description": null,
"timestamp": null
}
},
"swap_mode": "DELIVERED"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
page_size | integer | Page size | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_pages | integer | Total pages for page size | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
current_page | integer | Current page | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_elements | integer | Total element | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
products | object[] | Info about the product with the expedition | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X GET 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/swaps/S01ABC123DEF456G/products?size=100&page=1' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Request to get one specific product of a swap
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
Internal logistics swap id
Product id, usually subscription_device_id
OK Success
{
"product_id": "40397",
"product_code": "RM58AV3N2",
"product_description": "Caja de voz Ad Hoc v3",
"product_type": "ROUTER",
"product_type_id": 16,
"product_unit_price": 16.5,
"icc_imei": "string",
"identifier": "string",
"quantity": 1,
"product_comments": "string",
"msisdn": "666666666",
"financed": true,
"subscription_device_id": "40397",
"remaining_payment": 20.5,
"invoiced": true,
"status": "CREATED",
"associated_expedition": {
"expedition_id": "a13a4674f6547447ff1f8813f33b5a90f6616ec2514e3f6e162acc5b88e9cfcb-R0",
"current_status": {
"id": "1",
"value": "DELIVERED",
"description": "Order delivered to the client",
"final": false,
"reshippable": false,
"reason_code": "",
"reason_description": "",
"timestamp": "2023-05-02 11:00:09"
}
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
product_id | string | The product id in MasLogistics domain, usually suscription_device_id. (Read only parameter, only for GET requests) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
product_code* | string | Product code | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
product_description | string | Product description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
product_type | string
()
STBTERMINALROUTERSIMGENERICSMART_TVSMARTHOME | The product type. It is mandatory when using generic product_code | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
product_type_id | integer | Product Type Id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
product_unit_price | number | Product Unit price | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
icc_imei | string | Product imei | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
identifier | string | The physical product identifier, usually SerialNumber/MAC/IMEI. (Read only parameter, only for GET requests) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
quantity | integer | Product quantity | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
product_comments | string | Product comments | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
msisdn | string | MSISDN associated | pattern: ^\d{9} | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
financed | boolean | Is product financed | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subscription_device_id* | string | Identifier of an internal order in mas stack | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
remaining_payment | number | Remaining payment amount to pay on delivery | max: 999.99 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoiced | boolean | If this value is false it indicates that the product is on lease if it is true it is on sale and we should have the data_invoice info. | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status | string
()
CREATEDDISCARDED | The status of the product. (Read only parameter, only for GET requests) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
associated_expedition | object | Associated expedition info | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X GET 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/swaps/S01ABC123DEF456G/products/1234567890' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Request to get expeditions
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
QUERY PARAMETERS
Page size
Page number
Sort value, multiple values allowed, separte with coma
Date from (min) the creation of the expedition in ISO 8601 format and UTC
Date to (max) the creation of the expedition in ISO 8601 format and UTC
Filter expeditions by order ID. Returns expeditions that contain at least one product from this order, including ALL products in those expeditions.
OK Success
{
"page_size": 123,
"total_pages": 10,
"current_page": 1,
"total_elements": 3000,
"expeditions": [
{
"expedition_id": "a13a4674f6547447ff1f8813f33b5a90f6616ec2514e3f6e162acc5b88e9cfcb-R0",
"created_date": "2023-11-26",
"transport": {
"courier_id": "CORREOS",
"delivery_service": "DELIVERY_24",
"verify_identity": false
},
"tracking": {
"tracking_link": "http://gls.es/111",
"return_code": "1029373622"
},
"status_history": [
{
"id": null,
"value": null,
"description": null,
"final": null,
"reshippable": null,
"reason_code": null,
"reason_description": null,
"timestamp": null
}
],
"products": [
{
"product_id": null,
"product_code": null,
"product_description": null,
"product_type": null,
"product_type_id": null,
"product_unit_price": null,
"icc_imei": null,
"identifier": null,
"quantity": null,
"product_comments": null,
"msisdn": null,
"financed": null,
"subscription_device_id": null,
"remaining_payment": null,
"invoiced": null,
"status": null,
"order_id": null
}
]
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
page_size | integer | Page size | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_pages | integer | Total pages for page size | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
current_page | integer | Current page | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_elements | integer | Total element | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
expeditions | object[] | Info about the Expeditions | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X GET 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/expeditions?size=100&page=1&from=2021-03-24T13%3A31%3A16.425Z&to=2021-03-24T13%3A31%3A16.425Z&order_id=order-12345' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Request to get an expedition
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
Internal logistics expedition id
OK Success
{
"expedition_id": "a13a4674f6547447ff1f8813f33b5a90f6616ec2514e3f6e162acc5b88e9cfcb-R0",
"created_date": "2023-11-26",
"transport": {
"courier_id": "CORREOS",
"delivery_service": "DELIVERY_24",
"verify_identity": false
},
"tracking": {
"tracking_link": "http://gls.es/111",
"return_code": "1029373622"
},
"status_history": [
{
"id": "1",
"value": "DELIVERED",
"description": "Order delivered to the client",
"final": false,
"reshippable": false,
"reason_code": "",
"reason_description": "",
"timestamp": "2023-05-02 11:00:09"
}
],
"products": [
{
"product_id": "40397",
"product_code": "RM58AV3N2",
"product_description": "Caja de voz Ad Hoc v3",
"product_type": "ROUTER",
"product_type_id": 16,
"product_unit_price": 16.5,
"icc_imei": "string",
"identifier": "string",
"quantity": 1,
"product_comments": "string",
"msisdn": "666666666",
"financed": true,
"subscription_device_id": "40397",
"remaining_payment": 20.5,
"invoiced": true,
"status": "CREATED",
"order_id": "order-12345"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
expedition_id | string | Expedition id | minLength: 0, maxLength: 200 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
created_date | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transport | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tracking | object | Info about the tracking of the order | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status_history | object[] | List of status | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
products | object[] | List of products | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X GET 'https://logistics.sta.masstack.com/v2/orgs/yoigo/core/expeditions/a13a4674f6547447ff1f8813f33b5a90f6616ec2514e3f6e162acc5b88e9cfcb-R0' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Update a status order by ID for an external logistic operator
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
Information needed to send a status order update
{
"order_id_external": "12334567",
"expedition_id_external": "12334567",
"reexpedition": "R0",
"order_date": "2021-03-24T13:31:16.425Z",
"logistics_operator": "INTERBOX",
"delivery_type": "HOME",
"process_type": "SWAP",
"logistic_operation": "DELIVERY",
"portability": true,
"business": "string",
"status": {
"id": "3",
"description": "Description about status",
"timestamp": "2021-05-24T09:00:00Z",
"reason": {
"code": "INCOMPLETE",
"description": "Missing components or equipment"
}
},
"journeys": [
{
"devices": [
{
"subscription": null,
"type": null,
"reference": null,
"replacement": null,
"identifier": null,
"additional_identifier": null,
"active": null,
"subscription_device_id": null,
"price": null
}
],
"transport": {
"delivery_details": {
"package": {
"weight": null,
"dimensions": null
},
"coverage": true,
"secure_delivery": false,
"remaining_payment": {
"total": null,
"currency": null
},
"recipient_verification": {
"exclusive_delivery": null,
"verification": null
}
},
"delivery_date": "2025-11-10",
"courier": "CORREOS",
"service": "24h",
"tracking_link": "https://www.trackinglink.com/trackinglink/38383",
"expedition_number": "28272272722",
"delivery_note": {
"delivery_note_id": "111222333444",
"link": "https://www.gls.com/deliverynotelink/38383"
}
}
}
],
"documentation_only": true,
"documentation": [
{
"preprinted": true,
"total_pages": 10,
"documents": [
{
"recipient": "CLIENT",
"document_type": "WL",
"quantity": 1
}
]
}
],
"customer_delivering_info": {
"address": {
"building_street_type": "Calle",
"building_street_name": "Mayor",
"building_number": "208",
"building_floor": "A",
"building_others": "string",
"city": "Leganes",
"zipcode": "28912",
"region": "Madrid",
"country": "ES"
},
"client": {
"identity": {
"document_id": "00557788T",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666777888",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "BUSINESS SA"
},
"language": "ES",
"updated": true
}
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
order_id_external* | string | External order identifier generated by the logistics operator (For example, the MasLola id). Must be constant for the same order | minLength: 1, maxLength: 256 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
expedition_id_external | string | External expedition identifier generated by the logistics operator (For example, the EuroLogistics id). It may change during the order process | minLength: 1, maxLength: 256 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reexpedition* | string | Reexpedition identifier | minLength: 1, maxLength: 3 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
order_date | string | Order date in ISO 8601 format and UTC | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
logistics_operator | string
()
INTERBOXANOVOEUROLOGISTICADHLCEX | logistic operator | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
delivery_type* | string
()
HOMEAGENCYSHOPCOURIER | Delivery type. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
process_type | string
()
SWAPPEDIDOBAJADESISTIMIENTOCANCELACIONFIXDOAFINALPAYMENTBREAKDOWN_DELIVERYBREAKDOWN_PICKUPMIGRATION_DELIVERYMIGRATION_PICKUPCANCELLATION_SHOP | Logistics process type. | minLength: 1, maxLength: 40 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
logistic_operation | string
()
DELIVERYPICKUP | Logistic operation. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
portability | boolean | order with associated portability | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
business | string | Business name | minLength: 0, maxLength: 50 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status* | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
journeys* | object[] | minItems: 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
documentation_only | boolean | order with only documentation | false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
documentation | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customer_delivering_info | object | Customer delivering information. Mandatory if the order is not present or if the customer delivering info has been changed from last status (Marked as updated). | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OK Success
{
"code": 0,
"subcode": 0,
"message": "Operation executed correctly."
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | number | |||
subcode | number | |||
message | string |
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X POST 'https://logistics.sta.masstack.com/v2/orgs/yoigo/external/status' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"order_id_external": "12334567",
"expedition_id_external": "12334567",
"reexpedition": "R0",
"order_date": "2021-03-24T13:31:16.425Z",
"logistics_operator": "INTERBOX",
"delivery_type": "HOME",
"process_type": "SWAP",
"logistic_operation": "DELIVERY",
"portability": true,
"business": "string",
"status": {
"id": "3",
"description": "Description about status",
"timestamp": "2021-05-24T09:00:00Z",
"reason": {
"code": "INCOMPLETE",
"description": "Missing components or equipment"
}
},
"journeys": [
{
"devices": [
{
"subscription": null,
"type": null,
"reference": null,
"replacement": null,
"identifier": null,
"additional_identifier": null,
"active": null,
"subscription_device_id": null,
"price": null
}
],
"transport": {
"delivery_details": {
"package": {
"weight": null,
"dimensions": null
},
"coverage": true,
"secure_delivery": false,
"remaining_payment": {
"total": null,
"currency": null
},
"recipient_verification": {
"exclusive_delivery": null,
"verification": null
}
},
"delivery_date": "2025-11-10",
"courier": "CORREOS",
"service": "24h",
"tracking_link": "https://www.trackinglink.com/trackinglink/38383",
"expedition_number": "28272272722",
"delivery_note": {
"delivery_note_id": "111222333444",
"link": "https://www.gls.com/deliverynotelink/38383"
}
}
}
],
"documentation_only": true,
"documentation": [
{
"preprinted": true,
"total_pages": 10,
"documents": [
{
"recipient": "CLIENT",
"document_type": "WL",
"quantity": 1
}
]
}
],
"customer_delivering_info": {
"address": {
"building_street_type": "Calle",
"building_street_name": "Mayor",
"building_number": "208",
"building_floor": "A",
"building_others": "string",
"city": "Leganes",
"zipcode": "28912",
"region": "Madrid",
"country": "ES"
},
"client": {
"identity": {
"document_id": "00557788T",
"document_type": "NIF"
},
"contact_phone": {
"phone_number": "666777888",
"prefix": "+34"
},
"name": "Juan",
"surnames": [
"Perez"
],
"email": "example@gmail.com",
"commercial_name": "BUSINESS SA"
},
"language": "ES",
"updated": true
}
}'Notify a device picking to an order by ID for an external logisgic operator
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
Information needed to send a device
{
"subscription": {
"subscription_id": "SUBS-ID",
"order_id": "CRM-ID",
"msisdn": "666777888"
},
"type": {
"action_id": "1",
"family_id": "17",
"id": "ROUTER"
},
"reference": "8U8474JE3748",
"replacement": "Y",
"identifier": "10C25AD5580A",
"additional_identifier": "string",
"active": true,
"subscription_device_id": "XXXXXXXXX",
"price": {
"markup": {
"total": 24.5,
"currency": "EUR"
},
"no_markup": {
"total": 24.5,
"currency": "EUR"
}
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
subscription* | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reference | string | Device reference | minLength: 0, maxLength: 256 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
replacement | string | replacement , posible values "Y" or "N" | minLength: 0, maxLength: 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
identifier* | string | Device's identifier | minLength: 0, maxLength: 256 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
additional_identifier | string | Additional identifier, if exists | minLength: 0, maxLength: 256 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
active | boolean | The flag will be true if the device has been delivered and false if it has been collected | true | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subscription_device_id | string | Subscription device Id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
price | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OK Success
{
"code": 0,
"subcode": 0,
"message": "Operation executed correctly."
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
code | number | |||
subcode | number | |||
message | string |
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X POST 'https://logistics.sta.masstack.com/v2/orgs/yoigo/external/devices' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"subscription": {
"subscription_id": "SUBS-ID",
"order_id": "CRM-ID",
"msisdn": "666777888"
},
"type": {
"action_id": "1",
"family_id": "17",
"id": "ROUTER"
},
"reference": "8U8474JE3748",
"replacement": "Y",
"identifier": "10C25AD5580A",
"additional_identifier": "string",
"active": true,
"subscription_device_id": "XXXXXXXXX",
"price": {
"markup": {
"total": 24.5,
"currency": "EUR"
},
"no_markup": {
"total": 24.5,
"currency": "EUR"
}
}
}'Get a list of obsolescence records for an organization with pagination support
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
QUERY PARAMETERS
Page size
Page number
OK Success
{
"page_size": 123,
"total_pages": 10,
"current_page": 1,
"total_elements": 3000,
"obsolescences": [
{
"reference": "DEV-1234",
"obsolete": true,
"breakdowns_maximum": 3,
"days_obsolescence": 365
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
page_size | integer | Page size | |||||||||||||||||||||||||||
total_pages | integer | Total pages for page size | |||||||||||||||||||||||||||
current_page | integer | Current page | |||||||||||||||||||||||||||
total_elements | integer | Total element | |||||||||||||||||||||||||||
obsolescences | object[] | ||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X GET 'https://logistics.sta.masstack.com/v2/orgs/yoigo/management/obsolescence?size=100&page=1' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'create a new obsolescence
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
{
"reference": "DEV-1234",
"obsolete": true,
"breakdowns_maximum": 3,
"days_obsolescence": 365
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
reference* | string | Unique reference identifier (primary key) | maxLength: 256 | |
obsolete | boolean | null | Whether the device is considered obsolete | ||
breakdowns_maximum | integer (int32) | null | Maximum number of breakdowns allowed before considering obsolete | ||
days_obsolescence | integer (int32) | null | Number of days since creation to mark as obsolete |
Created Obsolescence record created
{
"reference": "DEV-1234",
"obsolete": true,
"breakdowns_maximum": 3,
"days_obsolescence": 365
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
reference* | string | Unique reference identifier (primary key) | maxLength: 256 | |
obsolete | boolean | null | Whether the device is considered obsolete | ||
breakdowns_maximum | integer (int32) | null | Maximum number of breakdowns allowed before considering obsolete | ||
days_obsolescence | integer (int32) | null | Number of days since creation to mark as obsolete |
curl -X POST 'https://logistics.sta.masstack.com/v2/orgs/yoigo/management/obsolescence' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"reference": "DEV-1234",
"obsolete": true,
"breakdowns_maximum": 3,
"days_obsolescence": 365
}'Get obsolescence record by reference
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
OK Obsolescence record found
{
"reference": "DEV-1234",
"obsolete": true,
"breakdowns_maximum": 3,
"days_obsolescence": 365
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
reference* | string | Unique reference identifier (primary key) | maxLength: 256 | |
obsolete | boolean | null | Whether the device is considered obsolete | ||
breakdowns_maximum | integer (int32) | null | Maximum number of breakdowns allowed before considering obsolete | ||
days_obsolescence | integer (int32) | null | Number of days since creation to mark as obsolete |
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X GET 'https://logistics.sta.masstack.com/v2/orgs/yoigo/management/obsolescence/:reference' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Update obsolescence
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
{
"reference": "DEV-1234",
"obsolete": true,
"breakdowns_maximum": 3,
"days_obsolescence": 365
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
reference* | string | Unique reference identifier (primary key) | maxLength: 256 | |
obsolete | boolean | null | Whether the device is considered obsolete | ||
breakdowns_maximum | integer (int32) | null | Maximum number of breakdowns allowed before considering obsolete | ||
days_obsolescence | integer (int32) | null | Number of days since creation to mark as obsolete |
OK Obsolescence record updated
{
"reference": "DEV-1234",
"obsolete": true,
"breakdowns_maximum": 3,
"days_obsolescence": 365
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
reference* | string | Unique reference identifier (primary key) | maxLength: 256 | |
obsolete | boolean | null | Whether the device is considered obsolete | ||
breakdowns_maximum | integer (int32) | null | Maximum number of breakdowns allowed before considering obsolete | ||
days_obsolescence | integer (int32) | null | Number of days since creation to mark as obsolete |
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X PUT 'https://logistics.sta.masstack.com/v2/orgs/yoigo/management/obsolescence/:reference' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"reference": "DEV-1234",
"obsolete": true,
"breakdowns_maximum": 3,
"days_obsolescence": 365
}'Delete an obsolescence record and return a confirmation message
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
OK Obsolescence record deleted successfully
{
"message": "Obsolescence record successfully deleted",
"reference": "DEV-1234"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
message | string | |||
reference | string |
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X DELETE 'https://logistics.sta.masstack.com/v2/orgs/yoigo/management/obsolescence/:reference' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get a list of communication configurations for an organization with pagination support
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
QUERY PARAMETERS
Page size
Page number
Filter by trigger uuidStatus
Filter by trigger deliveryType
Filter by documentationOnly flag
OK Success
{
"page_size": 123,
"total_pages": 10,
"current_page": 1,
"total_elements": 3000,
"communications": [
{
"communicationId": 1,
"alias": "order-confirmation",
"description": "Send order confirmation to customer",
"templateId": "TEMPLATE_ORDER_CONFIRMATION",
"notifyChannels": true,
"channels": [
"EMAIL",
"SMS"
],
"maxDelayFromOrderCreation": "PT24H",
"maxDelayFromStatusReport": "PT2H",
"documentationOnly": false,
"tenants": [
"yoigo",
"masmovil"
],
"allowedDevices": [
"DEVICE-123",
"DEVICE-456"
],
"arguments": {
"key": "value"
},
"exclusions": {
"courier": [
"GLS"
]
},
"createDate": "2025-01-15T10:30:00Z",
"updateDate": "2025-01-15T10:30:00Z",
"triggers": [
{
"communicationTriggerId": null,
"communicationId": null,
"uuidStatus": null,
"deliveryTypes": null,
"reminder": null,
"reminderDelay": null,
"arguments": null,
"createDate": null,
"updateDate": null
}
]
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
page_size | integer | Page size | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_pages | integer | Total pages for page size | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
current_page | integer | Current page | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
total_elements | integer | Total element | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
communications | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X GET 'https://logistics.sta.masstack.com/v2/orgs/yoigo/management/communications?size=100&page=1' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Create a new communication configuration with associated trigger states
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
{
"communicationId": 1,
"alias": "order-confirmation",
"description": "Send order confirmation to customer",
"templateId": "TEMPLATE_ORDER_CONFIRMATION",
"notifyChannels": true,
"channels": [
"EMAIL",
"SMS"
],
"maxDelayFromOrderCreation": "PT24H",
"maxDelayFromStatusReport": "PT2H",
"documentationOnly": false,
"tenants": [
"yoigo",
"masmovil"
],
"allowedDevices": [
"DEVICE-123",
"DEVICE-456"
],
"arguments": {
"key": "value"
},
"exclusions": {
"courier": [
"GLS"
]
},
"createDate": "2025-01-15T10:30:00Z",
"updateDate": "2025-01-15T10:30:00Z",
"triggers": [
{
"communicationTriggerId": 1,
"communicationId": 1,
"uuidStatus": "STATUS_DELIVERED",
"deliveryTypes": [
"HOME",
"SHOP"
],
"reminder": true,
"reminderDelay": "PT48H",
"arguments": {
"key": "value"
},
"createDate": "2025-01-15T10:30:00Z",
"updateDate": "2025-01-15T10:30:00Z"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
communicationId | integer (int64) | Unique communication identifier (auto-generated) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
alias* | string | Unique alias for the communication | maxLength: 256 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | Description of the communication | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
templateId* | string | Template identifier from mas-communications | maxLength: 256 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notifyChannels | boolean | null | Whether to notify through specified channels | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
channels | string[] | Communication channels | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
maxDelayFromOrderCreation | string | null | Maximum delay from order creation (ISO-8601 duration format) | pattern: ^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+S)?)?$ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
maxDelayFromStatusReport | string | null | Maximum delay from status report (ISO-8601 duration format) | pattern: ^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+S)?)?$ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
documentationOnly | boolean | null | Whether this communication is for documentation purposes only | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tenants | string[] | List of tenants this communication applies to | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
allowedDevices | string[] | List of device references this communication applies to | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
arguments | object | null | Additional arguments as JSON object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
exclusions | object | null | Exclusion criteria as JSON object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createDate | string (date-time) | Creation timestamp | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updateDate | string (date-time) | Last update timestamp | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
triggers | object[] | List of trigger states associated with this communication | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Created Communication configuration created
{
"communicationId": 1,
"alias": "order-confirmation",
"description": "Send order confirmation to customer",
"templateId": "TEMPLATE_ORDER_CONFIRMATION",
"notifyChannels": true,
"channels": [
"EMAIL",
"SMS"
],
"maxDelayFromOrderCreation": "PT24H",
"maxDelayFromStatusReport": "PT2H",
"documentationOnly": false,
"tenants": [
"yoigo",
"masmovil"
],
"allowedDevices": [
"DEVICE-123",
"DEVICE-456"
],
"arguments": {
"key": "value"
},
"exclusions": {
"courier": [
"GLS"
]
},
"createDate": "2025-01-15T10:30:00Z",
"updateDate": "2025-01-15T10:30:00Z",
"triggers": [
{
"communicationTriggerId": 1,
"communicationId": 1,
"uuidStatus": "STATUS_DELIVERED",
"deliveryTypes": [
"HOME",
"SHOP"
],
"reminder": true,
"reminderDelay": "PT48H",
"arguments": {
"key": "value"
},
"createDate": "2025-01-15T10:30:00Z",
"updateDate": "2025-01-15T10:30:00Z"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
communicationId | integer (int64) | Unique communication identifier (auto-generated) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
alias* | string | Unique alias for the communication | maxLength: 256 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | Description of the communication | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
templateId* | string | Template identifier from mas-communications | maxLength: 256 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notifyChannels | boolean | null | Whether to notify through specified channels | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
channels | string[] | Communication channels | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
maxDelayFromOrderCreation | string | null | Maximum delay from order creation (ISO-8601 duration format) | pattern: ^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+S)?)?$ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
maxDelayFromStatusReport | string | null | Maximum delay from status report (ISO-8601 duration format) | pattern: ^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+S)?)?$ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
documentationOnly | boolean | null | Whether this communication is for documentation purposes only | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tenants | string[] | List of tenants this communication applies to | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
allowedDevices | string[] | List of device references this communication applies to | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
arguments | object | null | Additional arguments as JSON object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
exclusions | object | null | Exclusion criteria as JSON object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createDate | string (date-time) | Creation timestamp | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updateDate | string (date-time) | Last update timestamp | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
triggers | object[] | List of trigger states associated with this communication | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X POST 'https://logistics.sta.masstack.com/v2/orgs/yoigo/management/communications' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"communicationId": 1,
"alias": "order-confirmation",
"description": "Send order confirmation to customer",
"templateId": "TEMPLATE_ORDER_CONFIRMATION",
"notifyChannels": true,
"channels": [
"EMAIL",
"SMS"
],
"maxDelayFromOrderCreation": "PT24H",
"maxDelayFromStatusReport": "PT2H",
"documentationOnly": false,
"tenants": [
"yoigo",
"masmovil"
],
"allowedDevices": [
"DEVICE-123",
"DEVICE-456"
],
"arguments": {
"key": "value"
},
"exclusions": {
"courier": [
"GLS"
]
},
"createDate": "2025-01-15T10:30:00Z",
"updateDate": "2025-01-15T10:30:00Z",
"triggers": [
{
"communicationTriggerId": 1,
"communicationId": 1,
"uuidStatus": "STATUS_DELIVERED",
"deliveryTypes": [
"HOME",
"SHOP"
],
"reminder": true,
"reminderDelay": "PT48H",
"arguments": {
"key": "value"
},
"createDate": "2025-01-15T10:30:00Z",
"updateDate": "2025-01-15T10:30:00Z"
}
]
}'Get a complete communication configuration including triggers by communication ID
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
OK Communication configuration found
{
"communicationId": 1,
"alias": "order-confirmation",
"description": "Send order confirmation to customer",
"templateId": "TEMPLATE_ORDER_CONFIRMATION",
"notifyChannels": true,
"channels": [
"EMAIL",
"SMS"
],
"maxDelayFromOrderCreation": "PT24H",
"maxDelayFromStatusReport": "PT2H",
"documentationOnly": false,
"tenants": [
"yoigo",
"masmovil"
],
"allowedDevices": [
"DEVICE-123",
"DEVICE-456"
],
"arguments": {
"key": "value"
},
"exclusions": {
"courier": [
"GLS"
]
},
"createDate": "2025-01-15T10:30:00Z",
"updateDate": "2025-01-15T10:30:00Z",
"triggers": [
{
"communicationTriggerId": 1,
"communicationId": 1,
"uuidStatus": "STATUS_DELIVERED",
"deliveryTypes": [
"HOME",
"SHOP"
],
"reminder": true,
"reminderDelay": "PT48H",
"arguments": {
"key": "value"
},
"createDate": "2025-01-15T10:30:00Z",
"updateDate": "2025-01-15T10:30:00Z"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
communicationId | integer (int64) | Unique communication identifier (auto-generated) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
alias* | string | Unique alias for the communication | maxLength: 256 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | Description of the communication | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
templateId* | string | Template identifier from mas-communications | maxLength: 256 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notifyChannels | boolean | null | Whether to notify through specified channels | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
channels | string[] | Communication channels | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
maxDelayFromOrderCreation | string | null | Maximum delay from order creation (ISO-8601 duration format) | pattern: ^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+S)?)?$ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
maxDelayFromStatusReport | string | null | Maximum delay from status report (ISO-8601 duration format) | pattern: ^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+S)?)?$ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
documentationOnly | boolean | null | Whether this communication is for documentation purposes only | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tenants | string[] | List of tenants this communication applies to | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
allowedDevices | string[] | List of device references this communication applies to | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
arguments | object | null | Additional arguments as JSON object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
exclusions | object | null | Exclusion criteria as JSON object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createDate | string (date-time) | Creation timestamp | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updateDate | string (date-time) | Last update timestamp | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
triggers | object[] | List of trigger states associated with this communication | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X GET 'https://logistics.sta.masstack.com/v2/orgs/yoigo/management/communications/:communicationId' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Update an existing communication configuration and its triggers
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
{
"communicationId": 1,
"alias": "order-confirmation",
"description": "Send order confirmation to customer",
"templateId": "TEMPLATE_ORDER_CONFIRMATION",
"notifyChannels": true,
"channels": [
"EMAIL",
"SMS"
],
"maxDelayFromOrderCreation": "PT24H",
"maxDelayFromStatusReport": "PT2H",
"documentationOnly": false,
"tenants": [
"yoigo",
"masmovil"
],
"allowedDevices": [
"DEVICE-123",
"DEVICE-456"
],
"arguments": {
"key": "value"
},
"exclusions": {
"courier": [
"GLS"
]
},
"createDate": "2025-01-15T10:30:00Z",
"updateDate": "2025-01-15T10:30:00Z",
"triggers": [
{
"communicationTriggerId": 1,
"communicationId": 1,
"uuidStatus": "STATUS_DELIVERED",
"deliveryTypes": [
"HOME",
"SHOP"
],
"reminder": true,
"reminderDelay": "PT48H",
"arguments": {
"key": "value"
},
"createDate": "2025-01-15T10:30:00Z",
"updateDate": "2025-01-15T10:30:00Z"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
communicationId | integer (int64) | Unique communication identifier (auto-generated) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
alias* | string | Unique alias for the communication | maxLength: 256 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | Description of the communication | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
templateId* | string | Template identifier from mas-communications | maxLength: 256 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notifyChannels | boolean | null | Whether to notify through specified channels | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
channels | string[] | Communication channels | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
maxDelayFromOrderCreation | string | null | Maximum delay from order creation (ISO-8601 duration format) | pattern: ^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+S)?)?$ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
maxDelayFromStatusReport | string | null | Maximum delay from status report (ISO-8601 duration format) | pattern: ^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+S)?)?$ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
documentationOnly | boolean | null | Whether this communication is for documentation purposes only | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tenants | string[] | List of tenants this communication applies to | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
allowedDevices | string[] | List of device references this communication applies to | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
arguments | object | null | Additional arguments as JSON object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
exclusions | object | null | Exclusion criteria as JSON object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createDate | string (date-time) | Creation timestamp | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updateDate | string (date-time) | Last update timestamp | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
triggers | object[] | List of trigger states associated with this communication | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
OK Communication configuration updated
{
"communicationId": 1,
"alias": "order-confirmation",
"description": "Send order confirmation to customer",
"templateId": "TEMPLATE_ORDER_CONFIRMATION",
"notifyChannels": true,
"channels": [
"EMAIL",
"SMS"
],
"maxDelayFromOrderCreation": "PT24H",
"maxDelayFromStatusReport": "PT2H",
"documentationOnly": false,
"tenants": [
"yoigo",
"masmovil"
],
"allowedDevices": [
"DEVICE-123",
"DEVICE-456"
],
"arguments": {
"key": "value"
},
"exclusions": {
"courier": [
"GLS"
]
},
"createDate": "2025-01-15T10:30:00Z",
"updateDate": "2025-01-15T10:30:00Z",
"triggers": [
{
"communicationTriggerId": 1,
"communicationId": 1,
"uuidStatus": "STATUS_DELIVERED",
"deliveryTypes": [
"HOME",
"SHOP"
],
"reminder": true,
"reminderDelay": "PT48H",
"arguments": {
"key": "value"
},
"createDate": "2025-01-15T10:30:00Z",
"updateDate": "2025-01-15T10:30:00Z"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
communicationId | integer (int64) | Unique communication identifier (auto-generated) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
alias* | string | Unique alias for the communication | maxLength: 256 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | string | Description of the communication | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
templateId* | string | Template identifier from mas-communications | maxLength: 256 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
notifyChannels | boolean | null | Whether to notify through specified channels | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
channels | string[] | Communication channels | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
maxDelayFromOrderCreation | string | null | Maximum delay from order creation (ISO-8601 duration format) | pattern: ^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+S)?)?$ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
maxDelayFromStatusReport | string | null | Maximum delay from status report (ISO-8601 duration format) | pattern: ^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+S)?)?$ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
documentationOnly | boolean | null | Whether this communication is for documentation purposes only | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tenants | string[] | List of tenants this communication applies to | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
allowedDevices | string[] | List of device references this communication applies to | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
arguments | object | null | Additional arguments as JSON object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
exclusions | object | null | Exclusion criteria as JSON object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
createDate | string (date-time) | Creation timestamp | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updateDate | string (date-time) | Last update timestamp | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
triggers | object[] | List of trigger states associated with this communication | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X PUT 'https://logistics.sta.masstack.com/v2/orgs/yoigo/management/communications/:communicationId' \
-H 'Authorization: Bearer {access-token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"communicationId": 1,
"alias": "order-confirmation",
"description": "Send order confirmation to customer",
"templateId": "TEMPLATE_ORDER_CONFIRMATION",
"notifyChannels": true,
"channels": [
"EMAIL",
"SMS"
],
"maxDelayFromOrderCreation": "PT24H",
"maxDelayFromStatusReport": "PT2H",
"documentationOnly": false,
"tenants": [
"yoigo",
"masmovil"
],
"allowedDevices": [
"DEVICE-123",
"DEVICE-456"
],
"arguments": {
"key": "value"
},
"exclusions": {
"courier": [
"GLS"
]
},
"createDate": "2025-01-15T10:30:00Z",
"updateDate": "2025-01-15T10:30:00Z",
"triggers": [
{
"communicationTriggerId": 1,
"communicationId": 1,
"uuidStatus": "STATUS_DELIVERED",
"deliveryTypes": [
"HOME",
"SHOP"
],
"reminder": true,
"reminderDelay": "PT48H",
"arguments": {
"key": "value"
},
"createDate": "2025-01-15T10:30:00Z",
"updateDate": "2025-01-15T10:30:00Z"
}
]
}'Delete a communication configuration and return a confirmation message
PATH PARAMETERS
Organization name as it is registered in Mas-Stack
OK Communication configuration deleted successfully
{
"message": "Obsolescence record successfully deleted",
"reference": "DEV-1234"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
message | string | |||
reference | string |
Response for client error when some field in the request is missing or invalid.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
Response when an internal or unexpected error occurs.
[
{
"code": "MLOG_0001",
"title": "OUT_OF_STOCK",
"details": "Out of stock"
},
{
"code": "MLOG_0003",
"title": "MISSING_MANDATORY_FIELDS",
"details": "Missing mandatory fields"
},
{
"code": "MLOG_0008",
"title": "RESERVATION_INVALID",
"details": "Reservation invalid"
},
{
"code": "MLOG_0010",
"title": "VALIDATION_FIELDS",
"details": "Field not valid"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
title | string | Error description | ||
ref | string | Link to error dictionary | ||
details | string | Error detail message | ||
code | string | Internal MasLogistics error code |
curl -X DELETE 'https://logistics.sta.masstack.com/v2/orgs/yoigo/management/communications/:communicationId' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'