CLcloudblue
Offers

GET /offers/{offer_id}/versions/{offerversion_id}/plans

Changed on

List Plans for specified Offer version.

Request

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

Path parameters

offer_idstring required
offerversion_idstring required

Query parameters

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

blueprint.status'draft' | 'active' | 'endofsale'

Filter for: blueprint.status

lookups: eq, ne, in

colorstring

Filter for: color

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

ordering: true

commitmentsstring

Filter for: commitments

lookups: eq, in

descriptionstring

Filter for: description

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

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

external_idstring

Filter for: external_id

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

idstring

Filter for: id

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

namestring

Filter for: name

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

ordering: true

periodsstring

Filter for: periods

lookups: eq, in

positioninteger

Filter for: position

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

ordering: true

Response

idstring
namestring required
colorstring required
periodsstring[] required
commitmentsstring[] nullable
descriptionstring nullable
external_idstring nullable
positioninteger nullable
gravityobject

Changes

  • 798ba51500b5Revision changes
    • info

      added the new optional query request parameter blueprint.status

    • info

      added the new optional query request parameter external_id

  • ed203419a9a7Revision changes
    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional query request parameter commitments

    • 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

      added the optional property / to the response with the status

    • info

      added the optional write-only property items/gravity to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status