Skip to content
Prokure Docs

Download the product-import CSV template

GET
/api/v1/products/import/template
curl --request GET \
  --url https://app.prokure.ca/api/v1/products/import/template

Returns an empty product-import CSV with the header row and one example, as a file download. The header row must carry all seven columns, in any order: oem_partner, name, model, description, commodity_codes, rep_status, source_url. They are matched by name, ignoring case and surrounding spaces. (optional) below describes the cell value, which may be left blank; the column itself is always required. oem_partner (required) - the manufacturer’s name; matched case-insensitively against manufacturers already on the account, and created and authorized when it is new. name (required) - the product name; at most 200 characters. model (optional) - at most 100 characters. Together with oem_partner and name it identifies the product: a repeat updates that row instead of adding a second one. description (optional) - at most 4000 characters. Quote the cell if it contains a comma or a line break. commodity_codes (optional) - semicolon-separated, at most 50 codes of at most 50 characters each. rep_status (optional) - carried or catalog; blank means carried. source_url (optional) - an http or https URL.

Responses

Section titled “Responses”

200

Section titled “200”

The import template, as a CSV file.

Media typetext/csv
string

401

Section titled “401”

Default Response

Media typeapplication/json
object
error
required
string
Allowed values: unauthorized forbidden no_membership membership_disabled unverified_email identity_conflict insufficient_scope validation_failed not_found missing_file unsupported_type file_too_large empty_document unreadable_document context_doc_cap_reached rule_cap_reached already_reverted superseded already_exists partner_not_authorized invalid_import rate_limited internal
message
required
string
requestId
required
string
issues
Array
issue_count
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "error": "unauthorized"
}

403

Section titled “403”

Default Response

Media typeapplication/json
object
error
required
string
Allowed values: unauthorized forbidden no_membership membership_disabled unverified_email identity_conflict insufficient_scope validation_failed not_found missing_file unsupported_type file_too_large empty_document unreadable_document context_doc_cap_reached rule_cap_reached already_reverted superseded already_exists partner_not_authorized invalid_import rate_limited internal
message
required
string
requestId
required
string
issues
Array
issue_count
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "error": "unauthorized"
}

429

Section titled “429”

Default Response

Media typeapplication/json
object
error
required
string
Allowed values: unauthorized forbidden no_membership membership_disabled unverified_email identity_conflict insufficient_scope validation_failed not_found missing_file unsupported_type file_too_large empty_document unreadable_document context_doc_cap_reached rule_cap_reached already_reverted superseded already_exists partner_not_authorized invalid_import rate_limited internal
message
required
string
requestId
required
string
issues
Array
issue_count
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "error": "unauthorized"
}

500

Section titled “500”

Default Response

Media typeapplication/json
object
error
required
string
Allowed values: unauthorized forbidden no_membership membership_disabled unverified_email identity_conflict insufficient_scope validation_failed not_found missing_file unsupported_type file_too_large empty_document unreadable_document context_doc_cap_reached rule_cap_reached already_reverted superseded already_exists partner_not_authorized invalid_import rate_limited internal
message
required
string
requestId
required
string
issues
Array
issue_count
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "error": "unauthorized"
}