Download the variant product CSV template

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

v1Operation ID v1_public_csv_template_variant_product

Returns variant_product_import_template.csv: the header row and two example rows for a custom variant product CSV import. It is a file, not JSON.

One row is one variant (one size and color). Rows with the same supplier_style_code, brand and title belong to one product. Columns: supplier_style_code, brand, title, description, supplier_code (the variant's own code), weight (pounds), size_id, size_label, color_id, color_label, color_hex, price. Keep these header names: the Import Portal matches columns to fields by their exact names.

Product CSV files are imported in the YoPrint web app (Import Portal). The public API has no product CSV upload.

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 variant_product_import_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 example rows are sample data. Delete them before you import.

Related

• POSTCreate a product/v1/api/store/{team_slug}/product
• POSTAdd a variant to a product/v1/api/store/{team_slug}/product/{hash_id}/variant
• PUTDownload the simple product CSV template/v1/api/store/{team_slug}/csv/template/simple_product

Example request

curl

curl -X PUT 'https://secure.yoprint.com/v1/api/store/your-team/csv/template/variant_product' \  -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.