Supplier - API Documentation

Getting Started

Welcome

How to integrate with us?

Get an API Access

Step 1 Contact us to get started and we will give you the initial requirement for accessing the system.

 

Generate API Key

Step 2 Upon receiving API Access, you will need to generate an API Key to retrieve / perform actions.

 

Connect to us!

Step 3 Check out our documentation for each APIs. Happy Coding!

 

Authentication

Once you received an API access from us, you can now walk through the following steps below:

Base Domain: https://dealers.smartpadpro.com.au/

  /service/oauth/account/authorize   Get Access Token

Returns Access Token valid for # of days.

Headers
Name Required Description Example
client-key *
Y
 This is the API access that will be provided by Smartpad Pro Team. TVMweU1ERVVNVEV3TkRBME1qTXlOdz09
client-secret *
Y
 This is the API access that will be provided by Smartpad Pro Team. $2y$10$bLiiNvM.zZDTRqh58tmBEOlrGrwMpXRGWWoTNJqYroaiKADFVnanq
Content-Type
N
 Designates the content to be in JSON format, encoded in the UTF-8 character encoding. application/json
Parameters
None
Response
Code Description
200 Successful
{
    "access_token": "eyJpdiI6Ilp1Nm40XC9XZmVzQjhVczFnXC9NXC9KZnc9PS...",
    "expires_in": 1573689518
}
400 Bad Request
{
    "error": {
        "code": 400,
        "message": "Please check required parameters"
    }
}
 

API Response Codes

List of expected responses from the system.

Headers
HTTP Status Code HTTP Method Description Expected Message
200 SUCCESS Standard success response 
{
    "error": {
        "code": 200,
        "message": "Successful"
    }
}
201 CREATED Standard success response 
{
    "error": {
        "code": 201,
        "message": "Successful"
    }
}
400 BADREQUEST Please check required parameters 
{
    "error": {
        "code": 400,
        "message": "Please check required parameters"
    }
}
401 UNAUTHORISED Please check your API credentails 
{
    "error": {
        "code": 401,
        "message": "Please check your API credentials"
    }
}
403 FORBIDDEN Please check your API credentails 
{
    "error": {
        "code": 403,
        "message": "Please check your API credentails"
    }
}
404 PAGENOTFOUND Page Not Found 
{
    "error": {
        "code": 404,
        "message": "Page Not Found"
    }
}
500 INTERNALSERVERERROR Internal Server Error 
{
    "error": {
        "code": 500,
        "message": "Internal Server Error"
    }
}
400 REJECTREASON Order with REJECT status requires REASON 
{
    "error": {
        "code": 400,
        "message": "Please check required parameters"
    }
}

API

Orders

List all orders ready for processing

  /service/v1/order   Get All Orders

Returns All Orders ready for processing.

Headers
Name Required Description Example
Authorization *
Y
 This is the response from the authorization API. Bearer eyJpdiI6Ilp1Nm40XC9XZmVzQjhVczFnXC9NXC9KZnc9PS...
client-key *
Y
 This is the API access that will be provided by Smartpad Pro Team. TVMweU1ERVVNVEV3TkRBME1qTXlOdz09
client-secret *
Y
 This is the API access that will be provided by Smartpad Pro Team. $2y$10$bLiiNvM.zZDTRqh58tmBEOlrGrwMpXRGWWoTNJqYroaiKADFVnanq
Content-Type
N
 Designates the content to be in JSON format, encoded in the UTF-8 character encoding. application/json
