Reason Codes
Add Reason Code
post /reasoncodesREQUEST BODY
object
posthttps://api.mysitoo.com/v2/accounts/1500/reasoncodes.json
{ "type": 10, "reasoncode": "103", "name": "Reclaims"}RESPONSE JSON
3| HTTP Status Code Summary | |
|---|---|
| 200 | Returns reasoncodeid |
| 400 | Bad Request. Invalid syntax, missing required argument or invalid request. |
| 401 | Unauthorized. Authorization failed. |
| 404 | Resource not found. The url is invalid. |
| 429 | Too Many Requests. |
| 500 | Internal Server Error. |
Get Reason Codes
get /reasoncodesPARAMETERS
type
array (integer)
query
Filter on type, use comma as separator for multiple types.
Example: /reasoncodes?type=10,20
start
integer
query
The index of the item to start from
Default: 0
num
integer
query
The number of items returned
Default: 10
fields
array (string)
query
Comma separated list of fields to return. Use this to query only the fields you are using. Default is all fields in reasoncode.
Example: /reasoncodes?fields=reasoncodeid,transactiontype,reasoncode,name
gethttps://api.mysitoo.com/v2/accounts/1500/reasoncodes.json?num=2
RESPONSE JSON
{ "totalcount": 2, "items": [ { "reasoncodeid": 1, "type": 10, "reasoncode": "101", "name": "Reclaim" }, { "reasoncodeid": 2, "type": 10, "reasoncode": "102", "name": "Guarantee" } ]}| HTTP Status Code Summary | |
|---|---|
| 200 | Returns an envelope with items of type reasoncode. |
| 400 | Bad Request. Invalid syntax, missing required argument or invalid request. |
| 401 | Unauthorized. Authorization failed. |
| 404 | Resource not found. The url is invalid. |
| 429 | Too Many Requests. |
| 500 | Internal Server Error. |
Get Reason Code
get /reasoncodes/{reasoncodeid}PARAMETERS
reasoncodeid
integer
path
REQUIRED
gethttps://api.mysitoo.com/v2/accounts/1500/reasoncodes/3.json
RESPONSE JSON
{ "reasoncodeid": 3, "type": 10, "reasoncode": "103", "name": "Reclaims"}| HTTP Status Code Summary | |
|---|---|
| 200 | Returns an item of type reasoncode. |
| 400 | Bad Request. Invalid syntax, missing required argument or invalid request. |
| 401 | Unauthorized. Authorization failed. |
| 404 | Resource not found. The url is invalid. |
| 429 | Too Many Requests. |
| 500 | Internal Server Error. |
Update Reason Code
put /reasoncodes/{reasoncodeid}PARAMETERS
reasoncodeid
integer
path
REQUIRED
REQUEST BODY
object
puthttps://api.mysitoo.com/v2/accounts/1500/reasoncodes/3.json
{ "name": "Customer Reclaim"}RESPONSE JSON
true| HTTP Status Code Summary | |
|---|---|
| 200 | Returns true |
| 400 | Bad Request. Invalid syntax, missing required argument or invalid request. |
| 401 | Unauthorized. Authorization failed. |
| 404 | Resource not found. The url is invalid. |
| 429 | Too Many Requests. |
| 500 | Internal Server Error. |
Delete Reason Code
delete /reasoncodes/{reasoncodeid}PARAMETERS
reasoncodeid
integer
path
REQUIRED
deletehttps://api.mysitoo.com/v2/accounts/1500/reasoncodes/3.json
RESPONSE JSON
true| HTTP Status Code Summary | |
|---|---|
| 200 | Returns true |
| 400 | Bad Request. Invalid syntax, missing required argument or invalid request. |
| 401 | Unauthorized. Authorization failed. |
| 404 | Resource not found. The url is invalid. |
| 429 | Too Many Requests. |
| 500 | Internal Server Error. |
Objects
reasoncodeobject
Reason codes are used to label warehouse transactions, events and actions.
PROPERTIES
reasoncodeid
integer
READ ONLY
The unique ID of the reason code.
The type of use for the reason code.
reasoncode
string
REQUIRED
The reason code. (Max 32 characters)
name
string
The display name used for the reason code. (Max 64 characters)
reasoncodetypeinteger
10ManualIn20ManualOut30Sales40Refund50StockTaking60Move70ShipmentIn75ShipmentReceiveItems80ShipmentOut100ItemManualPrice110ItemManualDiscount120ItemRefund130ItemReclaim140CashIn150CashOut160PickupRejected170ClosingCashDiff180SalesTaxExemption