Skip to content

CSV imports

Open .md

API reference Imports and exports

CSV templates, the service pricing CSV upload, and your import jobs. Customer, vendor and product CSV imports run in the web app's Import Portal, not on the public API.

10 operations

  • POSTImport a service's price table from CSV/v1/api/store/{team_slug}/imports/csvUploads a price table as a CSV file and saves it on a service in one request.
  • GETList import jobs/v1/api/store/{team_slug}/importsLists your team's import jobs, newest first, a page at a time.
  • GETList import activity/v1/api/store/{team_slug}/source-imports/activityLists the Import Portal's import activity, newest first unless you ask for sort=oldest, with paging by cursor.
  • GETGet an import job/v1/api/store/{team_slug}/imports/{hash_id}Returns one import job: its status and how many items succeeded, failed or were skipped.
  • PUTDownload the customer CSV template/v1/api/store/{team_slug}/csv/template/customerReturns customer_import_template.csv: the header row and one example row for a customer CSV import.
  • PUTDownload the service pricing CSV template/v1/api/store/{team_slug}/csv/template/service_pricingReturns 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.
  • PUTDownload the simple product CSV template/v1/api/store/{team_slug}/csv/template/simple_productReturns simple_product_import_template.csv: the header row and two example rows for a custom simple product CSV import.
  • PUTDownload the variant product CSV template/v1/api/store/{team_slug}/csv/template/variant_productReturns variant_product_import_template.csv: the header row and two example rows for a custom variant product CSV import.
  • PUTDownload the vendor CSV template/v1/api/store/{team_slug}/csv/template/vendorReturns vendor_import_template.csv: the header row and one example row for a vendor CSV import.
  • GETDownload an import job's failed rows/v1/api/store/{team_slug}/imports/{hash_id}/artifacts/error-csvDownloads the CSV of rows that failed in an import job, with the reason for each row.