Jump to

• Request
• Response

Get Transaction Line Available Rate Plans

get

/rest/v16/commerceDocuments{ProcessVarName}{MainDocVarName}/{id}/{subDocVarName}/{docNumber}/_availableRatePlanSet

Use this endpoint to retreve all available rate plans for the specified transaction line.

Request

Supported Media Types

• application/json

Path Parameters

• MainDocVarName(required): string
  The variable name of the main document, note the first letter must be capitalized.
• ProcessVarName(required): string
  The variable name of the commerce process, note the first letter must be capitalized.
• docNumber(required): integer
  Unique number to be used as the sub-document identifier.
• id(required): integer
  Current unique user-side ID. This is the internal identifier for a transaction within a CPQ site.
• subDocVarName(required): string
  The variable name for the sub-document.

Query Parameters

• excludeFieldTypes: string
  Exclude specified field types.
• fields: string
  Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
• limit: integer
  The requested page size, which limits the number of elements the collection should max return .
• offset: integer
  The offset of the page. By default, offset is 0, which means first page will be returned.
• orderby: string
  Specifies a comma-separated list of pairs to order the response by.
• q: string
  Allows to specify one or more filtering criteria. By default, no filtering is applied.
• totalResults: boolean
  Specifies that the total count of records should be included in the response when doing pagination.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : TransactionLine_availableRatePlanSet-collection

Type: object

Show Source

• _state: object state
  Title: state

  Captures the current state of the resource collection.Of available properties, only those that are applicable and whose values are known in the current context are included.
• count: integer
  The number of resource instances returned in the current range.
• hasMore: boolean
  Returns true if more resources are available on the server than the subset returned in current page.
• items: array items
• limit: integer
  The actual paging size used by the server.
• offset: integer
  The offset used in the current page.
• totalResults: integer
  Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "description":"The offset used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "totalResults":{
            "type":"integer",
            "description":"Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Returns true if more resources are available on the server than the subset returned in current page."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TransactionLine_availableRatePlanSet"
            }
        },
        "_state":{
            "$ref":"#/definitions/resourceCollectionState"
        }
    }
}

Nested Schema : state

Type: object

Title: state

Captures the current state of the resource collection.Of available properties, only those that are applicable and whose values are known in the current context are included.

Show Source

• actions: object Actions
  Title: Actions

  Captures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action.
• defaultRowState: object state
  Title: state

  Captures the current state of the resource row. Of available properties, only those that are applicable and whose values are known in the current context are included.
• focus: object Focused Users
  Title: Focused Users

  Details about users who are focused on this item. The object contains one property per focused user, where the property name is the user' s unique identifier.
• hasError: boolean
  Title: Has Error

  Boolean value that specifies whether any error that occurred has been assigned to the collection itself.
• hasWarning: boolean
  Title: Has Warning

  Boolean value that specifies whether any warning that was issued has been assigned to the collection itself.
• insertable: boolean
  Title: Insertable

  Boolean value that specifies whether new rows can be inserted into the collection.
• messages: array Messages
  Title: Messages

  Array of messages that have been generated for a specific object.
• queryable: boolean
  Title: Queryable

  Boolean value that specifies whether the rows in the collection can be queried.
• sortable: boolean
  Title: Sortable

  Boolean value that specifies whether the rows in the collection can be sorted.

