How to integrate with us?
Step 1 Contact us to get started and we will give you the initial requirement for accessing the system.
Step 2 Upon receiving API Access, you will need to generate an API Key to retrieve / perform actions.
Step 3 Check out our documentation for each APIs. Happy Coding!
Once you received an API access from us, you can now walk through the following steps below:
Base Domain: https://dealers.smartpadpro.com.au/
Returns Access Token valid for # of days.
HeadersName | Required | Description | Example |
client-key * | This is the API access that will be provided by Smartpad Pro Team. | TVMweU1ERVVNVEV3TkRBME1qTXlOdz09 | |
client-secret * | This is the API access that will be provided by Smartpad Pro Team. | $2y$10$bLiiNvM.zZDTRqh58tmBEOlrGrwMpXRGWWoTNJqYroaiKADFVnanq | |
Content-Type | Designates the content to be in JSON format, encoded in the UTF-8 character encoding. | application/json |
None |
Code | Description |
200 |
Successful
|
400 |
Bad Request
|
List of expected responses from the system.
HTTP Status Code | HTTP Method | Description | Expected Message |
200 |
SUCCESS | Standard success response |
|
201 |
CREATED | Standard success response |
|
400 |
BADREQUEST | Please check required parameters |
|
401 |
UNAUTHORISED | Please check your API credentails |
|
403 |
FORBIDDEN | Please check your API credentails |
|
404 |
PAGENOTFOUND | Page Not Found |
|
500 |
INTERNALSERVERERROR | Internal Server Error |
|
400 |
REJECTREASON | Order with REJECT status requires REASON |
|
List all orders ready for processing
Returns All Orders ready for processing.
HeadersName | Required | Description | Example |
Authorization * | This is the response from the authorization API. | Bearer eyJpdiI6Ilp1Nm40XC9XZmVzQjhVczFnXC9NXC9KZnc9PS... | |
client-key * | This is the API access that will be provided by Smartpad Pro Team. | TVMweU1ERVVNVEV3TkRBME1qTXlOdz09 | |
client-secret * | This is the API access that will be provided by Smartpad Pro Team. | $2y$10$bLiiNvM.zZDTRqh58tmBEOlrGrwMpXRGWWoTNJqYroaiKADFVnanq | |
Content-Type | Designates the content to be in JSON format, encoded in the UTF-8 character encoding. | application/json |
None |
Code | Description |
200 |
Successful
|
200 |
Successful
|
400 |
Bad Request
|
Confirm status of the order [confirm / rejected]
Updates the status of an order.
HeadersName | Required | Description | Example |
Authorization * | This is the response from the authorization API. | Bearer eyJpdiI6Ilp1Nm40XC9XZmVzQjhVczFnXC9NXC9KZnc9PS... | |
client-key * | This is the API access that will be provided by Smartpad Pro Team. | TVMweU1ERVVNVEV3TkRBME1qTXlOdz09 | |
client-secret * | This is the API access that will be provided by Smartpad Pro Team. | $2y$10$bLiiNvM.zZDTRqh58tmBEOlrGrwMpXRGWWoTNJqYroaiKADFVnanq | |
Content-Type | Designates the content to be in JSON format, encoded in the UTF-8 character encoding. | application/json |
Name | Required | Description | Example |
Status * | Y | Order status | confirm / rejected |
Reason | O | Required if the order status is rejected | Order Rejected |
Display | O | Custom Status provided by Supplier, will be shown in the customer side | { "status": "Not available", "background-color": "#000000", "text-color": "#ffffff" } |
{
"status": "rejected",
"reason": "Order Rejected",
"display": {
"status": "Not available",
"background-color": "#000000",
"text-color": "#ffffff"
}
}
Code | Description |
200 |
Successful
|
400 |
Bad Request
|
400 |
Bad Request
|
Update Order ETA
Updates the ETA date of an order.
HeadersName | Required | Description | Example |
Authorization * | This is the response from the authorization API. | Bearer eyJpdiI6Ilp1Nm40XC9XZmVzQjhVczFnXC9NXC9KZnc9PS... | |
client-key * | This is the API access that will be provided by Smartpad Pro Team. | TVMweU1ERVVNVEV3TkRBME1qTXlOdz09 | |
client-secret * | This is the API access that will be provided by Smartpad Pro Team. | $2y$10$bLiiNvM.zZDTRqh58tmBEOlrGrwMpXRGWWoTNJqYroaiKADFVnanq | |
Content-Type | Designates the content to be in JSON format, encoded in the UTF-8 character encoding. | application/json |
Name | Required | Description | Example |
ETA * | Y | Order new ETA date | 2019-12-10 |
Notes * | Y | Order ETA notes | Product to be delivered on December 9 |
{
"eta": "2019-12-10",
"notes": "Product to be delivered on December 9"
}
Code | Description |
200 |
Successful
|
400 |
Bad Request
|
Retrieve Products
Retrieves the Products.
HeadersName | Required | Description | Example |
Authorization * | This is the response from the authorization API. | Bearer eyJpdiI6Ilp1Nm40XC9XZmVzQjhVczFnXC9NXC9KZnc9PS... | |
client-key * | This is the API access that will be provided by Smartpad Pro Team. | TVMweU1ERVVNVEV3TkRBME1qTXlOdz09 | |
client-secret * | This is the API access that will be provided by Smartpad Pro Team. | $2y$10$bLiiNvM.zZDTRqh58tmBEOlrGrwMpXRGWWoTNJqYroaiKADFVnanq | |
Content-Type | Designates the content to be in JSON format, encoded in the UTF-8 character encoding. | application/json |
Name | Required | Description | Example |
Brand * | Y | Brand Name | TWC - The Blind Factory |
Code | Description |
200 |
Successful
|
400 |
Bad Request
|
Retrieve Product Options
Retrieves the Product options.
HeadersName | Required | Description | Example |
Authorization * | This is the response from the authorization API. | Bearer eyJpdiI6Ilp1Nm40XC9XZmVzQjhVczFnXC9NXC9KZnc9PS... | |
client-key * | This is the API access that will be provided by Smartpad Pro Team. | TVMweU1ERVVNVEV3TkRBME1qTXlOdz09 | |
client-secret * | This is the API access that will be provided by Smartpad Pro Team. | $2y$10$bLiiNvM.zZDTRqh58tmBEOlrGrwMpXRGWWoTNJqYroaiKADFVnanq | |
Content-Type | Designates the content to be in JSON format, encoded in the UTF-8 character encoding. | application/json |
Name | Required | Description | Example |
Brand * | Y | Brand Name | TWC - The Blind Factory |
Product * | Y | Product Name | Roller Blinds Budget |
Code | Description |
200 |
Successful
|
400 |
Bad Request
|
Note: to fully consume the APIs, please contact us.
We've created a complete end-to-end collection of API requests that you can make to the Smartpad Pro Supplier API and saved them as a Postman Collection.
Note: Be notified of new releases.
Added "CSV" value
Added "PDF" value
Added "selects" value
Added Products API
Added "Measurements" field
Updated "Options" to array
Added "TotalProduct" field
Added "Display" field