masstack

V2
API Overview Resources Schemas

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.

Parameters

Name In Type Required Description
orgId path string true Organization name as it is registered in Mas-Stack
reservation_id path string true Internal logistics reservation id
body body ReservationStatus true Information needed to change the status to a reservation to confirmed or cancelled.

Request body - instance of ReservationStatus

1
2
3
4
5
6

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

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


curl -X PUT https://logistics.sta.masstack.com/v2/orgs/yoigo/core/reservations/130 \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'order_id': '134566',
  'status': 'CONFIRM',
  'zip_code': '28912'
}"

Responses

Code Meaning Description Schema
200 OK Success ReservationStatus
4XX Unknown Response for client error when some field in the request is missing or invalid. [Error]
5XX Unknown Response when an internal or unexpected error occurs. [Error]

Parameters

Name In Type Required Description
orgId path string true Organization name as it is registered in Mas-Stack
body body Reservation true Information needed to create a new Reservation

Request body - instance of 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 false Information related to sales associated with the order
product_id string true Product identifier

Request example

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


curl -X POST https://logistics.sta.masstack.com/v2/orgs/yoigo/core/reservations \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'data_sales': {
    'agent': 'RETEN001',
    'channel': 'TELE_SALE_CARE',
    'type': 'NEW_SALE',
    'group': 'POS'
  },
  'product_id': 'RM58AV3N2'
}"

Responses

Code Meaning Description Schema
200 OK Success ReservationCreateResponse
4XX Unknown Response for client error when some field in the request is missing or invalid. [Error]
5XX Unknown Response when an internal or unexpected error occurs. [Error]

Parameters

Name In Type Required Description
orgId path string true Organization name as it is registered in Mas-Stack
body body CreateOrder true Information needed to create a new Order

Request body - JsonObject

  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

{
  "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",
    "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
      }
    ]
  }
}
Name Type Required Description
anonymous Order false Represents an order with its main details.
Name Type Required Description
anonymous object false Represents a new order creation request/response including products and documentation.
» products [Product] true [Info about the product]
» documentation Documentation false Info about the documentation related to the order

Request example

  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


curl -X POST https://logistics.sta.masstack.com/v2/orgs/yoigo/core/orders \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'order': {
    'reservation_id': '7d19cf38-a33d-42cd-8770-cea25db0b2e3',
    'subscription_id': '2203846',
    'work_order': 'MYSIM_213563123',
    'order_id_crm': '109384632',
    'order_id_external': '484543418',
    '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',
      'delivery_type': 'AGENCY',
      'ol_comments': 'ONT password'
    }
  },
  'products': [
    {
      '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',
      'quantity': 1,
      'product_comments': 'string',
      'msisdn': '666666666',
      'financed': true,
      'subscription_device_id': '40397',
      'remaining_payment': 20.5,
      'invoiced': true
    }
  ],
  'documentation': {
    'letter_type': 'WP',
    'documents': [
      {
        'document_id': 'd290f1ee-6c54-4b01-90e6-d701748f0851',
        'document_type': 'CONTRACT',
        'copies': 2,
        'signable': true,
        'signed': true
      }
    ]
  }
}"

Responses

Code Meaning Description Schema
200 OK Success CreateOrder
4XX Unknown Response for client error when some field in the request is missing or invalid. [Error]
5XX Unknown Response when an internal or unexpected error occurs. [Error]

Parameters

Name In Type Required Description
orgId path string true Organization name as it is registered in Mas-Stack
size query integer true Page size
page query integer true Page number
order_id query string false Order id in MasLogistics domain
order_id_crm query string false Order id in CRM domain
order_id_external query string false Order id in external domain
subscription_id query string false Subscription id
business_process query DirectBusinessProcess false Business process
delivery_type query DeliveryTypeEnum false Delivery type
identity_document_id query string false Client identity document id
product_identifier query string false Product identifier like IMEI, ICCID, Serial Number, etc.
product_code query string false The product reference
product_subscription_device_id query string false Product subscription device id
from_order_date query string(date-time) false From order date in ISO 8601 format. Example: 2021-05-24T09:00:00Z
to_order_date query string(date-time) false To order date in ISO 8601 format. Example: 2021-05-24T09:00:00Z
sort query string false Sort value, multiple values allowed, separate with coma

Enumerated Values

Property Values
business_process one of [PEDIDO, BREAKDOWN_DELIVERY, MIGRATION_DELIVERY]
delivery_type one of [AGENCY, SHOP, HOME, COURIER]
sort one of [DATE_DESC, DATE_ASC]

Request example

1
2
3
4
5


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'&order_id_external='string'&subscription_id='2203846'&business_process='PEDIDO'&delivery_type='AGENCY'&identity_document_id='12345678Z'&product_identifier='RM58AV3N2'&product_code='P0000001'&product_subscription_device_id='1123456789'&from_order_date='2021-05-24T09:00:00Z'&to_order_date='2021-05-25T09:00:00Z'&sort='DATE_DESC'?size=100&page=1 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK Success ArrayOfOrders
4XX Unknown Response for client error when some field in the request is missing or invalid. [Error]
5XX Unknown Response when an internal or unexpected error occurs. [Error]

Parameters

Name In Type Required Description
orgId path string true Organization name as it is registered in Mas-Stack
order_id path string true Internal logistics order id

Request example

1
2
3
4
5


curl -X GET https://logistics.sta.masstack.com/v2/orgs/yoigo/core/orders/888888-A9293 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK Success Order
4XX Unknown Response for client error when some field in the request is missing or invalid. [Error]
5XX Unknown Response when an internal or unexpected error occurs. [Error]

Parameters

Name In Type Required Description
orgId path string true Organization name as it is registered in Mas-Stack
order_id path string true Internal logistics order id
size query integer true Page size
page query integer true Page number

