# paths./bulk_device_unlock.post.description
Allows a request to perform an additional unlock check.

This action has an additional service fee for each use, with a delay prior to the check.

# paths./bulk_request.post.description
Create a bulk return, with multiple return requests inside a specified recovery program.

# paths./create_user.post.description
Create a new user, connected to the specified customer.

# paths./customer.get.description
Request the list of customer accounts that the current user can access.

# paths./customer.get.parameters[].description
A page number within the paginated result set.

# paths./customer/{customer_id}.patch.description
Modify settings for a customer account, replacing only those details which are provided.

# paths./customer/{customer_id}/upload_logo.post.description
Upload a customer logo to the CDN. Allowed file types are PNG, JPG, and SVG.

# paths./dashboard/device_compliance.get.description
Provides data for reviewing device compliance.

This tracking is reliant on the use of expected device details, and
will not provide full functionality for unknown device recovery.

# paths./dashboard/device_compliance.get.parameters[].description
Multiple values may be separated by commas.

# paths./dashboard/device_compliance.get.parameters[].description
Multiple values may be separated by commas.

# paths./dashboard/devices_by_condition_grade.get.description
Provides data for reviewing device grades for recovered devices.

# paths./dashboard/devices_by_condition_grade.get.parameters[].description
Multiple values may be separated by commas.

# paths./dashboard/devices_by_condition_grade.get.parameters[].description
Multiple values may be separated by commas.

# paths./dashboard/employee_purchase_status.get.parameters[].description
Multiple values may be separated by commas.

# paths./dashboard/enrollment_status.get.parameters[].description
Multiple values may be separated by commas.

# paths./dashboard/environmental_impact.get.description
Provides data for reviewing environmental impacts from device recovery.

# paths./dashboard/environmental_impact.get.parameters[].description
Multiple values may be separated by commas.

# paths./dashboard/environmental_impact.get.parameters[].description
Multiple values may be separated by commas.

# paths./dashboard/program_notification.get.parameters[].description
Multiple values may be separated by commas.

# paths./dashboard/program_status.get.parameters[].description
Multiple values may be separated by commas.

# paths./dashboard/recovery_rate.get.description
Return the data that is needed to generate the recovery rate chart.

# paths./dashboard/recovery_rate.get.parameters[].description
Multiple values may be separated by commas.

# paths./dashboard/recovery_rate.get.parameters[].description
Multiple values may be separated by commas.

# paths./dashboard/requested_devices.get.parameters[].description
Multiple values may be separated by commas.

# paths./dashboard/requested_devices.get.parameters[].description
Multiple values may be separated by commas.

# paths./dashboard/total_devices.get.description
Provides data for monitoring overall device recovery.

# paths./dashboard/total_devices.get.parameters[].description
Multiple values may be separated by commas.

# paths./dashboard/total_devices.get.parameters[].description
* `month` - month
* `day` - day
* `week` - week
* `year` - year
* `quarter` - quarter

# paths./dashboard/total_devices.get.parameters[].description
Multiple values may be separated by commas.

# paths./device.get.description
List the devices that are part of a specified recovery program

# paths./device.get.parameters[].description
Multiple values may be separated by commas.

# paths./device.get.parameters[].description
Multiple values may be separated by commas.

# paths./device.get.parameters[].description
Multiple values may be separated by commas.

# paths./device.get.parameters[].description
* `Mobile` - Mobile
* `Tablet` - Tablet
* `Laptop` - Laptop
* `Desktop` - Desktop
* `CompactDesktop` - CompactDesktop
* `IntegratedDesktop` - IntegratedDesktop
* `Unknown` - Unknown

# paths./device.get.parameters[].description
Multiple values may be separated by commas.

# paths./device.get.parameters[].description
Multiple values may be separated by commas.

# paths./device.get.parameters[].description
Multiple values may be separated by commas.

# paths./device.get.parameters[].description
Multiple values may be separated by commas.

# paths./device.get.parameters[].description
A page number within the paginated result set.

# paths./device.get.parameters[].description
Multiple values may be separated by commas.

# paths./device.get.parameters[].description
Multiple values may be separated by commas.

# paths./device.get.parameters[].description
Multiple values may be separated by commas.

# paths./device.get.parameters[].description
Multiple values may be separated by commas.

# paths./device.get.parameters[].description
Ordering

