get

GET /v2/migration/templates/{type} — Download a CSV template

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Downloads a blank CSV template for the given entity type. The response is a text/csv file attachment.

Path parameters

ParameterValues
typepatients, products, orders, subscriptions, coupons (case-insensitive)

CSV columns by type

PATIENTS

external_id, first_name, last_name, email, phone, date_of_birth, gender, notes,
billing_address1, billing_address2, billing_city, billing_state, billing_zipcode,
shipping_address1, shipping_address2, shipping_city, shipping_state, shipping_zipcode,
medication_1_name, medication_1_dosage, medication_1_frequency, medication_1_condition,
allergy_1_name, allergy_1_reaction

PRODUCTS

Columns map to ecommerce product and product variation fields (name, SKU, price, description, etc.).

ORDERS

Columns map to ecommerce order fields (external order ID, patient external ID, product SKU, amount, status, etc.).

SUBSCRIPTIONS

Columns map to subscription fields (external ID, patient external ID, product SKU, renewal date, status, etc.).

COUPONS

Columns map to coupon fields (code, discount type, amount, expiry, usage limits, etc.).

Required role

affiliate_super_admin or affiliate_admin

Rate limit

This endpoint is rate-limited per user to prevent excessive template downloads.

Errors

StatusDescription
400Invalid type value
404Template file not found on server
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!