List fee presets

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

v1Operation ID v1_public_fee_preset_index

Returns all the team's fee presets in one list.

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

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

• 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

• POSTSearch fee presets by name/v1/api/store/{team_slug}/setting/fee_preset/search
• POSTAdd a line item to a sales order or quote/v2/api/store/{team_slug}/v2/sales_order/{order_unique_key}/order_item

Example request

curl

curl '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'

Example response 200

Response

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