API

Docs and API's for Weasy.io

Orders

Manage all the shopping cart orders from your website.

Accepts GET PUT DELETE

All requests to the API must be authenticated with an API key on the HTTP Authorization header.

GET

Get all orders headers or order detail from your shopping carts

GET/orders/{?limit,page,since,status}

GET/orders/:id|trackingCode

Request example

~ curl -i -X GET \
-H 'X-API-KEY:xsFPVLn7aOllXixPDaGBgCZpyTmyX7G6CniNtKD' \
-H 'Content-Type:application/json' \
https://api.weasy.io/v1/orders

Body response example [ HTTP CODE: 200 ]

{  
   "items":[  
      {  
         "id":"1",
         "paymentRefGenerated":"",
         "invoiceProvider":0,
         "invoiceNumber":"",
         "shippingTrackingCode":"",
         "shippingCarrierID":0,
         "statusChangeCustomerNote":null,
         "trackingCode":"PS13DBA0",
         "taxIncluded":1,
         "ep_link":"",
         "ep_visa_key":"",
         "storePickUP":0,
         "refundDate":null,
         "viewed":0,
         "source":"pos",
         "enableWarningExpiredOrdersLevel":0,
         "status":"Finalizada",
         "paymentTypeID":0,
         "orderDate":"2018-03-21 22:06:02",
         "paymentDate":"0000-00-00 00:00:00",
         "orderValue":274.77,
         "discountValue":0,
         "paymentTypeFee":0,
         "upfrontPaymentValue":0,
         "shippingFees":0,
         "extraPaymentValue":0,
         "taxes":51.38,
         "weight":0,
         "discountVoucher":"",
         "observations":"",
         "idCustomer":13,
         "billing":{  
            "name":"John Smile",
            "address":"Hollywood Street",
            "zipCode":"50000",
            "city":"New York",
            "country":"us",
            "email":"user@weasy.io",
            "telephone":"123456789",
            "vatnumber":"999999999"
         },
         "shipping":{  
            "name":"John Smile",
            "address":"Hollywood Street",
            "zipCode":"50000",
            "city":"New York",
            "country":"us"
         },
         "visitorLanguage":"en",
         "refundDate":null,
         "refundTaxValue":0,
         "emailNotification":0,
         "parcialPaymentValue":0
      },
      ...
   ],
   "paging":{  
      "total":"100",
      "totalpages":4,
      "previous":"https://api.weasy.io/v1/orders?limit=25&page=1",
      "next":"https://api.weasy.io/v1/orders?limit=25&page=3"
   }
}

Path parameters

NAME	TYPE	REQUIRED	DESCRIPTION
limit	integer	optional	define items per page
page	integer	optional	define page to display
since	date	optional	filter result starting at defined date date format ISO 8601
status	string	optional	filter result by order status. Comma separator for multiple status options: all the status options can be obtained from the Order Status endpoint

Body attributes

A json payload containing the following attributes.

NAME	TYPE	REQUIRED	DESCRIPTION
lang	string	optional	define the language to show data options: all the iso country codes (ISO 3166-2) obtained from the Languages endpoint

PUT

Change an order status.

PUT/orders/:trackingCode

Request example

~ curl -i -X PUT \
-H 'X-API-KEY:xsFPVLn7aOllXixPDaGBgCZpyTmyX7G6CniNtKD' \
-H 'Content-Type:application/json' \
-d '{"status":"shipped","shippingtracking":"CTT-A3K8F72"}'\
https://api.weasy.io/v1/orders/MB123123

Body response example [ HTTP CODE: 200 ]

{  
   "status":"ok"
}
or
{  
   "status":"error",
   "message":"Unprocessable Entity"
}

Path parameters

NAME	TYPE	REQUIRED	DESCRIPTION
trackingCode	string	required	order tracking code

Body attributes

A json payload containing the following attributes.

NAME	TYPE	REQUIRED	DESCRIPTION
status	string	required	order new status options: order status endpoint /orderstatus
shippingtracking	string	optional	Shipping courier tracking code
shippingCarrierID	integer	optional	Shipping carrier ID The shipping carrier ID can be obtained in the shippingcarriers endpoint
note	string	optional	Used to add a note to the order

DELETE

Delete a order or collection of orders from your orders database.

DELETE/orders

Request example

~ curl -i -X DELETE \
-H 'X-API-KEY:xsFPVLn7aOllXixPDaGBgCZpyTmyX7G6CniNtKD' \
-H 'Content-Type:application/json' \
-d '[1,2]'\
https://api.weasy.io/v1/orders

Body response example [ HTTP CODE: 200 ]

[  
   {  
      "status":"ok",
      "id": 1,
   },
   {  
      "status":"error",
      "id":2,
   }
]

Body attributes

Attribute description
A json payload containing an array of id or ids.