[ { "group": "Auth", "name": "PostAuth", "version": "1.0.0", "type": "POST", "url": "https://api.dropshipzone.com.au/auth", "title": "Create Access Token", "description": "

Create access token base on user access information, token will be expired in 15 mins, after expiration, new token will be required.

", "header": { "fields": { "Header": [ { "group": "Header", "type": "String", "optional": false, "field": "Content-Type", "description": "

application/json

" } ] }, "examples": [ { "title": "Header-Example:", "content": "{\n \"Content-Type\": \"application/json\"\n}", "type": "json" } ] }, "parameter": { "fields": { "Request body": [ { "group": "Request body", "type": "String", "optional": false, "field": "email", "description": "

Api user email

" }, { "group": "Request body", "type": "String", "optional": false, "field": "password", "description": "

Api user password

" } ] }, "examples": [ { "title": "Request-Body-Example:", "content": "{\n \"email\": \"apiuseremail@apiuseremail.com\",\n \"password\": \"123456\"\n}", "type": "json" } ] }, "success": { "examples": [ { "title": "SuccessExample", "content": "HTTP/1.1 200\n{\n \"iat\": 1569986936,\n \"exp\": 1570206536,\n \"token\": \"xxxxxxxxxxxxx\"\n}", "type": "json" } ] }, "error": { "examples": [ { "title": "ErrorExample", "content": "HTTP/1.1 500\n{\n \"code\": \"InternalServer\",\n \"message\": \"boom!\"\n}", "type": "json" } ] }, "filename": "myapp/doc.js", "groupTitle": "Auth" }, { "group": "Category", "name": "GetCategory", "version": "1.0.0", "type": "GET", "url": "https://api.dropshipzone.com.au/category", "title": "Get All Category", "description": "

Get a list of Category and Category information.

", "header": { "fields": { "Header": [ { "group": "Header", "type": "String", "optional": false, "field": "Authorization", "description": "

jwt xxxxxxxxxxxxx(token created in auth)

" }, { "group": "Header", "type": "String", "optional": false, "field": "Content-Type", "description": "

application/json

" } ] }, "examples": [ { "title": "Header-Example:", "content": "{\n \"Authorization\": \"jwt xxxxxxxxxxxxx\",\n \"Content-Type\": \"application/json\"\n}", "type": "json" } ] }, "success": { "examples": [ { "title": "SuccessExample", "content": "HTTP/1.1 200\n[\n{\n \"category_id\": \"1\",\n \"include_in_menu\": \"1\",\n \"is_active\": null,\n \"is_anchor\": null,\n \"parent_id\": \"0\",\n \"path\": \"1\",\n \"title\": \"Root Catalog\"\n},\n{\n \"category_id\": \"2\",\n \"include_in_menu\": \"1\",\n \"is_active\": \"1\",\n \"is_anchor\": \"0\",\n \"parent_id\": \"1\",\n \"path\": \"1/2\",\n \"title\": \"Default Category\"\n}\n]", "type": "json" } ] }, "error": { "examples": [ { "title": "ErrorExample", "content": "HTTP/1.1 500\n{\n \"code\": \"InternalServer\",\n \"message\": \"boom!\"\n}", "type": "json" } ] }, "filename": "myapp/doc.js", "groupTitle": "Category" }, { "group": "Category", "name": "GetCategoryProducts", "version": "1.0.0", "type": "GET", "url": "https://api.dropshipzone.com.au/cat_prod?[page_no=:page_no]&[limit=:limit]", "title": "Get Category Products", "description": "

Get all Category contains Product

", "examples": [ { "title": "Example usage:", "content": "{GET} https://api.dropshipzone.com.au/cat_prod?page_no=1&limit=100", "type": "get" } ], "header": { "fields": { "Header": [ { "group": "Header", "type": "String", "optional": false, "field": "Authorization", "description": "

jwt xxxxxxxxxxxxx(token created in auth)

" }, { "group": "Header", "type": "String", "optional": false, "field": "Content-Type", "description": "

application/json

" } ] }, "examples": [ { "title": "Header-Example:", "content": "{\n \"Authorization\": \"jwt xxxxxxxxxxxxx\",\n \"Content-Type\": \"application/json\"\n}", "type": "json" } ] }, "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "Number", "optional": true, "field": "page_no", "defaultValue": "1", "description": "

