CLcloudblue
Products

GET /products/{product_product_id}/items

Changed on

Request

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

Path parameters

product_product_idstring required

Query parameters

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

app.idstring

Filter for: app.id

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

search: true

applicability'cb' | 'im'

Filter for: applicability

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

search: true

commitment.countinteger

Filter for: commitment.count

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

description.valuestring

Filter for: description.value

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

search: true

display_namestring

Filter for: display_name

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

search: true

distributor_groups.idstring

Filter for: distributor_groups.id

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

distributor_groups.mpnstring

Filter for: distributor_groups.mpn

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

distributor_groups.namestring

Filter for: distributor_groups.name

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

dynamicboolean

Filter for: dynamic

lookups: eq, ne

events.created.atstring date-time

Filter for: events.created.at

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

events.saleended.atstring date-time

Filter for: events.saleended.at

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

events.updated.atstring date-time

Filter for: events.updated.at

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

external_idstring

Filter for: external_id

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

frozenboolean

Filter for: frozen

lookups: eq, ne

group.idstring

Filter for: group.id

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

group.mpnstring

Filter for: group.mpn

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

group.namestring

Filter for: group.name

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

idstring

Filter for: id

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

search: true

item_type'Reservation' | 'PPU'

Filter for: item_type

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

search: true

local_idstring

Filter for: local_id

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

mpnstring

Filter for: mpn

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

search: true

namestring

Filter for: name

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

search: true

period'Monthly' | 'Yearly' | 'years_2' | 'years_3' | 'years_4' | 'years_5' | 'years_6' | 'OneTime' | 'days_7_trial' | 'days_14_trial' | 'days_30_trial' | 'monthly_trial'

Filter for: period

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

search: true

replacement.idstring

Filter for: replacement.id

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

status'draft' | 'published' | 'endofsale'

Filter for: status

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

search: true

type'Reservation' | 'PPU'

Filter for: type

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

search: true

unit.titlestring

Filter for: unit.title

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

search: true

usage_data_type'Integer' | 'Decimal(1)' | 'Decimal(2)' | 'Decimal(4)' | 'Decimal(8)'

Filter for: usage_data_type

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

search: true

verbose_idstring

Filter for: verbose_id

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

search: true

versionstring

Filter for: version

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

Response

idstring
namestring
status'draft' | 'published' | 'endofsale'
external_idstring required
mpnstring nullable
positioninteger
typestring
local_idstring
display_namestring required
periodstring
precisionstring
dynamicboolean
applicability'cb' | 'im' nullable

This value scopes applicability of the item to IM or CB partners exclusively. Empty value means Global availability.

descriptionstring
depthinteger
end_of_sale_notesstring nullable required
ui_visibilitystring

Changes

  • 54fef191d46cRevision changes
    • info

      added the new optional query request parameter distributor_groups.id

    • info

      added the new optional query request parameter distributor_groups.mpn

    • info

      added the new optional query request parameter distributor_groups.name

    • info

      added the optional property / to the response with the status

  • ed203419a9a7Revision changes
    • info

      added the new optional query request parameter applicability

    • info

      added the new enum value days_14_trial to the query request parameter period

    • info

      added the new enum value days_30_trial to the query request parameter period

    • info

      added the new enum value days_7_trial to the query request parameter period

    • info

      added the new enum value monthly_trial to the query request parameter period

    • info

      added the optional property / to the response with the status