* `delivery_date` - Delivery date
* `-delivery_date` - Delivery date (descending)
* `processed_date` - Processed date
* `-processed_date` - Processed date (descending)
* `status` - Status
* `-status` - Status (descending)
* `imei` - Imei
* `-imei` - Imei (descending)
* `serial_number` - Serial number
* `-serial_number` - Serial number (descending)
* `note` - Note
* `-note` - Note (descending)
* `model_number` - Model number
* `-model_number` - Model number (descending)
* `make` - Make
* `-make` - Make (descending)
* `model` - Model
* `-model` - Model (descending)
* `condition_grade` - Condition grade
* `-condition_grade` - Condition grade (descending)
* `device_type` - Device type
* `-device_type` - Device type (descending)
* `tracking_number` - Tracking number
* `-tracking_number` - Tracking number (descending)
* `activation_lock` - Activation lock
* `-activation_lock` - Activation lock (descending)
* `remote_managed` - Remote managed
* `-remote_managed` - Remote managed (descending)
* `firmware_lock` - Firmware lock
* `-firmware_lock` - Firmware lock (descending)
* `lock_category` - Lock category
* `-lock_category` - Lock category (descending)
* `recovery_program` - Recovery program
* `-recovery_program` - Recovery program (descending)
* `data_wipe_standard` - Data wipe standard
* `-data_wipe_standard` - Data wipe standard (descending)
* `systematic_erasure` - Systematic erasure
* `-systematic_erasure` - Systematic erasure (descending)

# paths./device.get.parameters[].description
* `DevicePending` - Device Pending
* `DeviceProcessed` - Device Processed
* `DeviceLocked` - Device Locked
* `DeviceFlagged` - Device Flagged
* `DevicePurchased` - Device Purchased
* `DevicePurchasedAndProcessed` - Device Purchased and Processed
* `DevicePurchasedAndLocked` - Device Purchased and Locked
* `DeviceFlaggedAndProcessed` - Device Flagged and Processed
* `DeviceFlaggedAndLocked` - Device Flagged and Locked

# paths./device_collection.get.description
Provides a searchable list so that IT users can collect devices.

# paths./device_collection.get.parameters[].description
Multiple values may be separated by commas.

# paths./device_collection.get.parameters[].description
Multiple values may be separated by commas.

# paths./device_collection.get.parameters[].description
Multiple values may be separated by commas.

# paths./device_collection.get.parameters[].description
Multiple values may be separated by commas.

# paths./device_collection.get.parameters[].description
A page number within the paginated result set.

# paths./device_collection.get.parameters[].description
Multiple values may be separated by commas.

# paths./device_collection.get.parameters[].description
Multiple values may be separated by commas.

# paths./device_journey.get.description
Provide the timeline details for the recovery of a device.

# paths./device_journey.get.parameters[].description
Multiple values may be separated by commas.

# paths./device_journey.get.parameters[].description
Multiple values may be separated by commas.

# paths./device_journey.get.parameters[].description
Multiple values may be separated by commas.

# paths./device_journey.get.parameters[].description
* `Mobile` - Mobile
* `Tablet` - Tablet
* `Laptop` - Laptop
* `Desktop` - Desktop
* `CompactDesktop` - CompactDesktop
* `IntegratedDesktop` - IntegratedDesktop
* `Unknown` - Unknown

# paths./device_journey.get.parameters[].description
Multiple values may be separated by commas.

# paths./device_journey.get.parameters[].description
Multiple values may be separated by commas.

# paths./device_journey.get.parameters[].description
Multiple values may be separated by commas.

# paths./device_journey.get.parameters[].description
Multiple values may be separated by commas.

# paths./device_journey.get.parameters[].description
A page number within the paginated result set.

# paths./device_journey.get.parameters[].description
Multiple values may be separated by commas.

# paths./device_journey.get.parameters[].description
Multiple values may be separated by commas.

# paths./device_journey.get.parameters[].description
Multiple values may be separated by commas.

# paths./device_journey.get.parameters[].description
Multiple values may be separated by commas.

# paths./device_journey.get.parameters[].description
Ordering

* `delivery_date` - Delivery date
* `-delivery_date` - Delivery date (descending)
* `processed_date` - Processed date
* `-processed_date` - Processed date (descending)
* `status` - Status
* `-status` - Status (descending)
* `imei` - Imei
* `-imei` - Imei (descending)
* `serial_number` - Serial number
* `-serial_number` - Serial number (descending)
* `note` - Note
* `-note` - Note (descending)
* `model_number` - Model number
* `-model_number` - Model number (descending)
* `make` - Make
* `-make` - Make (descending)
* `model` - Model
* `-model` - Model (descending)
* `condition_grade` - Condition grade
* `-condition_grade` - Condition grade (descending)
* `device_type` - Device type
* `-device_type` - Device type (descending)
* `tracking_number` - Tracking number
* `-tracking_number` - Tracking number (descending)
* `activation_lock` - Activation lock
* `-activation_lock` - Activation lock (descending)
* `remote_managed` - Remote managed
* `-remote_managed` - Remote managed (descending)
* `firmware_lock` - Firmware lock
* `-firmware_lock` - Firmware lock (descending)
* `lock_category` - Lock category
* `-lock_category` - Lock category (descending)
* `recovery_program` - Recovery program
* `-recovery_program` - Recovery program (descending)
* `data_wipe_standard` - Data wipe standard
* `-data_wipe_standard` - Data wipe standard (descending)
* `systematic_erasure` - Systematic erasure
* `-systematic_erasure` - Systematic erasure (descending)

