CLcloudblue
Pricing

GET /pricing/lists

Changed on

Create and manage PriceLists.

First PriceListVersion is created with PriceList creation.

PricePoints are created for each Item of each PriceList Product.

Request

  • Base URL
    https://api.connect.cloudblue.com/public/v1
  • Auth
    API key in header Authorization

Query parameters

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

currency'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAD' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XCG' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWG' | 'ZWL'

Filter for: currency

lookups: eq, ne, like, ilike, in, out

ordering: true

events.created.atstring date-time

Filter for: events.created.at

lookups: eq, ne, ge, gt, le, lt, in, out

ordering: true

events.updated.atstring date-time

Filter for: events.updated.at

lookups: eq, ne, ge, gt, le, lt, in, out

ordering: true

idstring

Filter for: id

lookups: eq, ne, like, ilike, null, in, out

search: true

ordering: true

namestring

Filter for: name

lookups: eq, ne, like, ilike, in, out

ordering: true

owner.idstring

Filter for: owner.id

lookups: eq, ne, like, ilike, null, in, out

owner.namestring

Filter for: owner.name

lookups: eq, ne, like, ilike, in, out

ordering: true

pricing_model_type'vendor_created' | 'vendor_modeled' | 'distributor_created'

Filter for: pricing_model_type

lookups: eq, ne, like, ilike, null, in, out

ordering: true

product.idstring

Filter for: product.id

lookups: eq, ne, like, ilike, null, in, out

product.namestring

Filter for: product.name

lookups: eq, ne, like, ilike, in, out

stats.listingsinteger

Filter for: stats.listings

lookups: eq, ne, ge, gt, le, lt, null, in, out

ordering: true

stats.listings_altinteger

Filter for: stats.listings_alt

lookups: eq, ne, ge, gt, le, lt, null, in, out

ordering: true

stats.productsinteger

Filter for: stats.products

lookups: eq, ne, ge, gt, le, lt, in, out

ordering: true

status'draft' | 'scheduled' | 'active' | 'terminated' | 'obsolete'

Filter for: status

lookups: eq, ne, like, ilike, in, out

ordering: true

Response

idstring
namestring required
descriptionstring required
currency'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAD' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XCG' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWG' | 'ZWL' required
compatibility'commerce' nullable
precisionnumber

Maximum PricePoints precision. Must be power of -10 (0.1, 0.01, etc.). Each PricePoint will be checked for precision excess.

status'draft' | 'scheduled' | 'active' | 'terminated' | 'obsolete'
model_typestring
source_priceliststring nullable
attributesobject[] required

PriceList attributes (columns). This is a array of objects. Each object must contain 'name' properties. Property 'description' is optional. Property 'id' is allowed for update only. Property 'name' must match pattern '^(Price|Suggested T0 Price|Suggested T1 Price|Suggested T2 Price|T1 Reseller Real Price|v.|d.|vc..{1:97})$'. At least one attribute must be specified. If specified 'name' and/or 'description' properties for predefined attributes then they will be redefined. Custom attribute names must use the prefix allowed for your role and price list type. Attributes order is equal to XLSX representation column order.

type'flat' | 'volume'

Changes

  • 798ba51500b5Revision changes
    • warning

      added the new ANG enum value to the / response property for the response status

    • warning

      added the new BGN enum value to the / response property for the response status

    • warning

      added the new CUC enum value to the / response property for the response status

    • warning

      added the new HRK enum value to the / response property for the response status

    • warning

      added the new SLL enum value to the / response property for the response status

    • warning

      added the new ZWL enum value to the / response property for the response status

    • info

      added the new enum value ANG to the query request parameter currency

    • info

      added the new enum value BGN to the query request parameter currency

    • info

      added the new enum value CUC to the query request parameter currency

    • info

      added the new enum value HRK to the query request parameter currency

    • info

      added the new enum value SLL to the query request parameter currency

    • info

      added the new enum value ZWL to the query request parameter currency

  • 54fef191d46cRevision changes
    • breaking

      removed the enum value ANG from the query request parameter currency

    • breaking

      removed the enum value BGN from the query request parameter currency

    • breaking

      removed the enum value CUC from the query request parameter currency

    • breaking

      removed the enum value HRK from the query request parameter currency

    • breaking

      removed the enum value SLL from the query request parameter currency

    • breaking

      removed the enum value ZWL from the query request parameter currency

    • warning

      added the new XAD enum value to the / response property for the response status

    • warning

      added the new XCG enum value to the / response property for the response status

    • warning

      added the new ZWG enum value to the / response property for the response status

    • warning

      added the new obsolete enum value to the / response property for the response status

    • info

      added the new optional query request parameter pricing_model_type

    • info

      added the new enum value XAD to the query request parameter currency

    • info

      added the new enum value XCG to the query request parameter currency

    • info

      added the new enum value ZWG to the query request parameter currency

    • info

      added the new enum value obsolete to the query request parameter status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      removed the ANG enum value from the / response property for the response status

    • info

      removed the BGN enum value from the / response property for the response status

    • info

      removed the CUC enum value from the / response property for the response status

    • info

      removed the HRK enum value from the / response property for the response status

    • info

      removed the SLL enum value from the / response property for the response status

    • info

      removed the ZWL enum value from the / response property for the response status