Parameters
None
Response
Code Description
200 Successful
{
    "data": {
        "ABS Wholesale": {
            "Vertical Blinds": [
                {
                    "ID": 13538,
                    "SubmittedDate": "2020-02-27 06:05:16",
                    "AccountName": "aaronlecornu",
                    "ClientName": "Edge de Guzman",
                    "OrderNumber": "O-196755",
                    "PurchaseOrderNumber": "PO-24257-306-003",
                    "BrandName": "ABS Wholesale",
                    "CategoryName": "Vertical Blinds",
                    "Options": [
                        {
                            "Window": "Dining",
                            "Product": "127mm Vertical Blinds Cord Control Category 0",
                            "Mount": "in reveal",
                            "Width": "2500",
                            "Drop": "2500",
                            "FixType": null,
                            "Control": null,
                            "InstallType": "",
                            "MeasurementType": "Opening Size",
                            "Measurements": [
                                {
                                    "Name": "1000",
                                    "Measurement": {
                                        "width": 3500,
                                        "height": 3500
                                    },
                                    "Default": true
                                },
                                {
                                    "Name": "2000",
                                    "Measurement": {
                                        "width": 4500,
                                        "height": 4500
                                    },
                                    "Default": false
                                },
                                {
                                    "Name": "3000",
                                    "Measurement": {
                                        "width": 5500,
                                        "height": 5500
                                    },
                                    "Default": false
                                },
                                {
                                    "Name": "4000",
                                    "Measurement": {
                                        "width": 6500,
                                        "height": 6500
                                    },
                                    "Default": false
                                },
                                {
                                    "Name": "5000",
                                    "Measurement": {
                                        "width": 7500,
                                        "height": 7500
                                    },
                                    "Default": false
                                }
                            ],
                            "BunchSide": "Right Bunch",
                            "ControlSide": "Left Control",
                            "FabricColour": "COLOUR TEST",
                            "FabricName": "Other Fabric",
                            "NotesandExtras": null,
                            "Options": "Add Chainless Bottom Weights",
                            "OtherFabricDetails": null,
                            "TrackColour": "Primrose",
                            "TrackSelection": "Uniline",
                            "UnilineOption": null,
                            "CostPrice": "150.00"
                        }
                    ],
                    "Notes": null,
                    "DeliveryAddress": null,
                    "ETA": "2020-02-28",
                    "TotalProduct": 1,
                    "PDF": "https://smartpadbucket.s3-ap-southeast-2.amazonaws.com/dealers/files/documents/10/b412ecdb-132a-48fd-95a5-fbd9e874b685.pdf",
                    "CSV": "https://smartpadbucket.s3-ap-southeast-2.amazonaws.com/dealers/files/documents/10/ad4e4fbe-b673-4c40-8800-45405ef17f20.xlsx"
                }
            ]
        }
    }
}
200 Successful
{
    "data": "No available orders right now."
}
400 Bad Request
{
    "error": {
        "code": 400,
        "message": "Please check required parameters"
    }
}
 

Order Status

Confirm status of the order [confirm / rejected]

  /service/v1/order/status/{ID}   Updates Status of the Order

Updates the status of an order.

Headers
Name Required Description Example
Authorization *
Y
 This is the response from the authorization API. Bearer eyJpdiI6Ilp1Nm40XC9XZmVzQjhVczFnXC9NXC9KZnc9PS...
client-key *
Y
 This is the API access that will be provided by Smartpad Pro Team. TVMweU1ERVVNVEV3TkRBME1qTXlOdz09
client-secret *
Y
 This is the API access that will be provided by Smartpad Pro Team. $2y$10$bLiiNvM.zZDTRqh58tmBEOlrGrwMpXRGWWoTNJqYroaiKADFVnanq
Content-Type
N
 Designates the content to be in JSON format, encoded in the UTF-8 character encoding. application/json
Parameters
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" }
Request 
{
    "status": "rejected",
    "reason": "Order Rejected",
    "display": {
        "status": "Not available",
        "background-color": "#000000",
        "text-color": "#ffffff"
    }
}

Response
Code Description
200 Successful
{
    "data": "Order Status Successfully Updated."
}
400 Bad Request
{
    "error": {
        "code": 400,
        "message": "Please check required parameters"
    }
}
400 Bad Request
{
    "error": {
        "code": 400,
        "message": "Order with REJECT status requires REASON"
    }
}
 

Order ETA

Update Order ETA

  /service/v1/order/eta/{ID}   Updates ETA of the Order

Updates the ETA date of an order.

Headers
Name Required Description Example
Authorization *
Y
 This is the response from the authorization API. Bearer eyJpdiI6Ilp1Nm40XC9XZmVzQjhVczFnXC9NXC9KZnc9PS...
