CLcloudblue
Pricing

GET /pricing/versions

Changed on

Create and manage PriceListVersions.

PricePoints will be created for each Item of each PriceList Product.

PriceListVersion XLSX representation will be fixed for Provider after schedule/activate.

After one of these actions any changes will not affect on XLSX representation for Provider.

For bulk update XLSX file download is needed to set:

  • HTTP Content-Type header: application/vnd.openxmlformats-officedocument.spreadsheetml.template

  • or add format='xlsx' param to query string (?format=xlsx)

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.

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

pricelist.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: pricelist.currency

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

search: true

ordering: true

pricelist.idstring

Filter for: pricelist.id

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

search: true

pricelist.namestring

Filter for: pricelist.name

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

search: true

ordering: true

pricelist.owner.idstring

Filter for: pricelist.owner.id

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

pricelist.owner.namestring

Filter for: pricelist.owner.name

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

ordering: true

pricelist.product.idstring

Filter for: pricelist.product.id

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

search: true

pricelist.product.namestring

Filter for: pricelist.product.name

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

search: true

pricelist.stats.listingsinteger

Filter for: pricelist.stats.listings

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

ordering: true

pricelist.stats.listings_altinteger

Filter for: pricelist.stats.listings_alt

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

ordering: true

pricelist.stats.productsinteger

Filter for: pricelist.stats.products

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

ordering: true

start_atstring date-time

Filter for: start_at

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

ordering: true

status'processing' | 'draft' | 'scheduled' | 'active' | 'obsolete' | 'expired'

Filter for: status

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

ordering: true

Response

idstring
descriptionstring required
start_atstring date-time

Time when this PriceListVersion is activated (in case of scheduling activation in future). PriceListVersions are being activated at begin of specified hour.

status'processing' | 'draft' | 'scheduled' | 'active' | 'obsolete' | 'expired'
xlsx_filestring uri-reference nullable

Link to XLSX representation file.

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 pricelist.currency

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

  • 54fef191d46cRevision changes
    • breaking

      removed the enum value ANG from the query request parameter pricelist.currency

    • breaking

      removed the enum value BGN from the query request parameter pricelist.currency

    • breaking

      removed the enum value CUC from the query request parameter pricelist.currency

    • breaking

      removed the enum value HRK from the query request parameter pricelist.currency

    • breaking

      removed the enum value SLL from the query request parameter pricelist.currency

    • breaking

      removed the enum value ZWL from the query request parameter pricelist.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

    • warning

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

    • info

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

    • info

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

    • info

      added the new enum value ZWG to the query request parameter pricelist.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

      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