GET /price-lists/{id}.json

GET /price-lists/{id}.json

Path parameters

  • id integer(int64) Required

    Numeric ID of the instance

    Minimum value is 1.

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • cacheImport boolean | null

      Cache import

    • compareAtPriceHeader string | null

      If not set, Onport will look for a column called compare_at_price.

    • comparePrevious boolean | null Required

      Compare previous

      Default value is true.

    • createdAt string(date-time)

      Created at

    • currencyId integer(int32) Required

      Currency

    • delimiter string | null

      Defaults to a comma (,) if not set. For example, you can enter | if your CSV file is pipe separated instead of comma separated.

    • id integer(int32)

      Id

    • importFromUrl boolean | null

      Import from url

    • importSeconds integer(int32) | null

      Import seconds

    • importUrl string | null

      Import url

    • lastFetchedAt string(date-time) | null

      Last fetched at

    • lastFetchedFile string | null

      Last fetched file

    • name string Required

      Name

    • parseNumber boolean | null

      Parse number

    • priceHeader string | null

      If not set, Onport will look for a column called retail_price.

    • skuHeader string | null

      If not set, Onport will look for a column called sku.

    • status string | null Required

      Status

      Values are active or archived. Default value is active.

    • type string Required

      Type

      Values are sale or purchase. Default value is sale.

    • updatedAt string(date-time)

      Updated at

    • zeroCompareAtPrices boolean | null

      Zero compare at prices

GET /price-lists/{id}.json
curl \
 --request GET 'http://api.example.com/v1/price-lists/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
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
}