<- Inventory API

Inventory API

All versions ->

List inventory adjustment reasonsBeta

GET

 /v2/inventory/adjustment-reasons

Returns the standard and custom inventory adjustment reasons available to the seller.

Permissions:INVENTORY_READ
Try in API Explorer
Link to section

Query parameters

Example code

Link to section

include_deleted

boolean

Indicates whether the response should include deleted custom inventory adjustment reasons. The default value is false.

Link to section

include_system_codes

boolean

Indicates whether the response should include Square-generated system inventory adjustment reason codes that cannot be used to write adjustments from the Connect API, such as SALE, RECOUNT, TRANSFER, IN_TRANSIT, and CANCELED_SALE. The default value is false.

Link to section

Response fields

Link to section

errors

Errors encountered when the request fails.

Link to section

adjustment_reasons

The standard, system-generated, and custom inventory adjustment reasons available to the seller.