Back to top

This guide provides list of REST API and sample code on many languages

Items 

Items 

Sort & Paginate Items
/editor/items/?page={pageNumber}&sort={sortField}

The api only returns a limited number of results per response. The page and sort query params provide a way to iterate through all the results as well as control in what order the results are returned. These 2 query parameters can be appended to any of the mulit-item response HTTP GET calls. The all field in the response will indicate the total number of results that were found.

  • Parameters
  • pageNumber
    number (optional) Example: 1
    sortField
    string (optional) Example: dateupdated

    append _ for descending sort i.e. dateupdated_

    Choices: id sku guid stock price name title mediacount media size color condition brand style date dateupdated status state category

  • Request
  • Headers
    X-Auth-User: {auth-username}
    X-Auth-Token: {auth-token}
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
    "1": {
    "id": "2387",
    "url": "http://play.suredone.com/1-moar-1moar",
    "uri": "1-moar-1moar",
    "galleryuri": "1-moar-1moar",
    "parenturi": "",
    "sku": "1MOAR",
    "guid": "1MOAR",
    "stock": "3",
    "price": "1.00",
    "reprice": "0.00",
    "discountprice": "0.00",
    "msrp": "0.00",
    "cost": "0.00",
    "featured": "0",
    "name": "",
    "title": "1 Moar",
    "keywords": "",
    "description": "",
    "notes": "",
    "htmltitle": "",
    "metadescription": "",
    "size": "",
    "color": "Black",
    "condition": "New",
    "brand": "",
    "style": "",
    "upc": "",
    "tags": "",
    "category1": "",
    "category2": "",
    "category3": "",
    "category4": "",
    "category5": "",
    "media": "",
    "media1": "",
    "media2": "",
    "media3": "",
    "media4": "",
    "media5": "",
    "media6": "",
    "media7": "",
    "media8": "",
    "media9": "",
    "media10": "",
    "mediacount": "0",
    "shipping": "0.00",
    "shippingadditional": "0.00",
    "handlingfee": "0.00",
    "weight": "0.00",
    "dimweight": "0.00",
    "boxlength": "0.00",
    "boxwidth": "0.00",
    "boxheight": "0.00",
    "boxweight": "0.00",
    "date": "2015-08-21 16:15:39",
    "dateupdated": "2015-08-21 16:19:40",
    "datesold": "0000-00-00 00:00:00",
    "totalsold": "0",
    "asset": "",
    "domain": "",
    "rule": "update",
    "state": "stock",
    "status": "publish",
    "active": "0",
    "type": "",
    "updatenotes": "",
    "googleshopping": "1",
    "googleshopurl": "",
    "googlecategory": "",
    "ebayid": "0",
    "ebaysku": "",
    "ebaycatid": "0",
    "ebaystoreid": "0",
    "ebaystoreid2": "0",
    "ebayprice": "0.00",
    "ebaytitle": "",
    "ebayoptions": "{\"shippingprofileid\":\"0\",\"paymentprofileid\":\"0\",\"returnprofileid\":\"0\",\"siteid\":\"\",\"location\":\"\",\"subtitle\":\"\",\"secondcategory\":\"\",\"paymentinstructions\":\"\",\"salestaxpercent\":0,\"taxcategory\":\"\",\"shipping\":{\"calculated\":{\"postalcode\":\"\",\"handlingfee\":0,\"shippingirregular\":false,\"shippingpackage\":\"\",\"internationalhandlingfee\":0},\"domestic\":{\"1\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"surcharge\":0,\"timemin\":0,\"timemax\":0},\"2\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"surcharge\":0,\"timemin\":0,\"timemax\":0},\"3\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"surcharge\":0,\"timemin\":0,\"timemax\":0},\"4\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"surcharge\":0,\"timemin\":0,\"timemax\":0}},\"international\":{\"1\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"location\":\"\"},\"2\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"location\":\"\"},\"3\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"location\":\"\"},\"4\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"location\":\"\"},\"5\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"location\":\"\"}},\"ratetable\":{\"dom\":\"off\",\"intl\":\"off\"},\"excludes\":[\"\"]},\"dispatch\":0,\"returns\":{\"description\":\"\"},\"template\":\"\",\"bestoffer\":{\"minimumprice\":0,\"autoacceptprice\":0},\"scheduletime\":\"\",\"siteshipping\":\"\",\"internationalon\":\"\",\"fitmentcatalog\":\"\",\"autorelist\":{\"max\":\"\",\"count\":\"\",\"duration\":\"\",\"action\":\"\",\"price\":\"\"},\"upcnot\":\"off\",\"paymentmethods\":[\"\"],\"shiptolocations\":[\"\"],\"itemspecifics\":[]}",
    "ebayshippingprofileid": "0",
    "ebaypaymentprofileid": "0",
    "ebayreturnprofileid": "0",
    "ebaysiteid": "",
    "ebaylocation": "",
    "ebaysubtitle": "",
    "ebaysecondcategory": "",
    "ebaypaymentinstructions": "",
    "ebaysalestaxpercent": 0,
    "ebaytaxcategory": "",
    "ebayshippingcalculatedpostalcode": "",
    "ebayshippingcalculatedhandlingfee": 0,
    "ebayshippingcalculatedshippingirregular": "false",
    "ebayshippingcalculatedshippingpackage": "",
    "ebayshippingcalculatedinternationalhandlingfee": 0,
    "ebayshippingdomestic1service": "",
    "ebayshippingdomestic1cost": 0,
    "ebayshippingdomestic1additionalcost": 0,
    "ebayshippingdomestic1insurancecost": 0,
    "ebayshippingdomestic1surcharge": 0,
    "ebayshippingdomestic1timemin": 0,
    "ebayshippingdomestic1timemax": 0,
    "ebayshippingdomestic2service": "",
    "ebayshippingdomestic2cost": 0,
    "ebayshippingdomestic2additionalcost": 0,
    "ebayshippingdomestic2insurancecost": 0,
    "ebayshippingdomestic2surcharge": 0,
    "ebayshippingdomestic2timemin": 0,
    "ebayshippingdomestic2timemax": 0,
    "ebayshippingdomestic3service": "",
    "ebayshippingdomestic3cost": 0,
    "ebayshippingdomestic3additionalcost": 0,
    "ebayshippingdomestic3insurancecost": 0,
    "ebayshippingdomestic3surcharge": 0,
    "ebayshippingdomestic3timemin": 0,
    "ebayshippingdomestic3timemax": 0,
    "ebayshippingdomestic4service": "",
    "ebayshippingdomestic4cost": 0,
    "ebayshippingdomestic4additionalcost": 0,
    "ebayshippingdomestic4insurancecost": 0,
    "ebayshippingdomestic4surcharge": 0,
    "ebayshippingdomestic4timemin": 0,
    "ebayshippingdomestic4timemax": 0,
    "ebayshippinginternational1service": "",
    "ebayshippinginternational1cost": 0,
    "ebayshippinginternational1additionalcost": 0,
    "ebayshippinginternational1insurancecost": 0,
    "ebayshippinginternational1location": "",
    "ebayshippinginternational2service": "",
    "ebayshippinginternational2cost": 0,
    "ebayshippinginternational2additionalcost": 0,
    "ebayshippinginternational2insurancecost": 0,
    "ebayshippinginternational2location": "",
    "ebayshippinginternational3service": "",
    "ebayshippinginternational3cost": 0,
    "ebayshippinginternational3additionalcost": 0,
    "ebayshippinginternational3insurancecost": 0,
    "ebayshippinginternational3location": "",
    "ebayshippinginternational4service": "",
    "ebayshippinginternational4cost": 0,
    "ebayshippinginternational4additionalcost": 0,
    "ebayshippinginternational4insurancecost": 0,
    "ebayshippinginternational4location": "",
    "ebayshippinginternational5service": "",
    "ebayshippinginternational5cost": 0,
    "ebayshippinginternational5additionalcost": 0,
    "ebayshippinginternational5insurancecost": 0,
    "ebayshippinginternational5location": "",
    "ebayshippingratetabledom": "off",
    "ebayshippingratetableintl": "off",
    "ebayshippingexcludes0": "",
    "ebaydispatch": 0,
    "ebayreturnsdescription": "",
    "ebaytemplate": "",
    "ebaybestofferminimumprice": 0,
    "ebaybestofferautoacceptprice": 0,
    "ebayscheduletime": "",
    "ebaysiteshipping": "",
    "ebayinternationalon": "",
    "ebayfitmentcatalog": "",
    "ebayautorelistmax": "",
    "ebayautorelistcount": "",
    "ebayautorelistduration": "",
    "ebayautorelistaction": "",
    "ebayautorelistprice": "",
    "ebayupcnot": "off",
    "ebaypaymentmethods0": "",
    "ebayshiptolocations0": "",
    "ebaystarttime": null,
    "ebayendtime": null,
    "ebaypromotionstarttime": null,
    "ebaypromotionendtime": null,
    "ebayautopay": null,
    "ebayduration": null,
    "ebaylisting": null,
    "ebaypaypalemailaddress": null,
    "ebaypaymentmethods": "",
    "ebayshiptolocations": "",
    "ebayshippingincludedintax": null,
    "ebayshippingtype": null,
    "ebayshippingglobal": null,
    "ebayshippingdomestic1cutofftime": null,
    "ebayshippingdomestic1expedited": null,
    "ebayshippingdomestic1freeshipping": null,
    "ebayshippingdomestic1localpickup": null,
    "ebayshippingdomestic1handling": null,
    "ebayshippingdomestic2cutofftime": null,
    "ebayshippingdomestic2expedited": null,
    "ebayshippingdomestic2freeshipping": null,
    "ebayshippingdomestic2localpickup": null,
    "ebayshippingdomestic2handling": null,
    "ebayshippingdomestic3cutofftime": null,
    "ebayshippingdomestic3expedited": null,
    "ebayshippingdomestic3freeshipping": null,
    "ebayshippingdomestic3localpickup": null,
    "ebayshippingdomestic3handling": null,
    "ebayshippingdomestic4cutofftime": null,
    "ebayshippingdomestic4expedited": null,
    "ebayshippingdomestic4freeshipping": null,
    "ebayshippingdomestic4localpickup": null,
    "ebayshippingdomestic4handling": null,
    "ebayshippinginternational1cutofftime": null,
    "ebayshippinginternational1handling": null,
    "ebayshippinginternational2cutofftime": null,
    "ebayshippinginternational2handling": null,
    "ebayshippinginternational3cutofftime": null,
    "ebayshippinginternational3handling": null,
    "ebayshippinginternational4cutofftime": null,
    "ebayshippinginternational4handling": null,
    "ebayshippinginternational5cutofftime": null,
    "ebayshippinginternational5handling": null,
    "ebayshippingexcludes": "",
    "ebaygetitfast": null,
    "ebayreturnsreturnsaccepted": null,
    "ebayreturnsrefund": null,
    "ebayreturnsreturnswithin": null,
    "ebayreturnsshippingcostpaidby": null,
    "ebayreturnsrestockingfeevalue": null,
    "ebayadult": null,
    "ebayprivate": null,
    "ebayholidayreturn": null,
    "ebaybestofferenabled": null,
    "ebayitemspecifics": "",
    "ebaybuyitnow": null,
    "ebayoutofstock": null,
    "ebayauctionsrelist": null,
    "ebaycurrency": null,
    "ebayprefiliteminfo": null,
    "ebayitemspecificsbottomssizemens": null,
    "ebayitemspecificssizetype": null,
    "ebayitemspecificsinseam": null,
    "ebayitemspecificsusshoesizemens": null,
    "ebayitemspecificssizemens": null,
    "amznsku": "",
    "amznasin": "",
    "amznitemtype": "0",
    "amzncategory": "0",
    "amznprice": "0.00",
    "amzntitle": "",
    "amznsearch": "",
    "amznfba": "",
    "amznstatus": "",
    "amznoptions": "",
    "amzn3sku": "",
    "amzn3asin": "",
    "amzn3itemtype": "0",
    "amzn3category": "0",
    "amzn3price": "0.00",
    "amzn3title": "",
    "amzn3search": "",
    "amzn3fba": "",
    "amzn3status": "",
    "amzn3options": "",
    "ebayepid": "",
    "amznstockfba": "0",
    "bulletpoint1": "",
    "bulletpoint2": "",
    "bulletpoint3": "",
    "bulletpoint4": "",
    "bulletpoint5": "",
    "department": "",
    "partnumber": "",
    "mpn": "",
    "carrier": "",
    "width": "",
    "amznminage": "0",
    "amznmaxage": "0",
    "amznexemption": "",
    "memory": "",
    "minstock": "",
    "sizemens": "",
    "amznminstock": "",
    "amznmaxstock": "",
    "fitmentnotes": "",
    "sproket": "",
    "model": "",
    "flavor": "",
    "vendor1stock": "0",
    "vendorsku": "",
    "media1alttext": "",
    "media2alttext": "",
    "media3alttext": "",
    "media4alttext": "",
    "media5alttext": "",
    "media6alttext": "",
    "media7alttext": "",
    "media8alttext": "",
    "media9alttext": "",
    "media10alttext": "",
    "media11alttext": "",
    "shoesize": "",
    "internationalshipping1": "0.00",
    "internationalshippinglocation1": "Worldwide",
    "etsylistingid": "0",
    "etsy2listingid": "0",
    "skuvaultsku": "",
    "skuvaultretailprice": "1.00",
    "skuvaultquantityavailable": "1",
    "skuvaultdescription": "1 Moar",
    "skuvaultclassification": "",
    "skuvaultsupplier": "",
    "skuvaultbrand": "",
    "skuvaultcost": "0.00",
    "skuvaultsaleprice": "0.00",
    "magentolistingid": "",
    "magentosku": "",
    "magento3listingid": "",
    "magento3sku": "",
    "volusionproductid": "0",
    "bigcommercelistingid": "221",
    "bigcommercesku": "1MOAR",
    "bigcommercecategories": "JSON::[\"1\"]",
    "bigcommerceisfreeshipping": "on",
    "bigcommercebrandid": "Coco Lee",
    "bigcommerceoptionsetid": "13",
    "bigcommerceskuid": 2451,
    "bigcommercetaxclassid": "",
    "total_stock": 3
    },
    "2": {
    "id": "2388",
    "url": "http://play.suredone.com/1-moar-1moar",
    "uri": "1-moar-1moar",
    "galleryuri": "1-moar-1moar",
    "parenturi": "",
    "sku": "1MOAR",
    "guid": "1MOAR-1",
    "stock": "13",
    "price": "11.00",
    "reprice": "0.00",
    "discountprice": "0.00",
    "msrp": "0.00",
    "cost": "0.00",
    "featured": "0",
    "name": "",
    "title": "1 Moar",
    "keywords": "",
    "description": "",
    "notes": "",
    "htmltitle": "",
    "metadescription": "",
    "size": "",
    "color": "Blue",
    "condition": "New",
    "brand": "",
    "style": "",
    "upc": "",
    "tags": "",
    "category1": "",
    "category2": "",
    "category3": "",
    "category4": "",
    "category5": "",
    "media": "",
    "media1": "",
    "media2": "",
    "media3": "",
    "media4": "",
    "media5": "",
    "media6": "",
    "media7": "",
    "media8": "",
    "media9": "",
    "media10": "",
    "mediacount": "0",
    "shipping": "0.00",
    "shippingadditional": "0.00",
    "handlingfee": "0.00",
    "weight": "0.00",
    "dimweight": "0.00",
    "boxlength": "0.00",
    "boxwidth": "0.00",
    "boxheight": "0.00",
    "boxweight": "0.00",
    "date": "2015-08-21 16:16:27",
    "dateupdated": "2015-08-21 16:19:44",
    "datesold": "0000-00-00 00:00:00",
    "totalsold": "0",
    "asset": "",
    "domain": "",
    "rule": "update",
    "state": "stock",
    "status": "attribute",
    "active": "0",
    "type": "",
    "updatenotes": "",
    "googleshopping": "1",
    "googleshopurl": "",
    "googlecategory": "",
    "ebayid": "0",
    "ebaysku": "",
    "ebaycatid": "0",
    "ebaystoreid": "0",
    "ebaystoreid2": "0",
    "ebayprice": "0.00",
    "ebaytitle": "",
    "ebayoptions": "{\"shippingprofileid\":\"0\",\"paymentprofileid\":\"0\",\"returnprofileid\":\"0\",\"siteid\":\"\",\"location\":\"\",\"subtitle\":\"\",\"secondcategory\":\"NaN\",\"paymentinstructions\":\"\",\"salestaxpercent\":0,\"taxcategory\":\"\",\"shipping\":{\"calculated\":{\"postalcode\":\"\",\"handlingfee\":0,\"shippingirregular\":false,\"shippingpackage\":\"\",\"internationalhandlingfee\":0},\"domestic\":{\"1\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"surcharge\":0,\"timemin\":0,\"timemax\":0},\"2\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"surcharge\":0,\"timemin\":0,\"timemax\":0},\"3\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"surcharge\":0,\"timemin\":0,\"timemax\":0},\"4\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"surcharge\":0,\"timemin\":0,\"timemax\":0}},\"international\":{\"1\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"location\":\"\"},\"2\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"location\":\"\"},\"3\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"location\":\"\"},\"4\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"location\":\"\"},\"5\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"location\":\"\"}},\"ratetable\":{\"dom\":\"off\",\"intl\":\"off\"},\"excludes\":[\"\"]},\"dispatch\":0,\"returns\":{\"description\":\"\"},\"template\":\"\",\"bestoffer\":{\"minimumprice\":0,\"autoacceptprice\":0},\"scheduletime\":\"\",\"siteshipping\":\"\",\"internationalon\":\"\",\"fitmentcatalog\":\"\",\"autorelist\":{\"max\":\"\",\"count\":\"\",\"duration\":\"\",\"action\":\"\",\"price\":\"\"},\"upcnot\":\"off\",\"paymentmethods\":[\"\"],\"shiptolocations\":[\"\"],\"itemspecifics\":[]}",
    "ebayshippingprofileid": "0",
    "ebaypaymentprofileid": "0",
    "ebayreturnprofileid": "0",
    "ebaysiteid": "",
    "ebaylocation": "",
    "ebaysubtitle": "",
    "ebaysecondcategory": "NaN",
    "ebaypaymentinstructions": "",
    "ebaysalestaxpercent": 0,
    "ebaytaxcategory": "",
    "ebayshippingcalculatedpostalcode": "",
    "ebayshippingcalculatedhandlingfee": 0,
    "ebayshippingcalculatedshippingirregular": "false",
    "ebayshippingcalculatedshippingpackage": "",
    "ebayshippingcalculatedinternationalhandlingfee": 0,
    "ebayshippingdomestic1service": "",
    "ebayshippingdomestic1cost": 0,
    "ebayshippingdomestic1additionalcost": 0,
    "ebayshippingdomestic1insurancecost": 0,
    "ebayshippingdomestic1surcharge": 0,
    "ebayshippingdomestic1timemin": 0,
    "ebayshippingdomestic1timemax": 0,
    "ebayshippingdomestic2service": "",
    "ebayshippingdomestic2cost": 0,
    "ebayshippingdomestic2additionalcost": 0,
    "ebayshippingdomestic2insurancecost": 0,
    "ebayshippingdomestic2surcharge": 0,
    "ebayshippingdomestic2timemin": 0,
    "ebayshippingdomestic2timemax": 0,
    "ebayshippingdomestic3service": "",
    "ebayshippingdomestic3cost": 0,
    "ebayshippingdomestic3additionalcost": 0,
    "ebayshippingdomestic3insurancecost": 0,
    "ebayshippingdomestic3surcharge": 0,
    "ebayshippingdomestic3timemin": 0,
    "ebayshippingdomestic3timemax": 0,
    "ebayshippingdomestic4service": "",
    "ebayshippingdomestic4cost": 0,
    "ebayshippingdomestic4additionalcost": 0,
    "ebayshippingdomestic4insurancecost": 0,
    "ebayshippingdomestic4surcharge": 0,
    "ebayshippingdomestic4timemin": 0,
    "ebayshippingdomestic4timemax": 0,
    "ebayshippinginternational1service": "",
    "ebayshippinginternational1cost": 0,
    "ebayshippinginternational1additionalcost": 0,
    "ebayshippinginternational1insurancecost": 0,
    "ebayshippinginternational1location": "",
    "ebayshippinginternational2service": "",
    "ebayshippinginternational2cost": 0,
    "ebayshippinginternational2additionalcost": 0,
    "ebayshippinginternational2insurancecost": 0,
    "ebayshippinginternational2location": "",
    "ebayshippinginternational3service": "",
    "ebayshippinginternational3cost": 0,
    "ebayshippinginternational3additionalcost": 0,
    "ebayshippinginternational3insurancecost": 0,
    "ebayshippinginternational3location": "",
    "ebayshippinginternational4service": "",
    "ebayshippinginternational4cost": 0,
    "ebayshippinginternational4additionalcost": 0,
    "ebayshippinginternational4insurancecost": 0,
    "ebayshippinginternational4location": "",
    "ebayshippinginternational5service": "",
    "ebayshippinginternational5cost": 0,
    "ebayshippinginternational5additionalcost": 0,
    "ebayshippinginternational5insurancecost": 0,
    "ebayshippinginternational5location": "",
    "ebayshippingratetabledom": "off",
    "ebayshippingratetableintl": "off",
    "ebayshippingexcludes0": "",
    "ebaydispatch": 0,
    "ebayreturnsdescription": "",
    "ebaytemplate": "",
    "ebaybestofferminimumprice": 0,
    "ebaybestofferautoacceptprice": 0,
    "ebayscheduletime": "",
    "ebaysiteshipping": "",
    "ebayinternationalon": "",
    "ebayfitmentcatalog": "",
    "ebayautorelistmax": "",
    "ebayautorelistcount": "",
    "ebayautorelistduration": "",
    "ebayautorelistaction": "",
    "ebayautorelistprice": "",
    "ebayupcnot": "off",
    "ebaypaymentmethods0": "",
    "ebayshiptolocations0": "",
    "ebaystarttime": null,
    "ebayendtime": null,
    "ebaypromotionstarttime": null,
    "ebaypromotionendtime": null,
    "ebayautopay": null,
    "ebayduration": null,
    "ebaylisting": null,
    "ebaypaypalemailaddress": null,
    "ebaypaymentmethods": "",
    "ebayshiptolocations": "",
    "ebayshippingincludedintax": null,
    "ebayshippingtype": null,
    "ebayshippingglobal": null,
    "ebayshippingdomestic1cutofftime": null,
    "ebayshippingdomestic1expedited": null,
    "ebayshippingdomestic1freeshipping": null,
    "ebayshippingdomestic1localpickup": null,
    "ebayshippingdomestic1handling": null,
    "ebayshippingdomestic2cutofftime": null,
    "ebayshippingdomestic2expedited": null,
    "ebayshippingdomestic2freeshipping": null,
    "ebayshippingdomestic2localpickup": null,
    "ebayshippingdomestic2handling": null,
    "ebayshippingdomestic3cutofftime": null,
    "ebayshippingdomestic3expedited": null,
    "ebayshippingdomestic3freeshipping": null,
    "ebayshippingdomestic3localpickup": null,
    "ebayshippingdomestic3handling": null,
    "ebayshippingdomestic4cutofftime": null,
    "ebayshippingdomestic4expedited": null,
    "ebayshippingdomestic4freeshipping": null,
    "ebayshippingdomestic4localpickup": null,
    "ebayshippingdomestic4handling": null,
    "ebayshippinginternational1cutofftime": null,
    "ebayshippinginternational1handling": null,
    "ebayshippinginternational2cutofftime": null,
    "ebayshippinginternational2handling": null,
    "ebayshippinginternational3cutofftime": null,
    "ebayshippinginternational3handling": null,
    "ebayshippinginternational4cutofftime": null,
    "ebayshippinginternational4handling": null,
    "ebayshippinginternational5cutofftime": null,
    "ebayshippinginternational5handling": null,
    "ebayshippingexcludes": "",
    "ebaygetitfast": null,
    "ebayreturnsreturnsaccepted": null,
    "ebayreturnsrefund": null,
    "ebayreturnsreturnswithin": null,
    "ebayreturnsshippingcostpaidby": null,
    "ebayreturnsrestockingfeevalue": null,
    "ebayadult": null,
    "ebayprivate": null,
    "ebayholidayreturn": null,
    "ebaybestofferenabled": null,
    "ebayitemspecifics": "",
    "ebaybuyitnow": null,
    "ebayoutofstock": null,
    "ebayauctionsrelist": null,
    "ebaycurrency": null,
    "ebayprefiliteminfo": null,
    "ebayitemspecificsbottomssizemens": null,
    "ebayitemspecificssizetype": null,
    "ebayitemspecificsinseam": null,
    "ebayitemspecificsusshoesizemens": null,
    "ebayitemspecificssizemens": null,
    "amznsku": "",
    "amznasin": "",
    "amznitemtype": "0",
    "amzncategory": "0",
    "amznprice": "0.00",
    "amzntitle": "",
    "amznsearch": "",
    "amznfba": "",
    "amznstatus": "",
    "amznoptions": "",
    "amzn3sku": "",
    "amzn3asin": "",
    "amzn3itemtype": "0",
    "amzn3category": "0",
    "amzn3price": "0.00",
    "amzn3title": "",
    "amzn3search": "",
    "amzn3fba": "",
    "amzn3status": "",
    "amzn3options": "",
    "ebayepid": "",
    "amznstockfba": "0",
    "bulletpoint1": "",
    "bulletpoint2": "",
    "bulletpoint3": "",
    "bulletpoint4": "",
    "bulletpoint5": "",
    "department": "",
    "partnumber": "",
    "mpn": "",
    "carrier": "",
    "width": "",
    "amznminage": "0",
    "amznmaxage": "0",
    "amznexemption": "",
    "memory": "",
    "minstock": "",
    "sizemens": "",
    "amznminstock": "",
    "amznmaxstock": "",
    "fitmentnotes": "",
    "sproket": "",
    "model": "",
    "flavor": "",
    "vendor1stock": "0",
    "vendorsku": "",
    "media1alttext": "",
    "media2alttext": "",
    "media3alttext": "",
    "media4alttext": "",
    "media5alttext": "",
    "media6alttext": "",
    "media7alttext": "",
    "media8alttext": "",
    "media9alttext": "",
    "media10alttext": "",
    "media11alttext": "",
    "shoesize": "",
    "internationalshipping1": "0.00",
    "internationalshippinglocation1": "Worldwide",
    "etsylistingid": "0",
    "etsy2listingid": "0",
    "skuvaultsku": "1MOAR-1",
    "skuvaultretailprice": "1.00",
    "skuvaultquantityavailable": "1",
    "skuvaultdescription": "1 Moar",
    "skuvaultclassification": "",
    "skuvaultsupplier": "",
    "skuvaultbrand": "",
    "skuvaultcost": "0.00",
    "skuvaultsaleprice": "0.00",
    "magentolistingid": "",
    "magentosku": "",
    "magento3listingid": "",
    "magento3sku": "",
    "volusionproductid": "0",
    "bigcommercelistingid": "221",
    "bigcommercesku": "1MOAR-1",
    "bigcommercecategories": "JSON::[\"1\"]",
    "bigcommerceisfreeshipping": "on",
    "bigcommercebrandid": "Coco Lee",
    "bigcommerceoptionsetid": "13",
    "bigcommerceskuid": 2452,
    "bigcommercetaxclassid": "",
    "total_stock": 13
    },
    "type": "items",
    "all": "2",
    "time": "2015-08-30 19:37:14"
    }