Request example

1
2
3
4
5


curl -X GET https://logistics.sta.masstack.com/v2/orgs/yoigo/core/orders/888888-A9293/products?size='100'&page='1'?size=100&page=1 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK Success ArrayOfProductWithExpedition
4XX Unknown Response for client error when some field in the request is missing or invalid. [Error]
5XX Unknown Response when an internal or unexpected error occurs. [Error]

Parameters

Name In Type Required Description
orgId path string true Organization name as it is registered in Mas-Stack
order_id path string true Internal logistics order id
product_id path string true Product id, usually subscription_device_id

Request example

1
2
3
4
5


curl -X GET https://logistics.sta.masstack.com/v2/orgs/yoigo/core/orders/888888-A9293/products/888888-A9293 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK Success ProductWithExpedition
4XX Unknown Response for client error when some field in the request is missing or invalid. [Error]
5XX Unknown Response when an internal or unexpected error occurs. [Error]

Parameters

Name In Type Required Description
orgId path string true Organization name as it is registered in Mas-Stack
order_id path string true Internal logistics order id
size query integer true Page size
page query integer true Page number

Request example

1
2
3
4
5


curl -X GET https://logistics.sta.masstack.com/v2/orgs/yoigo/core/orders/d290f1ee-6c54-4b01-90e6-d701748f0851/documents?size='100'&page='1'?size=100&page=1 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK Success ArrayOfDocuments
4XX Unknown Response for client error when some field in the request is missing or invalid. [Error]
5XX Unknown Response when an internal or unexpected error occurs. [Error]

Parameters

Name In Type Required Description
orgId path string true Organization name as it is registered in Mas-Stack
order_id path string true Internal logistics order id
document_id path string true The public document id managed by mas-logistics

Request example

1
2
3
4
5


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 "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK Success DocumentWithUrl
4XX Unknown Response for client error when some field in the request is missing or invalid. [Error]
5XX Unknown Response when an internal or unexpected error occurs. [Error]

Parameters

Name In Type Required Description
orgId path string true Organization name as it is registered in Mas-Stack
order_id path string true Internal logistics order id
size query integer true Page size
page query integer true Page number

Request example

1
2
3
4
5


curl -X GET https://logistics.sta.masstack.com/v2/orgs/yoigo/core/orders/d290f1ee-6c54-4b01-90e6-d701748f0851/communications?size='100'&page='1'?size=100&page=1 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK Success ArrayOfOrderCommunications
4XX Unknown Response for client error when some field in the request is missing or invalid. [Error]
5XX Unknown Response when an internal or unexpected error occurs. [Error]
Name In Type Required Description
orgId path string true Organization name as it is registered in Mas-Stack
body body SignDocumentsRequest true Information needed to sign the documents

Request body - instance of 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

Request example

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


curl -X POST https://logistics.sta.masstack.com/v2/orgs/yoigo/core/orders/documents/sign \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'order_ids': [
    '6ea0ca52-e194-45e2-a4fd-6d93923682bd',
    '8b243340-4b87-4b9b-bead-781698931477'
  ]
}"
Code Meaning Description Schema
200 OK Success SignDocumentsResponse
4XX Unknown Response for client error when some field in the request is missing or invalid. [Error]
5XX Unknown Response when an internal or unexpected error occurs. [Error]

Parameters

Name In Type Required Description
orgId path string true Organization name as it is registered in Mas-Stack
order_id path string true Internal logistics order id
body body CancellationRequest true Information needed to create a cancellation request

Request body - instance of 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]

Request example

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


curl -X POST https://logistics.sta.masstack.com/v2/orgs/yoigo/core/orders/888888-A9293/cancellation \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  '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'
    }
  ]
}"

Responses

Code Meaning Description Schema
200 OK Success CancellationRequest
4XX Unknown Response for client error when some field in the request is missing or invalid. [Error]
5XX Unknown Response when an internal or unexpected error occurs. [Error]

Parameters

Name In Type Required Description
orgId path string true Organization name as it is registered in Mas-Stack
order_id path string true Internal logistics order id
body body DeliveryConfirmationRequest true Information needed to create a cancellation request

Request body - instance of 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]

Request example

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


curl -X POST https://logistics.sta.masstack.com/v2/orgs/yoigo/core/orders/888888-A9293/confirmDelivery \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --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'
    }
  ]
}"

Responses

Code Meaning Description Schema
200 OK Success DeliveryConfirmationRequest
4XX Unknown Response for client error when some field in the request is missing or invalid. [Error]
5XX Unknown Response when an internal or unexpected error occurs. [Error]

Parameters

Name In Type Required Description
orgId path string true Organization name as it is registered in Mas-Stack
salesChannel query DataSalesChannelEnum false Sales channel identifier
salesType query DataSalesTypeEnum false Sales Type identifier
productId query string false Product identifier

Enumerated Values

Property Values
salesChannel one of [TELE_SALE_CARE, EXCLUSIVE_POS, FRANCHISE_POS, INDIRECT_POS, SELF_SALE_CARE, D2D]
salesType one of [NEW_SALE, ADD_SUBSCRIPTION_TO_BUNDLE, MIGRATION, EXISTENT_SUBSCRIPTION]

Request example

1
2
3
4
5


curl -X GET https://logistics.sta.masstack.com/v2/orgs/yoigo/core/stock?salesChannel='TELE_SALE_CARE'&salesType='NEW_SALE'&productId='string' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK Success ArrayOfStockItem
4XX Unknown Response for client error when some field in the request is missing or invalid. [Error]
5XX Unknown Response when an internal or unexpected error occurs. [Error]

Endpoints

Direct Logistics

    Reverse Logistics

      Expeditions Logistics

        External Logistic Operator

          Logistics Management