Yugster Deals API Documentation
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
README.md

README.md

Yugster API Documentation

Getting started

Yugster API requires a minimum of one mandatory header.

  1. Authorization - Authentication request header.

Authentication

Yugster API needs to be authenticated using a token.

You can obtain a token by contacting us through email admin@yugster.com

Response

Response will be in the JSON format.

Errors

Status Code Descriptions
2xx Success
4xx Bad request sent to server
5xx Server side error
Status Code Description
200 Success The request was successfully completed.
401 Unauthorized (Invalid Token) Request was rejected because of invalid Token.
404 URL Not Found The URL you've sent is wrong.
500 Server encountered an error which prevents it from fulfilling the request. We recommend you to contact us at admin@yugster.com if you receive this error.

Deals

List of all Deals

GET /api/deals

Request example:

curl -H "Authorization: Token token=your-token" https://www.yugster.com/api/deals

ResponseExample:

HTTP/1.1 200 OK

Content-Type: application/json; charset=utf-8

{

"deals_count":1732,

"page":"1",

"per_page":100,

"deals":{

        "74324":{

                "url":                  "https://www.yugster.com/daily-deal/77947-pet-carrier-travel-bag-for-small-or-medium-animals-3-colors",

                "title":                "Pet Carrier Travel Bag for Small or Medium Animals – 3 Colors",

                "description":          "<p class=\"p1\">Now you … Until Gone!</span></p>",
                
                "features":     	"<p><strong>What's in the… Warranty</li>\r\n</ul>",

                "listing_image_thumb":  "https://img.yugster.com/uploads/image/image/103067/listing\_BFLEDS.jpg",

                "listing_image":        "https://img.yugster.com/uploads/image/image/103067/BFLEDS.jpg",
                "category":     	"Pet Carriers & Crates",
                "full_category":  	"Animals & Pet Supplies > Pet Supplies > Pet Carriers & Crates",

                "images":[

                        "https://img.yugster.com/uploads/image/image/100839/tree-decor\_\_25845.1469036016.1280.1280\_1\_.jpg",

                        "https://img.yugster.com/uploads/image/image/100841/kids-christmas-tree\_\_64711.1469036060.1280.1280\_1\_.jpg",

                        "https://img.yugster.com/uploads/image/image/100842/children-decorating-christmas.jpg",

                        "https://img.yugster.com/uploads/image/image/101031/LEDS1.jpg"

                        ],
                    "products":{
                        "YUG59373":	
                                "title":	"Pet Carrier Travel Bag f…3 Colors Green - Medium",
                                "name": 	"Green - Medium",
                                "vendor_sku":	"15003689",
                                "quantity":	"more than 15",
                                "price":	9.97,
                                "image":	"https://img.yugster.com/uploads/image/image/119541/Green.jpg"
                        "YUG59369":	
                                "title":	"Pet Carrier Travel Bag for Small or Medium Animals – 3 Colors Blue - Small",
                                "name": 	"Blue - Small",
                                "vendor_sku":	"15003687",
                                "quantity":	"more than 15",
                                "price":	9.97,
                                "image":	"https://img.yugster.com/…e/image/119540/Blue.jpg",
                    }

                }

        }

}

Pagination

The pagination information will be included in the list API response under the root node. By default first page will be listed. For navigating through pages, use the page parameter. The per_page parameter is listed in root node and is set to 100 by default. No option to change this parameter.

Example:

curl -H "Authorization: Token token=your-token" https://www.yugster.com/api/deals?page=2

{

  deals_count: 1756,

  page: 2,

  per_page: 100,

  deals: {...}

}