# paths./device_journey.get.parameters[].description
* `DevicePending` - Device Pending
* `DeviceProcessed` - Device Processed
* `DeviceLocked` - Device Locked
* `DeviceFlagged` - Device Flagged
* `DevicePurchased` - Device Purchased
* `DevicePurchasedAndProcessed` - Device Purchased and Processed
* `DevicePurchasedAndLocked` - Device Purchased and Locked
* `DeviceFlaggedAndProcessed` - Device Flagged and Processed
* `DeviceFlaggedAndLocked` - Device Flagged and Locked

# paths./device_journey/{device_id}.get.description
Provide the timeline details for the recovery of a device.

# paths./device_release.post.description
Allows a request to release a device in an as is condition.

In this case, the device is not unlocked, but is released for sale at a lower value.

# paths./device_unlock.post.description
Allows a request to perform an additional unlock check.

This action has an additional service fee for each use, with a delay prior to the check.

# paths./email_domain.post.description
Create an email domain record for a customer.

# paths./email_domain/{customer_id}.get.description
Retrieve an email domain record for a customer.

# paths./email_domain/{customer_id}.put.description
Update an email domain record for a customer.

# paths./email_domain/{customer_id}.delete.description
Delete an email domain record for a customer.

# paths./email_domain/{customer_id}/verify_dkim.put.description
Initiate DKIM verification for an email domain.

# paths./email_domain/{customer_id}/verify_return_path.put.description
Initiate DKIM verification for an email domain.

# paths./expected.get.description
List the details of devices that are expected for a specified recovery program

# paths./expected.get.parameters[].description
Multiple values may be separated by commas.

# paths./expected.get.parameters[].description
A page number within the paginated result set.

# paths./expected.get.parameters[].description
Multiple values may be separated by commas.

# paths./expected.get.parameters[].description
Multiple values may be separated by commas.

# paths./expected/{id}.get.parameters[].description
A UUID string identifying this expected device.

# paths./freight_shipment.get.parameters[].description
A page number within the paginated result set.

# paths./freight_shipment.get.parameters[].description
Multiple values may be separated by commas.

# paths./freight_shipment.get.parameters[].description
* `PreTransit` - Pre Transit
* `InTransit` - In Transit
* `Delivered` - Delivered
* `Exception` - Exception

# paths./freight_shipment/{id}.get.parameters[].description
A unique integer value identifying this freight shipment.

# paths./freight_shipment/{id}.put.parameters[].description
A unique integer value identifying this freight shipment.

# paths./freight_shipment/{id}.patch.parameters[].description
A unique integer value identifying this freight shipment.

# paths./freight_shipment/{id}.delete.parameters[].description
A unique integer value identifying this freight shipment.

# paths./fulfillment_facility.get.description
Provides the list of facilities that are available for logistics fulfillment operations.

# paths./fulfillment_facility.get.parameters[].description
Multiple values may be separated by commas.

# paths./fulfillment_facility.get.parameters[].description
A page number within the paginated result set.

# paths./fulfillment_facility.post.description
Adds a new location for fulfillment operations.

# paths./fulfillment_facility/{name}.get.description
Get the details for the specified fulfillment facility.

# paths./fulfillment_facility/{name}.put.description
Update the settings for the specified fulfillment facility.

# paths./fulfillment_facility/{name}.patch.description
Update the settings for the specified fulfillment facility, changing only those items which are provided.

# paths./fulfillment_facility/{name}.delete.description
Deactivate the specified fulfillment facility

# paths./grid/compliance.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/compliance.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/compliance.get.parameters[].description
* `API` - API
* `RecoveryWizard` - Recovery Wizard
* `CSVUpload` - CSV Upload

# paths./grid/compliance.get.parameters[].description
A page number within the paginated result set.

# paths./grid/compliance.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/compliance.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/compliance.get.parameters[].description
* `RecoNotification` - Reco Notification
* `ReturnLabel` - Return Label
* `IndividualDeviceKit` - Individual Device Kit
* `BulkDeviceKit` - Bulk Device Kit
* `BulkTabletKit` - Bulk Tablet Kit
* `BulkReturnLabel` - Bulk Return Label
* `External` - External
* `LaptopKit` - Laptop Kit

# paths./grid/compliance.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/compliance.get.parameters[].description
* `InTransitToCenter` - In transit to center
* `DeliveredToCenter` - Delivered to center
* `InTransitToEndUser` - In transit to end user
* `DeliveredToEndUser` - Delivered to end user
* `PreTransit` - Pre Transit
* `Inactive` - Inactive
* `Failure` - Failure

