Sales Tax APIRefunds

Refund order

Create a refund against an order. An order can only be refunded once, regardless of whether the order is partially or fully refunded.

Path parameters

connectionIdstringRequired>=36 characters
represents the ID of a connection. It is used as a unique identifier for the connection
orderIdstringRequired
the id of the order to refund against

Headers

X-API-KEYstringRequired

Request

This endpoint expects an object.
itemslist of objectsOptional
represents the items of the refund request, if an empty lists or no lists is passed it is assumed the entire order will be refunded.
returnedDatestringOptionalformat: "date-time"

include only if this return is a change to a previously filed sales tax return, will trigger an Amended Sales Tax Return. (Not typically recommended to include.)

Response

Created
connectionIdstring>=36 characters
represents the ID of a connection. It is used as a unique identifier for the connection
itemslist of objects
createdDatestring or nullformat: "date-time"
represents the time when the refund was created.
returnedDatestring or nullformat: "date-time"
represents the time when the refund took effect.

Errors