Create a fee preset

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

v1Operation ID v1_public_fee_preset_store

Creates a fee preset and returns it.

Fee presets are saved fee names and prices, such as a rush fee or a setup fee. A fee line item on a sales order does not link to a preset: copy the preset's name and price into the fee line.

Permission

Needs the Manage Settings permission.

Business rules

• name is required. price is optional; send a whole number of thousandths (25000 is 25.00).

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.

• namestringrequired
• priceinteger

  The price. Send a whole number of thousandths: 25000 is 25.00.

Response

200Successful response.

• dataobjectrequired
  Child fields (3)

  • idstringrequired
  • namestringrequired
  • priceinteger | nullrequired

    The price. Thousandths, an older encoding: 12500 is 12.50. Usually a whole number; an amount finer than a thousandth comes back as a number with a fraction (1234.5 is 1.2345), or as a string ("1234.5") when you send X-Yoprint-Decimal-Format: exact-v1. See Money and quantities. Null when none was set.

• 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

  name is missing, or price is not a whole number. 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 fee presets/v1/api/store/{team_slug}/setting/fee_preset

Example request

curl

curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/setting/fee_preset' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "name": "Rush fee",    "price": 25000  }'

Example response 200

Response

{
  "data": {
    "id": "dJc8sLZs6Z6IB9",
    "name": "Rush fee",
    "price": 25000
  },
  "status": 200,
  "success": true
}