# paths./grid/compliance.get.parameters[].description
Ordering

* `serial_number` - Serial number
* `-serial_number` - Serial number (descending)
* `request_date` - Request date
* `-request_date` - Request date (descending)
* `name` - Name
* `-name` - Name (descending)
* `method` - Method
* `-method` - Method (descending)
* `status` - Status
* `-status` - Status (descending)
* `recovery_type` - Recovery type
* `-recovery_type` - Recovery type (descending)
* `tracking_number` - Tracking number
* `-tracking_number` - Tracking number (descending)
* `program_name` - Program name
* `-program_name` - Program name (descending)
* `imei` - Imei
* `-imei` - Imei (descending)
* `recipient_email` - Recipient email
* `-recipient_email` - Recipient email (descending)

# paths./grid/compliance.get.parameters[].description
* `AwaitingMethod` - Awaiting method
* `ReturnRequested` - Return requested
* `Failure` - Failure
* `Complete` - Complete
* `Cancelled` - Cancelled

# paths./grid/processing_view.get.description
View recovered devices for a recovery program.

# paths./grid/processing_view.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/processing_view.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/processing_view.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/processing_view.get.parameters[].description
* `Mobile` - Mobile
* `Tablet` - Tablet
* `Laptop` - Laptop
* `Desktop` - Desktop
* `CompactDesktop` - CompactDesktop
* `IntegratedDesktop` - IntegratedDesktop
* `Unknown` - Unknown

# paths./grid/processing_view.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/processing_view.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/processing_view.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/processing_view.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/processing_view.get.parameters[].description
A page number within the paginated result set.

# paths./grid/processing_view.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/processing_view.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/processing_view.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/processing_view.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/processing_view.get.parameters[].description
Ordering

* `delivery_date` - Delivery date
* `-delivery_date` - Delivery date (descending)
* `processed_date` - Processed date
* `-processed_date` - Processed date (descending)
* `status` - Status
* `-status` - Status (descending)
* `imei` - Imei
* `-imei` - Imei (descending)
* `serial_number` - Serial number
* `-serial_number` - Serial number (descending)
* `note` - Note
* `-note` - Note (descending)
* `model_number` - Model number
* `-model_number` - Model number (descending)
* `make` - Make
* `-make` - Make (descending)
* `model` - Model
* `-model` - Model (descending)
* `condition_grade` - Condition grade
* `-condition_grade` - Condition grade (descending)
* `device_type` - Device type
* `-device_type` - Device type (descending)
* `tracking_number` - Tracking number
* `-tracking_number` - Tracking number (descending)
* `activation_lock` - Activation lock
* `-activation_lock` - Activation lock (descending)
* `remote_managed` - Remote managed
* `-remote_managed` - Remote managed (descending)
* `firmware_lock` - Firmware lock
* `-firmware_lock` - Firmware lock (descending)
* `lock_category` - Lock category
* `-lock_category` - Lock category (descending)
* `recovery_program` - Recovery program
* `-recovery_program` - Recovery program (descending)
* `data_wipe_standard` - Data wipe standard
* `-data_wipe_standard` - Data wipe standard (descending)
* `systematic_erasure` - Systematic erasure
* `-systematic_erasure` - Systematic erasure (descending)

# paths./grid/processing_view.get.parameters[].description
* `DevicePending` - Device Pending
* `DeviceProcessed` - Device Processed
* `DeviceLocked` - Device Locked
* `DeviceFlagged` - Device Flagged
* `DevicePurchased` - Device Purchased
* `DevicePurchasedAndProcessed` - Device Purchased and Processed
* `DevicePurchasedAndLocked` - Device Purchased and Locked
* `DeviceFlaggedAndProcessed` - Device Flagged and Processed
* `DeviceFlaggedAndLocked` - Device Flagged and Locked

# paths./grid/request_history.get.description
Provides request history information details needed for display in the recovery platform.

# paths./grid/request_history.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/request_history.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/request_history.get.parameters[].description
* `API` - API
* `RecoveryWizard` - Recovery Wizard
* `CSVUpload` - CSV Upload

# paths./grid/request_history.get.parameters[].description
A page number within the paginated result set.

# paths./grid/request_history.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/request_history.get.parameters[].description
* `RetailReturn` - Retail Return
* `EmployeePurchase` - Employee Purchase
* `EmployeePurchasePlus` - Employee Purchase Plus
* `ReturnLabel` - Return Label
* `IndividualDeviceKit` - Individual Device Kit
* `LaptopKit` - Laptop Kit
* `DeviceCollection` - Device Collection

# paths./grid/request_history.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/request_history.get.parameters[].description
* `RecoNotification` - Reco Notification
* `ReturnLabel` - Return Label
* `IndividualDeviceKit` - Individual Device Kit
* `BulkDeviceKit` - Bulk Device Kit
* `BulkTabletKit` - Bulk Tablet Kit
* `BulkReturnLabel` - Bulk Return Label
* `External` - External
* `LaptopKit` - Laptop Kit

