masstack

V2
API Overview Resources Schemas

Schemas

ReservationStatus

1
2
3
4
5

{
  "reservation_id": "123456",
  "order_id": "134566",
  "status": "CONFIRM"
}
Name Type Required Description
reservation_id string false Reservation Id
order_id string false Order Id (newOrder service)
status string true Reservation status
Property Values
status one of [CONFIRM, CANCEL]

Reservation

1
2
3
4
5
6
7
8
9

{
  "data_sales": {
    "agent": "RETEN001",
    "channel": "TELE_SALE_CARE",
    "type": "NEW_SALE",
    "group": "POS"
  },
  "product_id": "RM58AV3N2"
}
Name Type Required Description
data_sales DataSales true Data sales information associated with the reservation
product_id string true Product identifier

ArrayOfStockItem

1
2
3
4
5
6
7
8
9

{
  "data": [
    {
      "warehouse_id": "50",
      "product_id": "RM58AV3N2",
      "available_quantity": 60
    }
  ]
}
Name Type Required Description
data [StockItem] false List of objects with stock information

StockItem

1
2
3
4
5

{
  "warehouse_id": "50",
  "product_id": "RM58AV3N2",
  "available_quantity": 60
}
Name Type Required Description
warehouse_id string false Warehouse Id
product_id string false productId
available_quantity integer false Available quantity

Order

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204

{
  "order": {
    "subscription_id": "2203846",
    "work_order": "MYSIM_213563123",
    "order_id": "12233-fff33",
    "order_id_crm": "109384632",
    "business_process": "PEDIDO",
    "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",
      "return_code": "A1234",
      "delivery_type": "AGENCY",
      "ol_comments": "ONT password"
    }
  },
  "products": [
    {
      "product_id": "40397",
      "product_code": "RM58AV3N2",
      "product_description": "Caja de voz Ad Hoc v3",
      "product_type": 16,
      "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
      }
    ]
  }
}
Name Type Required Description
order NewOrderData true Main order data, including ID and essential details
data_sales DataSales false Information related to sales associated with the order
client Client true Object with client data
invoice Invoice false Invoice information generated for the order
shipping Shipping true Shipping details, including address and delivery info
products [Product] true [Info about the product]
documentation Documentation false Info about the documentation related to the order

NewOrderData

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
  "subscription_id": "2203846",
  "work_order": "MYSIM_213563123",
  "order_id": "12233-fff33",
  "order_id_crm": "109384632",
  "business_process": "PEDIDO",
  "convergent": true,
  "language": "ES",
  "delivery_type": "AGENCY"
}
Name Type Required Description
subscription_id string false Identifier of a customer subscription, it can have several subscription_device_id associated to its line.
work_order string false Work Order
order_id string false The order identifier in MasLogistics domain. (Read only parameter, only for GET requests)
order_id_crm string false The order identifier of the requester. For example, the ItemNumber.
business_process string false The business process
convergent boolean false Is Order convergent
language string false Order language
delivery_type DeliveryTypeEnum false The delivery type
Property Values
business_process one of [PEDIDO, BREAKDOWN_DELIVERY, MIGRATION_DELIVERY]
language one of [ES, EN, EU, CA, GL, PT]

CancellationRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

{
  "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"
    }
  ]
}
Name Type Required Description
cancellation_request_id string false The identifier of the cancellation request in MasLogistics domain. (Read only parameter, only for GET requests)
reason string true none
products [ProductBasic] true [Info about the product]

DeliveryConfirmationRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

{
  "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"
    }
  ]
}
Name Type Required Description
products [ProductBasic] false [Info about the product]

PickupData

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

{
  "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
}
Name Type Required Description
subscription_id string false none
pickup_id string false The pickup identifier in MasLogistics domain. (Read only parameter, only for GET requests)
order_id_external string false The order identifier given by the logistics operator. (Read only parameter, only for GET requests)
order_id_crm string false The order identifier of the request. It is mandatory to sent the OT in router unsubscription process.
language string false Order language
business_process string true The business process
reason string false The reason of the pickup
delivery_type DeliveryTypeEnum true The delivery type
access_reused boolean false Access reused for routers pickups
Property Values
language one of [ES, EN, EU, CA, GL, PT]
business_process one of [UNSUBSCRIPTION, WITHDRAWAL, CANCELLATION, FINALPAYMENT, BREAKDOWN_PICKUP, MIGRATION_PICKUP]

