Devices

Get devices

Get all devices filtering. This endpoint cannot be called without a query parameter.

GET /orgs/{org}/subscriptions/devices

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name
mac_address	query	string	false	Mac address filter. Required if ‘serial_number’ filter is not provided
serial_number	query	string	false	Serial number filter. Required if ‘mac_address’ filter is not provided

Request example

1
2
3
4
5



curl -X GET https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/devices?mac_address='00-B0-D0-63-C2-26'&serial_number='SN-48392A7F4B' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Devices found	[Device]
403	Forbidden	Forbidden access	ErrorResponse
404	Not Found	A subscription with the specified id was not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
default	Default	Any client or server error	ErrorResponse

Get subscription devices

Get all subscription devices associated to the subscription

GET /orgs/{org}/subscriptions/{subscriptionId}/devices

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name
subscriptionId	path	string(uuid)	true	Subscription unique identifier
mac_address	query	string	false	Mac address filter

Request example

1
2
3
4
5



curl -X GET https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/devices?mac_address='00-B0-D0-63-C2-26' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Devices found for the subscription	[Device]
403	Forbidden	Forbidden access	ErrorResponse
404	Not Found	A subscription with the specified id was not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
default	Default	Any client or server error	ErrorResponse

Add device to subscription

Add a new device to a subscription

POST /orgs/{org}/subscriptions/{subscriptionId}/devices

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name
subscriptionId	path	string(uuid)	true	Subscription unique identifier
body	body	Device	true	Add device data

Request body - instance of 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
29
30
31
32


{
  "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
  "legacy_id": 756402,
  "catalogue_commercial_device_id": "CDCVPU_150f5badaa706651e67c59061d373d7e7e",
  "catalogue_device_id": "P09712MRC",
  "reservation_id": "1567",
  "signature_process_id": "18395",
  "shipping_order_id": "18395",
  "pickup_order_id": "P0000001",
  "in_store_delivery_date": "2025-01-05T03:30:15Z",
  "in_store_returned_date": "2025-01-05T03:30:15Z",
  "manufacturing_info": {
    "id_type": "SERIAL_NUMBER",
    "id": "9876543-AB-345"
  },
  "serial_number": "9876543-AB-345",
  "mac_address": "00-B0-D0-63-C2-26",
  "imei": "AA-BBBBBB-CCCCCC-D",
  "acquisition_type": "BORROWED",
  "commitments": [
    {
      "id": "ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39",
      "legacy_id": 345,
      "expiration_date": "2025-01-05T03:30:15Z",
      "cancellation_date": "2025-02-13T10:35:05Z",
      "cancellation_system": "killflex.auth.masmovil.com",
      "cancellation_user": "john.doe@masorange.es"
    }
  ],
  "insurable_amount": 135.49,
  "legacy_account_id": "245655"
}

Name	Type	Required	Description
id	string(uuid)	false	Device unique identifier
legacy_id	integer	false	Legacy unique identifier of the device associated with the subscription
catalogue_commercial_device_id	string	true	Commercial device id according to catalogue definition
catalogue_device_id	string	false	Device id according to catalogue definition
reservation_id	string	false	Id for device reservation
signature_process_id	string	false	Id of the resource containing subscriber valid signature to purchase device
shipping_order_id	string	false	Id of the shipping order related to the device according to logistic
pickup_order_id	string	false	Id of the pickup order related to the device according to reverse logistic
in_store_delivery_date	string(date-time)	false	In shop delivery date to the customer. Format according to ISO 8601.
in_store_returned_date	string(date-time)	false	In shop returned date. Format according to ISO 8601.
manufacturing_info	object	false	none
» id_type	string	false	Manufacturing id type
» id	string	false	Unique id for specific device
serial_number	string	false	The serial number or any alphanumeric identifier of a particular device
mac_address	string	false	A unique identifier assigned to the device network interface controller
imei	string	false	The International Mobile Equipment Identity of the device
acquisition_type	string	false	Specifies the type of acquisition for the device
commitments	[Commitment]	false	none
insurable_amount	number	false	The insurable value of the device, representing the maximum coverage amount for insurance purposes. A null value indicates that the device is not insurable
legacy_account_id	integer	true	Account ID associated with the subscription. Currently tied to MySim/Apollo storage.

Property	Values
acquisition_type	one of [BORROWED, FINANCED, ONE_TIME_PAYMENT]

Request example

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



curl -X POST https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/devices \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'catalogue_commercial_device_id': 'CDCVPU_150f5badaa706651e67c59061d373d7e7e',
  'reservation_id': '1567',
  'signature_process_id': '18395',
  'manufacturing_info': {
    'id_type': 'SERIAL_NUMBER',
    'id': '9876543-AB-345'
  },
  'serial_number': '9876543-AB-345',
  'mac_address': '00-B0-D0-63-C2-26',
  'imei': 'AA-BBBBBB-CCCCCC-D',
  'commitments': [
    {}
  ],
  'insurable_amount': 135.49
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Device added to subscription	Device
403	Forbidden	Forbidden access	ErrorResponse
404	Not Found	A subscription with the specified id was not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
default	Default	Any client or server error	ErrorResponse

Get device by ID

Get info for a specific device

GET /orgs/{org}/subscriptions/{subscriptionId}/devices/{deviceId}

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name
subscriptionId	path	string(uuid)	true	Subscription unique identifier
deviceId	path	string(uuid)	true	Device unique identifier

Request example

1
2
3
4
5



curl -X GET https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/devices/fd2fcd90-2218-4ef1-917b-7ce5f35eee1c \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Device found	Device
403	Forbidden	Forbidden access	ErrorResponse
404	Not Found	A device with the specified id was not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
default	Default	Any client or server error	ErrorResponse

Patch device

Updates device's data

PATCH /orgs/{org}/subscriptions/{subscriptionId}/devices/{deviceId}

Parameters

Name	In	Type	Required	Description
org	path	string	true	Organization name
subscriptionId	path	string(uuid)	true	Subscription unique identifier
deviceId	path	string(uuid)	true	Device unique identifier
body	body	OperationsSet	true	Array of operations to apply to the device

Request body - JsonObject

1
2
3
4
5
6
7
8


[
  {
    "op": "add",
    "path": "/status",
    "value": "DEACTIVATED",
    "reason": "SUBSCRIBER_REQUESTED"
  }
]

Name	Type	Required	Description
anonymous	[Operation]	false	none

Request example

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



curl -X PATCH https://subscriptions.masstack.com/v2/orgs/yoigo/subscriptions/ce2f20cb-35df-4ffe-bca6-c0ed0c28cb39/devices/fd2fcd90-2218-4ef1-917b-7ce5f35eee1c \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "[
  {
    'op': 'add',
    'path': '/status',
    'value': 'DEACTIVATED',
    'reason': 'SUBSCRIBER_REQUESTED'
  }
]" 

Responses

Code	Meaning	Description	Schema
200	OK	Device patched successfully	Device
400	Bad Request	Bad request	ErrorResponse
403	Forbidden	Forbidden access	ErrorResponse
404	Not Found	A device with the specified id was not found	ErrorResponse
500	Internal Server Error	Internal server error	ErrorResponse
default	Default	Any client or server error	ErrorResponse