# paths./grid/request_history.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/request_history.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/request_history.get.parameters[].description
Ordering

* `request_date` - Request date
* `-request_date` - Request date (descending)
* `recipient_name` - Recipient name
* `-recipient_name` - Recipient name (descending)
* `recipient_email` - Recipient email
* `-recipient_email` - Recipient email (descending)
* `sender_name` - Sender name
* `-sender_name` - Sender name (descending)
* `sender_email` - Sender email
* `-sender_email` - Sender email (descending)
* `address1` - Address1
* `-address1` - Address1 (descending)
* `address2` - Address2
* `-address2` - Address2 (descending)
* `city` - City
* `-city` - City (descending)
* `state` - State
* `-state` - State (descending)
* `postal_code` - Postal code
* `-postal_code` - Postal code (descending)
* `country_code` - Country code
* `-country_code` - Country code (descending)
* `method` - Method
* `-method` - Method (descending)
* `status` - Status
* `-status` - Status (descending)
* `recovery_type` - Recovery type
* `-recovery_type` - Recovery type (descending)
* `imei` - Imei
* `-imei` - Imei (descending)
* `serial_number` - Serial number
* `-serial_number` - Serial number (descending)
* `program_name` - Program name
* `-program_name` - Program name (descending)

# paths./grid/request_history.get.parameters[].description
* `AwaitingMethod` - Awaiting method
* `ReturnRequested` - Return requested
* `Failure` - Failure
* `Complete` - Complete
* `Cancelled` - Cancelled

# paths./grid/settlement.get.description
View recovered devices for a recovery program.

# paths./grid/settlement.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/settlement.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/settlement.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/settlement.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/settlement.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/settlement.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/settlement.get.parameters[].description
A page number within the paginated result set.

# paths./grid/settlement.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/settlement.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/settlement.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/settlement.get.parameters[].description
Ordering

* `processor_unique_number` - Processor unique number
* `-processor_unique_number` - Processor unique number (descending)
* `serial_number` - Serial number
* `-serial_number` - Serial number (descending)
* `imei` - Imei
* `-imei` - Imei (descending)
* `make` - Make
* `-make` - Make (descending)
* `model` - Model
* `-model` - Model (descending)
* `model_number` - Model number
* `-model_number` - Model number (descending)
* `asset_number` - Asset number
* `-asset_number` - Asset number (descending)
* `damages` - Damages
* `-damages` - Damages (descending)
* `damages_currency` - Damages currency
* `-damages_currency` - Damages currency (descending)
* `model_number` - Model number
* `-model_number` - Model number (descending)
* `grade` - Grade
* `-grade` - Grade (descending)
* `name` - Name
* `-name` - Name (descending)

# paths./grid/tracking_view.get.description
Provides tracking status details needed for display in the recovery platform.

# paths./grid/tracking_view.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/tracking_view.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/tracking_view.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/tracking_view.get.parameters[].description
* `API` - API
* `RecoveryWizard` - Recovery Wizard
* `CSVUpload` - CSV Upload

# paths./grid/tracking_view.get.parameters[].description
A page number within the paginated result set.

# paths./grid/tracking_view.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/tracking_view.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/tracking_view.get.parameters[].description
* `RecoNotification` - Reco Notification
* `ReturnLabel` - Return Label
* `IndividualDeviceKit` - Individual Device Kit
* `BulkDeviceKit` - Bulk Device Kit
* `BulkTabletKit` - Bulk Tablet Kit
* `BulkReturnLabel` - Bulk Return Label
* `External` - External
* `LaptopKit` - Laptop Kit

# paths./grid/tracking_view.get.parameters[].description
Multiple values may be separated by commas.

# paths./grid/tracking_view.get.parameters[].description
Ordering

* `carrier` - Carrier
* `-carrier` - Carrier (descending)
* `method` - Method
* `-method` - Method (descending)
* `name` - Name
* `-name` - Name (descending)
* `out_of_compliance` - Out of compliance
* `-out_of_compliance` - Out of compliance (descending)
* `recovery_type` - Recovery type
* `-recovery_type` - Recovery type (descending)
* `request_date` - Request date
* `-request_date` - Request date (descending)
* `status` - Status
* `-status` - Status (descending)
* `tracking_number` - Tracking number
* `-tracking_number` - Tracking number (descending)
* `email` - Email
* `-email` - Email (descending)
* `delivery_date` - Delivery date
* `-delivery_date` - Delivery date (descending)
* `tracking_url` - Tracking url
* `-tracking_url` - Tracking url (descending)
* `label_image_url` - Label image url
* `-label_image_url` - Label image url (descending)
* `program_name` - Program name
* `-program_name` - Program name (descending)
* `estimated_delivery_date` - Estimated delivery date
* `-estimated_delivery_date` - Estimated delivery date (descending)

