### Example API Response for Device Prices

Source: https://www.remoteretrieval.com/api-integration/index

An example JSON response structure for the 'GET Device Prices' API endpoint, showing the pricing details for different equipment types.

```json
[{"equipment_type":"Laptop","order_amount":77,"option_lbl":"Laptop($77)"},
{"equipment_type":"Monitor","order_amount":99,"option_lbl":"Monitor($99)"},
{"equipment_type":"Monitor_27","order_amount":149,"option_lbl":"Monitor_27($149)"},
{"equipment_type":"Tablet","order_amount":59,"option_lbl":"Tablet($59)"},
{"equipment_type":"Cell Phone","order_amount":59,"option_lbl":"Cell Phone($59)"}]
```

--------------------------------

### Example API Response for Order Details

Source: https://www.remoteretrieval.com/api-integration/index

An example JSON response structure for the 'GET Order Details' API endpoint, showcasing the data returned for a specific order.

```json
[
    {
        "order_id": 148,
        "employee_info": {
            "email": "rakygotoh@example.com",
            "name": "Nora Navarro",
            "address_line_1": "840 Nottingham Way",
            "address_line_2": "Front Office",
            "city": "Trenton",
            "state": "NJ",
            "zip": "08638"
        },
        "company_info": {
            "email": "support@example.com",
            "name": "Remote Retrieval",
            "address_line_1": "840 Nottingham Way",
            "address_line_2": null,
            "city": "Trenton",
            "state": "NJ",
            "zip": "08638"
        },
        "shipments": {
            "device_type": "Laptop",
            "send_status": "TRANSIT",
            "return_status": "TRANSIT"
        }
    }
]
```

--------------------------------

### Example API Response for Company Details

Source: https://www.remoteretrieval.com/api-integration/index

An example JSON response structure for the 'GET Company Details' API endpoint, illustrating the returned company information.

```json
{
    "company_name": "company HB",
    "company_email": "abc@example.com",
    "address_1": "abc address 123",
    "address_2": null,
    "city": "East Brunswick",
    "state": "NJ",
    "zip": "08816",
    "created_date": "24-Jun-2024"
}
```

--------------------------------

### API Key Authentication Example

Source: https://www.remoteretrieval.com/api-integration/index

This snippet illustrates how to authenticate API requests using an API Key. The key should be included in the 'Authorization' header, prefixed with 'Bearer '. This method ensures secure access to the API endpoints.

```HTTP
Authorization: Bearer < API_KEY >
```

--------------------------------

### GET All Orders API Endpoint

Source: https://www.remoteretrieval.com/api-integration/index

This snippet details the GET endpoint for retrieving a list of all orders. It specifies the HTTP method and path. The endpoint supports pagination via a 'cursor' query parameter, allowing retrieval of results in chunks of up to 25 per page.

```HTTP
GET /api/v1/orders
?cursor=LINK
```

--------------------------------

### GET Device Prices API

Source: https://www.remoteretrieval.com/api-integration/index

Retrieves device prices dynamically. This API provides real-time pricing data for all supported devices, ensuring accurate and up-to-date information.

```APIDOC
## GET /api/v1/get-device-prices

### Description
Retrieves device prices dynamically. This API provides real-time pricing data for all supported devices, ensuring accurate and up-to-date information. To retrieve monitor size categories, refer to these mappings: "Monitor_27" corresponds to displays between 24 inches to 27 inches. "Monitor" refers to displays between 17 inches to 23 inches.

### Method
GET

### Endpoint
/api/v1/get-device-prices

### Parameters
#### No parameters required for this endpoint.

### Request Example
```
GET /api/v1/get-device-prices
```

### Response
#### Success Response (200)
- **equipment_type** (string) - The type of equipment (e.g., Laptop, Monitor).
- **order_amount** (integer) - The price of the device.
- **option_lbl** (string) - A display label for the device and its price (e.g., "Laptop($77)").

#### Response Example
```json
[
    {"equipment_type":"Laptop","order_amount":77,"option_lbl":"Laptop($77)"},
    {"equipment_type":"Monitor","order_amount":99,"option_lbl":"Monitor($99)"},
    {"equipment_type":"Monitor_27","order_amount":149,"option_lbl":"Monitor_27($149)"},
    {"equipment_type":"Tablet","order_amount":59,"option_lbl":"Tablet($59)"},
    {"equipment_type":"Cell Phone","order_amount":59,"option_lbl":"Cell Phone($59)"}
]
```
```

