List stock adjustment reasons

GET/v1/api/store/{team_slug}/setting/adjustment_reason

v1Operation ID v1_public_adjustment_reason_index

Returns all the team's stock adjustment reasons in one list, on and off. This only manages the reasons: stock adjustments, stock takes and transfers are not part of the public API.

Reasons offered when someone adjusts stock by hand, such as Damaged or Stocktake. A stock adjustment stores the reason as text, so renaming or deleting a reason doesn't change past adjustments. Every team starts with YoPrint's built-in reasons (system: true): New Products, Returned, Production of Goods, Damaged, Shrinkage, Promotion and Stocktake.

Permission

Any team member can call it. Reading needs no extra permission.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team

Request body

This operation takes no request body.

Response

200Successful response.

• dataarray of objectsrequired
  Fields of each item (4)

  • enablebooleanrequired

    Whether stock adjustments offer it. False hides it.

  • idstringrequired
  • reasonstringrequired
  • systembooleanrequired

    True for YoPrint's built-in reasons.

• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

Notes

• Offer only reasons with enable: true.

Related

• POSTCreate a stock adjustment reason/v1/api/store/{team_slug}/setting/adjustment_reason

Example request

curl

curl 'https://secure.yoprint.com/v1/api/store/your-team/setting/adjustment_reason' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": [
    {
      "enable": true,
      "id": "ygAWpMiOJ7htSQ",
      "reason": "Damaged",
      "system": true
    }
  ],
  "status": 200,
  "success": true
}