Overwrite an existing ReturnedItem

put

https://api-sandbox-revel.revelup.com/resources/ReturnedItem/{ReturnedItemId}/

Overwrites a specific ReturnedItem API object

Path Params

ReturnedItemId

int64

required

ID of ReturnedItem to update

Body Params

new ReturnedItem object

inventory_cost

string

Numerical value representing the inventory cost per returned unit. Stores 4 decimal places and can contain up to 16 digits.

inventory_update

boolean

Defaults to false

Flag. If set to True, will update the current inventory cost to account for the item return.

product

uri

required

Expects URI of a Product resource. Specifies the product that is being returned to inventory.

product_price

float

required

Numerical value representing the price of the product at the time of the original sale.

quantity

integer

Numerical value representing how many of the specified products should be returned to the inventory.

return_value

float

required

Numerical value representing the price at which the products will be returned. Can be set arbitrarily and will determine how much the customer gets in return.

returns

uri

required

Expects URI of a Return API object. Specifies the return lot this return item is part of.

serial_number

string

Serial number of the returned item. Supports up to 256 characters.

tax

float

required

Numerical value representing the taxed amount of the return value. The customer is refunded the return value and the tax amount.

tax_included

boolean

Flag. If set to True, will assume the tax amount is already part of the return value total. If set to False, the tax amount will be added to the return value total when calculating how much the customer should be refunded.

tax_rate

float

Numerical value representing the current tax rate by which the tax amount should be calculated.

weight

float

Numerical value used to represent the weight of products that are sold by weight. Used the same way as the quantity field when part of calculations.

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

ReturnedItem 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.