--------------------------------

### GET /api/v1/orders

Source: https://www.remoteretrieval.com/api-integration/index

Retrieves a list of all orders with detailed payment and shipping statuses. Supports pagination.

```APIDOC
## GET /api/v1/orders

### Description
Retrieves a list of all orders with detailed payment and shipping statuses. Supports pagination.

### Method
GET

### Endpoint
/api/v1/orders

### Parameters
#### Query Parameters
- **cursor** (string) - Optional - Used for paginating results. Returns a URL link from the response for the next page. Results are paginated up to 25 per page.

### Response
#### Success Response (200)
- **payment_status** (string) - The status of the payment for the order. Possible values: "Completed", "Pending".
- **order_status** (string) - The status of the order. Possible values:
  - "Ship to Employee: Pending"
  - "Ship to Employee: SHIPPED"
  - "Box Delivered to Employee: 'STATUS'"
  - "Ship to Company: 'STATUS'"

#### Response Example
```json
{
  "orders": [
    {
      "order_id": "123",
      "payment_status": "Completed",
      "order_status": "Ship to Employee: SHIPPED",
      "details": "..."
    }
  ],
  "next_cursor": "/api/v1/orders?cursor=some_link"
}
```

### Authentication
API Key is required. Provide the key in the `Authorization` header as follows: `Authorization: Bearer <API_KEY>`
```

--------------------------------

### GET Order Details API

Source: https://www.remoteretrieval.com/api-integration/index

Retrieves specific details and information about an order. By sending a request to this endpoint, you can obtain detailed data of an order.

```APIDOC
## GET /api/v1/device_returns?oid=ORDER_ID

### Description
Retrieves specific details and information about an order. By sending a request to this endpoint, you can obtain detailed data of an order. It is designed to provide precise and targeted information to meet your needs.

### Method
GET

### Endpoint
/api/v1/device_returns

### Parameters
#### Query Parameters
- **oid** (string) - Required - The order ID for which to retrieve details.

### Request Example
```
GET /api/v1/device_returns?oid=ORDER_ID
```

### Response
#### Success Response (200)
- **order_id** (integer) - The unique identifier for the order.
- **employee_info** (object) - Information about the employee associated with the order.
  - **email** (string) - The employee's email address.
  - **name** (string) - The employee's full name.
  - **address_line_1** (string) - The first line of the employee's address.
  - **address_line_2** (string) - The second line of the employee's address.
  - **city** (string) - The city of the employee's address.
  - **state** (string) - The state of the employee's address.
  - **zip** (string) - The zip code of the employee's address.
- **company_info** (object) - Information about the company associated with the order.
  - **email** (string) - The company's email address.
  - **name** (string) - The company's name.
  - **address_line_1** (string) - The first line of the company's address.
  - **address_line_2** (string) - The second line of the company's address.
  - **city** (string) - The city of the company's address.
  - **state** (string) - The state of the company's address.
  - **zip** (string) - The zip code of the company's address.
- **shipments** (object) - Details about the shipment associated with the order.
  - **device_type** (string) - The type of device being shipped.
  - **send_status** (string) - The status of the shipment being sent.
  - **return_status** (string) - The status of the device return.

#### Response Example
```json
[
    {
        "order_id": 148,
        "employee_info": {
            "email": "rakygotoh@example.com",
            "name": "Nora Navarro",
            "address_line_1": "840 Nottingham Way",
            "address_line_2": "Front Office",
            "city": "Trenton",
            "state": "NJ",
            "zip": "08638"
        },
        "company_info": {
            "email": "support@example.com",
            "name": "Remote Retrieval",
            "address_line_1": "840 Nottingham Way",
            "address_line_2": null,
            "city": "Trenton",
            "state": "NJ",
            "zip": "08638"
        },
        "shipments": {
            "device_type": "Laptop",
            "send_status": "TRANSIT",
            "return_status": "TRANSIT"
        }
    }
]
```
```

