Create a stock adjustment reason

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

v1Operation ID v1_public_adjustment_reason_store

Adds a reason of your own and returns it. It is on unless you send enable: false.

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

Needs the Manage Settings permission.

Business rules

• reason is required. Reasons don't have to be unique.

Path parameters

• team_slugstringrequired

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

  • Example your-team

Request body

application/json, required.

• reasonstringrequired

  The text people pick.

• enableboolean
  • Default true

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).

  When

  The API key is missing or wrong.

  Fix

  Send your personal API key as Authorization: Bearer YOUR_API_KEY.

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

  When

  Your permission group lacks Manage Settings. This 403 has a short body, {"message": "Insufficient Permission"}, without success or error.

  Fix

  Ask the team owner to give your permission group Manage Settings.

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

• 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

  When

  reason is missing. error.code is validation_failed, and error.fields names each field with its messages.

  Fix

  Fix the fields listed in error.fields and send the request again.

Related

• GETList stock adjustment reasons/v1/api/store/{team_slug}/setting/adjustment_reason

Example request

curl

curl -X POST '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' \  -H 'Content-Type: application/json' \  -d '{    "reason": "Sample sent to customer"  }'

Example response 200

Response

{
  "data": {
    "enable": true,
    "id": "8MICavW4VoLtS2",
    "reason": "Sample sent to customer",
    "system": false
  },
  "status": 200,
  "success": true
}