# paths./grid/tracking_view.get.parameters[].description
* `InTransitToCenter` - In transit to center
* `DeliveredToCenter` - Delivered to center
* `InTransitToEndUser` - In transit to end user
* `DeliveredToEndUser` - Delivered to end user
* `PreTransit` - Pre Transit
* `Inactive` - Inactive
* `Failure` - Failure

# paths./grid/tracking_view.get.parameters[].description
Multiple values may be separated by commas.

# paths./itad_facility.get.description
Provides the list of facilities that are available for device processing operations.

# paths./itad_facility.get.parameters[].description
Multiple values may be separated by commas.

# paths./itad_facility.get.parameters[].description
A page number within the paginated result set.

# paths./itad_facility.post.description
Adds a new location for processing operations.

# paths./itad_facility/{name}.get.description
Get the details for the specified processing facility.

# paths./itad_facility/{name}.put.description
Update the settings for the specified processing facility.

# paths./itad_facility/{name}.patch.description
Update the settings for the specified processing facility, changing only those items which are provided.

# paths./itad_facility/{name}.delete.description
Deactivate the specified processing facility.

# paths./job_id.get.parameters[].description
Multiple values may be separated by commas.

# paths./job_id.get.parameters[].description
A page number within the paginated result set.

# paths./job_id/{id}.get.parameters[].description
A unique integer value identifying this fulfillment job id.

# paths./job_id/{id}.put.parameters[].description
A unique integer value identifying this fulfillment job id.

# paths./job_id/{id}.patch.parameters[].description
A unique integer value identifying this fulfillment job id.

# paths./job_id/{id}.delete.parameters[].description
A unique integer value identifying this fulfillment job id.

# paths./label_download.get.parameters[].description
Multiple values may be separated by commas.

# paths./my_customer.get.description
Describe the current user's organization.

# paths./my_user/accept_tos.post.description
Accept the Terms of Service for the Recovery Platform, which can be found at: https://mobilerecell.com/terms-privacy

# paths./notification.get.parameters[].description
* `BoxTrackingNotification` - Box Tracking Notification
* `ReturnToCustomerTrackingNotification` - Return To Customer Tracking Notification
* `RecoNotification` - Reco Notification
* `LabelNotification` - Label Notification
* `RetailNotification` - Retail Notification
* `BoxNotification` - Box Notification
* `CollectionSelectionNotification` - Collection Selection Notification

# paths./notification.get.parameters[].description
A page number within the paginated result set.

# paths./notification.get.parameters[].description
Multiple values may be separated by commas.

# paths./notification.get.parameters[].description
Ordering

* `sent_at` - Sent at
* `-sent_at` - Sent at (descending)

# paths./oneschema/create_delete_device_embed.post.description
Retrieve a OneSchema session token for a delete device import.

# paths./oneschema/create_device_data_embed.post.description
Retrieve a OneSchema session token for a processed device data import.

# paths./oneschema/create_device_image_embed.post.description
Retrieve a OneSchema session token for a device image import.

# paths./oneschema/create_itad_location_status_embed.post.description
Retrieve a OneSchema session token for an outbound requests import.

# paths./oneschema/create_orphan_device_assignment_embed.post.description
Retrieve a OneSchema session token for an orphan device assignment import.

# paths./oneschema/create_outbound_requests_embed.post.description
Retrieve a OneSchema session token for an outbound requests import.

# paths./oneschema/create_request_address_override_embed.post.description
Retrieve a OneSchema session token for a request address override import.

# paths./oneschema/create_request_generation_embed.post.description
Retrieve a OneSchema session token for a request generation import.

# paths./oneschema/create_retest_lock_device_embed.post.description
Retrieve a OneSchema session token for a Retest Lock Device import.

# paths./oneschema/create_return_authorization_embed.post.description
Retrieve a OneSchema session token for a return authorization import.

# paths./oneschema/create_return_to_device_device_embed.post.description
Retrieve a OneSchema session token for a Return To Customer Device import.

# paths./oneschema/create_settlement_line_items_embed.post.description
Retrieve a OneSchema session token for a settlement line items import.

# paths./oneschema/create_settlement_serialized_data_embed.post.description
Retrieve a OneSchema session token for a settlment serialized data import.

# paths./reco/{reco_token}.get.description
Get the status details for the specified reco process request.

# paths./reco/{reco_token}/choose_employee_purchase.post.description
Select employee purchase for the recovery.

# paths./recovery_program.get.description
Provides a list of the recovery programs that the current user has permission to view.

# paths./recovery_program.get.parameters[].description
Multiple values may be separated by commas.