--------------------------------

### GET Company Details API

Source: https://www.remoteretrieval.com/api-integration/index

Retrieves detailed information about a company. This endpoint provides comprehensive data on the specified company, including its name, address, and contact information.

```APIDOC
## GET /api/v1/company-details

### Description
Retrieves detailed information about a company. This endpoint provides comprehensive data on the specified company, including its name, address, contact information, and other relevant details.

### Method
GET

### Endpoint
/api/v1/company-details

### Parameters
#### No parameters required for this endpoint.

### Request Example
```
GET /api/v1/company-details
```

### Response
#### Success Response (200)
- **company_name** (string) - The name of the company.
- **company_email** (string) - The email address of the company.
- **address_1** (string) - The first line of the company's address.
- **address_2** (string) - The second line of the company's address.
- **city** (string) - The city of the company's address.
- **state** (string) - The state of the company's address.
- **zip** (string) - The zip code of the company's address.
- **created_date** (string) - The date the company record was created.

#### Response Example
```json
{
    "company_name": "company HB",
    "company_email": "abc@example.com",
    "address_1": "abc address 123",
    "address_2": null,
    "city": "East Brunswick",
    "state": "NJ",
    "zip": "08816",
    "created_date": "24-Jun-2024"
}
```
```

--------------------------------

### Retrieve Device Prices via API

Source: https://www.remoteretrieval.com/api-integration/index

Dynamically retrieves real-time pricing for various devices. Authentication is handled via an API key. The response is a JSON array containing equipment type, order amount, and a display label.

```bash
curl -X GET \
  'https://your-api-url.com/api/v1/get-device-prices' \
  -H 'Authorization: Bearer <API_KEY>'
```

--------------------------------

### POST Request to Create Order by CSV

Source: https://www.remoteretrieval.com/api-integration/index

This snippet demonstrates how to make a POST request to the /api/v1/create-order-by-csv endpoint to create bulk orders. It includes the sample payload with the 'order_file' parameter. Authentication is required via an API key in the Authorization header.

```http
POST /api/v1/create-order-by-csv
Authorization: Bearer < API_KEY >
Content-Type: application/json

{
     "order_file": "orders.csv"
}
```

--------------------------------

### POST /api/v1/create-order

Source: https://www.remoteretrieval.com/api-integration/index

Creates a new order for equipment return or delivery. Accepts a list of orders with detailed employee and company information.

```APIDOC
## POST /api/v1/create-order

### Description
Creates a new order for equipment return or delivery. Accepts a list of orders with detailed employee and company information.

### Method
POST

### Endpoint
/api/v1/create-order

### Parameters
#### Request Body
- **orders** (array) - Required - A list of order objects.
  - **type_of_equipment** (string) - Required - The type of equipment for the order (e.g., "Laptop").
  - **order_type** (string) - Required - The type of order (e.g., "Return To Company").
  - **employee_info** (object) - Required - Information about the employee.
    - **email** (string) - Required - Employee's email address.
    - **name** (string) - Required - Employee's full name.
    - **address_line_1** (string) - Required - Employee's street address line 1.
    - **address_line_2** (string) - Optional - Employee's street address line 2.
    - **address_city** (string) - Required - Employee's city.
    - **address_state** (string) - Required - Employee's state.
    - **address_country** (string) - Required - Employee's country.
    - **address_zip** (string) - Required - Employee's ZIP code.
    - **phone** (string) - Required - Employee's phone number.
  - **company_info** (object) - Required - Information for company return.
    - **return_person_name** (string) - Required - Name of the person to return the item to.
    - **return_company_name** (string) - Required - Name of the company for return.
    - **return_address_line_1** (string) - Required - Company's return street address line 1.
    - **return_address_line_2** (string) - Optional - Company's return street address line 2.
    - **return_address_city** (string) - Required - Company's return city.
    - **return_address_state** (string) - Required - Company's return state.
    - **return_address_country** (string) - Required - Company's return country.
    - **return_address_zip** (string) - Required - Company's return ZIP code.
    - **email** (string) - Required - Company's return email address.
    - **phone** (string) - Required - Company's return phone number.

### Request Example
```json
{
    "orders": [
        {
        "type_of_equipment": "Laptop",
        "order_type": "Return To Company",
        "employee_info": {
            "email": "kennethdavis@example.com",
            "name": "Kenneth Davis",
            "address_line_1": "1734 Steele Street",
            "address_line_2": "Apt 10A",
            "address_city": "Houston",
            "address_state": "TX",
            "address_country": "United States",
            "address_zip": "77001",
            "phone": "1231231234"
        },
        "company_info": {
            "return_person_name": "Dorothy Buchanan",
            "return_company_name": "BigCo",
            "return_address_line_1": "4522 Hanover Street",
            "return_address_line_2": "Ste 120",
            "return_address_city": "San Antonio",
            "return_address_state": "TX",
            "return_address_country": "United States",
            "return_address_zip": "78015",
            "email": "it-team@example.com",
            "phone": "1231231234"
        }
        }
    ]
}
```

### Response
#### Success Response (200)
- **order** (string) - The ID of the created order.
- **message** (string) - A confirmation message.
- **status** (string) - The status of the operation (e.g., "Success").
- **response_code** (integer) - The HTTP response code.

#### Response Example
```json
{
    "order": "212",
    "message": "Order has created!",
    "status": "Success",
    "response_code": 200
}
```
```

