Update ReturnedItem by ID

Updates a single ReturnedItem object

Log in to see full request history
Path Params
int64
required

ID of ReturnedItem to update

Body Params

ReturnedItem data that needs to be changed

string

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

boolean
Defaults to false

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

uri
required

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

float
required

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

integer

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

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.

uri
required

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

string

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

float
required

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

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.

float

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

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

301

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

400

Invalid input - please run the request body through a JSON validator.

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 - an invalid value was provided for one of the fields.

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json