DeliveryTypeEnum

1

"AGENCY"
Name Type Required Description
anonymous string false The delivery type
Property Values
anonymous one of [AGENCY, SHOP, HOME]

DataSales

1
2
3
4
5
6

{
  "agent": "RETEN001",
  "channel": "TELE_SALE_CARE",
  "type": "NEW_SALE",
  "group": "POS"
}
Name Type Required Description
agent string false client reference
channel DataSalesChannelEnum false Dta sales channel
type DataSalesTypeEnum false Data sales type
group DataSalesGroupEnum false Data sales group

Client

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

{
  "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"
  }
}
Name Type Required Description
identity Identity true Object representing the identity of a client
contact_phone Phone true Phone object with prefix and phone number
name string false Client name
surnames [string] false Client surnames
email string false Client email
commercial_name string false Client commercial name
address Address false Address object with street, number, city, zip code, province and country

Identity

1
2
3
4

{
  "document_id": "00000000A",
  "document_type": "NIF"
}
Name Type Required Description
document_id string true Document Id
document_type string true Document Type
Property Values
document_type one of [NIF, CIF, NIE, PASSPORT]

Document

1
2
3
4
5
6
7

{
  "document_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "document_type": "CONTRACT",
  "copies": 2,
  "signable": true,
  "signed": true
}
Name Type Required Description
document_id string false Public document id managed by mas-logistics, not the id managed by mas-documents
document_type string false Document Type
copies integer false The number of copies that must be printed
signable boolean false Defines if the document is signable in the MasLogistics context using the signOrderDocuments operation
signed boolean false Defines if the document is signed. If the document is not signable, this field will never be true
Property Values
document_type one of [CONTRACT, INE, CCGG, DELIVERY_NOTE]

DocumentWithUrl

1
2
3
4
5
6
7
8

{
  "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"
}
Name Type Required Description
anonymous Document false Object representing the document as contract, INE or delivery note
Name Type Required Description
anonymous object false none
» url string false The public url to download the document

Phone

1
2
3
4

{
  "phone_number": "666666666",
  "prefix": "+34"
}
Name Type Required Description
phone_number string false Phone Number
prefix string false Phone prefix

ReservationCreateResponse

1
2
3
4
5
6

{
  "product_id": "P0000001",
  "reservation_id": "250",
  "total_duration_in_seconds": 180,
  "valid_until": "2021-05-24T09:00:00Z"
}
Name Type Required Description
product_id string false The product Id
reservation_id string false Reservation Id
total_duration_in_seconds number false The time in seconds that the reservation is available before expire.
valid_until string false The timestamp when the reservation will expire in ISO 8601 format and UTC

Invoice

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

{
  "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
    }
  }
}
Name Type Required Description
address Address false Address object with street, number, city, zip code, province and country
client Client false Object with client data
data_invoice DataInvoice false Data invoice information

DataInvoice

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

{
  "base": 100,
  "tax_value": 21,
  "total_invoice": 121,
  "discount": 0,
  "payment_type": 0,
  "residual_value": 0,
  "initial_payment": 0,
  "fee": {
    "amount": 12,
    "duration": 12
  }
}
Name Type Required Description
base number true base invoice
tax_value number true invoice tax value
total_invoice number true total invoice
discount number false discount
payment_type integer true payment type
residual_value number false Final Payment
initial_payment number false Initial payment
fee Fee false Fee information

Fee

1
2
3
4

{
  "amount": 12,
  "duration": 12
}
Name Type Required Description
amount number false Fee amount
duration integer false Fee duration

Shipping

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

{
  "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",
    "return_code": "A1234",
    "delivery_type": "AGENCY",
    "ol_comments": "ONT password"
  }
}
Name Type Required Description
address Address true Address object with street, number, city, zip code, province and country
contact_data Client true Object with client data
data_delivery DataDelivery true Data delivery information

