Skip to main content
API docs by Redocly

Product Export (1.0.0)

Download OpenAPI specification:Download

Team Products Prices Promotions: team-product-prices-promotions@newstore.com URL: https://www.newstore.com

Product Export API

Product export

Product Export

listProducts

Use this resource to download products in a file. The export can be requested in CSV.

  • CSV delimiter is \t (tab)
  • CSV line is ended with \n (end line)
  • CSV cell is escaped when containing special characters \t (tab) \n (new line) \r (carriage return) with \\t \\n \\r
  • CSV cell is escaped with " (double quote) when contain double quote originally (relevant to json fields) RFC 4180

Schema:

  • product_id (string)
  • variant_group_id (string)
  • is_available (bool)
  • categories (json array)
    • path (string)
    • position (int32)
  • main_category_path (string)
  • main_category_position (int32)
  • external_identifiers (json array)
    • type (string)
    • value (string)
  • extended_attributes (json array)
    • name (string)
    • value (string)
  • title (string)
  • brand (string)
  • caption (string)
  • description (string)
  • keywords (json array of strings)
  • images (json array)
    • url (string)
    • title (string)
    • identifier (string)
    • altText (string)
    • dominantColor (string)
    • width (int32)
    • height (int32)
    • aspectRatio (float32)
    • tags (json array of strings)
  • template_id string
  • price (float32) price from default pricebook
  • currency (string)
  • country_of_origin (string)
  • tax_class_id (string)
  • preorder_start (string RFC3339 truncated to seconds)
  • online_from (string RFC3339 truncated to seconds)
  • online_to (string RFC3339 truncated to seconds)
  • variation_color_value (string)
  • variation_size_value (string)
  • variation_size_gender (string)
  • variation_size_type (string)
  • variation_size_system (string)
  • variation_size_sort_position (int32)
  • variation_additional_1_name (string)
  • variation_additional_1_value (string)
  • variation_additional_2_name (string)
  • variation_additional_2_value (string)
  • product_hts_number (string)
  • schedule_b (string)
  • shipping_dimension_height (float32)
  • shipping_dimension_length (float32)
  • shipping_dimension_unit (string)
  • shipping_dimension_width (float32)
  • shipping_weight_value (float32)
  • shipping_weight_unit (string)
  • serialized_inventory (bool)
  • variable_pricing (bool)
  • inventory_tracked (bool)
  • material (string)
  • updated_at (int64 Unix Timestamp Milliseconds)

Files are refreshed automatically. They are scheduled daily. Usually at 8:00 UTC. They are usually finished before 9:00 UTC. API can be used to retrieve max 1 day old snapshot of product data.

Response header Last-Modified can be used to determine when file was updated last time (example value Mon, 18 Dec 2023 08:00:21 GMT). Response header ETag can be used to determine whether version you already downloaded before match current one. (example value "2ad5ba4e24fe1c0d225e9a94049f142d") Please use it with combination with If-None-Match request header to download file only when something changed.

Authorizations:
oauth
path Parameters
catalog
required
string >= 1

The catalog the product, the user wants to export, belongs to.

query Parameters
locale
string >= 1
Default: "en-us"

The locale the user wants to export. Example en-us.csv

header Parameters
Accept
string
Default: text/csv
Value: "text/csv"

Responses

Response samples

Content type
application/problem+json
{
  • "request_id": "request1234",
  • "messages": [
    ],
  • "error_code": "400"
}