--------------------------------

### POST Create Order API Request

Source: https://www.remoteretrieval.com/api-integration/index

This snippet demonstrates how to make a POST request to create a new order. It includes the endpoint and the required JSON payload structure for specifying order details, employee information, and company return information. The response indicates the success or failure of the order creation.

```HTTP
POST /api/v1/create-order

{
    "orders": [
        {
        "type_of_equipment": "Laptop",
        "order_type": "Return To Company",
        "employee_info": {
            "email": "kennethdavis@example.com",
            "name": "Kenneth Davis",
            "address_line_1": "1734 Steele Street",
            "address_line_2": "Apt 10A",
            "address_city": "Houston",
            "address_state": "TX",
            "address_country": "United States",
            "address_zip": "77001",
            "phone": "1231231234"
        },
        "company_info": {
            "return_person_name": "Dorothy Buchanan",
            "return_company_name": "BigCo",
            "return_address_line_1": "4522 Hanover Street",
            "return_address_line_2": "Ste 120",
            "return_address_city": "San Antonio",
            "return_address_state": "TX",
            "return_address_country": "United States",
            "return_address_zip": "78015",
            "email": "it-team@example.com",
            "phone": "1231231234"
        }
        },
        {
        "type_of_equipment": "Laptop",
        "order_type": "Return To Company",
        "employee_info": {
            "email": "kennethdavis@example.com",
            "name": "Kenneth Davis",
            "address_line_1": "1734 Steele Street",
            "address_line_2": "Apt 10A",
            "address_city": "Houston",
            "address_state": "TX",
            "address_country": "United States",
            "address_zip": "77001",
            "phone": "1231231234"
        },
        "company_info": {
            "return_person_name": "Dorothy Buchanan",
            "return_company_name": "BigCo",
            "return_address_line_1": "4522 Hanover Street",
            "return_address_line_2": "Ste 120",
            "return_address_city": "San Antonio",
            "return_address_state": "TX",
            "return_address_country": "United States",
            "return_address_zip": "78015",
            "email": "it-team@example.com",
            "phone": "1231231234"
        }
        }
    ]
}
```

--------------------------------

### POST /api/v1/create-order-by-csv

Source: https://www.remoteretrieval.com/api-integration/index

This API endpoint enables users to create bulk orders by uploading a CSV file. The uploaded file is processed to store bulk orders in the database, and a confirmation response is returned upon successful creation.