ShippingPickup

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

{
  "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,
    "group_by": "string",
    "secure_delivery": false,
    "delivery_point_id": "SEUR-1234",
    "delivery_shop_name": "Mas Life Plaza España",
    "return_code": "A1234",
    "delivery_type": "AGENCY",
    "ol_comments": "ONT password"
  }
}
Name Type Required Description
address Address true Address object with street, number, city, zip code, province and country
contact_data Client true Object with client data
transport_data DataDelivery true Data delivery information

DataDelivery

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

{
  "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",
  "return_code": "A1234",
  "delivery_type": "AGENCY",
  "ol_comments": "ONT password"
}
Name Type Required Description
courier_id CourierIdEnum true messenger identifier in case you don’t know it you can send DEFAULT
delivery_service DeliveryServiceIdEnum true delivery service id if you do not know it you can send DEFAULT
exclusive boolean true Delivery to exact person
verify_identity boolean true The carrier must verify the identity document
retrieve_contract boolean true The carrier must return the signed document
group_by string false Group by
secure_delivery boolean false Defines if delivery should be secure
delivery_point_id string false The delivery point identifier. Normally the store SFID. Mandatory for orders with delivery type SHOP.
delivery_shop_name string false The delivery shop name. Mandatory for orders with delivery type SHOP.
return_code string false The return code provided by the courier (Read only parameter, only for GET requests)
delivery_type DeliveryTypeEnum false The delivery type
ol_comments string false information or instructions for OL

DataTransport

1
2
3
4
5

{
  "courier_id": "CORREOS",
  "delivery_service": "DELIVERY_24",
  "verify_identity": false
}
Name Type Required Description
courier_id CourierIdEnum false messenger identifier in case you don’t know it you can send DEFAULT
delivery_service DeliveryServiceIdEnum false delivery service id if you do not know it you can send DEFAULT
verify_identity boolean false The carrier must verify the identity document

Product

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

{
  "product_id": "40397",
  "product_code": "RM58AV3N2",
  "product_description": "Caja de voz Ad Hoc v3",
  "product_type": 16,
  "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"
}
Name Type Required Description
product_id string false The product id in MasLogistics domain, usually suscription_device_id. (Read only parameter, only for GET requests)
product_code string true Product code
product_description string false Product description
product_type string false The product type. (Read only parameter, only for GET requests)
product_type_id integer false Product Type Id
product_unit_price number false Product Unit price
icc_imei string false product imei
identifier string false The physical product identifier, usually SerialNumber/MAC/IMEI. (Read only parameter, only for GET requests)
quantity integer false Product quantity
product_comments string false Product comments
msisdn string false MSISDN associated
financed boolean false Is product financed
subscription_device_id string true Identifier of an internal order in mas stack
remaining_payment number false Remaining payment amount to pay on delivery
invoiced boolean false 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.
status AcceptanceStatus false The status of the product. (Read only parameter, only for GET requests)

ProductWithExpedition

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

{
  "product_id": "40397",
  "product_code": "RM58AV3N2",
  "product_description": "Caja de voz Ad Hoc v3",
  "product_type": 16,
  "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"
    }
  }
}
Name Type Required Description
anonymous Product false Info about the product
Name Type Required Description
anonymous object false none
» associated_expedition object false Associated expedition info
»» expedition_id string false Unique expedition identifier
»» current_status Status false Info about the status of the expedition

ProductBasic

1
2
3
4
5
6
7
8
9

{
  "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"
}
Name Type Required Description
product_code string true Product code
product_description string false Product description
product_type string false Product Type
product_type_id integer false Product Type Id
identifier string false Product imei/serial number. Mandatory for all the process types, except for routers unsubscription.
msisdn string false MSISDN associated
subscription_device_id string true Subscription device Id
Property Values
product_type one of [STB, TERMINAL, ROUTER]

PickupProductBasic

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

{
  "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"
}
Name Type Required Description
anonymous ProductBasic false Info about the product
Name Type Required Description
anonymous object false Basic information about a product in a pickup
» technology string false Technology type for routers pickups
» status AcceptanceStatus false The status of the product. (Read only parameter, only for GET requests)
Property Values
technology one of [FTTH, ADSL]

