Return or adjust a previously Captured transaction. [Additional License Required]. Our regular Returned API does not allow you to return (adjust) the original sales price. ReturnedPro enables you to Return a negative quantity, thereby increasing the original sales price (such as when a customer doesn't want to wait for a back-ordered item, and opts for a more expensive product instead).



Request body

The request body takes a complete ReturnedPro resource, containing the following writable properties:

    "apiKey": "string",
    "apiLoginID": "string",
    "cartItems": null,
    "orderID": "string",
    "returnedDate": "date-time"


Name Type Description Additional
apiKey string

Find your API KEY via

apiLoginID string

Find your API ID via

cartItems[] array Optional
orderID string

This is the immutable Order identifier used by your system to identify unique orders.

returnedDate date-time

The Date/Time the order was returned. IMPORTANT: Returning a previously captured order will create a tax credit which TaxCloud will automatically track and deduct from your next tax remittance.

Although our Returned API requires you to set the ReturnedDate parameter, this should be set to today's date unless you know what you are doing.

TO BE VERY CLEAR: If you provide a returnedDate, such as the original purchase date, and the tax return for that period has already been filed, you will trigger an obligation for TaxCloud (or any tax preparer) to file an Amended Sales Tax Return for that period (and likely any interviening period through current). AMENDED RETURNS INCUR AMENDMENT FEES.



The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK



Explore this API

Request Content-Type
Response Content-Type
Try it out!