This call is deprecated. We recommend to use Account Administration API instead.
The corresponding new call is: GET /v1/reason-code.
Get a list of reason codes.
| Parameter name | Description | Possible value | Required |
|---|---|---|---|
| purpose | Possible values: "WRITEOFF" - Inventory Write-off, "RETURN" - Return, "DISCOUNT" - Discount, "REGISTRATION" - Inventory registration, "EOD_VARIANCE" - End-of-Day variance, "TAX_EXEMPTION" - Tax exemption, "CASH_IN" - Cash In, "CASH_OUT" - Cash Out, "PROMOTION" - Promotion, "PURCHASE" - Purchase return. | string | |
| recordsOnPage | Number of records API should return. By default 20, at most 100. | integer | |
| pageNo | API returns at most recordsOnPage items at a time. To retrieve the next recordsOnPage items, send a new request with pageNo incremented by one. By default, API returns "page 1". | integer |
| Field name | Type | Description |
|---|---|---|
| reasonID | integer | |
| name | string | |
| purpose | string | Possible values: "WRITEOFF" - Inventory Write-off, "RETURN" - Return, "DISCOUNT" - Discount, "REGISTRATION" - Inventory registration, "EOD_VARIANCE" - End-of-Day variance, "TAX_EXEMPTION" - Tax exemption, "CASH_IN" - Cash In, "CASH_OUT" - Cash Out, "PROMOTION" - Promotion, "PURCHASE" - Purchase return. |
| manualDiscountDisablesPromotionTiers | Array of integers | Reason codes with "DISCOUNT" purpose can disable some promotion tiers from being applied to shopping cart row. |
| added | integer | Unix timestamp. Creation time. |
| lastModified | integer | Unix timestamp. Last modification time. |
| code | string | Reason code |