Page number with default 1.

" }, { "group": "Parameter", "type": "Number", "optional": true, "field": "limit", "defaultValue": "40", "description": "

Limit of the result with default 40, minimum 40 and maximum 160.

" } ] } }, "success": { "examples": [ { "title": "SuccessExample", "content": "HTTP/1.1 200\n{\n \"result\": [\n {\n \"category_id\": \"3\",\n \"product_id\": \"6697\",\n \"position\": \"1\"\n },\n ...\n ],\n \"total\": 38617,\n \"total_pages\": 966,\n \"current_page\": 1\n}", "type": "json" } ] }, "error": { "examples": [ { "title": "ErrorExample", "content": "HTTP/1.1 500\n{\n \"code\": \"InternalServer\",\n \"message\": \"boom!\"\n}", "type": "json" } ] }, "filename": "myapp/doc.js", "groupTitle": "Category" }, { "group": "Help", "name": "UserGuide", "version": "1.0.0", "type": "", "url": "-", "title": "User Guide", "description": "

How can I get information of all products, eg. stock quantity ?

  1. Call api method \"Get Products\" without passing keywords parameter eg: https://api.dropshipzone.com.au/products?page_no=1&limit=160
  2. Response of above api method contains 160 products information, like stock_qty, etc.
  3. Developer can continue to pass page_no incrementally until all products information retrieved.
", "filename": "myapp/doc.js", "groupTitle": "Help" }, { "group": "Order", "name": "Place_Order", "version": "1.0.0", "type": "POST", "url": "https://api.dropshipzone.com.au/placingOrder", "title": "Place Order", "description": "

Place order in Dropshipzone, after this api called, the order will be created in dropshipzone account as a "Not Submitted" order. User should then login Dropshipzone website and pay for the orders.

", "header": { "fields": { "Header": [ { "group": "Header", "type": "String", "optional": false, "field": "Authorization", "description": "

jwt xxxxxxxxxxxxx(token created in auth)

" }, { "group": "Header", "type": "String", "optional": false, "field": "Content-Type", "description": "

application/json

" } ] }, "examples": [ { "title": "Header-Example:", "content": "{\n \"Authorization\": \"jwt xxxxxxxxxxxxx\",\n \"Content-Type\": \"application/json\"\n}", "type": "json" } ] }, "parameter": { "examples": [ { "title": "Request-Body-Example:", "content": "{\n \"your_order_no\":\"PM2132342434\",\n \"first_name\":\"John\",\n \"last_name\":\"Baker\",\n \"address1\":\"add1\",\n \"address2\":\"add2\",\n \"suburb\":\"Eugowra\",\n \"state\":\"Australian Capital Territory\",\n \"postcode\":\"2806\",\n \"telephone\":\"0412345678\",\n \"comment\":\"comment test456\",\n \"order_items\":[\n {\n \"sku\":\"FURNI-E-TOY200-8BIN-WH\",\n \"qty\":1\n },\n {\n \"sku\":\"MOC-09M-2P-BK\",\n \"qty\":3\n }\n ]\n}", "type": "json" } ], "fields": { "Request body": [ { "group": "Request body", "type": "String", "optional": false, "field": "your_order_no", "description": "

Your unique Order Number

" }, { "group": "Request body", "type": "String", "optional": false, "field": "first_name", "description": "

Consignee first name

" }, { "group": "Request body", "type": "String", "optional": false, "field": "last_name", "description": "

Consignee last name

" }, { "group": "Request body", "type": "String", "optional": false, "field": "address1", "description": "

Consignee address first line

" }, { "group": "Request body", "type": "String", "optional": false, "field": "address2", "description": "

Consignee address second line

" }, { "group": "Request body", "type": "String", "optional": false, "field": "suburb", "description": "

Consignee address suburb

" }, { "group": "Request body", "type": "String", "optional": false, "field": "state", "description": "

Consignee address state

" }, { "group": "Request body", "type": "String", "optional": false, "field": "postcode", "description": "

Consignee address postcode

" }, { "group": "Request body", "type": "String", "optional": false, "field": "telephone", "description": "

Consignee telephone

" }, { "group": "Request body", "type": "String", "optional": false, "field": "comment", "description": "

Order notes

" }, { "group": "Request body", "type": "String", "optional": false, "field": "sku", "description": "

Order item SKU

" }, { "group": "Request body", "type": "String", "optional": false, "field": "qty", "description": "

Order item qantity

" } ] } }, "success": { "examples": [ { "title": "SuccessExample", "content": "HTTP/1.1 200\n[\n {\n \"status\": 1,\n \"serial_number\": \"P02100689\"\n }\n]", "type": "json" } ] }, "error": { "examples": [ { "title": "ErrorExample", "content": "HTTP/1.1 200\n[\n {\n \"status\": -1,\n \"serial_number\": \"P02100689\",\n \"errmsg\": \"order_id not has to be unique\"\n },\n {\n \"status\": -1,\n \"serial_number\": \"P02100689\",\n \"errmsg\": \"The postcode cannot be found\"\n },\n {\n \"status\": -1,\n \"serial_number\": \"P02100689\",\n \"errmsg\": \"The postcode 3000 does not exist in the Sydney city\"\n },\n {\n \"status\": -1,\n \"serial_number\": \"P02100689\",\n \"errmsg\": \"The email cannot be found\"\n },\n {\n \"status\": -1,\n \"serial_number\": \"P02100689\",\n \"errmsg\": \"Sorry, we do not have enough SKU: FURNI-E-TOY200-8BIN-WH in stock to fulfil your order\"\n },\n {\n \"status\": -1,\n \"serial_number\": \"P02100689\",\n \"errmsg\": \"The SKU: FURNI-E-TOY200-8BIN-WH does not exist\"\n },\n {\n \"status\": -1,\n \"serial_number\": \"P02100689\",\n \"errmsg\": \"order_items sku is required\"\n },\n {\n \"status\": -1,\n \"serial_number\": \"P02100689\",\n \"errmsg\": \"order_items qty is required\"\n }\n ]", "type": "json" } ] }, "filename": "myapp/doc.js", "groupTitle": "Order" }, { "group": "Product", "name": "GetProductBySku", "version": "1.0.0", "type": "GET", "url": "https://api.dropshipzone.com.au/products/:sku", "title": "Get Product By Sku", "description": "

Get Product details by Sku

", "header": { "fields": { "Header": [ { "group": "Header", "type": "String", "optional": false, "field": "Authorization", "description": "

jwt xxxxxxxxxxxxx(token created in auth)

" }, { "group": "Header", "type": "String", "optional": false, "field": "Content-Type", "description": "

application/json

" } ] }, "examples": [ { "title": "Header-Example:", "content": "{\n \"Authorization\": \"jwt xxxxxxxxxxxxx\",\n \"Content-Type\": \"application/json\"\n}", "type": "json" } ] }, "parameter": { "fields": { "Request body": [ { "group": "Request body", "type": "String", "optional": false, "field": "skus", "description": "

Product skus list. eg. FA-CHAIR-DIN470-BK,XMAS-ROPE-50M-WH

" } ] }, "examples": [ { "title": "Request-Body-Example:", "content": "{\n \"skus\": \"FA-CHAIR-DIN470-BK,XMAS-ROPE-50M-WH\"\n}", "type": "json" } ] }, "success": { "examples": [ { "title": "SuccessExample", "content": "HTTP/1.1 200\n[\n {\n \"sku\": \"XMAS-ROPE-50M-WH\",\n \"Category\": \"Occasions > Lights\",\n \"RRP\": {\n \"Standard\": \"162.95\"\n },\n \"RrpPrice\": \"162.95\",\n \"cost\": \"42.9660\",\n \"currency\": \"AUD\",\n \"desc\": \"

50M Christmas Rope Lights 1200 LED Cold White

\\r\\n

Rope in more sparkling joy with our Jingle Jollys LED Rope Light for your seasonal celebrations, wedding party or even a band gig. Comprising more than a thousand LED lights, our Rope Light delivers eight astounding lighting effects for a real colourful ambience. The ultra-bright LED lights consume very little power and are designed for all-weather applications. Hang it on trees, fences, roof gutters and patios, or if you prefer, use it indoors to create amazing mood lightings.
\\r\\n The entire length totals 50m long with each LED bulb placed only 2.3cm apart for better lighting intensity. And no worries about safety too as the rope light comes with an SAA-certified adaptor and controller.
\\r\\nSo let the light shine ever so brightly on your home and event with our LED Rope Light and party the night away with absolute abandon.

\\r\\n

Features
\\r\\n Low energy consumption
\\r\\nPerfect indoor events lighting
\\r\\nEasy to set up and store
\\r\\nSAA certified AC adaptor
\\r\\nCE and RoHS certified
\\r\\nEight lighting effects: Steady on, Combination, Wave, Sequential, Slow-glow, Chasing flash, Slow fade, Twinkle flash

\\r\\n

Specifications
\\r\\n LED bulb quantity: 1200
\\r\\nTotal cable length: 50m
\\r\\nLeading wire: 5m
\\r\\nDistance between LED bulbs: 2.3cm
\\r\\nAdapter: SAA approved, IP44,3.6W
\\r\\nColour: cold white

\\r\\n

Package Content
\\r\\n1 x 1200 LED Rope Lights

\\r\\n\",\n \"eancode\": \"9350062115626\",\n \"entity_id\": 9520,\n \"height\": \"16.0000\",\n \"in_stock\": \"0\",\n \"length\": \"30.0000\",\n \"price\": \"92.40\",\n \"product_status\": \"1\",\n \"status\": \"Out Of Stock\",\n \"stock_qty\": 0,\n \"title\": \"Jingle Jollys 50M Christmas Rope Lights 1200 LED Cold White\",\n \"weight\": \"5.5000\",\n \"width\": \"30.0000\",\n \"product_weight\": \"5.5000\",\n \"ETA\": \"2021-06-20 00:00:00\",\n \"gallery\": [\n \"https://cdn.dropshipzone.com.au/media/catalog/product/X/M/XMAS-ROPE-50M-WH-00.jpg\",\n \"https://cdn.dropshipzone.com.au/media/catalog/product/X/M/XMAS-ROPE-50M-WH-01.jpg\",\n \"https://cdn.dropshipzone.com.au/media/catalog/product/X/M/XMAS-ROPE-50M-WH-02.jpg\",\n \"https://cdn.dropshipzone.com.au/media/catalog/product/X/M/XMAS-ROPE-50M-WH-03.jpg\",\n \"https://cdn.dropshipzone.com.au/media/catalog/product/X/M/XMAS-ROPE-50M-WH-04.jpg\",\n \"https://cdn.dropshipzone.com.au/media/catalog/product/X/M/XMAS-ROPE-50M-WH-05.jpg\",\n \"https://cdn.dropshipzone.com.au/media/catalog/product/X/M/XMAS-ROPE-50M-WH-06.jpg\"\n ],\n \"freeshipping\": \"1\"\n },\n {\n \"sku\": \"FA-CHAIR-DIN470-BK\",\n \"Category\": \"Furniture > Bar Stools & Chairs\",\n \"RRP\": {\n \"Standard\": \"272.95\"\n },\n \"RrpPrice\": \"272.95\",\n \"cost\": \"60.1810\",\n \"currency\": \"AUD\",\n \"desc\": \"

Transform your home with French Provincial charm with our timeless Cayes Dining Chair. Oozing myriads of class and sophistication, the Cayes Dining Chair is upholstered in quality amber taupe linen over deep 13cm high resilience foam and set over a rubber wood frame.

\\r\\n

The tufted button design of the back rest, and the iconic curved back legs and turned front legs all add to the overall charisma of this classic chair.

\\r\\n

If there’s a symbol that characterises Provincial elegance eloquently, the Cayes French Provincial Dining Chair undoubtedly takes the front seat.

\\r\\n

Features:
\\r\\n Cayes French Provincial Dining Chair
\\r\\n 13cm thick seat cushioning
\\r\\n Tufted button design
\\r\\n High resilience foam
\\r\\n Solid rubber wood legs
\\r\\nw/ floor protectors

\\r\\n

Specifications:
\\r\\n Seat material: 90% Polyester & 10% Linen
\\r\\n Leg material: Rubber wood legs
\\r\\n Overall dimensions: 89 x 65 x 52.5cm
\\r\\nColour: Black

\\r\\n

Package Contents:
\\r\\n 1 x Dining Chair
\\r\\n1 x Assembly Manual

\\r\\n\",\n \"eancode\": \"9350062123942\",\n \"entity_id\": 9922,\n \"height\": \"63.0000\",\n \"in_stock\": \"1\",\n \"length\": \"57.0000\",\n \"price\": \"135.30\",\n \"product_status\": \"1\",\n \"status\": \"In Stock\",\n \"stock_qty\": 39,\n \"title\": \"Artiss Dining Chairs Chair French Provincial Wooden Fabric Retro Cafe Black x1\",\n \"weight\": \"9.8000\",\n \"width\": \"56.0000\",\n \"product_weight\": \"10.5000\",\n \"ETA\": \"2021-06-20 00:00:00\",\n \"gallery\": [\n \"https://cdn.dropshipzone.com.au/media/catalog/product/F/A/FA-CHAIR-DIN470-BK-00.jpg\",\n \"https://cdn.dropshipzone.com.au/media/catalog/product/F/A/FA-CHAIR-DIN470-BK-01.jpg\",\n \"https://cdn.dropshipzone.com.au/media/catalog/product/F/A/FA-CHAIR-DIN470-BK-02.jpg\",\n \"https://cdn.dropshipzone.com.au/media/catalog/product/F/A/FA-CHAIR-DIN470-BK-03.jpg\",\n \"https://cdn.dropshipzone.com.au/media/catalog/product/F/A/FA-CHAIR-DIN470-BK-04.jpg\",\n \"https://cdn.dropshipzone.com.au/media/catalog/product/F/A/FA-CHAIR-DIN470-BK-05.jpg\",\n \"https://cdn.dropshipzone.com.au/media/catalog/product/F/A/FA-CHAIR-DIN470-BK-99.jpg\"\n ],\n \"freeshipping\": \"1\"\n }\n]", "type": "json" } ] }, "error": { "examples": [ { "title": "ErrorExample", "content": "HTTP/1.1 500\n{\n \"code\": \"InternalServer\",\n \"message\": \"boom!\"\n}", "type": "json" } ] }, "filename": "myapp/doc.js", "groupTitle": "Product" }, { "group": "Product", "name": "GetProducts", "version": "1.0.0", "type": "GET", "url": "https://api.dropshipzone.com.au/products?[keywords=:keywords]&[page_no=:page_no]&[limit=:limit]", "title": "Get Products", "description": "

Get Products details / Get all products if keywords is empty

", "examples": [ { "title": "Example usage (With Keywords):", "content": "{GET} https://api.dropshipzone.com.au/products?keywords=Artiss Dining Chairs&page_no=2&limit=100", "type": "get" }, { "title": "Example usage (All Products):", "content": "{GET} https://api.dropshipzone.com.au/products?page_no=1&limit=160", "type": "get" } ], "header": { "fields": { "Header": [ { "group": "Header", "type": "String", "optional": false, "field": "Authorization", "description": "

jwt xxxxxxxxxxxxx(token created in auth)

" }, { "group": "Header", "type": "String", "optional": false, "field": "Content-Type", "description": "

application/json

" } ] }, "examples": [ { "title": "Header-Example:", "content": "{\n \"Authorization\": \"jwt xxxxxxxxxxxxx\",\n \"Content-Type\": \"application/json\"\n}", "type": "json" } ] }, "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": true, "field": "keywords", "description": "

Keywords of the product. eg. Artiss Dining Chairs. Get all products if it is empty.

" }, { "group": "Parameter", "type": "Number", "optional": true, "field": "page_no", "defaultValue": "1", "description": "

Page number with default 1.

" }, { "group": "Parameter", "type": "Number", "optional": true, "field": "limit", "defaultValue": "40", "description": "

Limit of the result with default 40, minimum 40 and maximum 160.

" } ] } }, "success": { "examples": [ { "title": "SuccessExample", "content": "HTTP/1.1 200\n{\n \"result\": [\n {\n \"sku\": \"MO-DIN-03-GYX4\",\n \"Category\": \"Furniture > Dining\",\n \"RRP\": {\n \"Standard\": \"439.95\"\n },\n \"RrpPrice\": \"439.95\",\n \"cost\": \"93.7200\",\n \"currency\": \"AUD\",\n \"desc\": \"

Artiss 4X Collins Dining Chairs - Dark Grey

\\n

Give your dining room a modernistic makeover with our fine selection of dining chairs. They come with soft faux linen fabric upholstery, wide comfortable seat, sturdy iron legs, quality fixings and designed with neutral hues to match your current décor. Not least, they are uber comfortable so that you can enjoy your meals more and less about your seating quality. Better still, all the dining chairs include anti-slip floor protectors to keep your pristine floor scratch-free at all times.

\\n

Features
* Soft faux linen fabric
* 150kg capacity
* Solid iron legs
* Wide comfortable seat
* Sturdy fixings
* Anti-slip design
* Easy to assemble

\\n

Specifications
* Seat material: Faux linen fabric
* Frame material: Iron legs
* Overall dimension: 45cm x 42cm x 86cm
* Seat height: 47cm
* Quantity: 4
* Colour: Dark grey

\\n

Package Content
4 x Collins Dining Chairs
1 x Assembly Manual

\",\n \"eancode\": \"9350062158364\",\n \"entity_id\": 14350,\n \"height\": \"66.0000\",\n \"in_stock\": \"1\",\n \"length\": \"65.0000\",\n \"price\": \"178.20\",\n \"product_status\": \"1\",\n \"status\": \"In Stock\",\n \"stock_qty\": 8,\n \"title\": \"Artiss 4X Collins Dining Chairs - Dark Grey\\n\",\n \"weight\": \"18.0000\",\n \"width\": \"53.0000\",\n \"ETA\": \"2021-06-20 00:00:00\",\n \"gallery\": [\n \"https://cdn.dropshipzone.com.au/media/catalog/product/M/O/MO-DIN-03-GYX4-00.jpg\",\n \"https://cdn.dropshipzone.com.au/media/catalog/product/M/O/MO-DIN-03-GYX4-01.jpg\",\n \"https://cdn.dropshipzone.com.au/media/catalog/product/M/O/MO-DIN-03-GYX4-02.jpg\",\n \"https://cdn.dropshipzone.com.au/media/catalog/product/M/O/MO-DIN-03-GYX4-03.jpg\",\n \"https://cdn.dropshipzone.com.au/media/catalog/product/M/O/MO-DIN-03-GYX4-04.jpg\",\n \"https://cdn.dropshipzone.com.au/media/catalog/product/M/O/MO-DIN-03-GYX4-05.jpg\",\n \"https://cdn.dropshipzone.com.au/media/catalog/product/M/O/MO-DIN-03-GYX4-06.jpg\"\n ]\n },\n ],\n \"total\": 1780,\n \"total_pages\": 45,\n \"current_page\": 2,\n \"page_size\": 40\n}", "type": "json" } ] }, "error": { "examples": [ { "title": "ErrorExample", "content": "HTTP/1.1 500\n{\n \"code\": \"InternalServer\",\n \"message\": \"boom!\"\n}", "type": "json" } ] }, "filename": "myapp/doc.js", "groupTitle": "Product" }, { "group": "Product", "name": "GetShippingState", "version": "1.0.0", "type": "GET", "url": "https://api.dropshipzone.com.au/shipping_state?[page_no=:page_no]&[limit=:limit]", "title": "Get Shipping Cost", "description": "

Get the product shipping cost by each state

", "examples": [ { "title": "Example usage:", "content": "{GET} https://api.dropshipzone.com.au/shipping_state?page_no=1&limit=100", "type": "get" } ], "header": { "fields": { "Header": [ { "group": "Header", "type": "String", "optional": false, "field": "Authorization", "description": "

jwt xxxxxxxxxxxxx(token created in auth)

" }, { "group": "Header", "type": "String", "optional": false, "field": "Content-Type", "description": "

application/json

" } ] }, "examples": [ { "title": "Header-Example:", "content": "{\n \"Authorization\": \"jwt xxxxxxxxxxxxx\",\n \"Content-Type\": \"application/json\"\n}", "type": "json" } ] }, "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "Number", "optional": true, "field": "page_no", "defaultValue": "1", "description": "