Address

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

{
  "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"
}
Name Type Required Description
street_type string false Street type
street string true Street name
number string false Building number
additional_details string false Other address parameters
city string true City
zip_code string true Postal code
province string true Province
country string true Country
bis string false Bis
floor string false Floor
block string false Block
stair string false Stair
letter string false Letter

Documentation

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

{
  "letter_type": "WP",
  "documents": [
    {
      "document_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "document_type": "CONTRACT",
      "copies": 2,
      "signable": true,
      "signed": true
    }
  ]
}
Name Type Required Description
letter_type string false Letter type. Possible values: “H”, “T”, “TV”, “RW”, “SR”, “WF”, “WP”, “JN”, “JP”, “JR”, “LC”, “N”, “PP0”, “PP8”, “R”
documents [Document] false List of documents

CourierIdEnum

1

"CORREOS"
Name Type Required Description
anonymous string false messenger identifier in case you don’t know it you can send DEFAULT
Property Values
anonymous one of [DEFAULT, GLS, HL, ASIGNA, SENDING, CORREOS, SUS_MEDIOS, INSIDE, ZELERIS, CTT]

DeliveryServiceIdEnum

1

"DELIVERY_24"
Name Type Required Description
anonymous string false delivery service id if you do not know it you can send DEFAULT
Property Values
anonymous one of [DEFAULT, DELIVERY_24, DELIVERY_10AM, DELIVERY_14AM, DELIVERY_72, DELIVERY_SECURED, DELIVERY_INSTALL, DELIVERY_STANDARD]

DataSalesChannelEnum

1

"TELE_SALE_CARE"
Name Type Required Description
anonymous string false Dta sales channel
Property Values
anonymous one of [TELE_SALE_CARE, EXCLUSIVE_POS, FRANCHISE_POS, INDIRECT_POS, SELF_SALE_CARE, D2D]

DataSalesTypeEnum

1

"NEW_SALE"
Name Type Required Description
anonymous string false Data sales type
Property Values
anonymous one of [NEW_SALE, ADD_SUBSCRIPTION_TO_BUNDLE, MIGRATION, EXISTENT_SUBSCRIPTION]

DataSalesGroupEnum

1

"POS"
Name Type Required Description
anonymous string false Data sales group
Property Values
anonymous one of [POS, ONLINE_DISTRIBUTION, INBOUND, OUTBOUND, RETENTION, LOYALTY, UNSUBSCRIBE, CANCELLATIONS, UNDER_CUSTOMER_BASE, BROADCAST_CUSTOMER_BASE, ADMINISTRATOR, CUSTOMER_SUPPORT]

Status

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
  "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"
}
Name Type Required Description
id string false status id
value StatusValue false status value
description string false status description
final boolean false Indicates if the status is a final state of an expedition
reshippable boolean false Indicates if the status is reshippable in a new expedition, but not in this one
reason_code string¦null false reason for the status, if needed
reason_description string¦null false reason description, if needed
timestamp string false status date

Tracking

1
2
3
4

{
  "tracking_link": "http://gls.es/111",
  "return_code": "1029373622"
}
Name Type Required Description
tracking_link string¦null false tracking link for the delivery
return_code string¦null false Code for returning the device

Expedition

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

{
  "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": 16,
      "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"
    }
  ]
}
Name Type Required Description
expedition_id string false Expedition id
created_date string false none
transport DataTransport false none
tracking Tracking false Info about the tracking of the order
status_history [Status] false List of status
products [Product] false List of products

Pickup

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

{
  "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
  },
  "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,
      "group_by": "string",
      "secure_delivery": false,
      "delivery_point_id": "SEUR-1234",
      "delivery_shop_name": "Mas Life Plaza España",
      "return_code": "A1234",
      "delivery_type": "AGENCY",
      "ol_comments": "ONT password"
    }
  },
  "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"
    }
  ]
}
Name Type Required Description
order PickupData true none
data_sales DataSales false Information related to sales associated with the order
client Client true Object with client data
shipping ShippingPickup true Shipping information for a pickup
products [PickupProductBasic] true Info about the pickup Product