```APIDOC
## POST /api/v1/create-order-by-csv

### Description
This API endpoint enables users to create bulk orders by uploading a CSV file. The uploaded file is processed to store bulk orders in the database, and a confirmation response is returned upon successful creation. This endpoint requires authentication and specific parameters to be included in the request body to ensure the correct and complete order information is provided.

### Method
POST

### Endpoint
/api/v1/create-order-by-csv

### Parameters
#### Header Parameters
- **Authorization** (string) - Required - API Key for authentication. Format: `Bearer <API_KEY>`

#### Request Body
- **order_file** (file) - Required - The CSV file containing order details.

### Request Example
```json
{
     "order_file": "orders.csv"
}
```

### Response
#### Success Response (200)
- **order** (string) - The ID of the created order.
- **message** (string) - A success message indicating the order creation status.
- **status** (string) - The status of the operation (e.g., "Success").
- **response_code** (integer) - The HTTP response code.

#### Response Example
```json
{
    "order": "212",
    "message": "Order has created!",
    "status": "Success",
    "response_code": 200
}
```
```

--------------------------------

### Create Order API

Source: https://www.remoteretrieval.com/api-integration/index

Allows users to create a new order with detailed information. Supports single or multiple order creation.

```APIDOC
## POST /api/v1/orders

### Description
This API endpoint allows users to create a new order. By sending the necessary order details to this endpoint, the system will generate and store a new order in the database, returning a confirmation response upon successful creation.

### Method
POST

### Endpoint
/api/v1/orders

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **type_of_equipment** (string) - Required - Type of equipment (Laptop, Monitor, Cell Phone, Tablet).
- **order_type** (string) - Required - Type of order (Return To Company, Recycle with Data Destruction).
- **return_add_srv** (integer) - Optional - Additional service for 'Return To Company' (1: Data destruction and return, 2: Data destruction and delivery to new employee).
- **ins_active** (integer) - Optional - Set to '1' to insure the product.
- **ins_amount** (float) - Optional - Insurance amount (required if ins_active is '1').
- **employee_info** (object) - Required - Employee details.
  - **email** (string) - Employee email address.
  - **name** (string) - Employee full name.
  - **address_line_1** (string) - Employee Address line 1.
  - **address_line_2** (string) - Optional - Employee Address line 2.
  - **address_city** (string) - Employee city.
  - **address_state** (string) - Employee state.
  - **address_country** (string) - Employee country.
  - **address_zip** (string) - Employee zip.
  - **phone** (string) - Employee phone.
- **company_info** (object) - Required - Company details.
  - **return_person_name** (string) - Company person name.
  - **return_company_name** (string) - Company name.
  - **return_address_line_1** (string) - Company address line 1.
  - **return_address_line_2** (string) - Optional - Company address line 2.
  - **return_address_city** (string) - Company city.
  - **return_address_state** (string) - Company state.
  - **return_address_country** (string) - Company country.
  - **return_address_zip** (string) - Company zip.
  - **email** (string) - Company email.
  - **phone** (string) - Company phone.
- **new_employee_info** (object) - Required if `return_add_srv` is 2 - New employee details.
  - **first_name** (string) - New employee first name.
  - **last_name** (string) - New employee last name.
  - **phone** (string) - New employee phone.
  - **email** (string) - New employee Email.
  - **address_line_1** (string) - New employee address line 1.
  - **address_city** (string) - New employee city.
  - **address_state** (string) - New employee state.
  - **address_zip** (string) - New employee zip.
  - **address_country** (string) - New employee country.
  - **newemp_msg** (string) - New employee message.

### Request Example
```json
{
  "orders": [
    {
      "type_of_equipment": "Laptop",
      "order_type": "Return To Company",
      "return_add_srv": 1,
      "ins_active": 1,
      "ins_amount": 1200.50,
      "employee_info": {
        "email": "employee@example.com",
        "name": "John Doe",
        "address_line_1": "123 Main St",
        "address_city": "Anytown",
        "address_state": "CA",
        "address_country": "USA",
        "address_zip": "90210",
        "phone": "555-123-4567"
      },
      "company_info": {
        "return_person_name": "Jane Smith",
        "return_company_name": "Acme Corp",
        "return_address_line_1": "456 Business Ave",
        "return_address_city": "Business City",
        "return_address_state": "NY",
        "return_address_country": "USA",
        "return_address_zip": "10001",
        "email": "company@example.com",
        "phone": "555-987-6543"
      }
    }
  ]
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.
- **order_id** (string) - ID of the created order.
- **status** (string) - Status of the order creation.
- **response_code** (integer) - HTTP response code.

#### Response Example
```json
{
    "message": "Order created successfully.",
    "order_id": "ORD123456789",
    "status": "Success",
    "response_code": 200
}
```
```

--------------------------------

### Retrieve Company Details via API

Source: https://www.remoteretrieval.com/api-integration/index

Fetches comprehensive details about a company. This endpoint requires API key authentication and provides company name, email, address, and creation date in the response.

```bash
curl -X GET \
  'https://your-api-url.com/api/v1/company-details' \
  -H 'Authorization: Bearer <API_KEY>'
```

--------------------------------

### Retrieve Order Details via API

Source: https://www.remoteretrieval.com/api-integration/index

Fetches detailed information for a specific order using its ID. Requires API key authentication. The response includes order status, payment status, and employee/company shipment details.

```bash
curl -X GET \
  'https://your-api-url.com/api/v1/device_returns?oid=ORDER_ID' \
  -H 'Authorization: Bearer <API_KEY>'
```

--------------------------------

### POST Create Order API Response

Source: https://www.remoteretrieval.com/api-integration/index

This snippet shows a successful response after creating an order. It includes the order ID, a success message, and the HTTP status code. This response confirms that the order has been processed and provides a reference for the newly created order.

```JSON
{
    "order": "212",
    "message": "Order has created!",
    "status": "Success",
    "response_code": 200
}
```

--------------------------------

### Create Order API Endpoint

Source: https://www.remoteretrieval.com/api-integration/index

This API endpoint facilitates the creation of new orders. It requires an API key for authentication and a JSON payload containing order details. The endpoint supports creating single or multiple orders and includes optional fields for insurance and delivery services.

```JSON
{
  "type_of_equipment": "Laptop",
  "order_type": "Return To Company",
  "return_add_srv": 1,
  "ins_active": "1",
  "ins_amount": "1000",
  "employee_info": {
    "email": "employee@example.com",
    "name": "John Doe",
    "address_line_1": "123 Main St",
    "address_city": "Anytown",
    "address_state": "CA",
    "address_country": "USA",
    "address_zip": "90210",
    "phone": "555-123-4567"
  },
  "company_info": {
    "return_person_name": "Jane Smith",
    "return_company_name": "Example Corp",
    "return_address_line_1": "456 Business Ave",
    "return_address_city": "Business City",
    "return_address_state": "NY",
    "return_address_country": "USA",
    "return_address_zip": "10001",
    "email": "company@example.com",
    "phone": "555-987-6543"
  },
  "new_employee_info": {
    "first_name": "New Emp First Name",
    "last_name": "New Emp Last Name",
    "phone": "555-111-2222",
    "email": "newemp@example.com",
    "address_line_1": "789 New St",
    "address_city": "New City",
    "address_state": "TX",
    "address_zip": "75001",
    "address_country": "USA",
    "newemp_msg": "Please deliver to the reception."
  }
}
```

--------------------------------

### Validate User API

Source: https://www.remoteretrieval.com/api-integration/index

This endpoint is used to validate the user's API key. It returns a success or failure response based on the validity of the provided key.

```APIDOC
## GET /api/v1/validate/user

### Description
This API will validate the user's API key.

### Method
GET

### Endpoint
/api/v1/validate/user

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.
- **email** (string) - User's email address.
- **status** (string) - Status of the validation.
- **response_code** (integer) - HTTP response code.

#### Response Example
```json
{
    "message": "Valid Key!",
    "email": "abc@example.com",
    "status": "Success",
    "response_code": 200
}
```
```

--------------------------------

### Validate User API Endpoint

Source: https://www.remoteretrieval.com/api-integration/index

This endpoint allows for user validation by sending an API key in the Authorization header. It returns a success or failure response based on the validity of the key.

```HTTP
GET /api/v1/validate/user
```

```JSON
{
    "message": "Valid Key!",
    "email": "abc@example.com",
    "status": "Success",
    "response_code": 200
}
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.