Body
Required
-
Cache import
-
If not set, Onport will look for a column called
compare_at_price
. -
Compare previous
Default value is
true
. -
Currency
-
Defaults to a comma (,) if not set. For example, you can enter | if your CSV file is pipe separated instead of comma separated.
-
Import from url
-
Import seconds
-
Import url
-
Last fetched at
-
Last fetched file
-
Name
-
Parse number
-
If not set, Onport will look for a column called
retail_price
. -
If not set, Onport will look for a column called
sku
. -
Status
Values are
active
orarchived
. Default value isactive
. -
Type
Values are
sale
orpurchase
. Default value issale
. -
Zero compare at prices
POST
/price-lists.json
curl \
--request POST 'http://api.example.com/v1/price-lists.json' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"cacheImport":true,"compareAtPriceHeader":"string","comparePrevious":true,"currencyId":42,"delimiter":"string","importFromUrl":true,"importSeconds":42,"importUrl":"string","lastFetchedAt":"2025-05-04T09:42:00Z","lastFetchedFile":"string","name":"string","parseNumber":true,"priceHeader":"string","skuHeader":"string","status":"active","type":"sale","zeroCompareAtPrices":true}'
Request examples
{
"cacheImport": true,
"compareAtPriceHeader": "string",
"comparePrevious": true,
"currencyId": 42,
"delimiter": "string",
"importFromUrl": true,
"importSeconds": 42,
"importUrl": "string",
"lastFetchedAt": "2025-05-04T09:42:00Z",
"lastFetchedFile": "string",
"name": "string",
"parseNumber": true,
"priceHeader": "string",
"skuHeader": "string",
"status": "active",
"type": "sale",
"zeroCompareAtPrices": true
}
Response examples (200)
{
"cacheImport": true,
"compareAtPriceHeader": "string",
"comparePrevious": true,
"createdAt": "2025-05-04T09:42:00Z",
"currencyId": 42,
"delimiter": "string",
"id": 42,
"importFromUrl": true,
"importSeconds": 42,
"importUrl": "string",
"lastFetchedAt": "2025-05-04T09:42:00Z",
"lastFetchedFile": "string",
"name": "string",
"parseNumber": true,
"priceHeader": "string",
"skuHeader": "string",
"status": "active",
"type": "sale",
"updatedAt": "2025-05-04T09:42:00Z",
"zeroCompareAtPrices": true
}