Show a stock adjustment reason

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

v1Operation ID v1_public_adjustment_reason_show

Returns one stock adjustment reason.

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
• hash_idstringrequired

  The stock adjustment reason's id: a hash id from an earlier answer. Only hash ids work here; anything else answers 404 page_not_found.

  • Example ygAWpMiOJ7htSQ

Request body

This operation takes no request body.

Response

200Successful response.

• dataobjectrequired
  Child fields (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.

Related

• PATCHUpdate a stock adjustment reason without checks/v1/api/store/{team_slug}/setting/adjustment_reason/{hash_id}

Example request

curl

curl 'https://secure.yoprint.com/v1/api/store/your-team/setting/adjustment_reason/ygAWpMiOJ7htSQ' \  -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
}