Chips

List Chips

GET /v2/chips

Parameter	Description
attributes	Specifies which attributes to retrieve. Can include values like 'serial', 'number', 'carrier', 'service_provider', and 'batch'. If null, retrieves all information.
includes	Specifies related entities to include in the query. Contains arrays for 'device' and 'enterprise', each with its own set of possible values, such as 'name', 'imei', 'code' for the 'device' array, and 'name', 'cnpj' for the 'enterprise' array.
filters	Specifies filters for various fields such as 'chips.serial', 'chips.number', 'chips.carrier', 'chips.service_provider', 'chips.batch', 'device.name', 'device.imei', 'device.code', 'enterprise.name', 'enterprise.cnpj'. Each filter field supports conditions like 'eq', 'neq', 'ilk', 'ew', 'sw'.
search	Specifies the search query with a maximum length of 100 characters.
limit	Specifies the maximum number of results to return. Must be a number between 1 and 100.
page	Specifies the page number for paginated results. Must be a number greater than or equal to 0.
count	Indicates whether to include the total count of results in the response.
sort	Specifies sorting criteria for 'number' and 'serial' fields. Values can be -1 (descending order) or 1 (ascending order).

Responses

Status	Meaning	Description
200	OK	Default Response
400	Bad Request	Bad Request

Create Chip

POST /v2/chips

Payload

{
  "body": {
    "data": [
      {
        "attributes": {
          "serial": "8996543747544368975",
          "number": "55319938457737",
          "carrier": "Softruck",
          "service_provider": "Vivo",
          "batch": "Batch 13"
        },
        "relationships": {
          "enterprise": {
            "type": "enterprise",
            "id": "123456789012345"
          }
        }
      }
    ]
  }
}

Field	Description	Required
data	Array of objects containing data attributes and relationships.	true
attributes	Object containing attributes related to the data.	true
- serial	String named after the serial number of the data. It must be maximum length of 20 characters, consisting only of digits.	true
- number	String named after the number attribute of the data. It must be maximum length of 20 characters, consisting only of digits.	true
- carrier	String named after the carrier attribute of the data. It can contain maximum length of 255 characters.	false
- service_provider	String named after the service provider attribute of the data. It must be maximum length of 50 characters.	true
- batch	String named after the batch attribute of the data. It can contain maximum length of 50 characters.	false
relationships	Object containing relationship data.	false
- enterprise	Object that represents the relationship with an enterprise.	false
- type	String named after the type of relationship.	true
- id	String named after the ID of the enterprise. It must be length of 15 characters, consisting of alphanumeric characters (uppercase and lowercase letters, and digits).	true

Responses

Status	Meaning	Description
200	OK	Default Response
400	Bad Request	One of 'Chip Already Exists', 'Chip Enterprise Data Required' or 'Validation Failed'

This operation does not require authentication

Delete Chips

DELETE /v2/chips

Payload

{
  "body": {
    "data": [
      {
        "type": "chips",
        "id": "ABC1234567890DEF"
      },
      {
        "type": "chips",
        "id": "GHI9876543210JKL"
      }
    ]
  }
}

Field	Description	Required
data	Array containing objects representing data items to be deleted.
type	String that specifies the type of data to be deleted.	true
id	String named after a length of 15 alphanumeric characters (uppercase and lowercase letters, and digits).	true

Responses

Status	Meaning	Description
200	OK	Default Response
400	Bad Request	One of 'Bad Request', 'Cannot Delete Chip(s)', 'Softruck Chip's Cannot Be Deleted'
401	Unauthorized	Unauthorized
404	Not Found	Not Found

This operation does not require authentication

Show Chip

GET /v2/chips/{id}

Parameter	Description
attributes	An array of strings specifying the attributes of the chips to be returned in the response, such as 'serial', 'number', 'carrier', 'service_provider', and 'batch'.
includes	Specifies related entities to include in the query. Contains arrays for 'device' and 'enterprise', each with its own set of possible values, such as 'name', 'imei', 'code' for the 'device' array, and 'name', 'cnpj' for the 'enterprise' array.

Responses

Status	Meaning	Description
200	OK	Default Response
400	Bad Request	Bad Request
401	Unauthorized	Unauthorized
404	Not Found	Not Found

This operation does not require authentication

Update Chips

PATCH /v2/chips/{id}

Payload

{
  "body": {
    "data": {
      "attributes": {
        "serial": "12345678901234567890",
        "number": "55319938457737",
        "carrier": "Softruck",
        "service_provider": "Vivo",
        "batch": "Batch 13"
      },
      "relationships": {
        "enterprise": {
          "type": "enterprise",
          "id": "123456789012345"
        }
      }
    }
  }
}

Field	Description	Required
data	Array of objects containing data attributes and relationships.	true
attributes	Object containing data-related attributes.	true
- serial	String of characters named after to the Integrated Circuit Card Identifier (ICCID), which is an 18 to 22 digit number usually printed on the back of a SIM card.	true
- number	String of characters named after to the Mobile Station International Subscriber Directory Number (MSISDN).	true
- carrier	String of characters named after to the line operator. Can contain a maximum length of 255 characters.	false
- service_provider	String of characters named after to the service provider. Must have a maximum length of 50 characters.	true
- batch	String of characters named after to the data batch attribute. Can contain a maximum length of 50 characters.	false
relationships	Object containing relationship data.	false
- enterprise	Object representing the relationship with a company.	false
- type	String of characters named after to the relationship type.	true
- id	String of characters named after to the company ID. Must have a length of 15 characters, composed of alphanumeric characters (uppercase and lowercase letters and digits).	true

Responses

Status	Meaning	Description
200	OK	Default Response
400	Bad Request	One of 'Bad Request', 'Cannot Update Chip(s)', 'Cannot Update Chip`s Enterprise With a Not Child Enterprise Owner'
401	Unauthorized	Unauthorized

This operation does not require authentication

Authentication Devices