curl --request GET \
--url 'https://api.suredone.com/v1/editor/items/?sort=dateupdated&page=1' \
--header 'x-auth-token: {auth-token}' \
--header 'x-auth-user: {auth-username}'
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.suredone.com/v1/editor/items/?sort=dateupdated&page=1",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_SSL_VERIFYHOST => false,
CURLOPT_HTTPHEADER => array(
"x-auth-token: {auth-token}",
"x-auth-user: {auth-username}"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
header('Content-Type: application/json');
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
// This example uses package from http://restsharp.org/
var client = new RestClient("https://api.suredone.com/v1/editor/items/?sort=dateupdated&page=1");
var request = new RestRequest(Method.GET);
request.AddHeader("x-auth-token", "{auth-token}");
request.AddHeader("x-auth-user", "{auth-username}");
IRestResponse response = client.Execute(request);
Console.Write(response.Content);
Console.ReadLine();
import http.client
conn = http.client.HTTPSConnection("api.suredone.com")
payload = ''
headers = {
'x-auth-user': "{auth-username}",
'x-auth-token': "{auth-token}"
}
conn.request("GET", "/v1/editor/items/?sort=dateupdated&page=1", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
// This example uses following package
// https://github.com/Mashape/unirest-java
try {
HttpResponse<String> response = Unirest.get("https://api.suredone.com/v1/editor/items/?sort=dateupdated&page=1")
.header("x-auth-user", "{auth-username}")
.header("x-auth-token", "{auth-token}")
.asString();
System.out.print(response.getBody());
} catch(UnirestException e){
e.printStackTrace();
}
var unirest = require("unirest");
var req = unirest("GET", "https://api.suredone.com/v1/editor/items/");
req.query({
"sort": "dateupdated",
"page": "1"
});
req.headers({
"x-auth-token": "{auth-token}",
"x-auth-user": "{auth-username}"
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
require 'uri'
require 'net/http'
url = URI("https://api.suredone.com/v1/editor/items/?sort=dateupdated&page=1")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["x-auth-user"] = '{auth-username}'
request["x-auth-token"] = '{auth-token}'
response = http.request(request)
puts response.read_body
Get Item By ID
/editor/items/edit/{id}
  • Parameters
  • id
    numeric (required) Example: 1705
  • Request
  • Headers
    X-Auth-User: {auth-username}
    X-Auth-Token: {auth-token}
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
    "id": "1705",
    "url": "http://play.suredone.com/acer-aspire-laptop-intel-core-i3-processor-14-display-4gb-memory-cobalt-blue-as3830t-6870",
    "uri": "acer-aspire-laptop-intel-core-i3-processor-14-display-4gb-memory-cobalt-blue-as3830t-6870",
    "galleryuri": "",
    "parenturi": "",
    "sku": "AS3830T-6870",
    "guid": "AS3830T-6870",
    "stock": "10",
    "price": "605.76",
    "reprice": "0.00",
    "discountprice": "0.00",
    "msrp": "0.00",
    "cost": "199.00",
    "featured": "0",
    "name": "",
    "title": "Acer Aspire Laptop / Intel® Core? i3 Processor / 14\" Display / 4GB Memory - Cobalt Blue",
    "keywords": "",
    "description": "Special features: Windows 7 Home Premium 64-bit; HDMI output; BluetoothNote: DVD/CD drive not included",
    "longdescription": "",
    "content": "",
    "notes": "",
    "htmltitle": "",
    "metadescription": "",
    "geolocation": "",
    "size": "",
    "color": "",
    "condition": "",
    "brand": "Acer",
    "style": "",
    "upc": "",
    "tags": "",
    "category1": "",
    "category2": "",
    "category3": "",
    "category4": "",
    "category5": "",
    "media1": "https://d3inagkmqs1m6q.cloudfront.net/1021/media-pics/as3830t-6870-acer-aspire-laptop-intel-core-i3-processor-14-display-4gb-memory-cobalt-blu.jpg",
    "media2": "",
    "media3": "",
    "media4": "",
    "media5": "",
    "media6": "",
    "media7": "",
    "media8": "",
    "media9": "",
    "media10": "",
    "mediax": "",
    "mediacount": "1",
    "shipping": "0.00",
    "shippingadditional": "0.00",
    "handlingfee": "0.00",
    "weight": "4.10",
    "dimweight": "0.00",
    "boxlength": "0.00",
    "boxwidth": "0.00",
    "boxheight": "0.00",
    "boxweight": "0.00",
    "date": "2015-02-18 19:10:53",
    "dateupdated": "2015-06-12 15:26:18",
    "datesold": "0000-00-00 00:00:00",
    "totalsold": "0",
    "asset": "",
    "domain": "",
    "rule": "update",
    "state": "stock",
    "status": "publish",
    "active": "0",
    "type": "",
    "updatereason": "",
    "updatenotes": "",
    "googleshopping": "1",
    "googleshopurl": "",
    "googlecategory": "",
    "ebayid": "0",
    "ebaysku": "",
    "ebaycatid": "0",
    "ebaystoreid": "0",
    "ebaystoreid2": "0",
    "ebayprice": "55.00",
    "ebaytitle": "",
    "ebaydescription": "",
    "ebayoptions": "{}",
    "amznsku": "",
    "amznasin": "",
    "amznitemtype": "0",
    "amzncategory": "0",
    "amznprice": "0.00",
    "amzntitle": "",
    "amznsearch": "",
    "amznfba": "",
    "amznstatus": "",
    "amznoptions": "",
    "amzn3sku": "",
    "amzn3asin": "",
    "amzn3itemtype": "0",
    "amzn3category": "0",
    "amzn3price": "0.00",
    "amzn3title": "",
    "amzn3search": "",
    "amzn3fba": "",
    "amzn3status": "",
    "amzn3options": "",
    "ebayepid": "",
    "amznstockfba": "1",
    "bulletpoint1": "",
    "bulletpoint2": "",
    "bulletpoint3": "",
    "bulletpoint4": "",
    "bulletpoint5": "",
    "department": "",
    "partnumber": "",
    "mpn": "",
    "carrier": "",
    "width": null,
    "amznminage": null,
    "amznmaxage": null,
    "amznexemption": null,
    "memory": "",
    "minstock": "",
    "sizemens": "",
    "amznminstock": "",
    "amznmaxstock": "",
    "fitmentnotes": "",
    "sproket": "",
    "model": "",
    "flavor": "",
    "vendor1stock": "0",
    "vendorsku": "",
    "media1alttext": "",
    "media2alttext": "",
    "media3alttext": "",
    "media4alttext": "",
    "media5alttext": "",
    "media6alttext": "",
    "media7alttext": "",
    "media8alttext": "",
    "media9alttext": "",
    "media10alttext": "",
    "media11alttext": "",
    "shoesize": "",
    "footwaresize": "",
    "footwearsize": "",
    "shoesizes": "",
    "internationalshipping1": "0.00",
    "internationalshippinglocation1": "Worldwide",
    "etsylistingid": "0",
    "etsytitle": "",
    "etsyprice": "",
    "etsydescription": "Special features: Windows 7 Home Premium 64-bit; HDMI output; BluetoothNote: DVD/CD drive not included",
    "etsy2listingid": "0",
    "skuvaultsku": "",
    "skuvaultretailprice": "605.76",
    "skuvaultquantityavailable": 10,
    "skuvaultdescription": "Acer Aspire Laptop / Intel® Core? i3 Processor / 14\" Display / 4GB Memory - Cobalt Blue",
    "magentolistingid": "0",
    "magentosku": "",
    "magento3listingid": "",
    "magento3sku": "",
    "volusionproductid": "0",
    "bigcommercelistingid": "0",
    "bigcommercesku": "",
    "total_stock": 11,
    "action": "edit",
    "time": "2015-09-01 15:40:00"
    }
curl --request GET \
--url https://api.suredone.com/v1/editor/items/edit/1705 \
--header 'x-auth-token: {auth-token}' \
--header 'x-auth-user: {auth-username}'
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.suredone.com/v1/editor/items/edit/1705",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_SSL_VERIFYHOST => false,
CURLOPT_HTTPHEADER => array(
"x-auth-token: {auth-token}",
"x-auth-user: {auth-username}"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
header('Content-Type: application/json');
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
// This example uses package from http://restsharp.org/
var client = new RestClient("https://api.suredone.com/v1/editor/items/edit/1705");
var request = new RestRequest(Method.GET);
request.AddHeader("x-auth-token", "{auth-token}");
request.AddHeader("x-auth-user", "{auth-username}");
IRestResponse response = client.Execute(request);
Console.Write(response.Content);
Console.ReadLine();
import http.client
conn = http.client.HTTPSConnection("api.suredone.com")
payload = ''
headers = {
'x-auth-user': "{auth-username}",
'x-auth-token': "{auth-token}"
}
conn.request("GET", "/v1/editor/items/edit/1705", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
// This example uses following package
// https://github.com/Mashape/unirest-java
try {
HttpResponse<String> response = Unirest.get("https://api.suredone.com/v1/editor/items/edit/1705")
.header("x-auth-user", "{auth-username}")
.header("x-auth-token", "{auth-token}")
.asString();
System.out.print(response.getBody());
} catch(UnirestException e){
e.printStackTrace();
}
var unirest = require("unirest");
var req = unirest("GET", "https://api.suredone.com/v1/editor/items/edit/1705");
req.headers({
"x-auth-token": "{auth-token}",
"x-auth-user": "{auth-username}"
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
require 'uri'
require 'net/http'
url = URI("https://api.suredone.com/v1/editor/items/edit/1705")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["x-auth-user"] = '{auth-username}'
request["x-auth-token"] = '{auth-token}'
response = http.request(request)
puts response.read_body
Get Item By GUID/SKU
/editor/items/edit/?{identifier}={value}
  • Parameters
  • identifier
    string (required) Example: guid

    Choices: guid sku

    value
     (required) Example: AS3830T

    6870 (string,required)

  • Request
  • Headers
    X-Auth-User: {auth-username}
    X-Auth-Token: {auth-token}
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
    "id": "1705",
    "url": "http://play.suredone.com/acer-aspire-laptop-intel-core-i3-processor-14-display-4gb-memory-cobalt-blue-as3830t-6870",
    "uri": "acer-aspire-laptop-intel-core-i3-processor-14-display-4gb-memory-cobalt-blue-as3830t-6870",
    "galleryuri": "",
    "parenturi": "",
    "sku": "AS3830T-6870",
    "guid": "AS3830T-6870",
    "stock": "10",
    "price": "605.76",
    "reprice": "0.00",
    "discountprice": "0.00",
    "msrp": "0.00",
    "cost": "199.00",
    "featured": "0",
    "name": "",
    "title": "Acer Aspire Laptop / Intel® Core? i3 Processor / 14\" Display / 4GB Memory - Cobalt Blue",
    "keywords": "",
    "description": "Special features: Windows 7 Home Premium 64-bit; HDMI output; BluetoothNote: DVD/CD drive not included",
    "longdescription": "",
    "content": "",
    "notes": "",
    "htmltitle": "",
    "metadescription": "",
    "geolocation": "",
    "size": "",
    "color": "",
    "condition": "",
    "brand": "Acer",
    "style": "",
    "upc": "",
    "tags": "",
    "category1": "",
    "category2": "",
    "category3": "",
    "category4": "",
    "category5": "",
    "media1": "https://d3inagkmqs1m6q.cloudfront.net/1021/media-pics/as3830t-6870-acer-aspire-laptop-intel-core-i3-processor-14-display-4gb-memory-cobalt-blu.jpg",
    "media2": "",
    "media3": "",
    "media4": "",
    "media5": "",
    "media6": "",
    "media7": "",
    "media8": "",
    "media9": "",
    "media10": "",
    "mediax": "",
    "mediacount": "1",
    "shipping": "0.00",
    "shippingadditional": "0.00",
    "handlingfee": "0.00",
    "weight": "4.10",
    "dimweight": "0.00",
    "boxlength": "0.00",
    "boxwidth": "0.00",
    "boxheight": "0.00",
    "boxweight": "0.00",
    "date": "2015-02-18 19:10:53",
    "dateupdated": "2015-06-12 15:26:18",
    "datesold": "0000-00-00 00:00:00",
    "totalsold": "0",
    "asset": "",
    "domain": "",
    "rule": "update",
    "state": "stock",
    "status": "publish",
    "active": "0",
    "type": "",
    "updatereason": "",
    "updatenotes": "",
    "googleshopping": "1",
    "googleshopurl": "",
    "googlecategory": "",
    "ebayid": "0",
    "ebaysku": "",
    "ebaycatid": "0",
    "ebaystoreid": "0",
    "ebaystoreid2": "0",
    "ebayprice": "55.00",
    "ebaytitle": "",
    "ebaydescription": "",
    "ebayoptions": "{}",
    "amznsku": "",
    "amznasin": "",
    "amznitemtype": "0",
    "amzncategory": "0",
    "amznprice": "0.00",
    "amzntitle": "",
    "amznsearch": "",
    "amznfba": "",
    "amznstatus": "",
    "amznoptions": "",
    "amzn3sku": "",
    "amzn3asin": "",
    "amzn3itemtype": "0",
    "amzn3category": "0",
    "amzn3price": "0.00",
    "amzn3title": "",
    "amzn3search": "",
    "amzn3fba": "",
    "amzn3status": "",
    "amzn3options": "",
    "ebayepid": "",
    "amznstockfba": "1",
    "bulletpoint1": "",
    "bulletpoint2": "",
    "bulletpoint3": "",
    "bulletpoint4": "",
    "bulletpoint5": "",
    "department": "",
    "partnumber": "",
    "mpn": "",
    "carrier": "",
    "width": null,
    "amznminage": null,
    "amznmaxage": null,
    "amznexemption": null,
    "memory": "",
    "minstock": "",
    "sizemens": "",
    "amznminstock": "",
    "amznmaxstock": "",
    "fitmentnotes": "",
    "sproket": "",
    "model": "",
    "flavor": "",
    "vendor1stock": "0",
    "vendorsku": "",
    "media1alttext": "",
    "media2alttext": "",
    "media3alttext": "",
    "media4alttext": "",
    "media5alttext": "",
    "media6alttext": "",
    "media7alttext": "",
    "media8alttext": "",
    "media9alttext": "",
    "media10alttext": "",
    "media11alttext": "",
    "shoesize": "",
    "footwaresize": "",
    "footwearsize": "",
    "shoesizes": "",
    "internationalshipping1": "0.00",
    "internationalshippinglocation1": "Worldwide",
    "etsylistingid": "0",
    "etsytitle": "",
    "etsyprice": "",
    "etsydescription": "Special features: Windows 7 Home Premium 64-bit; HDMI output; BluetoothNote: DVD/CD drive not included",
    "etsy2listingid": "0",
    "skuvaultsku": "",
    "skuvaultretailprice": "605.76",
    "skuvaultquantityavailable": 10,
    "skuvaultdescription": "Acer Aspire Laptop / Intel® Core? i3 Processor / 14\" Display / 4GB Memory - Cobalt Blue",
    "magentolistingid": "0",
    "magentosku": "",
    "magento3listingid": "",
    "magento3sku": "",
    "volusionproductid": "0",
    "bigcommercelistingid": "0",
    "bigcommercesku": "",
    "total_stock": 11,
    "action": "edit",
    "time": "2015-09-01 15:40:00"
    }
curl --request GET \
--url 'https://api.suredone.com/v1/editor/items/edit/?guid=AS3830T' \
--header 'x-auth-token: {auth-token}' \
--header 'x-auth-user: {auth-username}'
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.suredone.com/v1/editor/items/edit/?guid=AS3830T",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_SSL_VERIFYHOST => false,
CURLOPT_HTTPHEADER => array(
"x-auth-token: {auth-token}",
"x-auth-user: {auth-username}"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
header('Content-Type: application/json');
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
// This example uses package from http://restsharp.org/
var client = new RestClient("https://api.suredone.com/v1/editor/items/edit/?guid=AS3830T");
var request = new RestRequest(Method.GET);
request.AddHeader("x-auth-token", "{auth-token}");
request.AddHeader("x-auth-user", "{auth-username}");
IRestResponse response = client.Execute(request);
Console.Write(response.Content);
Console.ReadLine();
import http.client
conn = http.client.HTTPSConnection("api.suredone.com")
payload = ''
headers = {
'x-auth-user': "{auth-username}",
'x-auth-token': "{auth-token}"
}
conn.request("GET", "/v1/editor/items/edit/?guid=AS3830T", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
// This example uses following package
// https://github.com/Mashape/unirest-java
try {
HttpResponse<String> response = Unirest.get("https://api.suredone.com/v1/editor/items/edit/?guid=AS3830T")
.header("x-auth-user", "{auth-username}")
.header("x-auth-token", "{auth-token}")
.asString();
System.out.print(response.getBody());
} catch(UnirestException e){
e.printStackTrace();
}
var unirest = require("unirest");
var req = unirest("GET", "https://api.suredone.com/v1/editor/items/edit/");
req.query({
"guid": "AS3830T"
});
req.headers({
"x-auth-token": "{auth-token}",
"x-auth-user": "{auth-username}"
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
require 'uri'
require 'net/http'
url = URI("https://api.suredone.com/v1/editor/items/edit/?guid=AS3830T")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["x-auth-user"] = '{auth-username}'
request["x-auth-token"] = '{auth-token}'
response = http.request(request)
puts response.read_body
Add Item
/editor/items/add

Create a new item and have it sync to all the active channels. Below is an example of a basic item. You can get a full list of supported fields for your account by retrieving an item via the api and inspecting the returned object.

  • Parameters
  • identifier
    string (required) Example: guid
    guid
    string (required) Example: NikeKXE
    price
    numeric (required) Example: 99
    title
    string (required) Example: Nike Kobe X Elite
    media1
    string (optional) Example: http://images.nike.com/is/image/DotCom/PDP_HERO_M/KOBE-X-ELITE-747212_303_A_PREM.jpg
  • Request
  • Headers
    Content-Type: application/x-www-form-urlencoded
    X-Auth-User: {auth-username}
    X-Auth-Token: {auth-token}
    Body
    identifier=guid&guid=NikeKXE&price=99&title=Nike+Kobe+X+Elite&media1=http%3A%2F%2Fimages.nike.com%2Fis%2Fimage%2FDotCom%2FPDP_HERO_M%2FKOBE-X-ELITE-747212_303_A_PREM.jpg
    
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
    "1": {
    "result": "success",
    "errors": "",
    "codes": "",
    "htmlcodes": "",
    "messages": "",
    "notices": "",
    "action": "add",
    "identifier": "NikeKXE"
    },
    "result": "success",
    "message": "",
    "type": "items",
    "id": "guid",
    "time": "2015-09-01 14:34:07",
    "actions": 1,
    "email": null,
    "url": null
    }
curl --request POST \
--url https://api.suredone.com/v1/editor/items/add \
--header 'content-type: application/x-www-form-urlencoded' \
--header 'x-auth-token: {auth-token}' \
--header 'x-auth-user: {auth-username}' \
--data 'identifier=guid&guid=NikeKXE&price=99&title=Nike%20Kobe%20X%20Elite&media1=http%3A%2F%2Fimages.nike.com%2Fis%2Fimage%2FDotCom%2FPDP_HERO_M%2FKOBE-X-ELITE-747212_303_A_PREM.jpg'
<?php
$curl = curl_init();
$postFields = array(
'identifier' => 'guid',
'guid' => 'NikeKXE',
'price' => '99',
'title' => 'Nike Kobe X Elite',
'media1' => 'http://images.nike.com/is/image/DotCom/PDP_HERO_M/KOBE-X-ELITE-747212_303_A_PREM.jpg'
);
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.suredone.com/v1/editor/items/add",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_SSL_VERIFYHOST => false,
CURLOPT_POSTFIELDS => $postFields,
CURLOPT_HTTPHEADER => array(
"content-type: application/x-www-form-urlencoded",
"x-auth-token: {auth-token}",
"x-auth-user: {auth-username}"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
header('Content-Type: application/json');
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
// This example uses package from http://restsharp.org/
var client = new RestClient("https://api.suredone.com/v1/editor/items/add");
var request = new RestRequest(Method.POST);
request.AddHeader("x-auth-token", "{auth-token}");
request.AddHeader("x-auth-user", "{auth-username}");
request.AddHeader("content-type", "application/x-www-form-urlencoded");
Hashtable postData = new Hashtable();
postData["identifier"] = "guid";
postData["guid"] = "NikeKXE";
postData["price"] = "99";
postData["title"] = "Nike Kobe X Elite";
postData["media1"] = "http://images.nike.com/is/image/DotCom/PDP_HERO_M/KOBE-X-ELITE-747212_303_A_PREM.jpg";
// Convert post array into multipart/form-data payload
String formBoundary = "undefined";
String payload = "";
foreach (DictionaryEntry entry in postData){
payload += "--" + formBoundary + "\r\n" + "Content-Disposition: form-data; name=" + entry.Key.ToString() + "\r\n\r\n" + entry.Value.ToString() + "\r\n";
}
payload += "--" + formBoundary + "--";
request.AddParameter("application/x-www-form-urlencoded", payload, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.Write(response.Content);
Console.ReadLine();
import http.client
conn = http.client.HTTPSConnection("api.suredone.com")
payload = ''
postData = {}
postData['identifier'] = "guid"
postData['guid'] = "NikeKXE"
postData['price'] = "99"
postData['title'] = "Nike Kobe X Elite"
postData['media1'] = "http://images.nike.com/is/image/DotCom/PDP_HERO_M/KOBE-X-ELITE-747212_303_A_PREM.jpg"
#Convert post array into multipart/form-data payload
formBoundary = 'undefined'
for k,v in postData.items():
v = v.replace('\n','')
payload += '--'+ formBoundary +"\r\n"+'Content-Disposition: form-data; name='+k+"\r\n\r\n"+v+"\r\n"
payload += '--'+ formBoundary + '--'
headers = {
'content-type': "application/x-www-form-urlencoded",
'x-auth-user': "{auth-username}",
'x-auth-token': "{auth-token}"
}
conn.request("POST", "/v1/editor/items/add", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
// This example uses following package
// https://github.com/Mashape/unirest-java
HashMap<String, String> postData = new HashMap<String, String>();
postData.put("identifier","guid");
postData.put("guid","NikeKXE");
postData.put("price","99");
postData.put("title","Nike Kobe X Elite");
postData.put("media1","http://images.nike.com/is/image/DotCom/PDP_HERO_M/KOBE-X-ELITE-747212_303_A_PREM.jpg");
String postBody = "";
String formBoundary = "undefined";
for (Entry<String, String> entry : postData.entrySet()) {
String key = entry.getKey();
Object value = entry.getValue();
postBody += "--"+ formBoundary +"\r\n"+"Content-Disposition: form-data; name="+key+"\r\n\r\n"+value.toString()+"\r\n";
}
try {
HttpResponse<String> response = Unirest.post("https://api.suredone.com/v1/editor/items/add")
.header("content-type", "application/x-www-form-urlencoded")
.header("x-auth-user", "{auth-username}")
.header("x-auth-token", "{auth-token}")
.body( postBody )
.asString();
System.out.print(response.getBody());
} catch(UnirestException e){
e.printStackTrace();
}
var unirest = require("unirest");
var req = unirest("POST", "https://api.suredone.com/v1/editor/items/add");
req.headers({
"x-auth-token": "{auth-token}",
"x-auth-user": "{auth-username}",
"content-type": "application/x-www-form-urlencoded"
});
req.form({
"identifier": "guid",
"guid": "NikeKXE",
"price": "99",
"title": "Nike Kobe X Elite",
"media1": "http://images.nike.com/is/image/DotCom/PDP_HERO_M/KOBE-X-ELITE-747212_303_A_PREM.jpg"
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
require 'uri'
require 'net/http'
url = URI("https://api.suredone.com/v1/editor/items/add")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/x-www-form-urlencoded'
request["x-auth-user"] = '{auth-username}'
request["x-auth-token"] = '{auth-token}'
request.body = "identifier=guid&guid=NikeKXE&price=99&title=Nike%20Kobe%20X%20Elite&media1=http%3A%2F%2Fimages.nike.com%2Fis%2Fimage%2FDotCom%2FPDP_HERO_M%2FKOBE-X-ELITE-747212_303_A_PREM.jpg"
response = http.request(request)
puts response.read_body
Start Item
/editor/items/start/

Create a new item as a draft. Similar to the add method but this will not sync to any channels.

  • Parameters
  • identifier
    string (required) Example: guid
    guid
    string (required) Example: NikeKXE
    price
    numeric (required) Example: 99
    title
    string (required) Example: Nike Kobe X Elite
    media1
    string (optional) Example: http://images.nike.com/is/image/DotCom/PDP_HERO_M/KOBE-X-ELITE-747212_303_A_PREM.jpg
  • Request
  • Headers
    Content-Type: application/x-www-form-urlencoded
    X-Auth-User: {auth-username}
    X-Auth-Token: {auth-token}
    Body
    identifier=guid&guid=NikeKXE&price=99&title=Nike+Kobe+X+Elite&media1=http%3A%2F%2Fimages.nike.com%2Fis%2Fimage%2FDotCom%2FPDP_HERO_M%2FKOBE-X-ELITE-747212_303_A_PREM.jpg
    
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
    "1": {
    "result": "success",
    "errors": "",
    "codes": "",
    "htmlcodes": "",
    "messages": "",
    "notices": "",
    "action": "start",
    "identifier": "NikeKXE"
    },
    "result": "success",
    "message": "",
    "type": "items",
    "id": "guid",
    "time": "2015-09-01 14:34:07",
    "actions": 1,
    "email": null,
    "url": null
    }
curl --request POST \
--url https://api.suredone.com/v1/editor/items/start/ \
--header 'content-type: application/x-www-form-urlencoded' \
--header 'x-auth-token: {auth-token}' \
--header 'x-auth-user: {auth-username}' \
--data 'identifier=guid&guid=NikeKXE&price=99&title=Nike%20Kobe%20X%20Elite&media1=http%3A%2F%2Fimages.nike.com%2Fis%2Fimage%2FDotCom%2FPDP_HERO_M%2FKOBE-X-ELITE-747212_303_A_PREM.jpg'
<?php
$curl = curl_init();
$postFields = array(
'identifier' => 'guid',
'guid' => 'NikeKXE',
'price' => '99',
'title' => 'Nike Kobe X Elite',
'media1' => 'http://images.nike.com/is/image/DotCom/PDP_HERO_M/KOBE-X-ELITE-747212_303_A_PREM.jpg'
);
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.suredone.com/v1/editor/items/start/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_SSL_VERIFYHOST => false,
CURLOPT_POSTFIELDS => $postFields,
CURLOPT_HTTPHEADER => array(
"content-type: application/x-www-form-urlencoded",
"x-auth-token: {auth-token}",
"x-auth-user: {auth-username}"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
header('Content-Type: application/json');
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
// This example uses package from http://restsharp.org/
var client = new RestClient("https://api.suredone.com/v1/editor/items/start/");
var request = new RestRequest(Method.POST);
request.AddHeader("x-auth-token", "{auth-token}");
request.AddHeader("x-auth-user", "{auth-username}");
request.AddHeader("content-type", "application/x-www-form-urlencoded");
Hashtable postData = new Hashtable();
postData["identifier"] = "guid";
postData["guid"] = "NikeKXE";
postData["price"] = "99";
postData["title"] = "Nike Kobe X Elite";
postData["media1"] = "http://images.nike.com/is/image/DotCom/PDP_HERO_M/KOBE-X-ELITE-747212_303_A_PREM.jpg";
// Convert post array into multipart/form-data payload
String formBoundary = "undefined";
String payload = "";
foreach (DictionaryEntry entry in postData){
payload += "--" + formBoundary + "\r\n" + "Content-Disposition: form-data; name=" + entry.Key.ToString() + "\r\n\r\n" + entry.Value.ToString() + "\r\n";
}
payload += "--" + formBoundary + "--";
request.AddParameter("application/x-www-form-urlencoded", payload, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.Write(response.Content);
Console.ReadLine();
import http.client
conn = http.client.HTTPSConnection("api.suredone.com")
payload = ''
postData = {}
postData['identifier'] = "guid"
postData['guid'] = "NikeKXE"
postData['price'] = "99"
postData['title'] = "Nike Kobe X Elite"
postData['media1'] = "http://images.nike.com/is/image/DotCom/PDP_HERO_M/KOBE-X-ELITE-747212_303_A_PREM.jpg"
#Convert post array into multipart/form-data payload
formBoundary = 'undefined'
for k,v in postData.items():
v = v.replace('\n','')
payload += '--'+ formBoundary +"\r\n"+'Content-Disposition: form-data; name='+k+"\r\n\r\n"+v+"\r\n"
payload += '--'+ formBoundary + '--'
headers = {
'content-type': "application/x-www-form-urlencoded",
'x-auth-user': "{auth-username}",
'x-auth-token': "{auth-token}"
}
conn.request("POST", "/v1/editor/items/start/", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
// This example uses following package
// https://github.com/Mashape/unirest-java
HashMap<String, String> postData = new HashMap<String, String>();
postData.put("identifier","guid");
postData.put("guid","NikeKXE");
postData.put("price","99");
postData.put("title","Nike Kobe X Elite");
postData.put("media1","http://images.nike.com/is/image/DotCom/PDP_HERO_M/KOBE-X-ELITE-747212_303_A_PREM.jpg");
String postBody = "";
String formBoundary = "undefined";
for (Entry<String, String> entry : postData.entrySet()) {
String key = entry.getKey();
Object value = entry.getValue();
postBody += "--"+ formBoundary +"\r\n"+"Content-Disposition: form-data; name="+key+"\r\n\r\n"+value.toString()+"\r\n";
}
try {
HttpResponse<String> response = Unirest.post("https://api.suredone.com/v1/editor/items/start/")
.header("content-type", "application/x-www-form-urlencoded")
.header("x-auth-user", "{auth-username}")
.header("x-auth-token", "{auth-token}")
.body( postBody )
.asString();
System.out.print(response.getBody());
} catch(UnirestException e){
e.printStackTrace();
}
var unirest = require("unirest");
var req = unirest("POST", "https://api.suredone.com/v1/editor/items/start/");
req.headers({
"x-auth-token": "{auth-token}",
"x-auth-user": "{auth-username}",
"content-type": "application/x-www-form-urlencoded"
});
req.form({
"identifier": "guid",
"guid": "NikeKXE",
"price": "99",
"title": "Nike Kobe X Elite",
"media1": "http://images.nike.com/is/image/DotCom/PDP_HERO_M/KOBE-X-ELITE-747212_303_A_PREM.jpg"
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
require 'uri'
require 'net/http'
url = URI("https://api.suredone.com/v1/editor/items/start/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/x-www-form-urlencoded'
request["x-auth-user"] = '{auth-username}'
request["x-auth-token"] = '{auth-token}'
request.body = "identifier=guid&guid=NikeKXE&price=99&title=Nike%20Kobe%20X%20Elite&media1=http%3A%2F%2Fimages.nike.com%2Fis%2Fimage%2FDotCom%2FPDP_HERO_M%2FKOBE-X-ELITE-747212_303_A_PREM.jpg"
response = http.request(request)
puts response.read_body
Edit Item
/editor/items/edit

Edit an existing item. You can get a full list of supported fields for your account by retrieving an item via the api and inspecting the returned object.

  • Parameters
  • identifier
    string (required) Example: guid
    guid
    string (required) Example: NikeKXE
    price
    numeric (optional) Example: 89.99
    brand
    string (optional) Example: Nike
  • Request
  • Headers
    Content-Type: application/x-www-form-urlencoded
    X-Auth-User: {auth-username}
    X-Auth-Token: {auth-token}
    Body
    identifier=guid&guid=NikeKXE&price=89.99&brand=Nike
    
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
    "1": {
    "result": "success",
    "errors": "",
    "codes": "",
    "htmlcodes": "",
    "messages": "",
    "notices": "",
    "action": "edit",
    "identifier": "NikeKXE"
    },
    "result": "success",
    "message": "",
    "type": "items",
    "id": "guid",
    "time": "2015-09-01 16:15:36",
    "actions": 1,
    "email": null,
    "url": null
    }
curl --request POST \
--url https://api.suredone.com/v1/editor/items/edit \
--header 'content-type: application/x-www-form-urlencoded' \
--header 'x-auth-token: {auth-token}' \
--header 'x-auth-user: {auth-username}' \
--data 'identifier=guid&guid=NikeKXE&price=89.99&brand=Nike'
<?php
$curl = curl_init();
$postFields = array(
'identifier' => 'guid',
'guid' => 'NikeKXE',
'price' => '89.99',
'brand' => 'Nike'
);
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.suredone.com/v1/editor/items/edit",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_SSL_VERIFYHOST => false,
CURLOPT_POSTFIELDS => $postFields,
CURLOPT_HTTPHEADER => array(
"content-type: application/x-www-form-urlencoded",
"x-auth-token: {auth-token}",
"x-auth-user: {auth-username}"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
header('Content-Type: application/json');
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
// This example uses package from http://restsharp.org/
var client = new RestClient("https://api.suredone.com/v1/editor/items/edit");
var request = new RestRequest(Method.POST);
request.AddHeader("x-auth-token", "{auth-token}");
request.AddHeader("x-auth-user", "{auth-username}");
request.AddHeader("content-type", "application/x-www-form-urlencoded");
Hashtable postData = new Hashtable();
postData["identifier"] = "guid";
postData["guid"] = "NikeKXE";
postData["price"] = "89.99";
postData["brand"] = "Nike";
// Convert post array into multipart/form-data payload
String formBoundary = "undefined";
String payload = "";
foreach (DictionaryEntry entry in postData){
payload += "--" + formBoundary + "\r\n" + "Content-Disposition: form-data; name=" + entry.Key.ToString() + "\r\n\r\n" + entry.Value.ToString() + "\r\n";
}
payload += "--" + formBoundary + "--";
request.AddParameter("application/x-www-form-urlencoded", payload, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.Write(response.Content);
Console.ReadLine();
import http.client
conn = http.client.HTTPSConnection("api.suredone.com")
payload = ''
postData = {}
postData['identifier'] = "guid"
postData['guid'] = "NikeKXE"
postData['price'] = "89.99"
postData['brand'] = "Nike"
#Convert post array into multipart/form-data payload
formBoundary = 'undefined'
for k,v in postData.items():
v = v.replace('\n','')
payload += '--'+ formBoundary +"\r\n"+'Content-Disposition: form-data; name='+k+"\r\n\r\n"+v+"\r\n"
payload += '--'+ formBoundary + '--'
headers = {
'content-type': "application/x-www-form-urlencoded",
'x-auth-user': "{auth-username}",
'x-auth-token': "{auth-token}"
}
conn.request("POST", "/v1/editor/items/edit", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
// This example uses following package
// https://github.com/Mashape/unirest-java
HashMap<String, String> postData = new HashMap<String, String>();
postData.put("identifier","guid");
postData.put("guid","NikeKXE");
postData.put("price","89.99");
postData.put("brand","Nike");
String postBody = "";
String formBoundary = "undefined";
for (Entry<String, String> entry : postData.entrySet()) {
String key = entry.getKey();
Object value = entry.getValue();
postBody += "--"+ formBoundary +"\r\n"+"Content-Disposition: form-data; name="+key+"\r\n\r\n"+value.toString()+"\r\n";
}
try {
HttpResponse<String> response = Unirest.post("https://api.suredone.com/v1/editor/items/edit")
.header("content-type", "application/x-www-form-urlencoded")
.header("x-auth-user", "{auth-username}")
.header("x-auth-token", "{auth-token}")
.body( postBody )
.asString();
System.out.print(response.getBody());
} catch(UnirestException e){
e.printStackTrace();
}
var unirest = require("unirest");
var req = unirest("POST", "https://api.suredone.com/v1/editor/items/edit");
req.headers({
"x-auth-token": "{auth-token}",
"x-auth-user": "{auth-username}",
"content-type": "application/x-www-form-urlencoded"
});
req.form({
"identifier": "guid",
"guid": "NikeKXE",
"price": "89.99",
"brand": "Nike"
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
require 'uri'
require 'net/http'
url = URI("https://api.suredone.com/v1/editor/items/edit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/x-www-form-urlencoded'
request["x-auth-user"] = '{auth-username}'
request["x-auth-token"] = '{auth-token}'
request.body = "identifier=guid&guid=NikeKXE&price=89.99&brand=Nike"
response = http.request(request)
puts response.read_body
End Item
/editor/items/end

Disable an item. This will disable the listing on all active channels. The identifier can either be a guid or id. The specified identifier must also be one of the parameters provided. In the example below, guid is used as the identifier and a value of NikeKXE is passed in as the value for guid.

  • Parameters
  • identifier
    string (required) Example: guid

    Choices: id guid

    guid
    string (required) Example: NikeKXE
  • Request
  • Headers
    Content-Type: application/x-www-form-urlencoded
    X-Auth-User: {auth-username}
    X-Auth-Token: {auth-token}
    Body
    identifier=guid&guid=NikeKXE
    
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
    "1": {
    "result": "success",
    "errors": "",
    "codes": "",
    "htmlcodes": "",
    "messages": "",
    "notices": "",
    "action": "end",
    "identifier": "NikeKXE"
    },
    "result": "success",
    "message": "",
    "type": "items",
    "id": "guid",
    "time": "2015-09-01 17:19:32",
    "actions": 1,
    "email": null,
    "url": null
    }
curl --request POST \
--url https://api.suredone.com/v1/editor/items/end \
--header 'content-type: application/x-www-form-urlencoded' \
--header 'x-auth-token: {auth-token}' \
--header 'x-auth-user: {auth-username}' \
--data 'identifier=guid&guid=NikeKXE'
<?php
$curl = curl_init();
$postFields = array(
'identifier' => 'guid',
'guid' => 'NikeKXE'
);
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.suredone.com/v1/editor/items/end",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_SSL_VERIFYHOST => false,
CURLOPT_POSTFIELDS => $postFields,
CURLOPT_HTTPHEADER => array(
"content-type: application/x-www-form-urlencoded",
"x-auth-token: {auth-token}",
"x-auth-user: {auth-username}"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
header('Content-Type: application/json');
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
// This example uses package from http://restsharp.org/
var client = new RestClient("https://api.suredone.com/v1/editor/items/end");
var request = new RestRequest(Method.POST);
request.AddHeader("x-auth-token", "{auth-token}");
request.AddHeader("x-auth-user", "{auth-username}");
request.AddHeader("content-type", "application/x-www-form-urlencoded");
Hashtable postData = new Hashtable();
postData["identifier"] = "guid";
postData["guid"] = "NikeKXE";
// Convert post array into multipart/form-data payload
String formBoundary = "undefined";
String payload = "";
foreach (DictionaryEntry entry in postData){
payload += "--" + formBoundary + "\r\n" + "Content-Disposition: form-data; name=" + entry.Key.ToString() + "\r\n\r\n" + entry.Value.ToString() + "\r\n";
}
payload += "--" + formBoundary + "--";
request.AddParameter("application/x-www-form-urlencoded", payload, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.Write(response.Content);
Console.ReadLine();
import http.client
conn = http.client.HTTPSConnection("api.suredone.com")
payload = ''
postData = {}
postData['identifier'] = "guid"
postData['guid'] = "NikeKXE"
#Convert post array into multipart/form-data payload
formBoundary = 'undefined'
for k,v in postData.items():
v = v.replace('\n','')
payload += '--'+ formBoundary +"\r\n"+'Content-Disposition: form-data; name='+k+"\r\n\r\n"+v+"\r\n"
payload += '--'+ formBoundary + '--'
headers = {
'content-type': "application/x-www-form-urlencoded",
'x-auth-user': "{auth-username}",
'x-auth-token': "{auth-token}"
}
conn.request("POST", "/v1/editor/items/end", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
// This example uses following package
// https://github.com/Mashape/unirest-java
HashMap<String, String> postData = new HashMap<String, String>();
postData.put("identifier","guid");
postData.put("guid","NikeKXE");
String postBody = "";
String formBoundary = "undefined";
for (Entry<String, String> entry : postData.entrySet()) {
String key = entry.getKey();
Object value = entry.getValue();
postBody += "--"+ formBoundary +"\r\n"+"Content-Disposition: form-data; name="+key+"\r\n\r\n"+value.toString()+"\r\n";
}
try {
HttpResponse<String> response = Unirest.post("https://api.suredone.com/v1/editor/items/end")
.header("content-type", "application/x-www-form-urlencoded")
.header("x-auth-user", "{auth-username}")
.header("x-auth-token", "{auth-token}")
.body( postBody )
.asString();
System.out.print(response.getBody());
} catch(UnirestException e){
e.printStackTrace();
}
var unirest = require("unirest");
var req = unirest("POST", "https://api.suredone.com/v1/editor/items/end");
req.headers({
"x-auth-token": "{auth-token}",
"x-auth-user": "{auth-username}",
"content-type": "application/x-www-form-urlencoded"
});
req.form({
"identifier": "guid",
"guid": "NikeKXE"
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
require 'uri'
require 'net/http'
url = URI("https://api.suredone.com/v1/editor/items/end")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/x-www-form-urlencoded'
request["x-auth-user"] = '{auth-username}'
request["x-auth-token"] = '{auth-token}'
request.body = "identifier=guid&guid=NikeKXE"
response = http.request(request)
puts response.read_body
Relist Item
/editor/items/relist

Refreshes an item. If an item is disabled, it will re-enable the listing on all channels. If the item is already enabled, it will perform a full refresh of the data across all active channels. The identifier can either be a guid or id. The specified identifier must also be one of the parameters provided. In the example below, guid is used as the identifier and a value of NikeKXE is passed in as the value for guid.

  • Parameters
  • identifier
    string (required) Example: guid

    Choices: id guid

    guid
    string (required) Example: NikeKXE
  • Request
  • Headers
    Content-Type: application/x-www-form-urlencoded
    X-Auth-User: {auth-username}
    X-Auth-Token: {auth-token}
    Body
    identifier=guid&guid=NikeKXE
    
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
    "1": {
    "result": "success",
    "errors": "",
    "codes": "",
    "htmlcodes": "",
    "messages": "",
    "notices": "",
    "action": "relist",
    "identifier": "NikeKXE"
    },
    "result": "success",
    "message": "",
    "type": "items",
    "id": "guid",
    "time": "2015-09-01 17:28:12",
    "actions": 1,
    "email": null,
    "url": null
    }
curl --request POST \
--url https://api.suredone.com/v1/editor/items/relist \
--header 'content-type: application/x-www-form-urlencoded' \
--header 'x-auth-token: {auth-token}' \
--header 'x-auth-user: {auth-username}' \
--data 'identifier=guid&guid=NikeKXE'
<?php
$curl = curl_init();
$postFields = array(
'identifier' => 'guid',
'guid' => 'NikeKXE'
);
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.suredone.com/v1/editor/items/relist",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_SSL_VERIFYHOST => false,
CURLOPT_POSTFIELDS => $postFields,
CURLOPT_HTTPHEADER => array(
"content-type: application/x-www-form-urlencoded",
"x-auth-token: {auth-token}",
"x-auth-user: {auth-username}"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
header('Content-Type: application/json');
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
// This example uses package from http://restsharp.org/
var client = new RestClient("https://api.suredone.com/v1/editor/items/relist");
var request = new RestRequest(Method.POST);
request.AddHeader("x-auth-token", "{auth-token}");
request.AddHeader("x-auth-user", "{auth-username}");
request.AddHeader("content-type", "application/x-www-form-urlencoded");
Hashtable postData = new Hashtable();
postData["identifier"] = "guid";
postData["guid"] = "NikeKXE";
// Convert post array into multipart/form-data payload
String formBoundary = "undefined";
String payload = "";
foreach (DictionaryEntry entry in postData){
payload += "--" + formBoundary + "\r\n" + "Content-Disposition: form-data; name=" + entry.Key.ToString() + "\r\n\r\n" + entry.Value.ToString() + "\r\n";
}
payload += "--" + formBoundary + "--";
request.AddParameter("application/x-www-form-urlencoded", payload, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.Write(response.Content);
Console.ReadLine();
import http.client
conn = http.client.HTTPSConnection("api.suredone.com")
payload = ''
postData = {}
postData['identifier'] = "guid"
postData['guid'] = "NikeKXE"
#Convert post array into multipart/form-data payload
formBoundary = 'undefined'
for k,v in postData.items():
v = v.replace('\n','')
payload += '--'+ formBoundary +"\r\n"+'Content-Disposition: form-data; name='+k+"\r\n\r\n"+v+"\r\n"
payload += '--'+ formBoundary + '--'
headers = {
'content-type': "application/x-www-form-urlencoded",
'x-auth-user': "{auth-username}",
'x-auth-token': "{auth-token}"
}
conn.request("POST", "/v1/editor/items/relist", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
// This example uses following package
// https://github.com/Mashape/unirest-java
HashMap<String, String> postData = new HashMap<String, String>();
postData.put("identifier","guid");
postData.put("guid","NikeKXE");
String postBody = "";
String formBoundary = "undefined";
for (Entry<String, String> entry : postData.entrySet()) {
String key = entry.getKey();
Object value = entry.getValue();
postBody += "--"+ formBoundary +"\r\n"+"Content-Disposition: form-data; name="+key+"\r\n\r\n"+value.toString()+"\r\n";
}
try {
HttpResponse<String> response = Unirest.post("https://api.suredone.com/v1/editor/items/relist")
.header("content-type", "application/x-www-form-urlencoded")
.header("x-auth-user", "{auth-username}")
.header("x-auth-token", "{auth-token}")
.body( postBody )
.asString();
System.out.print(response.getBody());
} catch(UnirestException e){
e.printStackTrace();
}
var unirest = require("unirest");
var req = unirest("POST", "https://api.suredone.com/v1/editor/items/relist");
req.headers({
"x-auth-token": "{auth-token}",
"x-auth-user": "{auth-username}",
"content-type": "application/x-www-form-urlencoded"
});
req.form({
"identifier": "guid",
"guid": "NikeKXE"
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
require 'uri'
require 'net/http'
url = URI("https://api.suredone.com/v1/editor/items/relist")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/x-www-form-urlencoded'
request["x-auth-user"] = '{auth-username}'
request["x-auth-token"] = '{auth-token}'
request.body = "identifier=guid&guid=NikeKXE"
response = http.request(request)
puts response.read_body
Delete Item
/editor/items/delete

WARNING: This will completely delete the item, there is no way to retrieve a deleted item. A safer option would be to use the end action.

Delete an item from SureDone and all active channels. The identifier can either be a guid or id. The specified identifier must also be one of the parameters provided. In the example below, guid is used as the identifier and a value of NikeKXE is passed in as the value for guid.

  • Parameters
  • identifier
    string (required) Example: guid

    Choices: id guid

    guid
    string (required) Example: NikeKXE
  • Request
  • Headers
    Content-Type: application/x-www-form-urlencoded
    X-Auth-User: {auth-username}
    X-Auth-Token: {auth-token}
    Body
    identifier=guid&guid=NikeKXE
    
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
    "1": {
    "result": "success",
    "errors": "",
    "codes": "",
    "htmlcodes": "",
    "messages": "",
    "notices": "",
    "action": "delete",
    "identifier": "NikeKXE"
    },
    "result": "success",
    "message": "",
    "type": "items",
    "id": "guid",
    "time": "2015-09-01 17:31:27",
    "actions": 1,
    "email": null,
    "url": null
    }
curl --request POST \
--url https://api.suredone.com/v1/editor/items/delete \
--header 'content-type: application/x-www-form-urlencoded' \
--header 'x-auth-token: {auth-token}' \
--header 'x-auth-user: {auth-username}' \
--data 'identifier=guid&guid=NikeKXE'
<?php
$curl = curl_init();
$postFields = array(
'identifier' => 'guid',
'guid' => 'NikeKXE'
);
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.suredone.com/v1/editor/items/delete",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_SSL_VERIFYHOST => false,
CURLOPT_POSTFIELDS => $postFields,
CURLOPT_HTTPHEADER => array(
"content-type: application/x-www-form-urlencoded",
"x-auth-token: {auth-token}",
"x-auth-user: {auth-username}"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
header('Content-Type: application/json');
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
// This example uses package from http://restsharp.org/
var client = new RestClient("https://api.suredone.com/v1/editor/items/delete");
var request = new RestRequest(Method.POST);
request.AddHeader("x-auth-token", "{auth-token}");
request.AddHeader("x-auth-user", "{auth-username}");
request.AddHeader("content-type", "application/x-www-form-urlencoded");
Hashtable postData = new Hashtable();
postData["identifier"] = "guid";
postData["guid"] = "NikeKXE";
// Convert post array into multipart/form-data payload
String formBoundary = "undefined";
String payload = "";
foreach (DictionaryEntry entry in postData){
payload += "--" + formBoundary + "\r\n" + "Content-Disposition: form-data; name=" + entry.Key.ToString() + "\r\n\r\n" + entry.Value.ToString() + "\r\n";
}
payload += "--" + formBoundary + "--";
request.AddParameter("application/x-www-form-urlencoded", payload, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.Write(response.Content);
Console.ReadLine();
import http.client
conn = http.client.HTTPSConnection("api.suredone.com")
payload = ''
postData = {}
postData['identifier'] = "guid"
postData['guid'] = "NikeKXE"
#Convert post array into multipart/form-data payload
formBoundary = 'undefined'
for k,v in postData.items():
v = v.replace('\n','')
payload += '--'+ formBoundary +"\r\n"+'Content-Disposition: form-data; name='+k+"\r\n\r\n"+v+"\r\n"
payload += '--'+ formBoundary + '--'
headers = {
'content-type': "application/x-www-form-urlencoded",
'x-auth-user': "{auth-username}",
'x-auth-token': "{auth-token}"
}
conn.request("POST", "/v1/editor/items/delete", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
// This example uses following package
// https://github.com/Mashape/unirest-java
HashMap<String, String> postData = new HashMap<String, String>();
postData.put("identifier","guid");
postData.put("guid","NikeKXE");
String postBody = "";
String formBoundary = "undefined";
for (Entry<String, String> entry : postData.entrySet()) {
String key = entry.getKey();
Object value = entry.getValue();
postBody += "--"+ formBoundary +"\r\n"+"Content-Disposition: form-data; name="+key+"\r\n\r\n"+value.toString()+"\r\n";
}
try {
HttpResponse<String> response = Unirest.post("https://api.suredone.com/v1/editor/items/delete")
.header("content-type", "application/x-www-form-urlencoded")
.header("x-auth-user", "{auth-username}")
.header("x-auth-token", "{auth-token}")
.body( postBody )
.asString();
System.out.print(response.getBody());
} catch(UnirestException e){
e.printStackTrace();
}
var unirest = require("unirest");
var req = unirest("POST", "https://api.suredone.com/v1/editor/items/delete");
req.headers({
"x-auth-token": "{auth-token}",
"x-auth-user": "{auth-username}",
"content-type": "application/x-www-form-urlencoded"
});
req.form({
"identifier": "guid",
"guid": "NikeKXE"
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
require 'uri'
require 'net/http'
url = URI("https://api.suredone.com/v1/editor/items/delete")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/x-www-form-urlencoded'
request["x-auth-user"] = '{auth-username}'
request["x-auth-token"] = '{auth-token}'
request.body = "identifier=guid&guid=NikeKXE"
response = http.request(request)
puts response.read_body
Search by Keyword
/search/items/{keyword}
  • Parameters
  • keyword
    string (required) Example: 1MOAR
  • Request
  • Headers
    X-Auth-User: {auth-username}
    X-Auth-Token: {auth-token}
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
    "1": {
    "id": "2388",
    "url": "http://play.suredone.com/1-moar-1moar",
    "uri": "1-moar-1moar",
    "galleryuri": "1-moar-1moar",
    "parenturi": "",
    "sku": "1MOAR",
    "guid": "1MOAR-1",
    "stock": "13",
    "price": "11.00",
    "reprice": "0.00",
    "discountprice": "0.00",
    "msrp": "0.00",
    "cost": "0.00",
    "featured": "0",
    "name": "",
    "title": "1 Moar",
    "keywords": "",
    "description": "",
    "notes": "",
    "htmltitle": "",
    "metadescription": "",
    "size": "",
    "color": "Blue",
    "condition": "New",
    "brand": "",
    "style": "",
    "upc": "",
    "tags": "",
    "category1": "",
    "category2": "",
    "category3": "",
    "category4": "",
    "category5": "",
    "media": "",
    "media1": "",
    "media2": "",
    "media3": "",
    "media4": "",
    "media5": "",
    "media6": "",
    "media7": "",
    "media8": "",
    "media9": "",
    "media10": "",
    "mediacount": "0",
    "shipping": "0.00",
    "shippingadditional": "0.00",
    "handlingfee": "0.00",
    "weight": "0.00",
    "dimweight": "0.00",
    "boxlength": "0.00",
    "boxwidth": "0.00",
    "boxheight": "0.00",
    "boxweight": "0.00",
    "date": "2015-08-21 16:16:27",
    "dateupdated": "2015-08-21 16:19:44",
    "datesold": "0000-00-00 00:00:00",
    "totalsold": "0",
    "asset": "",
    "domain": "",
    "rule": "update",
    "state": "stock",
    "status": "attribute",
    "active": "0",
    "type": "",
    "updatenotes": "",
    "googleshopping": "1",
    "googleshopurl": "",
    "googlecategory": "",
    "ebayid": "0",
    "ebaysku": "",
    "ebaycatid": "0",
    "ebaystoreid": "0",
    "ebaystoreid2": "0",
    "ebayprice": "0.00",
    "ebaytitle": "",
    "ebayoptions": "{\"shippingprofileid\":\"0\",\"paymentprofileid\":\"0\",\"returnprofileid\":\"0\",\"siteid\":\"\",\"location\":\"\",\"subtitle\":\"\",\"secondcategory\":\"NaN\",\"paymentinstructions\":\"\",\"salestaxpercent\":0,\"taxcategory\":\"\",\"shipping\":{\"calculated\":{\"postalcode\":\"\",\"handlingfee\":0,\"shippingirregular\":false,\"shippingpackage\":\"\",\"internationalhandlingfee\":0},\"domestic\":{\"1\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"surcharge\":0,\"timemin\":0,\"timemax\":0},\"2\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"surcharge\":0,\"timemin\":0,\"timemax\":0},\"3\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"surcharge\":0,\"timemin\":0,\"timemax\":0},\"4\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"surcharge\":0,\"timemin\":0,\"timemax\":0}},\"international\":{\"1\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"location\":\"\"},\"2\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"location\":\"\"},\"3\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"location\":\"\"},\"4\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"location\":\"\"},\"5\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"location\":\"\"}},\"ratetable\":{\"dom\":\"off\",\"intl\":\"off\"},\"excludes\":[\"\"]},\"dispatch\":0,\"returns\":{\"description\":\"\"},\"template\":\"\",\"bestoffer\":{\"minimumprice\":0,\"autoacceptprice\":0},\"scheduletime\":\"\",\"siteshipping\":\"\",\"internationalon\":\"\",\"fitmentcatalog\":\"\",\"autorelist\":{\"max\":\"\",\"count\":\"\",\"duration\":\"\",\"action\":\"\",\"price\":\"\"},\"upcnot\":\"off\",\"paymentmethods\":[\"\"],\"shiptolocations\":[\"\"],\"itemspecifics\":[]}",
    "ebayshippingprofileid": "0",
    "ebaypaymentprofileid": "0",
    "ebayreturnprofileid": "0",
    "ebaysiteid": "",
    "ebaylocation": "",
    "ebaysubtitle": "",
    "ebaysecondcategory": "NaN",
    "ebaypaymentinstructions": "",
    "ebaysalestaxpercent": 0,
    "ebaytaxcategory": "",
    "ebayshippingcalculatedpostalcode": "",
    "ebayshippingcalculatedhandlingfee": 0,
    "ebayshippingcalculatedshippingirregular": "false",
    "ebayshippingcalculatedshippingpackage": "",
    "ebayshippingcalculatedinternationalhandlingfee": 0,
    "ebayshippingdomestic1service": "",
    "ebayshippingdomestic1cost": 0,
    "ebayshippingdomestic1additionalcost": 0,
    "ebayshippingdomestic1insurancecost": 0,
    "ebayshippingdomestic1surcharge": 0,
    "ebayshippingdomestic1timemin": 0,
    "ebayshippingdomestic1timemax": 0,
    "ebayshippingdomestic2service": "",
    "ebayshippingdomestic2cost": 0,
    "ebayshippingdomestic2additionalcost": 0,
    "ebayshippingdomestic2insurancecost": 0,
    "ebayshippingdomestic2surcharge": 0,
    "ebayshippingdomestic2timemin": 0,
    "ebayshippingdomestic2timemax": 0,
    "ebayshippingdomestic3service": "",
    "ebayshippingdomestic3cost": 0,
    "ebayshippingdomestic3additionalcost": 0,
    "ebayshippingdomestic3insurancecost": 0,
    "ebayshippingdomestic3surcharge": 0,
    "ebayshippingdomestic3timemin": 0,
    "ebayshippingdomestic3timemax": 0,
    "ebayshippingdomestic4service": "",
    "ebayshippingdomestic4cost": 0,
    "ebayshippingdomestic4additionalcost": 0,
    "ebayshippingdomestic4insurancecost": 0,
    "ebayshippingdomestic4surcharge": 0,
    "ebayshippingdomestic4timemin": 0,
    "ebayshippingdomestic4timemax": 0,
    "ebayshippinginternational1service": "",
    "ebayshippinginternational1cost": 0,
    "ebayshippinginternational1additionalcost": 0,
    "ebayshippinginternational1insurancecost": 0,
    "ebayshippinginternational1location": "",
    "ebayshippinginternational2service": "",
    "ebayshippinginternational2cost": 0,
    "ebayshippinginternational2additionalcost": 0,
    "ebayshippinginternational2insurancecost": 0,
    "ebayshippinginternational2location": "",
    "ebayshippinginternational3service": "",
    "ebayshippinginternational3cost": 0,
    "ebayshippinginternational3additionalcost": 0,
    "ebayshippinginternational3insurancecost": 0,
    "ebayshippinginternational3location": "",
    "ebayshippinginternational4service": "",
    "ebayshippinginternational4cost": 0,
    "ebayshippinginternational4additionalcost": 0,
    "ebayshippinginternational4insurancecost": 0,
    "ebayshippinginternational4location": "",
    "ebayshippinginternational5service": "",
    "ebayshippinginternational5cost": 0,
    "ebayshippinginternational5additionalcost": 0,
    "ebayshippinginternational5insurancecost": 0,
    "ebayshippinginternational5location": "",
    "ebayshippingratetabledom": "off",
    "ebayshippingratetableintl": "off",
    "ebayshippingexcludes0": "",
    "ebaydispatch": 0,
    "ebayreturnsdescription": "",
    "ebaytemplate": "",
    "ebaybestofferminimumprice": 0,
    "ebaybestofferautoacceptprice": 0,
    "ebayscheduletime": "",
    "ebaysiteshipping": "",
    "ebayinternationalon": "",
    "ebayfitmentcatalog": "",
    "ebayautorelistmax": "",
    "ebayautorelistcount": "",
    "ebayautorelistduration": "",
    "ebayautorelistaction": "",
    "ebayautorelistprice": "",
    "ebayupcnot": "off",
    "ebaypaymentmethods0": "",
    "ebayshiptolocations0": "",
    "ebaystarttime": null,
    "ebayendtime": null,
    "ebaypromotionstarttime": null,
    "ebaypromotionendtime": null,
    "ebayautopay": null,
    "ebayduration": null,
    "ebaylisting": null,
    "ebaypaypalemailaddress": null,
    "ebaypaymentmethods": "",
    "ebayshiptolocations": "",
    "ebayshippingincludedintax": null,
    "ebayshippingtype": null,
    "ebayshippingglobal": null,
    "ebayshippingdomestic1cutofftime": null,
    "ebayshippingdomestic1expedited": null,
    "ebayshippingdomestic1freeshipping": null,
    "ebayshippingdomestic1localpickup": null,
    "ebayshippingdomestic1handling": null,
    "ebayshippingdomestic2cutofftime": null,
    "ebayshippingdomestic2expedited": null,
    "ebayshippingdomestic2freeshipping": null,
    "ebayshippingdomestic2localpickup": null,
    "ebayshippingdomestic2handling": null,
    "ebayshippingdomestic3cutofftime": null,
    "ebayshippingdomestic3expedited": null,
    "ebayshippingdomestic3freeshipping": null,
    "ebayshippingdomestic3localpickup": null,
    "ebayshippingdomestic3handling": null,
    "ebayshippingdomestic4cutofftime": null,
    "ebayshippingdomestic4expedited": null,
    "ebayshippingdomestic4freeshipping": null,
    "ebayshippingdomestic4localpickup": null,
    "ebayshippingdomestic4handling": null,
    "ebayshippinginternational1cutofftime": null,
    "ebayshippinginternational1handling": null,
    "ebayshippinginternational2cutofftime": null,
    "ebayshippinginternational2handling": null,
    "ebayshippinginternational3cutofftime": null,
    "ebayshippinginternational3handling": null,
    "ebayshippinginternational4cutofftime": null,
    "ebayshippinginternational4handling": null,
    "ebayshippinginternational5cutofftime": null,
    "ebayshippinginternational5handling": null,
    "ebayshippingexcludes": "",
    "ebaygetitfast": null,
    "ebayreturnsreturnsaccepted": null,
    "ebayreturnsrefund": null,
    "ebayreturnsreturnswithin": null,
    "ebayreturnsshippingcostpaidby": null,
    "ebayreturnsrestockingfeevalue": null,
    "ebayadult": null,
    "ebayprivate": null,
    "ebayholidayreturn": null,
    "ebaybestofferenabled": null,
    "ebayitemspecifics": "",
    "ebaybuyitnow": null,
    "ebayoutofstock": null,
    "ebayauctionsrelist": null,
    "ebaycurrency": null,
    "ebayprefiliteminfo": null,
    "ebayitemspecificsbottomssizemens": null,
    "ebayitemspecificssizetype": null,
    "ebayitemspecificsinseam": null,
    "ebayitemspecificsusshoesizemens": null,
    "ebayitemspecificssizemens": null,
    "amznsku": "",
    "amznasin": "",
    "amznitemtype": "0",
    "amzncategory": "0",
    "amznprice": "0.00",
    "amzntitle": "",
    "amznsearch": "",
    "amznfba": "",
    "amznstatus": "",
    "amznoptions": "",
    "amzn3sku": "",
    "amzn3asin": "",
    "amzn3itemtype": "0",
    "amzn3category": "0",
    "amzn3price": "0.00",
    "amzn3title": "",
    "amzn3search": "",
    "amzn3fba": "",
    "amzn3status": "",
    "amzn3options": "",
    "ebayepid": "",
    "amznstockfba": "0",
    "bulletpoint1": "",
    "bulletpoint2": "",
    "bulletpoint3": "",
    "bulletpoint4": "",
    "bulletpoint5": "",
    "department": "",
    "partnumber": "",
    "mpn": "",
    "carrier": "",
    "width": "",
    "amznminage": "0",
    "amznmaxage": "0",
    "amznexemption": "",
    "memory": "",
    "minstock": "",
    "sizemens": "",
    "amznminstock": "",
    "amznmaxstock": "",
    "fitmentnotes": "",
    "sproket": "",
    "model": "",
    "flavor": "",
    "vendor1stock": "0",
    "vendorsku": "",
    "media1alttext": "",
    "media2alttext": "",
    "media3alttext": "",
    "media4alttext": "",
    "media5alttext": "",
    "media6alttext": "",
    "media7alttext": "",
    "media8alttext": "",
    "media9alttext": "",
    "media10alttext": "",
    "media11alttext": "",
    "shoesize": "",
    "internationalshipping1": "0.00",
    "internationalshippinglocation1": "Worldwide",
    "etsylistingid": "0",
    "etsy2listingid": "0",
    "skuvaultsku": "1MOAR-1",
    "skuvaultretailprice": "1.00",
    "skuvaultquantityavailable": "1",
    "skuvaultdescription": "1 Moar",
    "skuvaultclassification": "",
    "skuvaultsupplier": "",
    "skuvaultbrand": "",
    "skuvaultcost": "0.00",
    "skuvaultsaleprice": "0.00",
    "magentolistingid": "",
    "magentosku": "",
    "magento3listingid": "",
    "magento3sku": "",
    "volusionproductid": "0",
    "bigcommercelistingid": "221",
    "bigcommercesku": "1MOAR-1",
    "bigcommercecategories": "JSON::[\"1\"]",
    "bigcommerceisfreeshipping": "on",
    "bigcommercebrandid": "Coco Lee",
    "bigcommerceoptionsetid": "13",
    "bigcommerceskuid": 2452,
    "bigcommercetaxclassid": "",
    "total_stock": 13
    },
    "2": {
    "id": "2387",
    "url": "http://play.suredone.com/1-moar-1moar",
    "uri": "1-moar-1moar",
    "galleryuri": "1-moar-1moar",
    "parenturi": "",
    "sku": "1MOAR",
    "guid": "1MOAR",
    "stock": "3",
    "price": "1.00",
    "reprice": "0.00",
    "discountprice": "0.00",
    "msrp": "0.00",
    "cost": "0.00",
    "featured": "0",
    "name": "",
    "title": "1 Moar",
    "keywords": "",
    "description": "",
    "notes": "",
    "htmltitle": "",
    "metadescription": "",
    "size": "",
    "color": "Black",
    "condition": "New",
    "brand": "",
    "style": "",
    "upc": "",
    "tags": "",
    "category1": "",
    "category2": "",
    "category3": "",
    "category4": "",
    "category5": "",
    "media": "",
    "media1": "",
    "media2": "",
    "media3": "",
    "media4": "",
    "media5": "",
    "media6": "",
    "media7": "",
    "media8": "",
    "media9": "",
    "media10": "",
    "mediacount": "0",
    "shipping": "0.00",
    "shippingadditional": "0.00",
    "handlingfee": "0.00",
    "weight": "0.00",
    "dimweight": "0.00",
    "boxlength": "0.00",
    "boxwidth": "0.00",
    "boxheight": "0.00",
    "boxweight": "0.00",
    "date": "2015-08-21 16:15:39",
    "dateupdated": "2015-08-21 16:19:40",
    "datesold": "0000-00-00 00:00:00",
    "totalsold": "0",
    "asset": "",
    "domain": "",
    "rule": "update",
    "state": "stock",
    "status": "publish",
    "active": "0",
    "type": "",
    "updatenotes": "",
    "googleshopping": "1",
    "googleshopurl": "",
    "googlecategory": "",
    "ebayid": "0",
    "ebaysku": "",
    "ebaycatid": "0",
    "ebaystoreid": "0",
    "ebaystoreid2": "0",
    "ebayprice": "0.00",
    "ebaytitle": "",
    "ebayoptions": "{\"shippingprofileid\":\"0\",\"paymentprofileid\":\"0\",\"returnprofileid\":\"0\",\"siteid\":\"\",\"location\":\"\",\"subtitle\":\"\",\"secondcategory\":\"\",\"paymentinstructions\":\"\",\"salestaxpercent\":0,\"taxcategory\":\"\",\"shipping\":{\"calculated\":{\"postalcode\":\"\",\"handlingfee\":0,\"shippingirregular\":false,\"shippingpackage\":\"\",\"internationalhandlingfee\":0},\"domestic\":{\"1\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"surcharge\":0,\"timemin\":0,\"timemax\":0},\"2\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"surcharge\":0,\"timemin\":0,\"timemax\":0},\"3\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"surcharge\":0,\"timemin\":0,\"timemax\":0},\"4\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"surcharge\":0,\"timemin\":0,\"timemax\":0}},\"international\":{\"1\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"location\":\"\"},\"2\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"location\":\"\"},\"3\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"location\":\"\"},\"4\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"location\":\"\"},\"5\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"location\":\"\"}},\"ratetable\":{\"dom\":\"off\",\"intl\":\"off\"},\"excludes\":[\"\"]},\"dispatch\":0,\"returns\":{\"description\":\"\"},\"template\":\"\",\"bestoffer\":{\"minimumprice\":0,\"autoacceptprice\":0},\"scheduletime\":\"\",\"siteshipping\":\"\",\"internationalon\":\"\",\"fitmentcatalog\":\"\",\"autorelist\":{\"max\":\"\",\"count\":\"\",\"duration\":\"\",\"action\":\"\",\"price\":\"\"},\"upcnot\":\"off\",\"paymentmethods\":[\"\"],\"shiptolocations\":[\"\"],\"itemspecifics\":[]}",
    "ebayshippingprofileid": "0",
    "ebaypaymentprofileid": "0",
    "ebayreturnprofileid": "0",
    "ebaysiteid": "",
    "ebaylocation": "",
    "ebaysubtitle": "",
    "ebaysecondcategory": "",
    "ebaypaymentinstructions": "",
    "ebaysalestaxpercent": 0,
    "ebaytaxcategory": "",
    "ebayshippingcalculatedpostalcode": "",
    "ebayshippingcalculatedhandlingfee": 0,
    "ebayshippingcalculatedshippingirregular": "false",
    "ebayshippingcalculatedshippingpackage": "",
    "ebayshippingcalculatedinternationalhandlingfee": 0,
    "ebayshippingdomestic1service": "",
    "ebayshippingdomestic1cost": 0,
    "ebayshippingdomestic1additionalcost": 0,
    "ebayshippingdomestic1insurancecost": 0,
    "ebayshippingdomestic1surcharge": 0,
    "ebayshippingdomestic1timemin": 0,
    "ebayshippingdomestic1timemax": 0,
    "ebayshippingdomestic2service": "",
    "ebayshippingdomestic2cost": 0,
    "ebayshippingdomestic2additionalcost": 0,
    "ebayshippingdomestic2insurancecost": 0,
    "ebayshippingdomestic2surcharge": 0,
    "ebayshippingdomestic2timemin": 0,
    "ebayshippingdomestic2timemax": 0,
    "ebayshippingdomestic3service": "",
    "ebayshippingdomestic3cost": 0,
    "ebayshippingdomestic3additionalcost": 0,
    "ebayshippingdomestic3insurancecost": 0,
    "ebayshippingdomestic3surcharge": 0,
    "ebayshippingdomestic3timemin": 0,
    "ebayshippingdomestic3timemax": 0,
    "ebayshippingdomestic4service": "",
    "ebayshippingdomestic4cost": 0,
    "ebayshippingdomestic4additionalcost": 0,
    "ebayshippingdomestic4insurancecost": 0,
    "ebayshippingdomestic4surcharge": 0,
    "ebayshippingdomestic4timemin": 0,
    "ebayshippingdomestic4timemax": 0,
    "ebayshippinginternational1service": "",
    "ebayshippinginternational1cost": 0,
    "ebayshippinginternational1additionalcost": 0,
    "ebayshippinginternational1insurancecost": 0,
    "ebayshippinginternational1location": "",
    "ebayshippinginternational2service": "",
    "ebayshippinginternational2cost": 0,
    "ebayshippinginternational2additionalcost": 0,
    "ebayshippinginternational2insurancecost": 0,
    "ebayshippinginternational2location": "",
    "ebayshippinginternational3service": "",
    "ebayshippinginternational3cost": 0,
    "ebayshippinginternational3additionalcost": 0,
    "ebayshippinginternational3insurancecost": 0,
    "ebayshippinginternational3location": "",
    "ebayshippinginternational4service": "",
    "ebayshippinginternational4cost": 0,
    "ebayshippinginternational4additionalcost": 0,
    "ebayshippinginternational4insurancecost": 0,
    "ebayshippinginternational4location": "",
    "ebayshippinginternational5service": "",
    "ebayshippinginternational5cost": 0,
    "ebayshippinginternational5additionalcost": 0,
    "ebayshippinginternational5insurancecost": 0,
    "ebayshippinginternational5location": "",
    "ebayshippingratetabledom": "off",
    "ebayshippingratetableintl": "off",
    "ebayshippingexcludes0": "",
    "ebaydispatch": 0,
    "ebayreturnsdescription": "",
    "ebaytemplate": "",
    "ebaybestofferminimumprice": 0,
    "ebaybestofferautoacceptprice": 0,
    "ebayscheduletime": "",
    "ebaysiteshipping": "",
    "ebayinternationalon": "",
    "ebayfitmentcatalog": "",
    "ebayautorelistmax": "",
    "ebayautorelistcount": "",
    "ebayautorelistduration": "",
    "ebayautorelistaction": "",
    "ebayautorelistprice": "",
    "ebayupcnot": "off",
    "ebaypaymentmethods0": "",
    "ebayshiptolocations0": "",
    "ebaystarttime": null,
    "ebayendtime": null,
    "ebaypromotionstarttime": null,
    "ebaypromotionendtime": null,
    "ebayautopay": null,
    "ebayduration": null,
    "ebaylisting": null,
    "ebaypaypalemailaddress": null,
    "ebaypaymentmethods": "",
    "ebayshiptolocations": "",
    "ebayshippingincludedintax": null,
    "ebayshippingtype": null,
    "ebayshippingglobal": null,
    "ebayshippingdomestic1cutofftime": null,
    "ebayshippingdomestic1expedited": null,
    "ebayshippingdomestic1freeshipping": null,
    "ebayshippingdomestic1localpickup": null,
    "ebayshippingdomestic1handling": null,
    "ebayshippingdomestic2cutofftime": null,
    "ebayshippingdomestic2expedited": null,
    "ebayshippingdomestic2freeshipping": null,
    "ebayshippingdomestic2localpickup": null,
    "ebayshippingdomestic2handling": null,
    "ebayshippingdomestic3cutofftime": null,
    "ebayshippingdomestic3expedited": null,
    "ebayshippingdomestic3freeshipping": null,
    "ebayshippingdomestic3localpickup": null,
    "ebayshippingdomestic3handling": null,
    "ebayshippingdomestic4cutofftime": null,
    "ebayshippingdomestic4expedited": null,
    "ebayshippingdomestic4freeshipping": null,
    "ebayshippingdomestic4localpickup": null,
    "ebayshippingdomestic4handling": null,
    "ebayshippinginternational1cutofftime": null,
    "ebayshippinginternational1handling": null,
    "ebayshippinginternational2cutofftime": null,
    "ebayshippinginternational2handling": null,
    "ebayshippinginternational3cutofftime": null,
    "ebayshippinginternational3handling": null,
    "ebayshippinginternational4cutofftime": null,
    "ebayshippinginternational4handling": null,
    "ebayshippinginternational5cutofftime": null,
    "ebayshippinginternational5handling": null,
    "ebayshippingexcludes": "",
    "ebaygetitfast": null,
    "ebayreturnsreturnsaccepted": null,
    "ebayreturnsrefund": null,
    "ebayreturnsreturnswithin": null,
    "ebayreturnsshippingcostpaidby": null,
    "ebayreturnsrestockingfeevalue": null,
    "ebayadult": null,
    "ebayprivate": null,
    "ebayholidayreturn": null,
    "ebaybestofferenabled": null,
    "ebayitemspecifics": "",
    "ebaybuyitnow": null,
    "ebayoutofstock": null,
    "ebayauctionsrelist": null,
    "ebaycurrency": null,
    "ebayprefiliteminfo": null,
    "ebayitemspecificsbottomssizemens": null,
    "ebayitemspecificssizetype": null,
    "ebayitemspecificsinseam": null,
    "ebayitemspecificsusshoesizemens": null,
    "ebayitemspecificssizemens": null,
    "amznsku": "",
    "amznasin": "",
    "amznitemtype": "0",
    "amzncategory": "0",
    "amznprice": "0.00",
    "amzntitle": "",
    "amznsearch": "",
    "amznfba": "",
    "amznstatus": "",
    "amznoptions": "",
    "amzn3sku": "",
    "amzn3asin": "",
    "amzn3itemtype": "0",
    "amzn3category": "0",
    "amzn3price": "0.00",
    "amzn3title": "",
    "amzn3search": "",
    "amzn3fba": "",
    "amzn3status": "",
    "amzn3options": "",
    "ebayepid": "",
    "amznstockfba": "0",
    "bulletpoint1": "",
    "bulletpoint2": "",
    "bulletpoint3": "",
    "bulletpoint4": "",
    "bulletpoint5": "",
    "department": "",
    "partnumber": "",
    "mpn": "",
    "carrier": "",
    "width": "",
    "amznminage": "0",
    "amznmaxage": "0",
    "amznexemption": "",
    "memory": "",
    "minstock": "",
    "sizemens": "",
    "amznminstock": "",
    "amznmaxstock": "",
    "fitmentnotes": "",
    "sproket": "",
    "model": "",
    "flavor": "",
    "vendor1stock": "0",
    "vendorsku": "",
    "media1alttext": "",
    "media2alttext": "",
    "media3alttext": "",
    "media4alttext": "",
    "media5alttext": "",
    "media6alttext": "",
    "media7alttext": "",
    "media8alttext": "",
    "media9alttext": "",
    "media10alttext": "",
    "media11alttext": "",
    "shoesize": "",
    "internationalshipping1": "0.00",
    "internationalshippinglocation1": "Worldwide",
    "etsylistingid": "0",
    "etsy2listingid": "0",
    "skuvaultsku": "",
    "skuvaultretailprice": "1.00",
    "skuvaultquantityavailable": "1",
    "skuvaultdescription": "1 Moar",
    "skuvaultclassification": "",
    "skuvaultsupplier": "",
    "skuvaultbrand": "",
    "skuvaultcost": "0.00",
    "skuvaultsaleprice": "0.00",
    "magentolistingid": "",
    "magentosku": "",
    "magento3listingid": "",
    "magento3sku": "",
    "volusionproductid": "0",
    "bigcommercelistingid": "221",
    "bigcommercesku": "1MOAR",
    "bigcommercecategories": "JSON::[\"1\"]",
    "bigcommerceisfreeshipping": "on",
    "bigcommercebrandid": "Coco Lee",
    "bigcommerceoptionsetid": "13",
    "bigcommerceskuid": 2451,
    "bigcommercetaxclassid": "",
    "total_stock": 3
    },
    "type": "items",
    "all": "2",
    "time": "2015-08-30 19:17:26"
    }
curl --request GET \
--url https://api.suredone.com/v1/search/items/1MOAR \
--header 'x-auth-token: {auth-token}' \
--header 'x-auth-user: {auth-username}'
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.suredone.com/v1/search/items/1MOAR",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_SSL_VERIFYHOST => false,
CURLOPT_HTTPHEADER => array(
"x-auth-token: {auth-token}",
"x-auth-user: {auth-username}"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
header('Content-Type: application/json');
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
// This example uses package from http://restsharp.org/
var client = new RestClient("https://api.suredone.com/v1/search/items/1MOAR");
var request = new RestRequest(Method.GET);
request.AddHeader("x-auth-token", "{auth-token}");
request.AddHeader("x-auth-user", "{auth-username}");
IRestResponse response = client.Execute(request);
Console.Write(response.Content);
Console.ReadLine();
import http.client
conn = http.client.HTTPSConnection("api.suredone.com")
payload = ''
headers = {
'x-auth-user': "{auth-username}",
'x-auth-token': "{auth-token}"
}
conn.request("GET", "/v1/search/items/1MOAR", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
// This example uses following package
// https://github.com/Mashape/unirest-java
try {
HttpResponse<String> response = Unirest.get("https://api.suredone.com/v1/search/items/1MOAR")
.header("x-auth-user", "{auth-username}")
.header("x-auth-token", "{auth-token}")
.asString();
System.out.print(response.getBody());
} catch(UnirestException e){
e.printStackTrace();
}
var unirest = require("unirest");
var req = unirest("GET", "https://api.suredone.com/v1/search/items/1MOAR");
req.headers({
"x-auth-token": "{auth-token}",
"x-auth-user": "{auth-username}"
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
require 'uri'
require 'net/http'
url = URI("https://api.suredone.com/v1/search/items/1MOAR")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["x-auth-user"] = '{auth-username}'
request["x-auth-token"] = '{auth-token}'
response = http.request(request)
puts response.read_body
Search Items
/search/items/{field1}:={value1} {field2}:<{value2}

Search items by one or more conditions with each condition being separated by a space. The example below is searching for all itmes where brand is equal to Nike and price is less than 13.

  • Parameters
  • field1
    string (required) Example: brand
    value1
    string (required) Example: nike
    field2
    string (optional) Example: price
    value2
    string (optional) Example: 99
  • Request
  • Headers
    X-Auth-User: {auth-username}
    X-Auth-Token: {auth-token}
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
    "1": {
    "id": "2230",
    "url": "http://play.suredone.com/skuvault-test-create-0095",
    "uri": "skuvault-test-create-0095",
    "galleryuri": "",
    "parenturi": "",
    "sku": "0095",
    "guid": "0095",
    "stock": "0",
    "price": "0.00",
    "reprice": "0.00",
    "discountprice": "0.00",
    "msrp": "0.00",
    "cost": "0.00",
    "featured": "0",
    "name": "",
    "title": "SkuVault Test Create",
    "keywords": "",
    "description": "",
    "notes": "",
    "htmltitle": "",
    "metadescription": "",
    "size": "",
    "color": "",
    "condition": "",
    "brand": "nike",
    "style": "",
    "upc": "",
    "tags": "",
    "category1": "",
    "category2": "",
    "category3": "",
    "category4": "",
    "category5": "",
    "media": "",
    "media1": "",
    "media2": "",
    "media3": "",
    "media4": "",
    "media5": "",
    "media6": "",
    "media7": "",
    "media8": "",
    "media9": "",
    "media10": "",
    "mediacount": "0",
    "shipping": "0.00",
    "shippingadditional": "0.00",
    "handlingfee": "0.00",
    "weight": "0.00",
    "dimweight": "0.00",
    "boxlength": "0.00",
    "boxwidth": "0.00",
    "boxheight": "0.00",
    "boxweight": "0.00",
    "date": "2015-08-15 08:25:33",
    "dateupdated": "2015-08-24 12:41:35",
    "datesold": "0000-00-00 00:00:00",
    "totalsold": "0",
    "asset": "",
    "domain": "",
    "rule": "update",
    "state": "stock",
    "status": "publish",
    "active": "0",
    "type": "",
    "updatenotes": "",
    "googleshopping": "1",
    "googleshopurl": "",
    "googlecategory": "",
    "ebayid": "0",
    "ebaysku": "",
    "ebaycatid": "0",
    "ebaystoreid": "0",
    "ebaystoreid2": "0",
    "ebayprice": "0.00",
    "ebaytitle": "",
    "ebayoptions": "{\"paymentprofileid\":\"\",\"returnprofileid\":\"\",\"shippingprofileid\":\"\"}",
    "ebaypaymentprofileid": "",
    "ebayreturnprofileid": "",
    "ebayshippingprofileid": "",
    "ebaystarttime": null,
    "ebayendtime": null,
    "ebaypromotionstarttime": null,
    "ebaypromotionendtime": null,
    "ebaysiteid": null,
    "ebayautopay": null,
    "ebayduration": null,
    "ebaylisting": null,
    "ebaylocation": null,
    "ebaysubtitle": null,
    "ebaysecondcategory": null,
    "ebaypaypalemailaddress": null,
    "ebaypaymentmethods": null,
    "ebayshiptolocations": null,
    "ebaypaymentinstructions": null,
    "ebaysalestaxpercent": null,
    "ebayshippingincludedintax": null,
    "ebaytaxcategory": null,
    "ebayshippingcalculatedpostalcode": null,
    "ebayshippingcalculatedhandlingfee": null,
    "ebayshippingcalculatedshippingirregular": null,
    "ebayshippingcalculatedshippingpackage": null,
    "ebayshippingcalculatedinternationalhandlingfee": null,
    "ebayshippingtype": null,
    "ebayshippingglobal": null,
    "ebayshippingdomestic1service": null,
    "ebayshippingdomestic1cost": null,
    "ebayshippingdomestic1additionalcost": null,
    "ebayshippingdomestic1insurancecost": null,
    "ebayshippingdomestic1cutofftime": null,
    "ebayshippingdomestic1surcharge": null,
    "ebayshippingdomestic1expedited": null,
    "ebayshippingdomestic1timemin": null,
    "ebayshippingdomestic1timemax": null,
    "ebayshippingdomestic1freeshipping": null,
    "ebayshippingdomestic1localpickup": null,
    "ebayshippingdomestic1handling": null,
    "ebayshippingdomestic2service": null,
    "ebayshippingdomestic2cost": null,
    "ebayshippingdomestic2additionalcost": null,
    "ebayshippingdomestic2insurancecost": null,
    "ebayshippingdomestic2cutofftime": null,
    "ebayshippingdomestic2surcharge": null,
    "ebayshippingdomestic2expedited": null,
    "ebayshippingdomestic2timemin": null,
    "ebayshippingdomestic2timemax": null,
    "ebayshippingdomestic2freeshipping": null,
    "ebayshippingdomestic2localpickup": null,
    "ebayshippingdomestic2handling": null,
    "ebayshippingdomestic3service": null,
    "ebayshippingdomestic3cost": null,
    "ebayshippingdomestic3additionalcost": null,
    "ebayshippingdomestic3insurancecost": null,
    "ebayshippingdomestic3cutofftime": null,
    "ebayshippingdomestic3surcharge": null,
    "ebayshippingdomestic3expedited": null,
    "ebayshippingdomestic3timemin": null,
    "ebayshippingdomestic3timemax": null,
    "ebayshippingdomestic3freeshipping": null,
    "ebayshippingdomestic3localpickup": null,
    "ebayshippingdomestic3handling": null,
    "ebayshippingdomestic4service": null,
    "ebayshippingdomestic4cost": null,
    "ebayshippingdomestic4additionalcost": null,
    "ebayshippingdomestic4insurancecost": null,
    "ebayshippingdomestic4cutofftime": null,
    "ebayshippingdomestic4surcharge": null,
    "ebayshippingdomestic4expedited": null,
    "ebayshippingdomestic4timemin": null,
    "ebayshippingdomestic4timemax": null,
    "ebayshippingdomestic4freeshipping": null,
    "ebayshippingdomestic4localpickup": null,
    "ebayshippingdomestic4handling": null,
    "ebayshippinginternational1service": null,
    "ebayshippinginternational1cost": null,
    "ebayshippinginternational1additionalcost": null,
    "ebayshippinginternational1insurancecost": null,
    "ebayshippinginternational1cutofftime": null,
    "ebayshippinginternational1location": null,
    "ebayshippinginternational1handling": null,
    "ebayshippinginternational2service": null,
    "ebayshippinginternational2cost": null,
    "ebayshippinginternational2additionalcost": null,
    "ebayshippinginternational2insurancecost": null,
    "ebayshippinginternational2cutofftime": null,
    "ebayshippinginternational2location": null,
    "ebayshippinginternational2handling": null,
    "ebayshippinginternational3service": null,
    "ebayshippinginternational3cost": null,
    "ebayshippinginternational3additionalcost": null,
    "ebayshippinginternational3insurancecost": null,
    "ebayshippinginternational3cutofftime": null,
    "ebayshippinginternational3location": null,
    "ebayshippinginternational3handling": null,
    "ebayshippinginternational4service": null,
    "ebayshippinginternational4cost": null,
    "ebayshippinginternational4additionalcost": null,
    "ebayshippinginternational4insurancecost": null,
    "ebayshippinginternational4cutofftime": null,
    "ebayshippinginternational4location": null,
    "ebayshippinginternational4handling": null,
    "ebayshippinginternational5service": null,
    "ebayshippinginternational5cost": null,
    "ebayshippinginternational5additionalcost": null,
    "ebayshippinginternational5insurancecost": null,
    "ebayshippinginternational5cutofftime": null,
    "ebayshippinginternational5location": null,
    "ebayshippinginternational5handling": null,
    "ebayshippingratetabledom": null,
    "ebayshippingratetableintl": null,
    "ebayshippingexcludes": null,
    "ebaydispatch": null,
    "ebaygetitfast": null,
    "ebayreturnsreturnsaccepted": null,
    "ebayreturnsrefund": null,
    "ebayreturnsreturnswithin": null,
    "ebayreturnsdescription": null,
    "ebayreturnsshippingcostpaidby": null,
    "ebayreturnsrestockingfeevalue": null,
    "ebayadult": null,
    "ebayprivate": null,
    "ebaytemplate": null,
    "ebayholidayreturn": null,
    "ebaybestofferenabled": null,
    "ebaybestofferminimumprice": null,
    "ebaybestofferautoacceptprice": null,
    "ebayitemspecifics": "",
    "ebaybuyitnow": null,
    "ebayoutofstock": null,
    "ebayscheduletime": null,
    "ebayauctionsrelist": null,
    "ebaysiteshipping": null,
    "ebayinternationalon": null,
    "ebaycurrency": null,
    "ebayprefiliteminfo": null,
    "ebayfitmentcatalog": null,
    "ebayautorelistmax": null,
    "ebayautorelistcount": null,
    "ebayautorelistduration": null,
    "ebayautorelistaction": null,
    "ebayautorelistprice": null,
    "ebayupcnot": null,
    "ebayitemspecificsbottomssizemens": null,
    "ebayitemspecificssizetype": null,
    "ebayitemspecificsinseam": null,
    "ebayitemspecificsusshoesizemens": null,
    "ebayitemspecificssizemens": null,
    "amznsku": "",
    "amznasin": "",
    "amznitemtype": "0",
    "amzncategory": "0",
    "amznprice": "0.00",
    "amzntitle": "",
    "amznsearch": "",
    "amznfba": "",
    "amznstatus": "",
    "amznoptions": "",
    "amzn3sku": "",
    "amzn3asin": "",
    "amzn3itemtype": "0",
    "amzn3category": "0",
    "amzn3price": "0.00",
    "amzn3title": "",
    "amzn3search": "",
    "amzn3fba": "",
    "amzn3status": "",
    "amzn3options": "",
    "ebayepid": "",
    "amznstockfba": "0",
    "bulletpoint1": "",
    "bulletpoint2": "",
    "bulletpoint3": "",
    "bulletpoint4": "",
    "bulletpoint5": "",
    "department": "",
    "partnumber": "",
    "mpn": "",
    "carrier": "",
    "width": null,
    "amznminage": null,
    "amznmaxage": null,
    "amznexemption": null,
    "memory": "",
    "minstock": "",
    "sizemens": "",
    "amznminstock": "",
    "amznmaxstock": "",
    "fitmentnotes": "",
    "sproket": "",
    "model": "",
    "flavor": "",
    "vendor1stock": "0",
    "vendorsku": "",
    "media1alttext": "",
    "media2alttext": "",
    "media3alttext": "",
    "media4alttext": "",
    "media5alttext": "",
    "media6alttext": "",
    "media7alttext": "",
    "media8alttext": "",
    "media9alttext": "",
    "media10alttext": "",
    "media11alttext": "",
    "shoesize": "",
    "internationalshipping1": "0.00",
    "internationalshippinglocation1": "Worldwide",
    "etsylistingid": "0",
    "etsy2listingid": "0",
    "skuvaultsku": "0095",
    "skuvaultretailprice": "0.00",
    "skuvaultquantityavailable": 0,
    "skuvaultdescription": "SkuVault Test Create",
    "skuvaultclassification": "General",
    "skuvaultsupplier": "Unknown",
    "skuvaultcost": "0.00",
    "skuvaultsaleprice": "0.00",
    "magentolistingid": "",
    "magentosku": "",
    "magento3listingid": "",
    "magento3sku": "",
    "volusionproductid": "0",
    "bigcommercelistingid": "",
    "bigcommercesku": "",
    "total_stock": 0
    },
    "2": {
    "id": "2082",
    "url": "http://play.suredone.com/tfw-test-ben123",
    "uri": "tfw-test-ben123",
    "galleryuri": "",
    "parenturi": "",
    "sku": "BEN123",
    "guid": "BEN123",
    "stock": "0",
    "price": "10.00",
    "reprice": "0.00",
    "discountprice": "0.00",
    "msrp": "0.00",
    "cost": "0.00",
    "featured": "0",
    "name": "",
    "title": "TFW Test",
    "keywords": "",
    "description": "",
    "notes": "",
    "htmltitle": "",
    "metadescription": "",
    "size": "",
    "color": "",
    "condition": "New",
    "brand": "Nike",
    "style": "",
    "upc": "",
    "tags": "",
    "category1": "",
    "category2": "",
    "category3": "",
    "category4": "",
    "category5": "",
    "media": "",
    "media1": "",
    "media2": "",
    "media3": "",
    "media4": "",
    "media5": "",
    "media6": "",
    "media7": "",
    "media8": "",
    "media9": "",
    "media10": "",
    "mediacount": "0",
    "shipping": "0.00",
    "shippingadditional": "0.00",
    "handlingfee": "0.00",
    "weight": "0.00",
    "dimweight": "0.00",
    "boxlength": "0.00",
    "boxwidth": "0.00",
    "boxheight": "0.00",
    "boxweight": "0.00",
    "date": "2015-08-12 16:13:56",
    "dateupdated": "2015-08-12 16:16:06",
    "datesold": "0000-00-00 00:00:00",
    "totalsold": "0",
    "asset": "",
    "domain": "",
    "rule": "update",
    "state": "stock",
    "status": "publish",
    "active": "0",
    "type": "",
    "updatenotes": "",
    "googleshopping": "1",
    "googleshopurl": "",
    "googlecategory": "",
    "ebayid": "0",
    "ebaysku": "",
    "ebaycatid": "0",
    "ebaystoreid": "0",
    "ebaystoreid2": "0",
    "ebayprice": "0.00",
    "ebaytitle": "",
    "ebayoptions": "{\"paymentprofileid\":\"0\",\"returnprofileid\":\"0\",\"shippingprofileid\":\"0\",\"siteid\":\"\",\"location\":\"\",\"subtitle\":\"\",\"secondcategory\":\"\",\"paymentinstructions\":\"\",\"salestaxpercent\":0,\"taxcategory\":\"\",\"shipping\":{\"calculated\":{\"postalcode\":\"\",\"handlingfee\":0,\"shippingirregular\":false,\"shippingpackage\":\"\",\"internationalhandlingfee\":0},\"domestic\":{\"1\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"surcharge\":0,\"timemin\":0,\"timemax\":0},\"2\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"surcharge\":0,\"timemin\":0,\"timemax\":0},\"3\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"surcharge\":0,\"timemin\":0,\"timemax\":0},\"4\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"surcharge\":0,\"timemin\":0,\"timemax\":0}},\"international\":{\"1\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"location\":\"\"},\"2\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"location\":\"\"},\"3\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"location\":\"\"},\"4\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"location\":\"\"},\"5\":{\"service\":\"\",\"cost\":0,\"additionalcost\":0,\"insurancecost\":0,\"location\":\"\"}},\"excludes\":[\"\"]},\"dispatch\":0,\"returns\":{\"description\":\"\"},\"template\":\"\",\"bestoffer\":{\"minimumprice\":0,\"autoacceptprice\":0},\"scheduletime\":\"\",\"siteshipping\":\"\",\"internationalon\":\"\",\"fitmentcatalog\":\"\",\"autorelist\":{\"max\":\"\",\"count\":\"\",\"duration\":\"\",\"action\":\"\",\"price\":\"\"},\"upcnot\":\"off\",\"paymentmethods\":[\"\"],\"shiptolocations\":[\"\"],\"itemspecifics\":[]}",
    "ebaypaymentprofileid": "0",
    "ebayreturnprofileid": "0",
    "ebayshippingprofileid": "0",
    "ebaysiteid": "",
    "ebaylocation": "",
    "ebaysubtitle": "",
    "ebaysecondcategory": "",
    "ebaypaymentinstructions": "",
    "ebaysalestaxpercent": 0,
    "ebaytaxcategory": "",
    "ebayshippingcalculatedpostalcode": "",
    "ebayshippingcalculatedhandlingfee": 0,
    "ebayshippingcalculatedshippingirregular": "false",
    "ebayshippingcalculatedshippingpackage": "",
    "ebayshippingcalculatedinternationalhandlingfee": 0,
    "ebayshippingdomestic1service": "",
    "ebayshippingdomestic1cost": 0,
    "ebayshippingdomestic1additionalcost": 0,
    "ebayshippingdomestic1insurancecost": 0,
    "ebayshippingdomestic1surcharge": 0,
    "ebayshippingdomestic1timemin": 0,
    "ebayshippingdomestic1timemax": 0,
    "ebayshippingdomestic2service": "",
    "ebayshippingdomestic2cost": 0,
    "ebayshippingdomestic2additionalcost": 0,
    "ebayshippingdomestic2insurancecost": 0,
    "ebayshippingdomestic2surcharge": 0,
    "ebayshippingdomestic2timemin": 0,
    "ebayshippingdomestic2timemax": 0,
    "ebayshippingdomestic3service": "",
    "ebayshippingdomestic3cost": 0,
    "ebayshippingdomestic3additionalcost": 0,
    "ebayshippingdomestic3insurancecost": 0,
    "ebayshippingdomestic3surcharge": 0,
    "ebayshippingdomestic3timemin": 0,
    "ebayshippingdomestic3timemax": 0,
    "ebayshippingdomestic4service": "",
    "ebayshippingdomestic4cost": 0,
    "ebayshippingdomestic4additionalcost": 0,
    "ebayshippingdomestic4insurancecost": 0,
    "ebayshippingdomestic4surcharge": 0,
    "ebayshippingdomestic4timemin": 0,
    "ebayshippingdomestic4timemax": 0,
    "ebayshippinginternational1service": "",
    "ebayshippinginternational1cost": 0,
    "ebayshippinginternational1additionalcost": 0,
    "ebayshippinginternational1insurancecost": 0,
    "ebayshippinginternational1location": "",
    "ebayshippinginternational2service": "",
    "ebayshippinginternational2cost": 0,
    "ebayshippinginternational2additionalcost": 0,
    "ebayshippinginternational2insurancecost": 0,
    "ebayshippinginternational2location": "",
    "ebayshippinginternational3service": "",
    "ebayshippinginternational3cost": 0,
    "ebayshippinginternational3additionalcost": 0,
    "ebayshippinginternational3insurancecost": 0,
    "ebayshippinginternational3location": "",
    "ebayshippinginternational4service": "",
    "ebayshippinginternational4cost": 0,
    "ebayshippinginternational4additionalcost": 0,
    "ebayshippinginternational4insurancecost": 0,
    "ebayshippinginternational4location": "",
    "ebayshippinginternational5service": "",
    "ebayshippinginternational5cost": 0,
    "ebayshippinginternational5additionalcost": 0,
    "ebayshippinginternational5insurancecost": 0,
    "ebayshippinginternational5location": "",
    "ebayshippingexcludes0": "",
    "ebaydispatch": 0,
    "ebayreturnsdescription": "",
    "ebaytemplate": "",
    "ebaybestofferminimumprice": 0,
    "ebaybestofferautoacceptprice": 0,
    "ebayscheduletime": "",
    "ebaysiteshipping": "",
    "ebayinternationalon": "",
    "ebayfitmentcatalog": "",
    "ebayautorelistmax": "",
    "ebayautorelistcount": "",
    "ebayautorelistduration": "",
    "ebayautorelistaction": "",
    "ebayautorelistprice": "",
    "ebayupcnot": "off",
    "ebaypaymentmethods0": "",
    "ebayshiptolocations0": "",
    "ebaystarttime": null,
    "ebayendtime": null,
    "ebaypromotionstarttime": null,
    "ebaypromotionendtime": null,
    "ebayautopay": null,
    "ebayduration": null,
    "ebaylisting": null,
    "ebaypaypalemailaddress": null,
    "ebaypaymentmethods": "",
    "ebayshiptolocations": "",
    "ebayshippingincludedintax": null,
    "ebayshippingtype": null,
    "ebayshippingglobal": null,
    "ebayshippingdomestic1cutofftime": null,
    "ebayshippingdomestic1expedited": null,
    "ebayshippingdomestic1freeshipping": null,
    "ebayshippingdomestic1localpickup": null,
    "ebayshippingdomestic1handling": null,
    "ebayshippingdomestic2cutofftime": null,
    "ebayshippingdomestic2expedited": null,
    "ebayshippingdomestic2freeshipping": null,
    "ebayshippingdomestic2localpickup": null,
    "ebayshippingdomestic2handling": null,
    "ebayshippingdomestic3cutofftime": null,
    "ebayshippingdomestic3expedited": null,
    "ebayshippingdomestic3freeshipping": null,
    "ebayshippingdomestic3localpickup": null,
    "ebayshippingdomestic3handling": null,
    "ebayshippingdomestic4cutofftime": null,
    "ebayshippingdomestic4expedited": null,
    "ebayshippingdomestic4freeshipping": null,
    "ebayshippingdomestic4localpickup": null,
    "ebayshippingdomestic4handling": null,
    "ebayshippinginternational1cutofftime": null,
    "ebayshippinginternational1handling": null,
    "ebayshippinginternational2cutofftime": null,
    "ebayshippinginternational2handling": null,
    "ebayshippinginternational3cutofftime": null,
    "ebayshippinginternational3handling": null,
    "ebayshippinginternational4cutofftime": null,
    "ebayshippinginternational4handling": null,
    "ebayshippinginternational5cutofftime": null,
    "ebayshippinginternational5handling": null,
    "ebayshippingratetabledom": null,
    "ebayshippingratetableintl": null,
    "ebayshippingexcludes": "",
    "ebaygetitfast": null,
    "ebayreturnsreturnsaccepted": null,
    "ebayreturnsrefund": null,
    "ebayreturnsreturnswithin": null,
    "ebayreturnsshippingcostpaidby": null,
    "ebayreturnsrestockingfeevalue": null,
    "ebayadult": null,
    "ebayprivate": null,
    "ebayholidayreturn": null,
    "ebaybestofferenabled": null,
    "ebayitemspecifics": "",
    "ebaybuyitnow": null,
    "ebayoutofstock": null,
    "ebayauctionsrelist": null,
    "ebaycurrency": null,
    "ebayprefiliteminfo": null,
    "ebayitemspecificsbottomssizemens": null,
    "ebayitemspecificssizetype": null,
    "ebayitemspecificsinseam": null,
    "ebayitemspecificsusshoesizemens": null,
    "ebayitemspecificssizemens": null,
    "amznsku": "",
    "amznasin": "",
    "amznitemtype": "0",
    "amzncategory": "0",
    "amznprice": "0.00",
    "amzntitle": "",
    "amznsearch": "",
    "amznfba": "",
    "amznstatus": "",
    "amznoptions": "",
    "amzn3sku": "",
    "amzn3asin": "",
    "amzn3itemtype": "0",
    "amzn3category": "0",
    "amzn3price": "0.00",
    "amzn3title": "",
    "amzn3search": "",
    "amzn3fba": "",
    "amzn3status": "",
    "amzn3options": "",
    "ebayepid": "",
    "amznstockfba": "0",
    "bulletpoint1": "",
    "bulletpoint2": "",
    "bulletpoint3": "",
    "bulletpoint4": "",
    "bulletpoint5": "",
    "department": "",
    "partnumber": "",
    "mpn": "",
    "carrier": "",
    "width": "",
    "amznminage": "0",
    "amznmaxage": "0",
    "amznexemption": "",
    "memory": "",
    "minstock": "",
    "sizemens": "",
    "amznminstock": "",
    "amznmaxstock": "",
    "fitmentnotes": "",
    "sproket": "",
    "model": "",
    "flavor": "",
    "vendor1stock": "0",
    "vendorsku": "",
    "media1alttext": "",
    "media2alttext": "",
    "media3alttext": "",
    "media4alttext": "",
    "media5alttext": "",
    "media6alttext": "",
    "media7alttext": "",
    "media8alttext": "",
    "media9alttext": "",
    "media10alttext": "",
    "media11alttext": "",
    "shoesize": "",
    "internationalshipping1": "0.00",
    "internationalshippinglocation1": "Worldwide",
    "etsylistingid": "0",
    "etsy2listingid": "0",
    "skuvaultsku": "BEN123",
    "skuvaultretailprice": "10",
    "skuvaultquantityavailable": "0",
    "skuvaultdescription": "TFW Test",
    "skuvaultbrand": "Nike",
    "skuvaultcost": "10",
    "skuvaultsaleprice": "10",
    "skuvaultclassification": "Nike",
    "skuvaultsupplier": "",
    "magentolistingid": "",
    "magentosku": "",
    "magento3listingid": "",
    "magento3sku": "",
    "volusionproductid": "0",
    "bigcommercelistingid": "",
    "bigcommercesku": "",
    "bigcommercebrandid": "",
    "bigcommerceoptionsetid": "",
    "bigcommercetaxclassid": "",
    "total_stock": 0
    },
    "type": "items",
    "all": "2",
    "time": "2015-08-30 19:07:42"
    }
curl --request GET \
--url 'https://api.suredone.com/v1/search/items/brand:=nike%20price:&lt;99' \
--header 'x-auth-token: {auth-token}' \
--header 'x-auth-user: {auth-username}'
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.suredone.com/v1/search/items/brand:=nike%20price:&lt;99",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_SSL_VERIFYHOST => false,
CURLOPT_HTTPHEADER => array(
"x-auth-token: {auth-token}",
"x-auth-user: {auth-username}"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
header('Content-Type: application/json');
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
// This example uses package from http://restsharp.org/
var client = new RestClient("https://api.suredone.com/v1/search/items/brand:=nike%20price:&lt;99");
var request = new RestRequest(Method.GET);
request.AddHeader("x-auth-token", "{auth-token}");
request.AddHeader("x-auth-user", "{auth-username}");
IRestResponse response = client.Execute(request);
Console.Write(response.Content);
Console.ReadLine();
import http.client
conn = http.client.HTTPSConnection("api.suredone.com")
payload = ''
headers = {
'x-auth-user': "{auth-username}",
'x-auth-token': "{auth-token}"
}
conn.request("GET", "/v1/search/items/brand:=nike%20price:&lt;99", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
// This example uses following package
// https://github.com/Mashape/unirest-java
try {
HttpResponse<String> response = Unirest.get("https://api.suredone.com/v1/search/items/brand:=nike%20price:&lt;99")
.header("x-auth-user", "{auth-username}")
.header("x-auth-token", "{auth-token}")
.asString();
System.out.print(response.getBody());
} catch(UnirestException e){
e.printStackTrace();
}
var unirest = require("unirest");
var req = unirest("GET", "https://api.suredone.com/v1/search/items/brand:=nike%20price:&lt;99");
req.headers({
"x-auth-token": "{auth-token}",
"x-auth-user": "{auth-username}"
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
require 'uri'
require 'net/http'
url = URI("https://api.suredone.com/v1/search/items/brand:=nike%20price:&lt;99")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["x-auth-user"] = '{auth-username}'
request["x-auth-token"] = '{auth-token}'
response = http.request(request)
puts response.read_body

Orders 

Orders 

Get Single Order
/orders/edit/{orderNumber}

Retrieve an order based on the order number.

  • Parameters
  • orderNumber
    string (required) Example: SD1523063605948
  • Request
  • Headers
    X-Auth-User: {auth-username}
    X-Auth-Token: {auth-token}
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
    "1": {
    "oid": "46",
    "order": "SD1523063605948",
    "date": "2015-08-18 14:17:05",
    "account": "",
    "payment": "Visa",
    "paymenttime": "2015-08-18 08:17:05",
    "transactionid": "ch_6ooWGovpZsyW38",
    "correlationid": "2D64dSgOp8ssE7pw",
    "shipdetails": "",
    "shipcarrier": "USPS",
    "shipservice": "USPS-PRIORITY",
    "shipasgift": "0",
    "shiptracking": "",
    "shipdate": "0000-00-00 00:00:00",
    "shippaid": "0.00",
    "shippedby": "play@suredone.com",
    "total": "1283.94",
    "itemtotal": "1274.99",
    "shippingtotal": "8.95",
    "handlingtotal": "0.00",
    "taxtotal": "0.00",
    "discount": "0.00",
    "code": "",
    "items": "MCH0020",
    "names": "",
    "titles": "Apple® MacBook®Pro/Intel® Core? i7 Processor/13.3\" Display",
    "prices": "1274.99",
    "qtys": "1",
    "media": "https://d3inagkmqs1m6q.cloudfront.net/1021/media-tms/mch0019-431639467.jpg",
    "uris": "apple-macbookpro-intel-core-i7-processor-133-display-mch0020",
    "weights": "4.50",
    "dimweights": "0.00",
    "boxlengths": "0.00",
    "boxwidths": "0.00",
    "boxheights": "0.00",
    "boxweights": "0.00",
    "email": "demo@suredone.com",
    "bcountry": "US",
    "bfirstname": "Test",
    "bminitial": "",
    "blastname": "User",
    "bbusiness": "",
    "baddress1": "115 E 23rd St",
    "baddress2": "",
    "baddress3": "",
    "bcity": "New York",
    "bstate": "NY",
    "bzip": "10010",
    "bphone": "877-675-7355",
    "bphone2": "",
    "shiplocation": "BillingAddress",
    "scountry": "US",
    "sfirstname": "Test",
    "sminitial": "",
    "slastname": "User",
    "sbusiness": "",
    "saddress1": "115 E 23rd St",
    "saddress2": "",
    "saddress3": "",
    "scity": "New York",
    "sstate": "NY",
    "szip": "10010",
    "sphone": "877-675-7355",
    "comments": "",
    "internalnotes": "",
    "returnitems": "",
    "returnreason": "",
    "returnid": "",
    "returntotal": "0.00",
    "returndate": "0000-00-00 00:00:00",
    "dateupdated": "2015-08-28 17:02:15",
    "bstatename": "New York",
    "bcountryname": "UNITED STATES",
    "sstatename": "New York",
    "scountryname": "UNITED STATES",
    "shipauth": true,
    "stockby": "stock",
    "item": {
    "0": {
    "guid": "MCH0020",
    "order_qty": 1,
    "order_price": 1274.99,
    "sku": "MCH0020",
    "stock": "9",
    "price": "1274.99",
    "msrp": "0.00",
    "cost": "0.00",
    "title": "Apple® MacBook®Pro/Intel® Core? i7 Processor/13.3\" Display",
    "size": "",
    "color": "",
    "condition": "",
    "brand": "apple",
    "style": "",
    "upc": "",
    "weight": "4.50",
    "dimweight": "0.00",
    "boxlength": "0.00",
    "boxwidth": "0.00",
    "boxheight": "0.00",
    "boxweight": "0.00",
    "state": "stock",
    "status": "publish",
    "ebayepid": "",
    "amznstockfba": "2",
    "bulletpoint1": "",
    "bulletpoint2": "",
    "bulletpoint3": "",
    "bulletpoint4": "",
    "bulletpoint5": "",
    "department": "",
    "partnumber": "",
    "mpn": "",
    "carrier": "",
    "width": null,
    "amznminage": null,
    "amznmaxage": null,
    "amznexemption": null,
    "memory": "",
    "minstock": "",
    "sizemens": "",
    "amznminstock": "",
    "amznmaxstock": "",
    "fitmentnotes": "",
    "sproket": "",
    "model": "",
    "flavor": "",
    "vendor1stock": "0",
    "vendorsku": "",
    "media1alttext": "",
    "media2alttext": "",
    "media3alttext": "",
    "media4alttext": "",
    "media5alttext": "",
    "media6alttext": "",
    "media7alttext": "",
    "media8alttext": "",
    "media9alttext": "",
    "media10alttext": "",
    "media11alttext": "",
    "shoesize": "",
    "footwaresize": "",
    "footwearsize": "",
    "shoesizes": ""
    }
    }
    },
    "all": 1,
    "time": "2015-09-01 17:51:22"
    }
curl --request GET \
--url https://api.suredone.com/v1/orders/edit/SD1523063605948 \
--header 'x-auth-token: {auth-token}' \
--header 'x-auth-user: {auth-username}'
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.suredone.com/v1/orders/edit/SD1523063605948",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_SSL_VERIFYHOST => false,
CURLOPT_HTTPHEADER => array(
"x-auth-token: {auth-token}",
"x-auth-user: {auth-username}"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
header('Content-Type: application/json');
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
// This example uses package from http://restsharp.org/
var client = new RestClient("https://api.suredone.com/v1/orders/edit/SD1523063605948");
var request = new RestRequest(Method.GET);
request.AddHeader("x-auth-token", "{auth-token}");
request.AddHeader("x-auth-user", "{auth-username}");
IRestResponse response = client.Execute(request);
Console.Write(response.Content);
Console.ReadLine();
import http.client
conn = http.client.HTTPSConnection("api.suredone.com")
payload = ''
headers = {
'x-auth-user': "{auth-username}",
'x-auth-token': "{auth-token}"
}
conn.request("GET", "/v1/orders/edit/SD1523063605948", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
// This example uses following package
// https://github.com/Mashape/unirest-java
try {
HttpResponse<String> response = Unirest.get("https://api.suredone.com/v1/orders/edit/SD1523063605948")
.header("x-auth-user", "{auth-username}")
.header("x-auth-token", "{auth-token}")
.asString();
System.out.print(response.getBody());
} catch(UnirestException e){
e.printStackTrace();
}
var unirest = require("unirest");
var req = unirest("GET", "https://api.suredone.com/v1/orders/edit/SD1523063605948");
req.headers({
"x-auth-token": "{auth-token}",
"x-auth-user": "{auth-username}"
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
require 'uri'
require 'net/http'
url = URI("https://api.suredone.com/v1/orders/edit/SD1523063605948")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["x-auth-user"] = '{auth-username}'
request["x-auth-token"] = '{auth-token}'
response = http.request(request)
puts response.read_body
Sort & Paginate Orders
/orders/all/?page={pageNumber}&sort={sortField}

The api only returns a limited number of results per response. The page and sort query params provide a way to iterate through all the results as well as control in what order the results are returned. These 2 query parameters can be appended to any of the mulit-item response HTTP GET calls. The all field in the response will indicate the total number of results that were found.

  • Parameters
  • pageNumber
    number (required) Example: 1
    sortField
    string (required) Example: payment

    append _ for descending sort i.e. payment_

    Choices: order payment shiptracking shipdate total items titles date oid dateupdated

  • Request
  • Headers
    X-Auth-User: {auth-username}
    X-Auth-Token: {auth-token}
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
    "1": {
    "oid": "46",
    "order": "SD1523063605948",
    "date": "2015-08-18 14:17:05",
    "account": "",
    "payment": "Visa",
    "paymenttime": "2015-08-18 08:17:05",
    "transactionid": "ch_6ooWGovpZsyW38",
    "correlationid": "2D64dSgOp8ssE7pw",
    "shipdetails": "",
    "shipcarrier": "USPS",
    "shipservice": "USPS-PRIORITY",
    "shipasgift": "0",
    "shiptracking": "",
    "shipdate": "0000-00-00 00:00:00",
    "shippaid": "0.00",
    "shippedby": "play@suredone.com",
    "total": "1283.94",
    "itemtotal": "1274.99",
    "shippingtotal": "8.95",
    "handlingtotal": "0.00",
    "taxtotal": "0.00",
    "discount": "0.00",
    "code": "",
    "items": "MCH0020",
    "names": "",
    "titles": "Apple® MacBook®Pro/Intel® Core? i7 Processor/13.3\" Display",
    "prices": "1274.99",
    "qtys": "1",
    "media": "https://d3inagkmqs1m6q.cloudfront.net/1021/media-tms/mch0019-431639467.jpg",
    "uris": "apple-macbookpro-intel-core-i7-processor-133-display-mch0020",
    "weights": "4.50",
    "dimweights": "0.00",
    "boxlengths": "0.00",
    "boxwidths": "0.00",
    "boxheights": "0.00",
    "boxweights": "0.00",
    "email": "demo@suredone.com",
    "bcountry": "US",
    "bfirstname": "Test",
    "bminitial": "",
    "blastname": "User",
    "bbusiness": "",
    "baddress1": "115 E 23rd St",
    "baddress2": "",
    "baddress3": "",
    "bcity": "New York",
    "bstate": "NY",
    "bzip": "10010",
    "bphone": "877-675-7355",
    "bphone2": "",
    "shiplocation": "BillingAddress",
    "scountry": "US",
    "sfirstname": "Test",
    "sminitial": "",
    "slastname": "User",
    "sbusiness": "",
    "saddress1": "115 E 23rd St",
    "saddress2": "",
    "saddress3": "",
    "scity": "New York",
    "sstate": "NY",
    "szip": "10010",
    "sphone": "877-675-7355",
    "comments": "",
    "internalnotes": "",
    "returnitems": "",
    "returnreason": "",
    "returnid": "",
    "returntotal": "0.00",
    "returndate": "0000-00-00 00:00:00",
    "dateupdated": "2015-08-28 17:02:15",
    "bstatename": "New York",
    "bcountryname": "UNITED STATES",
    "sstatename": "New York",
    "scountryname": "UNITED STATES",
    "shipauth": true,
    "stockby": "stock",
    "item": {
    "0": {
    "guid": "MCH0020",
    "order_qty": 1,
    "order_price": 1274.99,
    "sku": "MCH0020",
    "stock": "9",
    "price": "1274.99",
    "msrp": "0.00",
    "cost": "0.00",
    "title": "Apple® MacBook®Pro/Intel® Core? i7 Processor/13.3\" Display",
    "size": "",
    "color": "",
    "condition": "",
    "brand": "apple",
    "style": "",
    "upc": "",
    "weight": "4.50",
    "dimweight": "0.00",
    "boxlength": "0.00",
    "boxwidth": "0.00",
    "boxheight": "0.00",
    "boxweight": "0.00",
    "state": "stock",
    "status": "publish",
    "ebayepid": "",
    "amznstockfba": "2",
    "bulletpoint1": "",
    "bulletpoint2": "",
    "bulletpoint3": "",
    "bulletpoint4": "",
    "bulletpoint5": "",
    "department": "",
    "partnumber": "",
    "mpn": "",
    "carrier": "",
    "width": null,
    "amznminage": null,
    "amznmaxage": null,
    "amznexemption": null,
    "memory": "",
    "minstock": "",
    "sizemens": "",
    "amznminstock": "",
    "amznmaxstock": "",
    "fitmentnotes": "",
    "sproket": "",
    "model": "",
    "flavor": "",
    "vendor1stock": "0",
    "vendorsku": "",
    "media1alttext": "",
    "media2alttext": "",
    "media3alttext": "",
    "media4alttext": "",
    "media5alttext": "",
    "media6alttext": "",
    "media7alttext": "",
    "media8alttext": "",
    "media9alttext": "",
    "media10alttext": "",
    "media11alttext": "",
    "shoesize": "",
    "footwaresize": "",
    "footwearsize": "",
    "shoesizes": ""
    }
    }
    },
    "2": {
    "oid": "..."
    },
    "all": "19",
    "time": "2015-09-01 18:09:58"
    }
curl --request GET \
--url 'https://api.suredone.com/v1/orders/all/?sort=payment&page=1' \
--header 'x-auth-token: {auth-token}' \
--header 'x-auth-user: {auth-username}'
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.suredone.com/v1/orders/all/?sort=payment&page=1",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_SSL_VERIFYHOST => false,
CURLOPT_HTTPHEADER => array(
"x-auth-token: {auth-token}",
"x-auth-user: {auth-username}"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
header('Content-Type: application/json');
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
// This example uses package from http://restsharp.org/
var client = new RestClient("https://api.suredone.com/v1/orders/all/?sort=payment&page=1");
var request = new RestRequest(Method.GET);
request.AddHeader("x-auth-token", "{auth-token}");
request.AddHeader("x-auth-user", "{auth-username}");
IRestResponse response = client.Execute(request);
Console.Write(response.Content);
Console.ReadLine();
import http.client
conn = http.client.HTTPSConnection("api.suredone.com")
payload = ''
headers = {
'x-auth-user': "{auth-username}",
'x-auth-token': "{auth-token}"
}
conn.request("GET", "/v1/orders/all/?sort=payment&page=1", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
// This example uses following package
// https://github.com/Mashape/unirest-java
try {
HttpResponse<String> response = Unirest.get("https://api.suredone.com/v1/orders/all/?sort=payment&page=1")
.header("x-auth-user", "{auth-username}")
.header("x-auth-token", "{auth-token}")
.asString();
System.out.print(response.getBody());
} catch(UnirestException e){
e.printStackTrace();
}
var unirest = require("unirest");
var req = unirest("GET", "https://api.suredone.com/v1/orders/all/");
req.query({
"sort": "payment",
"page": "1"
});
req.headers({
"x-auth-token": "{auth-token}",
"x-auth-user": "{auth-username}"
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
require 'uri'
require 'net/http'
url = URI("https://api.suredone.com/v1/orders/all/?sort=payment&page=1")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["x-auth-user"] = '{auth-username}'
request["x-auth-token"] = '{auth-token}'
response = http.request(request)
puts response.read_body
Get Awaiting Orders
/orders/awaiting

Get all orders that have not yet been shipped.

  • Request
  • Headers
    X-Auth-User: {auth-username}
    X-Auth-Token: {auth-token}
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
    "1": {
    "oid": "46",
    "order": "SD1523063605948",
    "date": "2015-08-18 14:17:05",
    "account": "",
    "payment": "Visa",
    "paymenttime": "2015-08-18 08:17:05",
    "transactionid": "ch_6ooWGovpZsyW38",
    "correlationid": "2D64dSgOp8ssE7pw",
    "shipdetails": "",
    "shipcarrier": "USPS",
    "shipservice": "USPS-PRIORITY",
    "shipasgift": "0",
    "shiptracking": "",
    "shipdate": "0000-00-00 00:00:00",
    "shippaid": "0.00",
    "shippedby": "play@suredone.com",
    "total": "1283.94",
    "itemtotal": "1274.99",
    "shippingtotal": "8.95",
    "handlingtotal": "0.00",
    "taxtotal": "0.00",
    "discount": "0.00",
    "code": "",
    "items": "MCH0020",
    "names": "",
    "titles": "Apple® MacBook®Pro/Intel® Core? i7 Processor/13.3\" Display",
    "prices": "1274.99",
    "qtys": "1",
    "media": "https://d3inagkmqs1m6q.cloudfront.net/1021/media-tms/mch0019-431639467.jpg",
    "uris": "apple-macbookpro-intel-core-i7-processor-133-display-mch0020",
    "weights": "4.50",
    "dimweights": "0.00",
    "boxlengths": "0.00",
    "boxwidths": "0.00",
    "boxheights": "0.00",
    "boxweights": "0.00",
    "email": "demo@suredone.com",
    "bcountry": "US",
    "bfirstname": "Test",
    "bminitial": "",
    "blastname": "User",
    "bbusiness": "",
    "baddress1": "115 E 23rd St",
    "baddress2": "",
    "baddress3": "",
    "bcity": "New York",
    "bstate": "NY",
    "bzip": "10010",
    "bphone": "877-675-7355",
    "bphone2": "",
    "shiplocation": "BillingAddress",
    "scountry": "US",
    "sfirstname": "Test",
    "sminitial": "",
    "slastname": "User",
    "sbusiness": "",
    "saddress1": "115 E 23rd St",
    "saddress2": "",
    "saddress3": "",
    "scity": "New York",
    "sstate": "NY",
    "szip": "10010",
    "sphone": "877-675-7355",
    "comments": "",
    "internalnotes": "",
    "returnitems": "",
    "returnreason": "",
    "returnid": "",
    "returntotal": "0.00",
    "returndate": "0000-00-00 00:00:00",
    "dateupdated": "2015-08-28 17:02:15",
    "bstatename": "New York",
    "bcountryname": "UNITED STATES",
    "sstatename": "New York",
    "scountryname": "UNITED STATES",
    "shipauth": true,
    "stockby": "stock",
    "item": {
    "0": {
    "guid": "MCH0020",
    "order_qty": 1,
    "order_price": 1274.99,
    "sku": "MCH0020",
    "stock": "9",
    "price": "1274.99",
    "msrp": "0.00",
    "cost": "0.00",
    "title": "Apple® MacBook®Pro/Intel® Core? i7 Processor/13.3\" Display",
    "size": "",
    "color": "",
    "condition": "",
    "brand": "apple",
    "style": "",
    "upc": "",
    "weight": "4.50",
    "dimweight": "0.00",
    "boxlength": "0.00",
    "boxwidth": "0.00",
    "boxheight": "0.00",
    "boxweight": "0.00",
    "state": "stock",
    "status": "publish",
    "ebayepid": "",
    "amznstockfba": "2",
    "bulletpoint1": "",
    "bulletpoint2": "",
    "bulletpoint3": "",
    "bulletpoint4": "",
    "bulletpoint5": "",
    "department": "",
    "partnumber": "",
    "mpn": "",
    "carrier": "",
    "width": null,
    "amznminage": null,
    "amznmaxage": null,
    "amznexemption": null,
    "memory": "",
    "minstock": "",
    "sizemens": "",
    "amznminstock": "",
    "amznmaxstock": "",
    "fitmentnotes": "",
    "sproket": "",
    "model": "",
    "flavor": "",
    "vendor1stock": "0",
    "vendorsku": "",
    "media1alttext": "",
    "media2alttext": "",
    "media3alttext": "",
    "media4alttext": "",
    "media5alttext": "",
    "media6alttext": "",
    "media7alttext": "",
    "media8alttext": "",
    "media9alttext": "",
    "media10alttext": "",
    "media11alttext": "",
    "shoesize": "",
    "footwaresize": "",
    "footwearsize": "",
    "shoesizes": ""
    }
    }
    },
    "2": {
    "oid": "..."
    },
    "all": "16",
    "time": "2015-09-01 18:25:58"
    }
curl --request GET \
--url https://api.suredone.com/v1/orders/awaiting \
--header 'x-auth-token: {auth-token}' \
--header 'x-auth-user: {auth-username}'
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.suredone.com/v1/orders/awaiting",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_SSL_VERIFYHOST => false,
CURLOPT_HTTPHEADER => array(
"x-auth-token: {auth-token}",
"x-auth-user: {auth-username}"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
header('Content-Type: application/json');
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
// This example uses package from http://restsharp.org/
var client = new RestClient("https://api.suredone.com/v1/orders/awaiting");
var request = new RestRequest(Method.GET);
request.AddHeader("x-auth-token", "{auth-token}");
request.AddHeader("x-auth-user", "{auth-username}");
IRestResponse response = client.Execute(request);
Console.Write(response.Content);
Console.ReadLine();
import http.client
conn = http.client.HTTPSConnection("api.suredone.com")
payload = ''
headers = {
'x-auth-user': "{auth-username}",
'x-auth-token': "{auth-token}"
}
conn.request("GET", "/v1/orders/awaiting", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
// This example uses following package
// https://github.com/Mashape/unirest-java
try {
HttpResponse<String> response = Unirest.get("https://api.suredone.com/v1/orders/awaiting")
.header("x-auth-user", "{auth-username}")
.header("x-auth-token", "{auth-token}")
.asString();
System.out.print(response.getBody());
} catch(UnirestException e){
e.printStackTrace();
}
var unirest = require("unirest");
var req = unirest("GET", "https://api.suredone.com/v1/orders/awaiting");
req.headers({
"x-auth-token": "{auth-token}",
"x-auth-user": "{auth-username}"
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
require 'uri'
require 'net/http'
url = URI("https://api.suredone.com/v1/orders/awaiting")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["x-auth-user"] = '{auth-username}'
request["x-auth-token"] = '{auth-token}'
response = http.request(request)
puts response.read_body
Get Shipped Orders
/orders/shipped

Get all shipped orders. An order is conidered shipped if it has a shipdate.

  • Request
  • Headers
    X-Auth-User: {auth-username}
    X-Auth-Token: {auth-token}
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
    "1": {
    "oid": "46",
    "order": "SD1523063605948",
    "date": "2015-08-18 14:17:05",
    "account": "",
    "payment": "Visa",
    "paymenttime": "2015-08-18 08:17:05",
    "transactionid": "ch_6ooWGovpZsyW38",
    "correlationid": "2D64dSgOp8ssE7pw",
    "shipdetails": "",
    "shipcarrier": "USPS",
    "shipservice": "USPS-PRIORITY",
    "shipasgift": "0",
    "shiptracking": "",
    "shipdate": "2015-09-01 18:24:02",
    "shippaid": "0.00",
    "shippedby": "play@suredone.com",
    "total": "1283.94",
    "itemtotal": "1274.99",
    "shippingtotal": "8.95",
    "handlingtotal": "0.00",
    "taxtotal": "0.00",
    "discount": "0.00",
    "code": "",
    "items": "MCH0020",
    "names": "",
    "titles": "Apple® MacBook®Pro/Intel® Core? i7 Processor/13.3\" Display",
    "prices": "1274.99",
    "qtys": "1",
    "media": "https://d3inagkmqs1m6q.cloudfront.net/1021/media-tms/mch0019-431639467.jpg",
    "uris": "apple-macbookpro-intel-core-i7-processor-133-display-mch0020",
    "weights": "4.50",
    "dimweights": "0.00",
    "boxlengths": "0.00",
    "boxwidths": "0.00",
    "boxheights": "0.00",
    "boxweights": "0.00",
    "email": "demo@suredone.com",
    "bcountry": "US",
    "bfirstname": "Test",
    "bminitial": "",
    "blastname": "User",
    "bbusiness": "",
    "baddress1": "115 E 23rd St",
    "baddress2": "",
    "baddress3": "",
    "bcity": "New York",
    "bstate": "NY",
    "bzip": "10010",
    "bphone": "877-675-7355",
    "bphone2": "",
    "shiplocation": "BillingAddress",
    "scountry": "US",
    "sfirstname": "Test",
    "sminitial": "",
    "slastname": "User",
    "sbusiness": "",
    "saddress1": "115 E 23rd St",
    "saddress2": "",
    "saddress3": "",
    "scity": "New York",
    "sstate": "NY",
    "szip": "10010",
    "sphone": "877-675-7355",
    "comments": "",
    "internalnotes": "",
    "returnitems": "",
    "returnreason": "",
    "returnid": "",
    "returntotal": "0.00",
    "returndate": "0000-00-00 00:00:00",
    "dateupdated": "2015-08-28 17:02:15",
    "bstatename": "New York",
    "bcountryname": "UNITED STATES",
    "sstatename": "New York",
    "scountryname": "UNITED STATES",
    "shipauth": true,
    "stockby": "stock",
    "item": {
    "0": {
    "guid": "MCH0020",
    "order_qty": 1,
    "order_price": 1274.99,
    "sku": "MCH0020",
    "stock": "9",
    "price": "1274.99",
    "msrp": "0.00",
    "cost": "0.00",
    "title": "Apple® MacBook®Pro/Intel® Core? i7 Processor/13.3\" Display",
    "size": "",
    "color": "",
    "condition": "",
    "brand": "apple",
    "style": "",
    "upc": "",
    "weight": "4.50",
    "dimweight": "0.00",
    "boxlength": "0.00",
    "boxwidth": "0.00",
    "boxheight": "0.00",
    "boxweight": "0.00",
    "state": "stock",
    "status": "publish",
    "ebayepid": "",
    "amznstockfba": "2",
    "bulletpoint1": "",
    "bulletpoint2": "",
    "bulletpoint3": "",
    "bulletpoint4": "",
    "bulletpoint5": "",
    "department": "",
    "partnumber": "",
    "mpn": "",
    "carrier": "",
    "width": null,
    "amznminage": null,
    "amznmaxage": null,
    "amznexemption": null,
    "memory": "",
    "minstock": "",
    "sizemens": "",
    "amznminstock": "",
    "amznmaxstock": "",
    "fitmentnotes": "",
    "sproket": "",
    "model": "",
    "flavor": "",
    "vendor1stock": "0",
    "vendorsku": "",
    "media1alttext": "",
    "media2alttext": "",
    "media3alttext": "",
    "media4alttext": "",
    "media5alttext": "",
    "media6alttext": "",
    "media7alttext": "",
    "media8alttext": "",
    "media9alttext": "",
    "media10alttext": "",
    "media11alttext": "",
    "shoesize": "",
    "footwaresize": "",
    "footwearsize": "",
    "shoesizes": ""
    }
    }
    },
    "2": {
    "oid": "..."
    },
    "all": "3",
    "time": "2015-09-01 18:24:58"
    }
curl --request GET \
--url https://api.suredone.com/v1/orders/shipped \
--header 'x-auth-token: {auth-token}' \
--header 'x-auth-user: {auth-username}'
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.suredone.com/v1/orders/shipped",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_SSL_VERIFYHOST => false,
CURLOPT_HTTPHEADER => array(
"x-auth-token: {auth-token}",
"x-auth-user: {auth-username}"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
header('Content-Type: application/json');
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
// This example uses package from http://restsharp.org/
var client = new RestClient("https://api.suredone.com/v1/orders/shipped");
var request = new RestRequest(Method.GET);
request.AddHeader("x-auth-token", "{auth-token}");
request.AddHeader("x-auth-user", "{auth-username}");
IRestResponse response = client.Execute(request);
Console.Write(response.Content);
Console.ReadLine();
import http.client
conn = http.client.HTTPSConnection("api.suredone.com")
payload = ''
headers = {
'x-auth-user': "{auth-username}",
'x-auth-token': "{auth-token}"
}
conn.request("GET", "/v1/orders/shipped", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
// This example uses following package
// https://github.com/Mashape/unirest-java
try {
HttpResponse<String> response = Unirest.get("https://api.suredone.com/v1/orders/shipped")
.header("x-auth-user", "{auth-username}")
.header("x-auth-token", "{auth-token}")
.asString();
System.out.print(response.getBody());
} catch(UnirestException e){
e.printStackTrace();
}
var unirest = require("unirest");
var req = unirest("GET", "https://api.suredone.com/v1/orders/shipped");
req.headers({
"x-auth-token": "{auth-token}",
"x-auth-user": "{auth-username}"
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
require 'uri'
require 'net/http'
url = URI("https://api.suredone.com/v1/orders/shipped")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["x-auth-user"] = '{auth-username}'
request["x-auth-token"] = '{auth-token}'
response = http.request(request)
puts response.read_body
Search Orders
/search/orders/{field1}:={value1} {field2}:<{value2}

Search orders by one or more conditions with each condition being separated by a space. The example below is searching for all itmes where shipcarrier is equal to UPS and total is less than 61.

  • Parameters
  • field1
    string (required) Example: shipcarrier
    value1
    string (required) Example: UPS
    field2
    string (optional) Example: total
    value2
    string (optional) Example: 61
  • Request
  • Headers
    X-Auth-User: {auth-username}
    X-Auth-Token: {auth-token}
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
    "1": {
    "oid": "28",
    "order": "SD13097689151690",
    "date": "2015-09-01 20:47:24",
    "account": "",
    "payment": "",
    "paymenttime": "2015-09-01 20:47:24",
    "transactionid": "",
    "correlationid": "",
    "shipdetails": "",
    "shipcarrier": "UPS",
    "shipservice": "",
    "shipasgift": "0",
    "shiptracking": "1Z9999999999999999",
    "shipdate": "0000-00-00 00:00:00",
    "shippaid": "0.00",
    "shippedby": "",
    "total": "60.00",
    "itemtotal": "0.00",
    "shippingtotal": "0.00",
    "handlingtotal": "0.00",
    "taxtotal": "0.00",
    "discount": "0.00",
    "code": "",
    "items": "0305*NikeKXE",
    "names": "",
    "titles": "shaneprod1*Busa Fairing Set",
    "prices": "55.00*499.00",
    "qtys": "1*1",
    "media": "",
    "uris": "shaneprod1-0305*fairings",
    "weights": "0.00*0.00",
    "dimweights": "0.00*0.00",
    "boxlengths": "0.00*0.00",
    "boxwidths": "0.00*0.00",
    "boxheights": "0.00*0.00",
    "boxweights": "0.00*0.00",
    "email": "john@testdomain.com",
    "bcountry": "",
    "bfirstname": "",
    "bminitial": "",
    "blastname": "",
    "bbusiness": "",
    "baddress1": "",
    "baddress2": "",
    "baddress3": "",
    "bcity": "",
    "bstate": "",
    "bzip": "",
    "bphone": "",
    "bphone2": "",
    "shiplocation": "",
    "scountry": "US",
    "sfirstname": "john",
    "sminitial": "",
    "slastname": "smith",
    "sbusiness": "",
    "saddress1": "",
    "saddress2": "",
    "saddress3": "",
    "scity": "",
    "sstate": "",
    "szip": "",
    "sphone": "",
    "comments": "",
    "internalnotes": "",
    "returnitems": "",
    "returnreason": "",
    "returnid": "",
    "returntotal": "0.00",
    "returndate": "0000-00-00 00:00:00",
    "dateupdated": "2015-09-01 21:26:46",
    "bcountryname": "",
    "sstatename": "",
    "scountryname": "UNITED STATES",
    "shipauth": true,
    "item": {
    "0": {
    "guid": "0305",
    "order_qty": 1,
    "order_price": 55,
    "sku": "0305",
    "stock": "4",
    "price": "55.00",
    "msrp": "0.00",
    "cost": "0.00",
    "title": "shaneprod1",
    "size": "",
    "color": "",
    "condition": "",
    "brand": "",
    "style": "",
    "upc": "",
    "weight": "0.00",
    "dimweight": "0.00",
    "boxlength": "0.00",
    "boxwidth": "0.00",
    "boxheight": "0.00",
    "boxweight": "0.00",
    "state": "stock",
    "status": "publish",
    "bulletpoint2": "",
    "bulletpoint3": "",
    "bulletpoint4": "",
    "bulletpoint5": "",
    "bulletpoint1": ""
    },
    "1": {
    "guid": "NikeKXE",
    "order_qty": 1,
    "order_price": 499,
    "sku": "NikeKXE",
    "stock": "0",
    "price": "499.00",
    "msrp": "0.00",
    "cost": "0.00",
    "title": "Busa Fairing Set",
    "size": "",
    "color": "",
    "condition": "New",
    "brand": "",
    "style": "",
    "upc": "",
    "weight": "0.00",
    "dimweight": "0.00",
    "boxlength": "0.00",
    "boxwidth": "0.00",
    "boxheight": "0.00",
    "boxweight": "0.00",
    "state": "stock",
    "status": "publish",
    "bulletpoint2": "",
    "bulletpoint3": "",
    "bulletpoint4": "",
    "bulletpoint5": "",
    "bulletpoint1": ""
    }
    }
    },
    "all": "1",
    "time": "2015-09-01 21:48:21",
    "type": "orders"
    }
curl --request GET \
--url 'https://api.suredone.com/v1/search/orders/shipcarrier:=UPS%20total:&lt;61' \
--header 'x-auth-token: {auth-token}' \
--header 'x-auth-user: {auth-username}'
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.suredone.com/v1/search/orders/shipcarrier:=UPS%20total:&lt;61",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_SSL_VERIFYHOST => false,
CURLOPT_HTTPHEADER => array(
"x-auth-token: {auth-token}",
"x-auth-user: {auth-username}"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
header('Content-Type: application/json');
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
// This example uses package from http://restsharp.org/
var client = new RestClient("https://api.suredone.com/v1/search/orders/shipcarrier:=UPS%20total:&lt;61");
var request = new RestRequest(Method.GET);
request.AddHeader("x-auth-token", "{auth-token}");
request.AddHeader("x-auth-user", "{auth-username}");
IRestResponse response = client.Execute(request);
Console.Write(response.Content);
Console.ReadLine();
import http.client
conn = http.client.HTTPSConnection("api.suredone.com")
payload = ''
headers = {
'x-auth-user': "{auth-username}",
'x-auth-token': "{auth-token}"
}
conn.request("GET", "/v1/search/orders/shipcarrier:=UPS%20total:&lt;61", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
// This example uses following package
// https://github.com/Mashape/unirest-java
try {
HttpResponse<String> response = Unirest.get("https://api.suredone.com/v1/search/orders/shipcarrier:=UPS%20total:&lt;61")
.header("x-auth-user", "{auth-username}")
.header("x-auth-token", "{auth-token}")
.asString();
System.out.print(response.getBody());
} catch(UnirestException e){
e.printStackTrace();
}
var unirest = require("unirest");
var req = unirest("GET", "https://api.suredone.com/v1/search/orders/shipcarrier:=UPS%20total:&lt;61");
req.headers({
"x-auth-token": "{auth-token}",
"x-auth-user": "{auth-username}"
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
require 'uri'
require 'net/http'
url = URI("https://api.suredone.com/v1/search/orders/shipcarrier:=UPS%20total:&lt;61")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Get.new(url)
request["x-auth-user"] = '{auth-username}'
request["x-auth-token"] = '{auth-token}'
response = http.request(request)
puts response.read_body
Add Order
/orders/add

Create a new order. Below is an example of a basic order. You can get a full list of supported fields for your account by retrieving an order via the api and inspecting the returned object.

Note: the field sold, when set to true will reconcile inventory based on the quantity sold across all active channels. Leave this field out if you do not wish to reconcile inventory.

  • Parameters
  • order
    string (required) Example: SD13097689151690
    total
    int (optional) Example: 60
    email
    string (optional) Example: john@testdomain.com
    scountry
    string (required) Example: US
    slastname
    string (required) Example: smith
    sfirstname
    string (optional) Example: john
    items
    string (optional) Example: 0305*NikeKXE

    a star (*) delimited list of guids in the order

    qtys
    string (optional) Example: 1*1

    a star (*) delimited list of quanitites sold for each item listed above, make sure that index of the item matches the coresponding index in qtys

    sold
    string (optional) Example: true

    see note above

  • Request
  • Headers
    Content-Type: application/x-www-form-urlencoded
    X-Auth-User: {auth-username}
    X-Auth-Token: {auth-token}
    Body
    order=SD13097689151690&total=60&email=john@testdomain.com&scountry=US&slastname=smith&sfirstname=john&items=0305*NikeKXE&qtys=1*1&sold=true
    
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
    "result": "success",
    "message": "2015-09-01 20:47:24",
    "order": "SD13097689151690",
    "time": "2015-09-01 20:47:24"
    }
curl --request POST \
--url https://api.suredone.com/v1/orders/add \
--header 'content-type: application/x-www-form-urlencoded' \
--header 'x-auth-token: {auth-token}' \
--header 'x-auth-user: {auth-username}' \
--data 'order=SD13097689151690&total=60&email=john%40testdomain.com&scountry=US&slastname=smith&sfirstname=john&items=0305*NikeKXE&qtys=1*1&sold=true'
<?php
$curl = curl_init();
$postFields = array(
'order' => 'SD13097689151690',
'total' => '60',
'email' => 'john@testdomain.com',
'scountry' => 'US',
'slastname' => 'smith',
'sfirstname' => 'john',
'items' => '0305*NikeKXE',
'qtys' => '1*1',
'sold' => json_encode(null)
);
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.suredone.com/v1/orders/add",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_SSL_VERIFYHOST => false,
CURLOPT_POSTFIELDS => $postFields,
CURLOPT_HTTPHEADER => array(
"content-type: application/x-www-form-urlencoded",
"x-auth-token: {auth-token}",
"x-auth-user: {auth-username}"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
header('Content-Type: application/json');
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
// This example uses package from http://restsharp.org/
var client = new RestClient("https://api.suredone.com/v1/orders/add");
var request = new RestRequest(Method.POST);
request.AddHeader("x-auth-token", "{auth-token}");
request.AddHeader("x-auth-user", "{auth-username}");
request.AddHeader("content-type", "application/x-www-form-urlencoded");
Hashtable postData = new Hashtable();
postData["order"] = "SD13097689151690";
postData["total"] = "60";
postData["email"] = "john@testdomain.com";
postData["scountry"] = "US";
postData["slastname"] = "smith";
postData["sfirstname"] = "john";
postData["items"] = "0305*NikeKXE";
postData["qtys"] = "1*1";
postData["sold"] = "true";
// Convert post array into multipart/form-data payload
String formBoundary = "undefined";
String payload = "";
foreach (DictionaryEntry entry in postData){
payload += "--" + formBoundary + "\r\n" + "Content-Disposition: form-data; name=" + entry.Key.ToString() + "\r\n\r\n" + entry.Value.ToString() + "\r\n";
}
payload += "--" + formBoundary + "--";
request.AddParameter("application/x-www-form-urlencoded", payload, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.Write(response.Content);
Console.ReadLine();
import http.client
conn = http.client.HTTPSConnection("api.suredone.com")
payload = ''
postData = {}
postData['order'] = "SD13097689151690"
postData['total'] = "60"
postData['email'] = "john@testdomain.com"
postData['scountry'] = "US"
postData['slastname'] = "smith"
postData['sfirstname'] = "john"
postData['items'] = "0305*NikeKXE"
postData['qtys'] = "1*1"
postData['sold'] = "true"
#Convert post array into multipart/form-data payload
formBoundary = 'undefined'
for k,v in postData.items():
v = v.replace('\n','')
payload += '--'+ formBoundary +"\r\n"+'Content-Disposition: form-data; name='+k+"\r\n\r\n"+v+"\r\n"
payload += '--'+ formBoundary + '--'
headers = {
'content-type': "application/x-www-form-urlencoded",
'x-auth-user': "{auth-username}",
'x-auth-token': "{auth-token}"
}
conn.request("POST", "/v1/orders/add", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
// This example uses following package
// https://github.com/Mashape/unirest-java
HashMap<String, String> postData = new HashMap<String, String>();
postData.put("order","SD13097689151690");
postData.put("total","60");
postData.put("email","john@testdomain.com");
postData.put("scountry","US");
postData.put("slastname","smith");
postData.put("sfirstname","john");
postData.put("items","0305*NikeKXE");
postData.put("qtys","1*1");
postData.put("sold","true");
String postBody = "";
String formBoundary = "undefined";
for (Entry<String, String> entry : postData.entrySet()) {
String key = entry.getKey();
Object value = entry.getValue();
postBody += "--"+ formBoundary +"\r\n"+"Content-Disposition: form-data; name="+key+"\r\n\r\n"+value.toString()+"\r\n";
}
try {
HttpResponse<String> response = Unirest.post("https://api.suredone.com/v1/orders/add")
.header("content-type", "application/x-www-form-urlencoded")
.header("x-auth-user", "{auth-username}")
.header("x-auth-token", "{auth-token}")
.body( postBody )
.asString();
System.out.print(response.getBody());
} catch(UnirestException e){
e.printStackTrace();
}
var unirest = require("unirest");
var req = unirest("POST", "https://api.suredone.com/v1/orders/add");
req.headers({
"x-auth-token": "{auth-token}",
"x-auth-user": "{auth-username}",
"content-type": "application/x-www-form-urlencoded"
});
req.form({
"order": "SD13097689151690",
"total": "60",
"email": "john@testdomain.com",
"scountry": "US",
"slastname": "smith",
"sfirstname": "john",
"items": "0305*NikeKXE",
"qtys": "1*1",
"sold": "true"
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
require 'uri'
require 'net/http'
url = URI("https://api.suredone.com/v1/orders/add")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/x-www-form-urlencoded'
request["x-auth-user"] = '{auth-username}'
request["x-auth-token"] = '{auth-token}'
request.body = "order=SD13097689151690&total=60&email=john%40testdomain.com&scountry=US&slastname=smith&sfirstname=john&items=0305*NikeKXE&qtys=1*1&sold=true"
response = http.request(request)
puts response.read_body
Fulfill Order
/orders/edit

Fulfill an order by sending in tracking information. Multiple tracking numbers should be delimited with a * or ,. SureDone also uses the shiptracking field to determine the order’s status. These reserved codes will not be treated like a normal tracking number. They each have a special meaning in the system and are specified below.

  • Parameters
  • order
    string (required) Example: SD13097689151690
    shipcarrier
    string (required) Example: UPS
    shiptracking
    string (required) Example: 1Z9999999999999999
    • NOTRACKING

    • REFUNDED | CANCELED

    • PICKUP used for cash on hand orders

    • INCOMPLETE used for orders missing information

    • PENDING used for orders that have been exported for processing

    • ORDERED used for orders that have been exported for processing and have been acknowledged

    • SHIPPED used to mark an order as shipped but does not have a tracking number

    • DROPSHIPPED used to mark an order as dropshipped but does not have a tracking number yet (similar to ORDERED)

    shipdate
    string (required) Example: 2015-08-30 00:54:20

    should be in UTC and in the format YYYY-MM-DD hh:mm:ss

  • Request
  • Headers
    Content-Type: application/x-www-form-urlencoded
    X-Auth-User: {auth-username}
    X-Auth-Token: {auth-token}
    Body
    order=SD13097689151690&shipcarrier=UPS&shiptracking=1Z9999999999999999&shipdate:2015-08-30 00:54:20
    
  • Response  200
  • Headers
    Content-Type: application/json
    Body
    {
    "result": "success",
    "message": null,
    "order": "SD13097689151690",
    "time": "2015-09-01 21:26:47"
    }
curl --request POST \
--url https://api.suredone.com/v1/orders/edit \
--header 'content-type: application/x-www-form-urlencoded' \
--header 'x-auth-token: {auth-token}' \
--header 'x-auth-user: {auth-username}' \
--data 'order=SD13097689151690&shipcarrier=UPS&shiptracking=1Z9999999999999999&shipdate=2015-08-30%2000%3A54%3A20'
<?php
$curl = curl_init();
$postFields = array(
'order' => 'SD13097689151690',
'shipcarrier' => 'UPS',
'shiptracking' => '1Z9999999999999999',
'shipdate' => '2015-08-30 00:54:20'
);
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.suredone.com/v1/orders/edit",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_SSL_VERIFYPEER => false,
CURLOPT_SSL_VERIFYHOST => false,
CURLOPT_POSTFIELDS => $postFields,
CURLOPT_HTTPHEADER => array(
"content-type: application/x-www-form-urlencoded",
"x-auth-token: {auth-token}",
"x-auth-user: {auth-username}"
),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
header('Content-Type: application/json');
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
// This example uses package from http://restsharp.org/
var client = new RestClient("https://api.suredone.com/v1/orders/edit");
var request = new RestRequest(Method.POST);
request.AddHeader("x-auth-token", "{auth-token}");
request.AddHeader("x-auth-user", "{auth-username}");
request.AddHeader("content-type", "application/x-www-form-urlencoded");
Hashtable postData = new Hashtable();
postData["order"] = "SD13097689151690";
postData["shipcarrier"] = "UPS";
postData["shiptracking"] = "1Z9999999999999999";
postData["shipdate"] = "2015-08-30 00:54:20";
// Convert post array into multipart/form-data payload
String formBoundary = "undefined";
String payload = "";
foreach (DictionaryEntry entry in postData){
payload += "--" + formBoundary + "\r\n" + "Content-Disposition: form-data; name=" + entry.Key.ToString() + "\r\n\r\n" + entry.Value.ToString() + "\r\n";
}
payload += "--" + formBoundary + "--";
request.AddParameter("application/x-www-form-urlencoded", payload, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.Write(response.Content);
Console.ReadLine();
import http.client
conn = http.client.HTTPSConnection("api.suredone.com")
payload = ''
postData = {}
postData['order'] = "SD13097689151690"
postData['shipcarrier'] = "UPS"
postData['shiptracking'] = "1Z9999999999999999"
postData['shipdate'] = "2015-08-30 00:54:20"
#Convert post array into multipart/form-data payload
formBoundary = 'undefined'
for k,v in postData.items():
v = v.replace('\n','')
payload += '--'+ formBoundary +"\r\n"+'Content-Disposition: form-data; name='+k+"\r\n\r\n"+v+"\r\n"
payload += '--'+ formBoundary + '--'
headers = {
'content-type': "application/x-www-form-urlencoded",
'x-auth-user': "{auth-username}",
'x-auth-token': "{auth-token}"
}
conn.request("POST", "/v1/orders/edit", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
// This example uses following package
// https://github.com/Mashape/unirest-java
HashMap<String, String> postData = new HashMap<String, String>();
postData.put("order","SD13097689151690");
postData.put("shipcarrier","UPS");
postData.put("shiptracking","1Z9999999999999999");
postData.put("shipdate","2015-08-30 00:54:20");
String postBody = "";
String formBoundary = "undefined";
for (Entry<String, String> entry : postData.entrySet()) {
String key = entry.getKey();
Object value = entry.getValue();
postBody += "--"+ formBoundary +"\r\n"+"Content-Disposition: form-data; name="+key+"\r\n\r\n"+value.toString()+"\r\n";
}
try {
HttpResponse<String> response = Unirest.post("https://api.suredone.com/v1/orders/edit")
.header("content-type", "application/x-www-form-urlencoded")
.header("x-auth-user", "{auth-username}")
.header("x-auth-token", "{auth-token}")
.body( postBody )
.asString();
System.out.print(response.getBody());
} catch(UnirestException e){
e.printStackTrace();
}
var unirest = require("unirest");
var req = unirest("POST", "https://api.suredone.com/v1/orders/edit");
req.headers({
"x-auth-token": "{auth-token}",
"x-auth-user": "{auth-username}",
"content-type": "application/x-www-form-urlencoded"
});
req.form({
"order": "SD13097689151690",
"shipcarrier": "UPS",
"shiptracking": "1Z9999999999999999",
"shipdate": "2015-08-30 00:54:20"
});
req.end(function (res) {
if (res.error) throw new Error(res.error);
console.log(res.body);
});
require 'uri'
require 'net/http'
url = URI("https://api.suredone.com/v1/orders/edit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE
request = Net::HTTP::Post.new(url)
request["content-type"] = 'application/x-www-form-urlencoded'
request["x-auth-user"] = '{auth-username}'
request["x-auth-token"] = '{auth-token}'
request.body = "order=SD13097689151690&shipcarrier=UPS&shiptracking=1Z9999999999999999&shipdate=2015-08-30%2000%3A54%3A20"
response = http.request(request)
puts response.read_body

Generated on 03 Sep 2015

Learn More

Fill in your details below and a representative will contact you to discuss your needs.


View Demo

Fill in your details below to access the demo.