SignDocumentsRequest

1
2
3
4
5
6

{
  "order_ids": [
    "6ea0ca52-e194-45e2-a4fd-6d93923682bd",
    "8b243340-4b87-4b9b-bead-781698931477"
  ]
}
Name Type Required Description
order_ids [string] false Order ids to sign

SignDocumentsResponse

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

{
  "sign_id": "6ea0ca52-e194-45e2-a4fd-6d93923682bd",
  "documents": [
    {
      "document_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "document_type": "CONTRACT",
      "copies": 2,
      "signable": true,
      "signed": true
    }
  ]
}
Name Type Required Description
sign_id string false The sign id from MasDocuments
documents [Document] false [Object representing the document as contract, INE or delivery note]

ArrayOfExpeditions

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

{
  "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": "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": 16,
          "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"
        }
      ]
    }
  ]
}
Name Type Required Description
anonymous Pagination false Pagination information
Name Type Required Description
anonymous object false List of expeditions
» expeditions [Expedition] false Info about the Expeditions

ArrayOfProductWithExpedition

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

{
  "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": 16,
      "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"
        }
      }
    }
  ]
}
Name Type Required Description
anonymous Pagination false Pagination information
Name Type Required Description
anonymous object false List of products with expeditions
» products [ProductWithExpedition] false Info about the product with the expedition

ArrayOfOrders

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212

{
  "page_size": 123,
  "total_pages": 10,
  "current_page": 1,
  "total_elements": 3000,
  "orders": [
    {
      "order": {
        "subscription_id": "2203846",
        "work_order": "MYSIM_213563123",
        "order_id": "12233-fff33",
        "order_id_crm": "109384632",
        "business_process": "PEDIDO",
        "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",
          "return_code": "A1234",
          "delivery_type": "AGENCY",
          "ol_comments": "ONT password"
        }
      },
      "products": [
        {
          "product_id": "40397",
          "product_code": "RM58AV3N2",
          "product_description": "Caja de voz Ad Hoc v3",
          "product_type": 16,
          "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
          }
        ]
      }
    }
  ]
}
Name Type Required Description
anonymous Pagination false Pagination information
Name Type Required Description
anonymous object false List of Orders
» orders [Order] false List of Orders

ArrayOfDocuments

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

{
  "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
    }
  ]
}
Name Type Required Description
anonymous Pagination false Pagination information
Name Type Required Description
anonymous object false none
» documents [Document] false [Object representing the document as contract, INE or delivery note]

StatusValue

1

"DELIVERED"
Name Type Required Description
anonymous string false status value
Property Values
anonymous one of [ABANDONED, ABSENT_INCIDENCE, ACCEPTED, ACCEPTED_BY_MANUFACTURER, CANCELLATION_REQUEST, CANCELLED, COLLECTED, COLLECTION_REQUEST, COMPLETE_RMA, CONTRACT_GENERATED, CONTRACT_MISSING, CONTRACT_NOT_RETRIEVED, CONTRACT_RETRIEVED, CONTRACT_SIGNED, CUSTOMER_CONTACTED, DELIVERED, DELIVERED_CUSTODIAN, DELIVERED_IN_DELIVERY_POINT, DELIVERED_TO_MANUFACTURER, DELIVERED_TO_OL, DELIVERY_IN_WAREHOUSE, DELIVERY_INCIDENCE, DELIVERY_REQUESTED, DELIVERY_TO_MANUFACTURER, DESTROYED, DISASTER, DOCUMENTATION_SENT, ERROR, ERROR_RMA, EXPEDITION_CREATED, EXPIRED, FAIL_CONTACT, FRAUD, IN_DELIVERY, IN_DELIVERY_TO_MANUFACTURER, IN_TRANSIT, IN_WAREHOUSE, INCIDENCE, MISSING_DATA, NOT_COLLECTED, NOT_DELIVERED, NOT_FRAUD, NOT_PENALIZED, NOT_PICKUP, NOT_SENT, ON_DEPARTURE, ORDER_MODIFIED, ORDER_READY, ORDER_RECEIVED, OUT_OF_STOCK, PAID, PENALIZED, PENDING_CUSTOMER_CONTACT, PENDING_PENALTY, PENDING_RMA, PERMANENCE_ALREADY_LOADED, PERMANENCE_ASSOCIATED, PICKING, PICKING_STARTED, PICKUP_ACORDED, PICKUP_DONE, PICKUP_FAIL, PICKUP_IN_PROCESS, PICKUP_MODIFIED, PICKUP_REQUEST, POSSIBLE_FRAUD, PREPICKING, READY_TO_SHIPPING, REFOUND_PENDING, REJECTED, REJECTED_BY_MANUFACTURER, RETURNED, RETURNED_TO_CLIENT, RETURNED_TO_OL, RETURNED_TO_WAREHOUSE, SENT, SENT_TO_MANUFACTURER, SENT_TO_OL, SENT_TO_WAREHOUSE, SINISTER, START_EXTRACTION, STARTED, STORED, STORED_IN_OL, TRANSPORT_INCIDENCE, UNKNOWN, WAREHOUSE_DELIVERED, WAREHOUSE_EXIT, WAREHOUSE_REJECTED]

