Download an example import file

GET

api

admin

imports

example

Download an example import file

const options = {
  method: 'GET',
  headers: {'x-spree-api-key': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('http://{defaultHost}/api/v3/admin/imports/example', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Authorizations

x-spree-api-key

string

header

required

Secret API key for admin access

Authorization

string

header

required

JWT token for admin user authentication

Headers

x-spree-api-key

string

required

Authorization

string

required

Query Parameters

type

string

required

Registered import type, e.g. products.

Response

302

Redirect to the example CSV

⌘I

Download an example import file

const options = {
  method: 'GET',
  headers: {'x-spree-api-key': '<api-key>', Authorization: 'Bearer <token>'}
};

fetch('http://{defaultHost}/api/v3/admin/imports/example', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

API basics

Endpoints

Authorizations

Headers

Query Parameters

Response