Overwrite an existing Return

put

https://qa2.revelup.com/resources/Return/{ReturnId}/

Overwrites a specific Return API object

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

ReturnId

int64

required

ID of Return to update

Body Params

new Return object

amount

integer

required

Total value of the return, calculated by adding up all the returned item prices. Will be used in reporting to calculate monetary loss caused by returns.

canceled

boolean

Flag. If set to True, the return won't be counted in reporting.

created_by

uri

required

URI of the User API object that created this resource.

created_date

date-time

required

ISO8601 timestamp of the time the resource was created

customer

uri

URI of the Customer API object attached to this return. Usually the same customer as the one on the linked Order resource.

establishment

uri

required

URI of the Establishment API object that this return is created under. Will participate in this establishment's reporting calculations.

order

uri

URI of the Order API object this return was created from, if any. Can be used to easily track which order the returned items were taken from.

payout

uri

URI of a Payout API object. Used when a receiptless return is issued and paid out in cash.

reason

string

required

Text field used to explain the reason behind the return, which is then documented in the Adjustments report. Limited to 2047 characters.

return_date

date-time

required

ISO8601 timestamp of the time the return was executed. If the return is performed on the POS, this can be earlier than the created_date as it uses the local POS timestamp.

return_items

array of objects

List of ReturnedItem API objects representing individual returned items. New ReturnedItems can be attached via PATCH call by providing a URI list instead of the full resource body for each resource.

return_items

tax_country

string

Text field used to represent the current tax country. Validated against an internal list of countries to see if tax should be calculated as part of the amount. Limited to 100 characters.

tender

integer

enum

Integer value representing the way the money was returned. Currently
limited to cash (0) or store credit (1).

Return Tender Types:

0 - RETURN_TENDER_TYPE_CASH
1 - RETURN_TENDER_TYPE_GIFT_CARD

Allowed:

total_tax

integer

required

Sum of all tax fields from the linked ReturnedItem API resources. Used in Tax and Adjustment report calculations.

updated_by

uri

required

URI of the User API object that last made changes to this resource.

updated_date

date-time

required

ISO8601 timestamp of the last time the resource was updated.

Responses

204

Resource successfully updated

301

Invalid request URL - make sure that the URL ends with a trailing slash.

400

Provided JSON body is either invalid or empty

401

Authentication error - make sure the API key & secret is valid, active and provided in the "API-AUTHENTICATION" header.

404

Return not found

445

Message: Integrity Error - either a required field is missing from the request body or an invalid value was provided for one of the fields.

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here!