Introduction

This tutorial will show you how to get started using Unduit REST API's. You will sign up as a developer on Unduit, create your access token, and get a development environment setup locally.

Register On Unduit

Enter your first name, last name, email, and a secure password. Then click the Singup button

Create Access Token

Place Repair Order

Endpoint

POST: https://old.unduit.com/api/v2/repair_order

Place repair order properties

Name Data Type Description
token string, required "token": "XqwPorzAB259-QklgM"
Developer Access Token
partner_access_key string, required "partner_access_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
Partner Access Key
company_id int, required "company_id": 123456
The ID of the Company account.
user_id int, required "user_id": 123456
The ID of the Company User.
email string, required "email": "[email protected]"
The User's Email Address.
shipping_firstname string, required "shipping_firstname":"Jon"
The User's Firstname.
shipping_lastname string, required "shipping_lastname":"Doe"
The User's Lastname.
address_line1 string, required "address_line1":"187 Prairie Avenue"
First Line of Address.
address_line2 string, required "address_line2":"Suite 101"
Second Line of Address.
city string, required "city":"Chicago"
City
state string, required "state":"IL"
State
zip string, required "zip":"60605"
Zip
phone string, required "phone":"123456789"
Phone Number
cost_center string, optional "cost_center":"COST CENTER"
Cost Center (character limit: 30 characters)
print_cost_center boolean, optional "print_cost_center":"1"
Print cost center on invoice
glo_code string, optional "glo_code":"GL code"
GL Code (character limit: 30 characters)
print_gl_code boolean, optional "print_gl_code":"1"
Print GL code on invoice
po string, optional "po":"12345"
PO Number (character limit: 30 characters)
print_po boolean, optional "print_po":"1"
Print PO on invoice
site_no string, optional "site_no":"789954"
Site Number (character limit: 30 characters)
print_site_no boolean, optional "print_site_no":"1"
Print site number on invoice
custom_field1 string, optional "custom_field1":"Custom Field"
Custom field (character limit: 30 characters)
print_custom_field1 boolean, optional "print_custom_field1":"1"
Print custom field 1 on invoice
custom_field2 string, optional "custom_field2":"Custom Field"
Custom field (character limit: 30 characters)
print_custom_field2 boolean, optional "print_custom_field2":"1"
Print custom field 2 on invoice
items json array, required "items": 
[{
  "brand": "Apple",
  "device": "iPhone",
  "model": "iPhone X",
  "service_description": "Battery Replacement",
  "ticket_number": "Tkt-10001",
  "imei": "6268453321478594",
  "asset_tag": "asset tags",
  "employee_name": "Johnathan",
  "employee_id": "BA-1254",
  "custom_field1": "enter custom text",
  "custom_field2": "enter custom text"
}, {
  "brand": "Apple",
  "device": "iPhone",
  "model": "iPhone X",
  "service_description": "Battery Replacement",
  "ticket_number": "Tkt-10001",
  "imei": "6268453321478594",
  "asset_tag": "asset tags",
  "employee_name": "Johnathan",
  "employee_id": "BA-1254",
  "custom_field1": "enter custom text",
  "custom_field2": "enter custom text"
}]
  • brand: Brand of device
  • device: Type of device
  • model: Model name or number
  • service_description: e.g Broken Glass, Water Damage etc.
  • ticket_number(optional): Ticket Number (character limit: 30 characters)
  • imei(optional): IMEI No. of device (character limit: 30 characters)
  • asset_tag(optional): Asset tags (character limit: 30 characters)
  • employee_name(optional): Employee Name (character limit: 30 characters)
  • employee_id(optional): Employee ID (character limit: 30 characters)
  • custom_field1(optional): Custom Field 1 (character limit: 30 characters)
  • custom_field2(optional): Custom Field 2 (character limit: 30 characters)

Response

