API

Docs and API's for Weasy.io

Returns

Manage all the shopping cart returns 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 returns headers or returns detail from your e-commerce

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

GET/returns/:id|trackingCode

Request example

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

Body response example [ HTTP CODE: 200 ]

{  
   "items":[  
       {
            "id": "1",
            "trackingCode": "RT0BD8B",
            "status": "Cancelada",
            "date": "2021-01-19 10:01:23",
            "voucherGranted": "",
            "idOrder": "90",
            "orderTrackingNumber": "MB3642A068",
            "viewed": "1",
            "creditNoteNumber": "",
            "creditNoteProvider": "",
            "closeType": "1",
            "amountToReturn": "500",
            "currency": "eur"
        },
        {
            "id": "2",
            "trackingCode": "RT04A7B",
            "status": "Pendente",
            "date": "2021-01-19 11:01:12",
            "voucherGranted": "",
            "idOrder": "91",
            "orderTrackingNumber": "MB364241A1",
            "viewed": "0",
            "creditNoteNumber": "",
            "creditNoteProvider": "",
            "closeType": "0",
            "amountToReturn": "1000",
            "currency": "eur"
        },
      ...
   ],
   "paging":{  
      "total":"100",
      "totalpages":4,
      "previous":"https://api.weasy.io/v1/returns?limit=25&page=1",
      "next":"https://api.weasy.io/v1/returns?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 a return status.

PUT/returns/: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/returns/MB123123

Body response example [ HTTP CODE: 200 ]

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

Path parameters

NAME	TYPE	REQUIRED	DESCRIPTION
trackingCode	string	required	return tracking code

Body attributes

A json payload containing the following attributes.

NAME	TYPE	REQUIRED	DESCRIPTION
status	string	required	order new status options: Finished Canceled Pending Waiting
refundType	string	required if status = "Finalizada" (finished)	Return refund type options: 1 for Exchange product 2 for Cash Refund 3 for Voucher

DELETE

Delete a ret or collection of returns from your returns database.

DELETE/returns

Request example

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

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.