Page number with default 1.

" }, { "group": "Parameter", "type": "Number", "optional": true, "field": "limit", "defaultValue": "40", "description": "

Limit of the result with default 40, minimum 40 and maximum 160.

" } ] } }, "success": { "examples": [ { "title": "SuccessExample", "content": "HTTP/1.1 200\n{\n \"result\": [\n {\n \"group_id\": 1,\n \"sku\": \"WS-1150\",\n \"act\": \"0.0000\",\n \"nsw\": \"0\",\n \"nt\": \"0\",\n \"qld\": \"0\",\n \"rssr_id\": \"10007\",\n \"sa\": \"0\",\n \"tas\": \"0\",\n \"vic\": \"0\",\n \"wa\": \"0\"\n },\n ...\n ],\n \"total\": 11074,\n \"total_pages\": 277,\n \"current_page\": 1,\n \"page_size\": 40\n}", "type": "json" } ] }, "error": { "examples": [ { "title": "ErrorExample", "content": "HTTP/1.1 500\n{\n \"code\": \"InternalServer\",\n \"message\": \"boom!\"\n}", "type": "json" } ] }, "filename": "myapp/doc.js", "groupTitle": "Product" }, { "group": "Product", "name": "Stock_Level", "version": "1.0.0", "type": "POST", "url": "https://api.dropshipzone.com.au/stock", "title": "Get Stock", "description": "

Get stock level of a product, 10 days is limited

", "header": { "fields": { "Header": [ { "group": "Header", "type": "String", "optional": false, "field": "Authorization", "description": "

jwt xxxxxxxxxxxxx(token created in auth)

" }, { "group": "Header", "type": "String", "optional": false, "field": "Content-Type", "description": "

application/json

" } ] }, "examples": [ { "title": "Header-Example:", "content": "{\n \"Authorization\": \"jwt xxxxxxxxxxxxx\",\n \"Content-Type\": \"application/json\"\n}", "type": "json" } ] }, "parameter": { "fields": { "Request body": [ { "group": "Request body", "type": "String", "optional": false, "field": "start_time", "description": "

Start Time of stock level. eg. 2020-8-03 05:11:44

" }, { "group": "Request body", "type": "String", "optional": false, "field": "end_time", "description": "

End Time of stock level. eg. 2020-8-10 05:11:44

" }, { "group": "Request body", "type": "Number", "optional": true, "field": "page_no", "defaultValue": "1", "description": "

Page number with default 1.

" }, { "group": "Request body", "type": "Number", "optional": true, "field": "limit", "defaultValue": "40", "description": "

Limit of the result with default 40, minimum 40 and maximum 160.

" }, { "group": "Request body", "type": "String", "optional": false, "field": "skus", "description": "

Product sku. eg. FA-CHAIR-DIN470-BK,XMAS-ROPE-50M-WH

" } ] }, "examples": [ { "title": "Request-Body-Example:", "content": "{\n \"start_time\": \"2020-8-03 05:11:44\",\n \"end_time\": \"2020-8-10 05:11:44\",\n \"page_no\": 1,\n \"limit\": 60,\n \"skus\": \"FURNI-L-COF01-BK-AB\"\n}", "type": "json" } ] }, "success": { "examples": [ { "title": "SuccessExample", "content": "HTTP/1.1 200\n{\n \"result\": [\n {\n \"sku\": \"FURNI-L-COF01-BK-AB\",\n \"created_at\": \"2020-08-03T05:36:16.000Z\",\n \"new_qty\": \"0.00\",\n \"status\": \"Out Of Stock\"\n }\n ],\n \"total\": 1,\n \"page_no\": 1,\n \"limit\": 60\n}", "type": "json" } ] }, "error": { "examples": [ { "title": "ErrorExample", "content": "HTTP/1.1 500\n{\n \"code\": \"InternalServer\",\n \"message\": \"caused by InvalidArgumentError: The range must be less than 10 days apart.\"\n}", "type": "json" } ] }, "filename": "myapp/doc.js", "groupTitle": "Product" }, { "group": "Shipping", "name": "Get_Zone_Mapping", "version": "1.0.0", "type": "POST", "url": "https://api.dropshipzone.com.au/get_zone_mapping", "title": "Get Zone Mapping", "description": "

Get Zone Mapping Data

", "header": { "fields": { "Header": [ { "group": "Header", "type": "String", "optional": false, "field": "Authorization", "description": "

jwt xxxxxxxxxxxxx(token created in auth)

" }, { "group": "Header", "type": "String", "optional": false, "field": "Content-Type", "description": "

application/json

" } ] }, "examples": [ { "title": "Header-Example:", "content": "{\n \"Authorization\": \"jwt xxxxxxxxxxxxx\",\n \"Content-Type\": \"application/json\"\n}", "type": "json" } ] }, "parameter": { "fields": { "Request body": [ { "group": "Request body", "type": "String", "optional": false, "field": "postcode", "description": "

the postcode that would like to map. eg. "2823,6302"

" } ] }, "examples": [ { "title": "Request-Body-Example:", "content": "{\n \"postcode\": \"2823,6302\"\n}", "type": "json" } ] }, "success": { "examples": [ { "title": "SuccessExample", "content": "HTTP/1.1 200\n{\n \"result\": [\n {\n \"postcode\": \"2823\",\n \"zone\": \"NSW_R\"\n },\n {\n \"postcode\": \"6302\",\n \"zone\": \"WA_R\"\n }\n ],\n \"total\": 2,\n \"total_pages\": 1,\n \"current_page\": 1,\n \"page_size\": 40,\n \"code\": 1,\n \"message\": \"ok\"\n}", "type": "json" } ] }, "error": { "examples": [ { "title": "ErrorExample", "content": "HTTP/1.1 500\n{\n \"code\": 0,\n \"data\": [],\n \"message\": \"no data\"\n}", "type": "json" } ] }, "filename": "myapp/doc.js", "groupTitle": "Shipping" } ]