Deployed Equipment

Overview

The Deployed Equipment resources in the POS Portal API are essential for managing the devices or equipment that have been shipped to and are associated with specific merchants. These resources allow you to track the status, manage the deployment, and maintain the equipment throughout its lifecycle. This guide will walk you through how to effectively use the deployed equipment resources.

Managing Deployed Equipment

Managing deployed equipment involves tracking devices from deployment through their entire lifecycle, including updates, maintenance, and eventual decommissioning. Below are the key steps for using the deployed equipment resources in the POS Portal API.

Step 1: Retrieve Deployed Equipment

To manage deployed equipment effectively, you need to start by retrieving detailed information about the devices that have been deployed to specific merchants.

• Get Deployed Equipment
  Use this endpoint to retrieve a list of all deployed equipment associated with a specific merchant or location. This allows you to monitor the status and details of each device in the field. The response will include details such as equipment IDs, serial numbers, deployment dates, and status, helping you maintain an accurate record of all deployed devices.

  GET /v2/deployedequipment
  

Sample Request

  {
    "merchantId": "12345",
  }

Step 2: Retrieve Specific Equipment Details

Once you have a list of deployed equipment, you may need to drill down into the details of a specific device.

• Get Specific Deployed Equipment Details
  Use this endpoint to retrieve detailed information about a specific piece of deployed equipment, including its configuration, status, and any associated data. This endpoint provides in-depth information about the selected device, allowing you to manage it more effectively.

  GET /v2/deployedequipment/{id}
  

Step 3: Update Deployed Equipment

As equipment is used, it may need updates or maintenance. Keeping the deployed equipment records up-to-date is crucial for accurate tracking.

• Update Deployed Equipment
  Use this endpoint to update the status or details of deployed equipment. This could involve changing its status to reflect maintenance, repair, or decommissioning. This ensures that the records for each piece of deployed equipment are current and accurate.

  POST /v2/deployedequipment/{id}
  

Summary

Effective management of deployed equipment is key to ensuring that all devices in the field are properly tracked, maintained, and updated throughout their lifecycle. By using the deployed equipment resources in the POS Portal API, you can keep detailed records, monitor equipment status, and manage updates or maintenance as needed.

For more detailed information on the Deployed Equipment endpoint and its parameters, please refer to the POS Portal API Documentation.