# paths./recovery_program.get.parameters[].description
Multiple values may be separated by commas.

# paths./recovery_program.get.parameters[].description
Multiple values may be separated by commas.

# paths./recovery_program.get.parameters[].description
A page number within the paginated result set.

# paths./recovery_program/{program_id}.get.description
Get the settings for the specified recovery program.

# paths./recovery_program/{program_id}.put.description
Modify the settings of a recovery program.

# paths./recovery_program/{program_id}.patch.description
Modify settings for a recovery program, replacing only those details which are provided.

# paths./request_coe.get.description
Generate Certificate of Erasure pdf for devices.

# paths./request_coe.get.parameters[].description
Multiple values may be separated by commas.

# paths./request_tracking_journey/{request_id}.get.description
Provide the timeline details for request recovery.

# paths./return_request.get.description
List the return requests that are part of a specified recovery program

# paths./return_request.get.parameters[].description
* `API` - API
* `RecoveryWizard` - Recovery Wizard
* `CSVUpload` - CSV Upload

# paths./return_request.get.parameters[].description
A page number within the paginated result set.

# paths./return_request.get.parameters[].description
Multiple values may be separated by commas.

# paths./return_request.get.parameters[].description
* `RecoNotification` - Reco Notification
* `ReturnLabel` - Return Label
* `IndividualDeviceKit` - Individual Device Kit
* `BulkDeviceKit` - Bulk Device Kit
* `BulkTabletKit` - Bulk Tablet Kit
* `BulkReturnLabel` - Bulk Return Label
* `External` - External
* `LaptopKit` - Laptop Kit

# paths./return_request.get.parameters[].description
* `AwaitingMethod` - Awaiting method
* `ReturnRequested` - Return requested
* `Failure` - Failure
* `Complete` - Complete
* `Cancelled` - Cancelled

# paths./return_request.post.description
Create a new return request to initiate the recovery process for a device.
        It is recommended to provide the IMEI and/or serial number of the device to enable compliance tracking for the device.
        Custom print label messages may be provided using the `ReturnLabelReference` and/or `OutboundLabelReference` tags.
        Messages may be truncated due to length restrictions by carrier.

# paths./return_request/{request_id}/add_outbound_tracking_number.post.description
Add an outbound tracking number to a request, as would be needed for box fullfillment operations.

Note: This is only enabled for use with external requests.

# paths./return_request/{request_id}/add_return_tracking_number.post.description
Add a tracking number to a request.

Note: This is only enabled for use with external requests.

# paths./return_request/{request_id}/report_device_collection.post.description
Report the device associated with this request as collected.

# paths./sender_signature.post.description
Create a sender signature for a customer.

# paths./sender_signature/{customer_id}.get.description
Retrieve a sender signature for a customer.

# paths./sender_signature/{customer_id}.put.description
Update a sender signature for a customer.

# paths./sender_signature/{customer_id}.delete.description
Delete a sender signature record for a customer.

# paths./user.get.description
Provides a list of the users that the current user has permission to view.

# paths./user.get.parameters[].description
Multiple values may be separated by commas.

# paths./user.get.parameters[].description
A page number within the paginated result set.

# paths./user/{user_id}.put.description
Modify the details of the specified user.

# paths./user/{user_id}.patch.description
Modify details for a user, replacing only those details which are provided.

# paths./user/{user_id}/upload_picture.post.description
Allowed file types are PNG, JPG, and SVG.

# components.schemas.ActionEnum.description
* `Info` - Info
* `Update` - Update
* `Cancel` - Cancel
* `Failure` - Failure
* `Complete` - Complete

# components.schemas.AvailableRecoveryMethodsEnum.description
* `ReturnLabel` - ReturnLabel
* `RetailReturn` - RetailReturn
* `EmployeePurchase` - EmployeePurchase
* `IndividualDeviceKit` - IndividualDeviceKit
* `LaptopKit` - LaptopKit
* `DeviceCollection` - DeviceCollection

# components.schemas.BulkRecoveryType.description
* `BulkDeviceKit` - BulkDeviceKit
* `BulkTabletKit` - BulkTabletKit
* `BulkReturnLabel` - BulkReturnLabel
* `LaptopKit` - LaptopKit

# components.schemas.BulkRecoveryTypeEnum.description
* `BulkDeviceKit` - BulkDeviceKit
* `BulkTabletKit` - BulkTabletKit
* `BulkReturnLabel` - BulkReturnLabel

# components.schemas.ChangeRoleRoleEnum.description
* `Administrator` - Administrator
* `Manager` - Manager
* `Operator` - Operator
* `SettlementAdmin` - SettlementAdmin

