Introduction

Welcome to the Remote Retrieval API documentation. This API allows you to manage orders through the mentioned endpoints. You'll need to authenticate using an API token to access the endpoints.

Validate User

Send a request with the API token key to this endpoint to validate the user. If the key is invalid, a failure response will be generated; otherwise, a success response will be returned.

➤ AUTHORIZATION > API

HTTP: API Key

Authentication is performed using an API key, which can be obtained from the Enterprise Remote Retriever portal. When making an API call, the key should be provided in the Authorization header as follows:

Authorization: Bearer < API_KEY >

Endpoint

GET /api/v1/validate/user

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

Create Order

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. This endpoint requires authentication and specific parameters to be included in the request body to ensure the correct and complete order information is provided.

➤ AUTHORIZATION > API

HTTP: API Key

Authentication is performed using an API key, which can be obtained from the Enterprise Remote Retriever portal. When making an API call, the key should be provided in the Authorization header as follows:

Authorization: Bearer < API_KEY >

➤ REQUEST BODY SCHEMA

For creating order, must follow payload sample. It is sample for creating two orders. You can create single order or multiple orders by this API.

✧ type_of_equipment:
There are two type of equipments: 1) Laptop 2) Monitor

✧ order_type:
There are two type of orders: 1) Return To Company 2) Sell this Equipment

✧ employee_info.email:
Employee email address

✧ employee_info.name:
Employee full name

✧ employee_info.address_line_1:
Employee Address in line 1

✧ employee_info.address_line_2:
Employee Address in line 2, It is not mandatory field

✧ employee_info.address_city:
Employee city

✧ employee_info.address_state:
Employee state

✧ employee_info.address_country:
Employee country

✧ employee_info.address_zip:
Employee zip

✧ employee_info.phone:
Employee phone

✧ company_info.return_person_name:
Company person name

✧ company_info.return_company_name:
Company name

✧ company_info.return_address_line_1:
Company address in line 1.

✧ company_info.return_address_line_2:
Company address in line 2, it is not mandatory field.

✧ company_info.return_address_city:
Company city

✧ company_info.return_address_state:
Company state

✧ company_info.return_address_country:
Company country

✧ company_info.return_address_zip:
Company zip

✧ company_info.email:
Company email

✧ company_info.phone:
Company phone

Endpoint

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"
        }
        }
    ]
}
                                        

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

All Orders

This API fetches complete order list with different statuses:

Payment Status:

• If the `payment_status` is "Completed," it confirms that the payment for the order has been successfully processed. The customer has fully paid for the order, and no further payment action is required.

• If the `payment_status` is "Pending," it indicates that the payment is still in progress or has not been completed. This could mean the payment is awaiting confirmation, or the customer has not yet provided payment details.

Order Status:

• If the `order_status` is "Ship to Employee: Pending," it signifies that a shipping label for the order has not yet been created. This means the order is not yet ready to be shipped to the employee, and further actions may be needed to prepare the shipment.

• If the `order_status` is "Ship to Employee: SHIPPED," it confirms that a shipping label has been created, and the order has been shipped to the employee. The package is now in transit to the employee's location.

• If the `order_status` is "Box Delivered to Employee: 'STATUS'," it provides the current status of the box that was sent to the employee. This status could vary, showing whether the box is in transit, delivered, or any other relevant delivery status.

• If the `order_status` is "Ship to Company: 'STATUS'," it reflects the current status of the device that has been sent back to the company. This could indicate whether the device is in transit, received, or any other pertinent status related to the return process.

This detailed breakdown helps in understanding the various stages of an order and payment processing, ensuring transparency and clarity in the order fulfillment and return processes.

➤ AUTHORIZATION > API

HTTP: API Key

Authentication is performed using an API key, which can be obtained from the Enterprise Remote Retriever portal. When making an API call, the key should be provided in the Authorization header as follows:

Authorization: Bearer < API_KEY >

➤ QUERY PARAMETERS

cursor: Results are paginated up to 25 per page. It returns URL link from response for next page.

?cursor=LINK

Endpoint

GET /api/v1/orders

{
    "next": null,
    "previous": null,
    "results": [
        {
            "order_id": 220,
            "payment_status": "Completed",
            "order_status": "Ship to Company: DELIVERED ",
            "employee_info": {
                "email": "jycypa@example.com",
                "name": "Fay Mooney",
                "address_line_1": "1734 Steele Street",
		"address_line_2": "",
		"city": "Arlington Heights",
		"state": "IL",
		"zip": "60005"
            },
            "company_info": {
	    	"email": "it-team@example.com",
	    	"name": "Dorothy Buchanan",
	    	"address_line_1": "4522 Hanover Street",
	    	"address_line_2": "",
	    	"city": "New York",
	    	"state": "NY",
	    	"zip": "10016"
            },
            "shipments": {
                "device_type": "Laptop",
                "send_status": "DELIVERED",
                "return_status": "DELIVERED"
            }
        }
    ]
}
                                    

Order Details

This endpoint allows you to retrieve specific details and information. By sending a request to this endpoint, you can obtain detailed data of order. It is designed to provide precise and targeted information to meet your needs.

➤ AUTHORIZATION > API

HTTP: API Key

Authentication is performed using an API key, which can be obtained from the Enterprise Remote Retriever portal. When making an API call, the key should be provided in the Authorization header as follows:

Authorization: Bearer < API_KEY >

➤ QUERY PARAMETERS

order ID: For getting order details, must send order ID for required order details

?oid=ORDER_ID

Endpoint

GET /api/v1/device_returns?oid=ORDER_ID

[
    {
        "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"
        }
    }
]
                                    

Company Details

To retrieve detailed information about a company, use this endpoint. This endpoint provides comprehensive data on the specified company, including its name, address, contact information, and other relevant details.

➤ AUTHORIZATION > API

HTTP: API Key

Authentication is performed using an API key, which can be obtained from the Enterprise Remote Retriever portal. When making an API call, the key should be provided in the Authorization header as follows:

Authorization: Bearer < API_KEY >

Endpoint

GET /api/v1/company-details

{
    "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 Collection

To download the API collection, please follow these steps. First, navigate to the API documentation page. Click on the button to initiate the download. The API collection will be downloaded as a file, which can be imported into your preferred API testing tool, such as Postman. This collection contains all the endpoints and sample requests to help you get started with integrating and testing the API efficiently.