client-key *
Y
 This is the API access that will be provided by Smartpad Pro Team. TVMweU1ERVVNVEV3TkRBME1qTXlOdz09
client-secret *
Y
 This is the API access that will be provided by Smartpad Pro Team. $2y$10$bLiiNvM.zZDTRqh58tmBEOlrGrwMpXRGWWoTNJqYroaiKADFVnanq
Content-Type
N
 Designates the content to be in JSON format, encoded in the UTF-8 character encoding. application/json
Parameters
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
Request 
{
    "eta": "2019-12-10",
    "notes": "Product to be delivered on December 9"
}

Response
Code Description
200 Successful
{
    "data": "Order ETA Successfully Updated."
}
400 Bad Request
{
    "error": {
        "code": 400,
        "message": "Please check required parameters"
    }
}
 

Product

Retrieve Products

  /service/v1/product/{brand}   Retrieves the Products

Retrieves the Products.

Headers
Name Required Description Example
Authorization *
Y
 This is the response from the authorization API. Bearer eyJpdiI6Ilp1Nm40XC9XZmVzQjhVczFnXC9NXC9KZnc9PS...
client-key *
Y
 This is the API access that will be provided by Smartpad Pro Team. TVMweU1ERVVNVEV3TkRBME1qTXlOdz09
client-secret *
Y
 This is the API access that will be provided by Smartpad Pro Team. $2y$10$bLiiNvM.zZDTRqh58tmBEOlrGrwMpXRGWWoTNJqYroaiKADFVnanq
Content-Type
N
 Designates the content to be in JSON format, encoded in the UTF-8 character encoding. application/json
