Stock Adjustment

StockAdjustment

adjustment_type
string
archived_at
string or null <date-time>
comment
string or null
created_at
string <date-time>
id
string <int64>
object
object
quantity
integer or null
updated_at
string <date-time>
object
{}

List stock adjustments

get/stock_adjustments
SecuritybasicAuth
Request
query Parameters
order
string
Deprecated
Enum: "asc" "desc"
page
integer
per_page
integer [ 1 .. 100 ]
q[]
Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value Format
archived_at date-time
created_at date-time
id int64
product_id int64
updated_at date-time
sort
Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc
Responses
200

successful operation

Request samples 
Response samples 
application/json
{}
Create stock adjustment
post/stock_adjustments
SecuritybasicAuth 
Request 
Request Body schema: application/json
adjustment_type
string
The reason for modifying the stock level.


Increase types: Stock Purchase, Returned, Other


Decrease types: Damaged, Out of Date, Item Sold, Other


 Enum: "Stock Purchase" "Returned" "Other" "Damaged" "Out of Date" "Item Sold"  
comment
string or null
 
product_id
string <int64> 
The existing product you want to adjust the stock level of.


 
quantity
integer or null
A negative value is only allowed when a decreasing adjustment type has been selected and vice versa.


 
Responses 
201
Resource was created


422
Resource could not be saved due to validation errors


Request samples 
application/json
{
  • "quantity": 0,
  • "adjustment_type": "Stock Purchase",
  • "comment": "string",
  • "product_id": "1"
}
Response samples 
application/json
{}
Get stock adjustment
get/stock_adjustments/{id}
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
query Parameters
q[]
Array of strings
Filter result by one or more fields.


See Filtering Results


Available filters:






Value
Format





archived_at
date-time





 
Responses 
200
Successful operation


Request samples 
Response samples 
application/json
{}