{
  "status": true,
  "order": {
    "order_number": "15619671201053",
    "total_amount": "0.00",
    "shipping_name": "Awais Ansari",
    "address_line1": "1629 S Prairie Ave",
    "address_line2": "2403",
    "city": "Chicago",
    "state": "IL",
    "zip": "60616",
    "items": [{
      "order_number": "15619671201053",
      "brand": "Apple",
      "device": "iPhone",
      "model": "iPhone X",
      "service_description": "Battery Replacement"
    }, {
      "order_number": "15619671201053",
      "brand": "Apple",
      "device": "iPhone",
      "model": "iPhone X",
      "service_description": "Battery Replacement"
    }]
  }
}

Place Buyback Order

Endpoint

POST: https://old.unduit.com/api/v2/buyback_order

Place buy-back order properties

Name Data Type Description
token string, required "token": "XqwPorzAB259-QklgM"
Developer Access Token
partner_access_key string, required "partner_access_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
Partner Access Key
company_id int, required "company_id": 123456
The ID of the Company account.
user_id int, required "user_id": 123456
The ID of the Company User.
email string, required "email": "[email protected]"
The User's Email Address.
shipping_firstname string, required "shipping_firstname":"Jon"
The User's Firstname.
shipping_lastname string, required "shipping_lastname":"Doe"
The User's Lastname.
address_line1 string, required "address_line1":"187 Prairie Avenue"
First Line of Address.
address_line2 string, required "address_line2":"Suite 101"
Second Line of Address.
city string, required "city":"Chicago"
City
state string, required "state":"IL"
State
zip string, required "zip":"60605"
Zip
phone string, required "phone":"123456789"
Phone Number
items json array, required "items": 
[{
  "brand": "Apple",
  "device": "iPhone",
  "model": "iPhone X",
  "qty": "10" 
}, {
  "brand": "Apple",
  "device": "iPhone",
  "model": "iPhone Xs",
  "qty": "100" 
}]
  • brand: Brand of device
  • device: Type of device
  • model: Model name or number
  • qty: Quantity

Response

{
  "status": true,
  "order": {
    "order_number": "156196757490",
    "shipping_name": "Awais Ansari",
    "address_line1": "1629 S Prairie Ave",
    "address_line2": "2403",
    "city": "Chicago",
    "state": "IL",
    "zip": "60616",
    "items": [{
      "order_number": "156196757490",
      "brand": "Apple",
      "device": "iPhone",
      "model": "iPhone X",
      "qty": "10"
    }, {
      "order_number": "156196757490",
      "brand": "Apple",
      "device": "iPhone",
      "model": "iPhone 7",
      "qty": "10"
    }]
  }
}

Place Recycle Order

Endpoint

POST: https://old.unduit.com/api/v2/recycle_order

Place recycle order properties

Name Data Type Description
token string, required "token": "XqwPorzAB259-QklgM"
Developer Access Token
partner_access_key string, required "partner_access_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
Partner Access Key
company_id int, required "company_id": 123456
The ID of the Company account.
user_id int, required "user_id": 123456
The ID of the Company User.
email string, required "email": "[email protected]"
The User's Email Address.
shipping_firstname string, required "shipping_firstname":"Jon"
The User's Firstname.
shipping_lastname string, required "shipping_lastname":"Doe"
The User's Lastname.
address_line1 string, required "address_line1":"187 Prairie Avenue"
First Line of Address.
address_line2 string, required "address_line2":"Suite 101"
Second Line of Address.
city string, required "city":"Chicago"
City
state string, required "state":"IL"
State
zip string, required "zip":"60605"
Zip
phone string, required "phone":"123456789"
Phone Number
items json array, required "items": 
[{
  "brand": "Apple",
  "device": "iPhone",
  "model": "iPhone X",
  "qty": "10" 
}, {
  "brand": "Apple",
  "device": "iPhone",
  "model": "iPhone Xs",
  "qty": "100"  
}]
  • brand: Brand of device
  • device: Type of device
  • model: Model name or number
  • qty: Quantity

Response