{
    "type":"object",
    "properties":{
        "insertable":{
            "type":"boolean",
            "description":"Boolean value that specifies whether new rows can be inserted into the collection.",
            "title":"Insertable"
        },
        "queryable":{
            "type":"boolean",
            "description":"Boolean value that specifies whether the rows in the collection can be queried.",
            "title":"Queryable"
        },
        "sortable":{
            "type":"boolean",
            "description":"Boolean value that specifies whether the rows in the collection can be sorted.",
            "title":"Sortable"
        },
        "hasError":{
            "type":"boolean",
            "description":"Boolean value that specifies whether any error that occurred has been assigned to the collection itself.",
            "title":"Has Error"
        },
        "hasWarning":{
            "type":"boolean",
            "description":"Boolean value that specifies whether any warning that was issued has been assigned to the collection itself.",
            "title":"Has Warning"
        },
        "actions":{
            "type":"object",
            "description":"Captures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action.",
            "title":"Actions"
        },
        "messages":{
            "type":"array",
            "description":"Array of messages that have been generated for a specific object.",
            "title":"Messages",
            "items":{
                "type":"string",
                "description":"An error, warning, or informational message."
            }
        },
        "defaultRowState":{
            "$ref":"#/definitions/resourceRowState"
        },
        "focus":{
            "type":"object",
            "description":"Details about users who are focused on this item. The object contains one property per focused user, where the property name is the user' s unique identifier.",
            "title":"Focused Users"
        }
    },
    "title":"state",
    "description":"Captures the current state of the resource collection.Of available properties, only those that are applicable and whose values are known in the current context are included."
}

Nested Schema : items

Type: array

Show Source

• Array of: object Available Rate Plan Set
  Title: Available Rate Plan Set

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/TransactionLine_availableRatePlanSet"
    }
}

Nested Schema : Actions

Type: object

Title: Actions

Captures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action.

Nested Schema : state

Type: object

Title: state

Captures the current state of the resource row. Of available properties, only those that are applicable and whose values are known in the current context are included.

Show Source

• actions: object Actions
  Title: Actions

  Captures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action.
• attributes: object Attributes
  Title: Attributes

  Captures the current state of each attribute whose state was requested. The object contains one property per group, where the property name is the resource field name for the attribute.
• deletable: boolean
  Title: Deletable

  Boolean value that specifies whether the row can be deleted.
• hasError: boolean
  Title: Has Error

  Boolean value that specifies whether any error that occurred has been assigned to the row itself.
• hasWarning: boolean
  Title: Has Warning

  Boolean value that specifies whether any warning that was issued has been assigned to the row itself.
• messages: array Messages
  Title: Messages

  Array of messages that have been generated for a specific object.
• updatable: boolean
  Title: Updatable

  Boolean value that specifies whether the row can be updated.

{
    "type":"object",
    "properties":{
        "updatable":{
            "type":"boolean",
            "description":"Boolean value that specifies whether the row can be updated.",
            "title":"Updatable"
        },
        "deletable":{
            "type":"boolean",
            "description":"Boolean value that specifies whether the row can be deleted.",
            "title":"Deletable"
        },
        "hasError":{
            "type":"boolean",
            "description":"Boolean value that specifies whether any error that occurred has been assigned to the row itself.",
            "title":"Has Error"
        },
        "hasWarning":{
            "type":"boolean",
            "description":"Boolean value that specifies whether any warning that was issued has been assigned to the row itself.",
            "title":"Has Warning"
        },
        "actions":{
            "type":"object",
            "description":"Captures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action.",
            "title":"Actions"
        },
        "messages":{
            "type":"array",
            "description":"Array of messages that have been generated for a specific object.",
            "title":"Messages",
            "items":{
                "type":"string",
                "description":"An error, warning, or informational message."
            }
        },
        "attributes":{
            "type":"object",
            "description":"Captures the current state of each attribute whose state was requested. The object contains one property per group, where the property name is the resource field name for the attribute.",
            "title":"Attributes"
        }
    },
    "title":"state",
    "description":"Captures the current state of the resource row. Of available properties, only those that are applicable and whose values are known in the current context are included."
}

Nested Schema : Focused Users

Type: object

Title: Focused Users

Details about users who are focused on this item. The object contains one property per focused user, where the property name is the user' s unique identifier.

Nested Schema : Messages

Type: array

Title: Messages

Array of messages that have been generated for a specific object.

Show Source

• Array of: string
  An error, warning, or informational message.