# components.schemas.ComplianceRecoveryTypeEnum.description
* `RecoNotification` - Reco Notification
* `ReturnLabel` - Return Label
* `IndividualDeviceKit` - Individual Device Kit
* `BulkDeviceKit` - Bulk Device Kit
* `BulkTabletKit` - Bulk Tablet Kit
* `BulkReturnLabel` - Bulk Return Label
* `External` - External
* `LaptopKit` - Laptop Kit
* `RetailReturn` - Retail Return
* `EmployeePurchase` - Employee Purchase
* `EmployeePurchasePlus` - Employee Purchase Plus
* `DeviceCollection` - Device Collection

# components.schemas.DeviceTypeEnum.description
* `Mobile` - Mobile
* `Tablet` - Tablet
* `Laptop` - Laptop
* `Desktop` - Desktop
* `CompactDesktop` - CompactDesktop
* `IntegratedDesktop` - IntegratedDesktop
* `Unknown` - Unknown

# components.schemas.EventTypeEnum.description
* `Bounced` - Bounced
* `Delivered` - Delivered
* `Opened` - Opened
* `Clicked` - Clicked
* `SpamComplaint` - Spam Complaint

# components.schemas.FreightShipmentStatusEnum.description
* `PreTransit` - Pre Transit
* `InTransit` - In Transit
* `Delivered` - Delivered
* `Exception` - Exception

# components.schemas.IndividualRecoveryType.description
* `RecoNotification` - RecoNotification
* `ReturnLabel` - ReturnLabel
* `IndividualDeviceKit` - IndividualDeviceKit
* `External` - External
* `LaptopKit` - LaptopKit

# components.schemas.LabelStatus.description
* `InTransitToCenter` - In transit to center
* `DeliveredToCenter` - Delivered to center
* `InTransitToEndUser` - In transit to end user
* `DeliveredToEndUser` - Delivered to end user
* `PreTransit` - Pre Transit
* `Inactive` - Inactive
* `Failure` - Failure

# components.schemas.NotificationTypeEnum.description
* `BoxTrackingNotification` - Box Tracking Notification
* `ReturnToCustomerTrackingNotification` - Return To Customer Tracking Notification
* `RecoNotification` - Reco Notification
* `LabelNotification` - Label Notification
* `RetailNotification` - Retail Notification
* `BoxNotification` - Box Notification
* `CollectionSelectionNotification` - Collection Selection Notification

# components.schemas.RecoActionEnum.description
* `RetailReturn` - Retail Return
* `EmployeePurchase` - Employee Purchase
* `EmployeePurchasePlus` - Employee Purchase Plus
* `ReturnLabel` - Return Label
* `IndividualDeviceKit` - Individual Device Kit
* `LaptopKit` - Laptop Kit
* `DeviceCollection` - Device Collection

# components.schemas.RecoveryMethod.description
* `API` - API
* `RecoveryWizard` - Recovery Wizard
* `CSVUpload` - CSV Upload

# components.schemas.RecoveryMethodEnum.description
* `RetailReturn` - Retail Return
* `EmployeePurchase` - Employee Purchase
* `EmployeePurchasePlus` - Employee Purchase Plus
* `ReturnLabel` - Return Label
* `IndividualDeviceKit` - Individual Device Kit
* `LaptopKit` - Laptop Kit
* `DeviceCollection` - Device Collection
* `RecoNotification` - Reco Notification
* `BulkDeviceKit` - Bulk Device Kit
* `BulkTabletKit` - Bulk Tablet Kit
* `BulkReturnLabel` - Bulk Return Label
* `External` - External

# components.schemas.RecoveryType.description
* `RecoNotification` - Reco Notification
* `ReturnLabel` - Return Label
* `IndividualDeviceKit` - Individual Device Kit
* `BulkDeviceKit` - Bulk Device Kit
* `BulkTabletKit` - Bulk Tablet Kit
* `BulkReturnLabel` - Bulk Return Label
* `External` - External
* `LaptopKit` - Laptop Kit

# components.schemas.RemoteManagedEnum.description
* `Enrolled` - Enrolled
* `NotEnrolled` - Not Enrolled

# components.schemas.ReturnRequestStatus.description
* `AwaitingMethod` - Awaiting method
* `ReturnRequested` - Return requested
* `Failure` - Failure
* `Complete` - Complete
* `Cancelled` - Cancelled

# components.schemas.UserRole.description
* `SuperUser` - SuperUser
* `CustomerAdministrator` - CustomerAdministrator
* `Administrator` - Administrator
* `Manager` - Manager
* `Operator` - Operator
* `SettlementAdmin` - SettlementAdmin

# tags[].description
Provides an interface for reviewing and managing recovery programs in the platform.

# tags[].description
Manage return requests within a recovery program.

# tags[].description
Manage bulk return requests within a recovery program.

# tags[].description
Provide timeline details for devices and requests.

# tags[].description
Supports verification of device unlocks. This is important for providing the greatest value for the recovered device.

# tags[].description
Manage return requests within a recovery program.