Import Products

POST 
https://euwest.api.elasticpath.com/pcm/products/import

You can use the Product Import API to:

• Add new products, including:

  • main image files. See Importing Main Image Files.
  • custom data. See Importing custom data.
  • Make bulk updates to existing products.

You cannot use product import to:

• Delete existing products.
• Import product bundles.

The Product Import API uses a Comma Separated Values (CSV) file to import products, main image files and custom extension data. Each row in a .csv file represents a product you want to create/update. See an example file.

Each file can have 50,000 rows, including the header. If a CSV file exceeds 50,000 rows, an error is displayed, and the products are not imported. A CSV file must not be larger than 50 megabytes. If a CSV file is larger than 50 megabytes, a 503 client read error is displayed.

If you want to create/update more than 50,000 products or your CSV file is larger than 50 megabytes, you must have a separate CSV file and import each CSV file one at a time.

See Characteristics of CSV Files.

Request

Responses

201

Import started

400

Bad request. The request failed validation.

422

Bad request. The request failed validation.

500

Internal server error. There was a system failure in the platform.

Authorization: http

name: bearerAuthtype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://euwest.api.elasticpath.com/pcm/products/import");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent(string.Empty);
content.Headers.ContentType = new MediaTypeHeaderValue("multipart/form-data");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://euwest.api.elasticpath.com

Auth

Bearer Token

Body

file

The file you want to upload. Ensure that the file format is Comma Separated Values (CSV).

ResponseClear

Click the Send API Request button above and see the response here!