{
    "type":"array",
    "description":"Array of messages that have been generated for a specific object.",
    "title":"Messages",
    "items":{
        "type":"string",
        "description":"An error, warning, or informational message."
    }
}

Nested Schema : Actions

Type: object

Title: Actions

Captures the current state of each action whose state was requested. The object contains one property per action, where the property name is the variable name for the action.

Nested Schema : Attributes

Type: object

Title: Attributes

Captures the current state of each attribute whose state was requested. The object contains one property per group, where the property name is the resource field name for the attribute.

Nested Schema : Messages

Type: array

Title: Messages

Array of messages that have been generated for a specific object.

Show Source

• Array of: string
  An error, warning, or informational message.

{
    "type":"array",
    "description":"Array of messages that have been generated for a specific object.",
    "title":"Messages",
    "items":{
        "type":"string",
        "description":"An error, warning, or informational message."
    }
}

Nested Schema : Available Rate Plan Set

Type: object

Title: Available Rate Plan Set

Show Source

• _availableRatePlanSet_rate_plan_integration_id: string
  Title: Available Rate Plan Integration Id

  Rate Plan Integration ID
• _availableRatePlanSet_rate_plan_name: string
  Title: Available Rate Plan Name

  Rate plan name
• _availableRatePlanSet_rate_plan_number: string
  Title: Available Rate Plan Number

  Rate Plan Number
• _bs_id: integer
  Title: _bs_id

  _bs_id
• _document_number: integer
  Title: _document_number

  _document_number
• _row_number: integer
  Title: _row_number

  _row_number
• _sequence_number: integer
  Title: _sequence_number

  _sequence_number
• _state: object state
  Title: state

  Captures the current state of the resource row. Of available properties, only those that are applicable and whose values are known in the current context are included.
• _transaction_currency_pref: object _transaction_currency_pref
  Title: _transaction_currency_pref

{
    "type":"object",
    "properties":{
        "_sequence_number":{
            "type":"integer",
            "description":"_sequence_number",
            "title":"_sequence_number"
        },
        "_document_number":{
            "type":"integer",
            "description":"_document_number",
            "title":"_document_number"
        },
        "_availableRatePlanSet_rate_plan_integration_id":{
            "type":"string",
            "description":"Rate Plan Integration ID",
            "title":"Available Rate Plan Integration Id"
        },
        "_availableRatePlanSet_rate_plan_name":{
            "type":"string",
            "description":"Rate plan name",
            "title":"Available Rate Plan Name"
        },
        "_bs_id":{
            "type":"integer",
            "description":"_bs_id",
            "title":"_bs_id"
        },
        "_row_number":{
            "type":"integer",
            "description":"_row_number",
            "title":"_row_number"
        },
        "_transaction_currency_pref":{
            "type":"object",
            "description":"",
            "title":"_transaction_currency_pref",
            "properties":{
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the currency  resource.",
                    "title":"Id"
                },
                "currencyCode":{
                    "type":"string",
                    "description":"Unique currency code for the currency.",
                    "title":"Currency Code"
                }
            }
        },
        "_availableRatePlanSet_rate_plan_number":{
            "type":"string",
            "description":"Rate Plan Number",
            "title":"Available Rate Plan Number"
        },
        "_state":{
            "$ref":"#/definitions/resourceRowState"
        }
    },
    "title":"Available Rate Plan Set"
}

Nested Schema : _transaction_currency_pref

Type: object

Title: _transaction_currency_pref

Show Source

• currencyCode: string
  Title: Currency Code

  Unique currency code for the currency.
• id: integer
  Title: Id

  Primary Key of the currency resource.

{
    "type":"object",
    "description":"",
    "title":"_transaction_currency_pref",
    "properties":{
        "id":{
            "type":"integer",
            "description":"Primary Key of the currency  resource.",
            "title":"Id"
        },
        "currencyCode":{
            "type":"string",
            "description":"Unique currency code for the currency.",
            "title":"Currency Code"
        }
    }
}

Back to Top