AcceptanceStatus

1

"CREATED"
Name Type Required Description
anonymous string false The status of the product. (Read only parameter, only for GET requests)
Property Values
anonymous one of [CREATED, DISCARDED]

Pagination

1
2
3
4
5
6

{
  "page_size": 123,
  "total_pages": 10,
  "current_page": 1,
  "total_elements": 3000
}
Name Type Required Description
page_size integer false Page size
total_pages integer false Total pages for page size
current_page integer false Current page
total_elements integer false Total element

Errors

1
2
3
4
5
6
7
8

[
  {
    "title": "PRODUCT_NOT_EXIST",
    "ref": "string",
    "details": "Product id doesn't exists or isn't available",
    "code": "MLOG_XXXX"
  }
]
Name Type Required Description
anonymous [Error] false List of errors

Error

1
2
3
4
5
6

{
  "title": "PRODUCT_NOT_EXIST",
  "ref": "string",
  "details": "Product id doesn't exists or isn't available",
  "code": "MLOG_XXXX"
}
Name Type Required Description
title string false Error description
ref string false Link to error dictionary
details string false Error detail message
code string false Internal error code

ExternalOrder

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

{
  "order_id_external": "OL-ID",
  "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": [
        {
          "reference": "8U8474JE3748",
          "subscription": {
            "subscription_id": "SUBS-ID",
            "order_id": "CRM-ID",
            "msisdn": "666777888"
          },
          "type": {
            "action_id": "1",
            "family_id": "17",
            "id": "ROUTER"
          },
          "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"
            }
          }
        }
      ],
      "transport": {
        "delivery_details": {
          "package": {
            "weight": 2.5,
            "dimensions": 0
          },
          "coverage": true,
          "secure_delivery": false,
          "remaining_payment": {
            "total": 24.5,
            "currency": "EUR"
          },
          "recipient_verification": {
            "exclusive_delivery": false,
            "verification": {
              "required": true,
              "completed": false
            }
          }
        },
        "courier": "GLS",
        "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": [
    {
      "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
  }
}
Name Type Required Description
order_id_external string true External order identifier
reexpedition string true Reexpedition identifier
order_date string false Order date in ISO 8601 format and UTC
logistics_operator string false logistic operator
delivery_type string true Delivery type.
process_type string false Logistics process type.
logistic_operation string false Logistic operation.
portability boolean false order with associated portability
business string false Business name
status ExternalStatus true none
journeys [Journey] true none
documentation ExternalDocumentation false none
customer_delivering_info CustomerDeliveringInfo true none
Property Values
logistics_operator one of [INTERBOX, ANOVO]
delivery_type one of [HOME, AGENCY, SHOP]
process_type one of [SWAP, PEDIDO, BAJA, DESISTIMIENTO, CANCELACION, FIX, DOA, FINALPAYMENT, BREAKDOWN_DELIVERY, BREAKDOWN_PICKUP, MIGRATION_DELIVERY, MIGRATION_PICKUP]
logistic_operation one of [DELIVERY, PICKUP]

Journey

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

{
  "devices": [
    {
      "reference": "8U8474JE3748",
      "subscription": {
        "subscription_id": "SUBS-ID",
        "order_id": "CRM-ID",
        "msisdn": "666777888"
      },
      "type": {
        "action_id": "1",
        "family_id": "17",
        "id": "ROUTER"
      },
      "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"
        }
      }
    }
  ],
  "transport": {
    "delivery_details": {
      "package": {
        "weight": 2.5,
        "dimensions": 0
      },
      "coverage": true,
      "secure_delivery": false,
      "remaining_payment": {
        "total": 24.5,
        "currency": "EUR"
      },
      "recipient_verification": {
        "exclusive_delivery": false,
        "verification": {
          "required": true,
          "completed": false
        }
      }
    },
    "courier": "GLS",
    "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"
    }
  }
}
Name Type Required Description
devices [Device] true none
transport Transport false none