{
  "status": true,
  "order": {
    "order_number": "156196772268",
    "shipping_name": "Awais Ansari",
    "address_line1": "1629 S Prairie Ave",
    "address_line2": "2403",
    "city": "Chicago",
    "state": "IL",
    "zip": "60616",
    "items": [{
      "order_number": "156196772268",
      "brand": "Apple",
      "device": "iPhone",
      "model": "iPhone 8",
      "qty": "9"
    }, {
      "order_number": "156196772268",
      "brand": "Apple",
      "device": "iPhone",
      "model": "iPhone 7",
      "qty": "11"
    }]
  }
}

Get Brands

Endpoint

GET: https://old.unduit.com/api/v2/brands

Retrieve brands properties

Name Data Type Description
token string, required "token": "XqwPorzAB259-QklgM"
Developer Access Token
partner_access_key string, required "partner_access_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
Partner Access Key

Response

  {
    "status":true,
    "brands":[
        {
          "brand_id":"96",
          "name":"Apple"
        },
        {
          "brand_id":"105",
          "name":"Samsung"
        }
    ]
  }

Get Devices

Endpoint

GET: https://old.unduit.com/api/v2/devices/{brand_id}

Retrieve devices properties

Name Data Type Description
brand_id int, required "brand_id": 96
ID of brand
Header Content
Name Data Type Description
token string, required "token": "XqwPorzAB259-QklgM"
Developer Access Token
partner_access_key string, required "partner_access_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
Partner Access Key

Response

  {
    "status":true,
    "devices":[
        {
          "device_id":"98",
          "name":"iPhone"
        },
        {
          "device_id":"111",
          "name":"iPod "
        },
        {
          "device_id":"148",
          "name":"iPad"
        }
      ]
  }

Get Models

Endpoint

GET: https://old.unduit.com/api/v2/models/{device_id}

Retrieve models properties

Name Data Type Description
device_id int, required "device_id": 98
ID of device
Header Content
Name Data Type Description
token string, required "token": "XqwPorzAB259-QklgM"
Developer Access Token
partner_access_key string, required "partner_access_key": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
Partner Access Key

Response

  {
    "status":true,
    "models":[
        {
          "model_id":"200",
          "name":"iPhone 7"
        },
        {
          "model_id":"201",
          "name":"iPhone 7+"
        },
        {
          "model_id":"213",
          "name":"iPhone 8"
        },
        {
          "model_id":"214",
          "name":"iPhone 8+"
        },
        {
          "model_id":"215",
          "name":"iPhone X"
        }
    ]
  }

Get Buyback Orders

Endpoint

GET: https://old.unduit.com/api/v2/orders/buyback/{offset}

Retrieve buyback orders

Header Content
Name Data Type Description
token string, required "token": XqwPorzAB259-QklgM
Developer Access Token
partner_access_key string, required "partner_access_key": xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Partners Access Key

Response

{
"status": true,
"response": [
    {
        "order_number": "15619671201053",
        "total_amount": "0.00",
        "shipping_name": "Awais Ansari",
        "company_name": "Unduit",
        "company_id": "121324",
        "order_status": "Order Received"
    },
    {
        "order_number": "15619671201053",
        "total_amount": "0.00",
        "shipping_name": "Awais Ansari",
        "company_name": "Unduit",
        "order_status": "Order Received"
    },
    
],
"next": true,
"previous": false
}

Get Buyback Order Detail

Endpoint

GET: https://old.unduit.com/api/v2/orders/buyback/detail/{order_number}

Retrieve buyback orders detail properties

Name Data Type Description
order_number int, required "order_number": 125478995602
Order Number
Header Content
Name Data Type Description
token string, required "token": XqwPorzAB259-QklgM
Developer Access Token
partner_access_key string, required "partner_access_key": xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Partners Access Key

Response

{
"status": true,
"order": {
    "order_number": "15619671201053",
    "total_amount": "0.00",
    "shipping_name": "Awais Ansari",
    "address_line1": "1629 S Prairie Ave",
    "address_line2": "2403",
    "city": "Chicago",
    "state": "IL",
    "zip": "60616",
    "company_name": "Unduit",
    "company_id": "121324",
    "items": [
        {
            "item_id": "1254",
            "brand": "Apple",
            "device": "iPhone",
            "model": "iPhone X",            
            "qty": "10"
        },
        {
            "item_id": "1254",
            "brand": "Apple",
            "device": "iPhone",
            "model": "iPhone X",            
            "qty": "10"
        }
    ]
}
}