Parameters
Name Required Description Example
Brand * Y Brand Name TWC - The Blind Factory
Response
Code Description
200 Successful
{
    "data": {
        "TWC - The Blind Factory": [
            "Roller Blind Budget",
            "Roller Blind Group 1",
            "Roller Blind Group 2",
            "Roller Blind Group 3",
            "Roller Blind Group 4",
            "Roller Blind Group 5",
            "Roller Blind Group 6",
            "Roman Blinds Group 1",
            "Roman Blinds Group 2",
            "Roman Blinds Group 3",
            "Roman Blinds Group 4",
            "Roman Blinds Group 5",
            "Roman Blinds Group 6",
            "Panel Glides Budget",
            "Panel Glides Group 1",
            "Panel Glides Group 2",
            "Panel Glides Group 3",
            "Panel Glides Group 4",
            "Panel Glides Group 5",
            "Panel Glides Group 6",
            "Panel Glides Track Only",
            "50mm Aluminium Venetian",
            "Vertical Blinds Budget",
            "Vertical Blinds Group 1",
            "Vertical Blinds Group 2",
            "Vertical System - Track Only",
            "Auto Awning Group 1",
            "Auto Awning Group 2",
            "Auto Awning Group 3",
            "Auto Awning Group 4",
            "Fixed Guide Awning Group 1",
            "Fixed Guide Awning Group 2",
            "Fixed Guide Awning Group 3",
            "Fixed Guide Awning Group 4",
            "50mm Pure Wood Venetian",
            "Recloth Awning Group 1",
            "Recloth Awning Group 2",
            "Recloth Awning Group 3",
            "Recloth Awning Group 4",
            "Rope and Pulley Straight Drop Awning Group 1",
            "Rope and Pulley Straight Drop Awning Group 2",
            "Rope and Pulley Straight Drop Awning Group 3",
            "Rope and Pulley Straight Drop Awning Group 4",
            "25mm Slimline Venetian Blinds",
            "Straight Drop Awning Group 1",
            "Straight Drop Awning Group 2",
            "Straight Drop Awning Group 3",
            "Straight Drop Awning Group 4",
            "25mm Sunset Aluminium Venetian",
            "System 2000 Pivot Arm Awning Group 1",
            "System 2000 Pivot Arm Awning Group 2",
            "System 2000 Pivot Arm Awning Group 3",
            "System 2000 Pivot Arm Awning Group 4",
            "Visionwood 50mm Venetian",
            "Visionwood 63mm Venetian",
            "Honeycell 25mm Blockout",
            "25mm Honeycell",
            "Roller Shutters",
            "Roller Blind Pelmet",
            "Vertical Blind Pelmet",
            "50mm Pure Wood Venetian Glossy",
            "Straight Drop Wire Guide Group 1",
            "Roller Blind Pelmet - FRS Valance 100mm",
            "Roller Blind Pelmet - FRS Valance 120mm",
            "Roller Blind Pelmet - Box 90 Cassette Headbox ONLY",
            "Roller Blind Pelmet - Box 90 Side Channels ONLY",
            "Roller Blind Pelmet - Bonded Pelmet Group 2",
            "Roller Blind Pelmet - Bonded Pelmet Group 3",
            "Roller Blind Pelmet - Bonded Pelmet Group 4",
            "Roller Blind Pelmet - Bonded Pelmet Group 5",
            "Roller Blind Pelmet - Bonded Pelmet Group 6",
            "Roller Blind Pelmet - Box 90 Cassette Headbox and Side Channels",
            "Straight Drop Wire Guide Group 2",
            "Straight Drop Wire Guide Group 3",
            "Vertical Blinds Slats Only - Budget",
            "Vertical Blinds Slats Only - Group 1",
            "Vertical Blinds Slats Only - Group 2",
            "System 2000 Pivot Arm Awning",
            "Pivot Arm Awning",
            "Fixed Guide Awnings",
            "Panel Glides Option",
            "Panel Glides",
            "Fixed Guide Awning",
            "Straight Drop Wire Guide Group 1",
            "Straight Drop Wire Guide Group 2",
            "Straight Drop Wire Guide Group 3",
            "Spare Parts",
            "Straight Drop Wire Guide",
            "Straight Drop Wire Guide",
            "Roller Blind Main Options",
            "Roller Blind",
            "Roller Blind Bonded Pelmets",
            "Roller Blind Bonded Pelmet Options",
            "Roman Blind Main Options",
            "Roman Blinds",
            "Vertical Blind Main Options",
            "Vertical Blind",
            "Vertical Blinds Slat Only Options",
            "Vertical Blind Slats Only",
            "Auto Awnings",
            "Auto Awnings",
            "Re Cloth Awning Options",
            "Re Cloth Awning",
            "Rope and Pulley Straight Drop Awning Options",
            "Rope and Pulley Straight Drop Awnings",
            "Straight Drop Awnings Options",
            "Straight Drop Awnings"
        ]
    }
}
400 Bad Request
{
    "error": {
        "code": 400,
        "message": "Please check required parameters"
    }
}
 

Product Options

Retrieve Product Options

  /service/v1/product/{brand}/{product}/options   Retrieves the Product Options

Retrieves the Product options.

Headers
Name Required Description Example
Authorization *
Y
 This is the response from the authorization API. Bearer eyJpdiI6Ilp1Nm40XC9XZmVzQjhVczFnXC9NXC9KZnc9PS...
client-key *
Y
 This is the API access that will be provided by Smartpad Pro Team. TVMweU1ERVVNVEV3TkRBME1qTXlOdz09
client-secret *
Y
 This is the API access that will be provided by Smartpad Pro Team. $2y$10$bLiiNvM.zZDTRqh58tmBEOlrGrwMpXRGWWoTNJqYroaiKADFVnanq
Content-Type
N
 Designates the content to be in JSON format, encoded in the UTF-8 character encoding. application/json