ExternalDocumentation

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

[
  {
    "preprinted": true,
    "total_pages": 10,
    "documents": [
      {
        "recipient": "CLIENT",
        "document_type": "WL",
        "quantity": 1
      }
    ]
  }
]
Name Type Required Description
preprinted boolean false none
total_pages number false Total printed pages
documents [object] false none
» recipient string false Recipient of the documentation
» document_type string false Type of document
» quantity number false Quantity of this document
Property Values
recipient one of [CLIENT, COMPANY]
document_type one of [WL, INE, CONTRACT, INVOICE, SEPA, MIGRATION, PARTICULAR_CONDITIONS, FINANCING_CONDITIONS, PORTABILITY_VALIDATION]

Transport

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

{
  "delivery_details": {
    "package": {
      "weight": 2.5,
      "dimensions": 0
    },
    "coverage": true,
    "secure_delivery": false,
    "remaining_payment": {
      "total": 24.5,
      "currency": "EUR"
    },
    "recipient_verification": {
      "exclusive_delivery": false,
      "verification": {
        "required": true,
        "completed": false
      }
    }
  },
  "courier": "GLS",
  "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"
  }
}
Name Type Required Description
delivery_details object false none
» package object false none
»» weight number false Weight in kg.
»» dimensions number false Volume.
» coverage boolean false Is covered by insurance
» secure_delivery boolean false Defines if delivery should be secure
» remaining_payment Price false none
» recipient_verification object false none
»» exclusive_delivery boolean false The carrier must verify the identity document
»» verification object false none
»»» required boolean false The carrier must take photo the identity document
»»» completed boolean false The carrier successfully has taken photo the identity document
courier string true Logistic transportation courier
service string true Logistics Service type
tracking_link string false Tracking link
expedition_number string false The expedition number of the courier when its postal office
delivery_note object false none
» delivery_note_id string false Identificative number of the delivery note
» link string false Link to the delivery note
Property Values
courier one of [GLS, HL, ASIGNA, SENDING, CORREOS, INSIDE, SUS_MEDIOS, ZELERIS, CTT, DEFAULT]
service one of [DELIVERY_24, DELIVERY_10AM, DELIVERY_14AM, DELIVERY_72, DELIVERY_SECURED, DELIVERY_INSTALL, DELIVERY_STANDARD, DEFAULT]

BaseDevice

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

{
  "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"
    }
  }
}
Name Type Required Description
subscription Subscription false none
type DeviceType false none
reference string false Device reference
replacement string false replacement , posible values “Y” or “N”
identifier string false Device’s identifier
additional_identifier string false Additional identifier, if exists
active boolean false The flag will be true if the device has been delivered and false if it has been collected
subscription_device_id string false Subscription device Id
price object false none
» markup Price false none
» no_markup Price false none

Device

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

{
  "reference": "8U8474JE3748",
  "subscription": {
    "subscription_id": "SUBS-ID",
    "order_id": "CRM-ID",
    "msisdn": "666777888"
  },
  "type": {
    "action_id": "1",
    "family_id": "17",
    "id": "ROUTER"
  },
  "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"
    }
  }
}
Name Type Required Description
reference string true Device reference
subscription Subscription true none