Get Repair Orders

Endpoint

GET: https://old.unduit.com/api/v2/orders/repair/{offset}

Retrieve repair orders properties

Header Content
Name Data Type Description
token string, required "token": XqwPorzAB259-QklgM
Developer Access Token
partner_access_key string, required "partner_access_key": xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Partners Access Key

Response

{
"status": true,
"response": [
    {
        "order_number": "15619671201053",
        "total_amount": "0.00",
        "shipping_name": "Awais Ansari",
        "company_name": "Unduit",
        "company_id": "121324",
        "order_status": "Order Received"
    },
    {
        "order_number": "15619671201053",
        "total_amount": "0.00",
        "shipping_name": "Awais Ansari",
        "company_name": "Unduit",
        "order_status": "Order Received"
    },
],
"next": true,
"previous": false
}

Get Repair Order Detail

Endpoint

GET: https://old.unduit.com/api/v2/orders/repair/detail/{order_number}

Retrieve repair orders properties

Name Data Type Description
order_number int, required "order_number": 125478995602
Order Number
Header Content
Name Data Type Description
token string, required "token": XqwPorzAB259-QklgM
Developer Access Token
partner_access_key string, required "partner_access_key": xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Partners Access Key

Response

{
  "status": true,
  "order": {
    "order_number": "15619671201053",
    "total_amount": "0.00",
    "shipping_name": "Awais Ansari",
    "address_line1": "1629 S Prairie Ave",
    "address_line2": "2403",
    "city": "Chicago",
    "state": "IL",
    "zip": "60616",
    "items": [{
      "order_number": "15619671201053",
      "brand": "Apple",
      "device": "iPhone",
      "model": "iPhone X",
      "service_description": "Battery Replacement"
    }, {
      "order_number": "15619671201053",
      "brand": "Apple",
      "device": "iPhone",
      "model": "iPhone X",
      "service_description": "Battery Replacement"
    }]
  }
}

Get Recycle Orders

Endpoint

GET: https://old.unduit.com/api/v2/orders/recycle/{offset}

Retrieve recycle orders properties

Header Content
Name Data Type Description
token string, required "token": XqwPorzAB259-QklgM
Developer Access Token
partner_access_key string, required "partner_access_key": xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Partners Access Key

Response

{
"status": true,
"response": [
    {
        "order_number": "15619671201053",
        "total_amount": "0.00",
        "shipping_name": "Awais Ansari",
        "company_name": "Unduit",
        "company_id": "121324",
        "order_status": "Order Received"
    },
    {
        "order_number": "15619671201053",
        "total_amount": "0.00",
        "shipping_name": "Awais Ansari",
        "company_name": "Unduit",
        "order_status": "Order Received"
    },
],
"next": false,
"previous": false
}

Get Recycle Order Detail

Endpoint

GET: https://old.unduit.com/api/v2/order/recycle/detail/{order_number}

Retrieve recycle order detail properties

Name Data Type Description
order_number int, required "order_number": 125478995602
Order Number
Header Content
Name Data Type Description
token string, required "token": XqwPorzAB259-QklgM
Developer Access Token
partner_access_key string, required "partner_access_key": xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Partners Access Key

Response

{
"status": true,
"order": {
    "order_number": "15619671201053",
    "total_amount": "0.00",
    "shipping_name": "Awais Ansari",
    "address_line1": "1629 S Prairie Ave",
    "address_line2": "2403",
    "city": "Chicago",
    "state": "IL",
    "zip": "60616",
    "company_name": "Unduit",
    "company_id": "121324",
    "items": [
        {
            "item_id": "1254",
            "brand": "Apple",
            "device": "iPhone",
            "model": "iPhone X",            
            "qty": "10"
        },
        {
            "item_id": "1254",
            "brand": "Apple",
            "device": "iPhone",
            "model": "iPhone X",            
            "qty": "10"
        }
    ]
}
}