Parameters
Name Required Description Example
Brand * Y Brand Name TWC - The Blind Factory
Product * Y Product Name Roller Blinds Budget
Response
Code Description
200 Successful
{
    "data": {
        "TWC - The Blind Factory": {
            "Roller Blind Budget": [
                {
                    "option": "Window",
                    "selects": []
                },
                {
                    "option": "Product",
                    "selects": []
                },
                {
                    "option": "Mount",
                    "selects": []
                },
                {
                    "option": "Width",
                    "selects": []
                },
                {
                    "option": "Drop",
                    "selects": []
                },
                {
                    "option": "Fix Type",
                    "selects": []
                },
                {
                    "option": "Control",
                    "selects": []
                },
                {
                    "option": "Install Type",
                    "selects": []
                },
                {
                    "option": "Measurement Type",
                    "selects": []
                },
                {
                    "option": "Acmeda Options",
                    "selects": []
                },
                {
                    "option": "Base Rail Colour",
                    "selects": [
                        "Anodised Silver",
                        "Black",
                        "Bone",
                        "Bronze Pearl",
                        "Dune",
                        "Pure White",
                        "Sandstone"
                    ]
                },
                {
                    "option": "Base Rail Colour Options",
                    "selects": []
                },
                {
                    "option": "Bottom Finish",
                    "selects": [
                        "D30 Base Rail",
                        "D30 Silent Base Rail",
                        "Oval Base Rail",
                        "Small Flat Base Rail",
                        "Heavy Duty Flat",
                        "S1 Plain Lathe",
                        "S5 Double Lathe",
                        "S6 Twin Lathe",
                        "S7 Wave Scallop",
                        "S8 Georgian Scallop",
                        "S9 U-Scallop"
                    ]
                },
                {
                    "option": "Bracket and Link Selection",
                    "selects": [
                        "Standard (Single)",
                        "Single Bracket Covers",
                        "Slimline Double Brackets Top Back",
                        "Slimline Double Brackets Top Front",
                        "TO SUIT Slimline Top Front",
                        "TO SUIT Slimline Top Back",
                        "Easy Link",
                        "Linked to Left",
                        "Linked to Right",
                        "Easy Link Double Blinds",
                        "Square Combo Double Brackets Same Side",
                        "Square Combo Double Brackets Opposite Side",
                        "TO SUIT Square Combo Double Brackets Same Side",
                        "TO SUIT Square Combo Double Brackets Opposite Side"
                    ]
                },
                {
                    "option": "Bracket Colour",
                    "selects": [
                        "Black",
                        "Grey",
                        "Sandstone",
                        "White"
                    ]
                },
                {
                    "option": "Chain Colour",
                    "selects": [
                        "Black",
                        "Grey",
                        "Sandstone",
                        "White"
                    ]
                },
                {
                    "option": "Chain Legth",
                    "selects": [
                        "500mm",
                        "750mm",
                        "1000mm",
                        "1250mm",
                        "1500mm",
                        "1750mm",
                        "2000mm",
                        "2250mm"
                    ]
                },
                {
                    "option": "Chain Length",
                    "selects": [
                        "500mm",
                        "750mm",
                        "1000mm",
                        "1250mm",
                        "1500mm",
                        "1750mm",
                        "2000mm",
                        "2250mm",
                        "Standard"
                    ]
                },
                {
                    "option": "Chain Length",
                    "selects": [
                        "500mm",
                        "750mm",
                        "1000mm",
                        "1250mm",
                        "1500mm",
                        "1750mm",
                        "2000mm",
                        "2250mm",
                        "Standard"
                    ]
                },
                {
                    "option": "Control Side",
                    "selects": [
                        "Left",
                        "Right"
                    ]
                },
                {
                    "option": "Control Side",
                    "selects": [
                        "Left",
                        "Right"
                    ]
                },
                {
                    "option": "Control Side",
                    "selects": [
                        "Left",
                        "Right"
                    ]
                },
                {
                    "option": "Control Side",
                    "selects": [
                        "Left",
                        "Right"
                    ]
                },
                {
                    "option": "Control Side",
                    "selects": [
                        "Left",
                        "Right"
                    ]
                },
                {
                    "option": "Control Type",
                    "selects": [
                        "Plastic Control Chain",
                        "Metal Control Chain",
                        "Stainless Steel Control Chain",
                        "Acmeda Motorised",
                        "Somfy Motorised",
                        "Spring Operation"
                    ]
                },
                {
                    "option": "Extras and Notes",
                    "selects": []
                },
                {
                    "option": "Fabric Name",
                    "selects": [
                        "Beacon Blockout",
                        "Chess",
                        "Cross",
                        "Crypto",
                        "Eternity",
                        "Fox",
                        "Geo",
                        "Globe",
                        "Knight",
                        "Minus",
                        "Lateral",
                        "Peak",
                        "Puzzle",
                        "Rubik",
                        "Soma"
                    ]
                },
                {
                    "option": "FRS Colour",
                    "selects": [
                        "Anodised Silver",
                        "Black",
                        "Sandstone",
                        "White"
                    ]
                },
                {
                    "option": "FRS Fabric Wrapped Options",
                    "selects": []
                },
                {
                    "option": "FRS Fabric Wrapped Options",
                    "selects": []
                },
                {
                    "option": "FRS Finish",
                    "selects": [
                        "Plain",
                        "Fabric Wrapped Matching",
                        "Fabric Wrapped Other Fabric"
                    ]
                },
                {
                    "option": "FRS Valance Option Details",
                    "selects": []
                },
                {
                    "option": "FRS Valance Options",
                    "selects": [
                        "No Valance",
                        "100mm FRS Valance",
                        "120mm FRS Valance"
                    ]
                },
                {
                    "option": "Metal Chain Options",
                    "selects": []
                },
                {
                    "option": "Motor Option",
                    "selects": [
                        "Automate 240v E6 ARC Motor",
                        "Automate Rechargeable ZERO 1.1NM",
                        "Automate Rechargeable ZERO 2.0NM",
                        "Automate 240v M6 C-BUS ONLY"
                    ]
                },
                {
                    "option": "Motor Option",
                    "selects": [
                        "Sonesse RTS 40mm 3/30 with Molex",
                        "Altus RTS 40mm 3/30 with Molex",
                        "Altus 50mm RH 6/32 with Molex",
                        "LS 40mm 3/30 NON RTS with Molex",
                        "Sonesse WT 40mm 3/30 NON RTS with Molex",
                        "Ariane LT50 RH 6/32 with Molex",
                        "Somfy Battery Operated Wire Free Motor"
                    ]
                },
                {
                    "option": "Other Fabric Details",
                    "selects": []
                },
                {
                    "option": "Other Fabric Details",
                    "selects": []
                },
                {
                    "option": "Plastic Chain Options",
                    "selects": []
                },
                {
                    "option": "Product Notes hidden on quote",
                    "selects": []
                },
                {
                    "option": "Pull Ring",
                    "selects": [
                        "None",
                        "Metal - Birch White",
                        "Metal - Silver",
                        "Metal - White",
                        "Crocheted Ring - Colour Matched",
                        "Silk Tassel - Colour Matched",
                        "Turks Head Tassel - Colour Matched"
                    ]
                },
                {
                    "option": "Remote and Accessories",
                    "selects": [
                        "Situo 1 RTS Pure Remote White",
                        "Situo 5 RTS Pure Remote White",
                        "Telis 16 RTS Pure Remote White",
                        "Connexoon Wi Fi Hub"
                    ]
                },
                {
                    "option": "Remotes and Accessories",
                    "selects": [
                        "PUSH 5 Channel Remote Whote",
                        "PUSH 5 Channel Remote Black",
                        "Paradigm + 15 Channel Remote"
                    ]
                },
                {
                    "option": "Roll Direction",
                    "selects": [
                        "Standard",
                        "Reverse"
                    ]
                },
                {
                    "option": "Roller Blind Extras",
                    "selects": [
                        "Spring Assist",
                        "Wire Guide System (D30 or HD Base Only)",
                        "60mm Heavy Duty Tube"
                    ]
                },
                {
                    "option": "Roller Main Options",
                    "selects": []
                },
                {
                    "option": "Somfy Options",
                    "selects": []
                },
                {
                    "option": "Spring Options",
                    "selects": []
                },
                {
                    "option": "Stainless Steel Chain Options",
                    "selects": []
                }
            ]
        }
    }
}
400 Bad Request
{
    "error": {
        "code": 400,
        "message": "Please check required parameters"
    }
}

Tools

Postman Collection

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.

Releases

Software Updates

Note: Be notified of new releases.