PickingDevice

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

{
  "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"
    }
  }
}
Name Type Required Description
subscription Subscription true none

DeviceType

1
2
3
4
5

{
  "action_id": "1",
  "family_id": "17",
  "id": "ROUTER"
}
Name Type Required Description
action_id string false Action id
family_id string false Family code
id string false Device type identifier. NULLABLE.
Property Values
id one of [SIM, TERMINAL, ROUTER, SMART_TV, SMARTHOME, STB, STB_APPLE, GENERIC, WIFIMESH]

Subscription

1
2
3
4
5

{
  "subscription_id": "SUBS-ID",
  "order_id": "CRM-ID",
  "msisdn": "666777888"
}
Name Type Required Description
subscription_id string¦null false Subscription identifier
order_id string false Order identifier
msisdn string¦null false Mobile Station International Subscriber Directory Number. MSISDN associated for the order associated to the device.

ExternalClient

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

{
  "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"
}
Name Type Required Description
identity ExternalIdentity true none
contact_phone ExternalPhone true none
name string false Client name
surnames [string] false none
email string false Client email
commercial_name string false Client commercial name

ExternalIdentity

1
2
3
4

{
  "document_id": "00557788T",
  "document_type": "NIF"
}
Name Type Required Description
document_id string true Identity Document Id
document_type string true Identity Document Type
Property Values
document_type one of [NIF, CIF, NIE, PASSPORT]

Price

1
2
3
4

{
  "total": 24.5,
  "currency": "EUR"
}
Name Type Required Description
total number false Total Amount
currency string false Currency as ISO 4217 code

ExternalPhone

1
2
3
4

{
  "phone_number": "666777888",
  "prefix": "+34"
}
Name Type Required Description
phone_number string true Phone Number
prefix string false Phone prefix

CustomerDeliveringInfo

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

{
  "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
}
Name Type Required Description
address ExternalAddress false none
client ExternalClient true none
language string false Preferred language as ISO 639-1 code
updated boolean false Indicates if the customer delivery info has been changed from last status
Property Values
language one of [ES, CA, EU, EN, PT, GL]

ExternalStatus

1
2
3
4
5
6
7
8
9

{
  "id": "3",
  "description": "Description about status",
  "timestamp": "2021-05-24T09:00:00Z",
  "reason": {
    "code": "INCOMPLETE",
    "description": "Missing components or equipment"
  }
}
Name Type Required Description
id string true Status id
description string false Description about status
timestamp string true Order status timestamp in ISO 8601 format and UTC
reason object false none
» code string false The reason code of the status
» description string false The reason description of the status
Property Values
code one of [INCOMPLETE, DAMAGED, NON-REPRODUCIBLE, MISSING_DOCUMENTS, BLOCKED, IMPOSSIBLE_TURN_ON, FMI_ACTIVE, NFF, OUT_OF_WARRANTY, IRRETRIEVABLE, SINISTER, EXCEED_LIMIT_OF_ATTEMPTS]

ExternalAddress

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

{
  "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"
}
Name Type Required Description
building_street_type string false Street type
building_street_name string false Street name
building_number string false Building number
building_floor string false Building floor
building_others string false Other address parameters
city string false City
zipcode string false Zip code
region string false Region
country string false Country ISO 3166

ExternalErrors

1
2
3
4
5
6
7
8

[
  {
    "title": "PRODUCT_NOT_EXIST",
    "ref": "string",
    "details": "Product id doesn't exists or isn't available",
    "code": "MLOG_XXXX"
  }
]
Name Type Required Description
anonymous [ExternalError] false none

ExternalError

1
2
3
4
5
6

{
  "title": "PRODUCT_NOT_EXIST",
  "ref": "string",
  "details": "Product id doesn't exists or isn't available",
  "code": "MLOG_XXXX"
}
Name Type Required Description
title string false Error description
ref string false Link to error dictionary
details string false Error detail message
code string false Internal error code
Schemas