Download the service pricing CSV template

PUT/v1/api/store/{team_slug}/csv/template/service_pricing

v1Operation ID v1_public_csv_template_service_pricing

Returns service_pricing_template.csv: an example price table for one service, with three options (1 Color, 2 Color, 4 Color) and price breaks at 1, 10 and 30. It is a file, not JSON. Fill it in and upload it with POST /v1/api/store/{team_slug}/imports/csv.

The first column is qty/type: the quantity where each price break starts. Every other column is one option of the service (for example 1 Color, 2 Color), and each cell is that option's price at that quantity. A cell can hold two prices, first|additional (for example 10.00|11.00): the price for the first print location, then the price for each additional location.

Permission

Any member of the team.

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

200The template, UTF-8 with a byte order mark, sent as an attachment named service_pricing_template.csv.

The answer is a file (text/csv), not JSON. The example saves it with curl -o.

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

• The route uses PUT but changes nothing. Send no body.
• The rules each cell must follow are on the upload operation.

Related

• POSTImport a service's price table from CSV/v1/api/store/{team_slug}/imports/csv

Example request

curl

curl -X PUT 'https://secure.yoprint.com/v1/api/store/your-team/csv/template/service_pricing' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -o export.csv

Example response 200

A text/csv file.