Product DocumentationConga Community
API Reference

Add lineitem to ramp line

post
https://rls.congacloud.com/api/cart/v1/carts//items//ramp-lines

Adds a ramp line item to the given cart ID and line item ID.

Required Fields:

  • cartId (route) - required
  • itemId (route) - required
  • lineItem (body) - required

Responses

  • 200 OK: the ramp line item was added.
  • 202 Accepted: the request was accepted for processing.
  • 400 Bad Request: the request payload is invalid.
  • 422 Unprocessable Entity: the request could not be processed.
  • 500 Internal Server Error: an unexpected error occurred.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The cart's unique identifier

string
required

The unique identifier of the ramp line item

Body Params

The ramp line item

string | null

ABO action.

string | null

Added by.

string | null

Added by rule info.

AdHocGroup
object
int32 | null

Group sequence.

double | null

Adjusted price.

double | null

Adjustment amount.

string | null

Adjustment type.

boolean | null

Allocate group adjustment.

string | null

Allowable action.

boolean | null

Allow manual adjustment.

boolean | null

Allow proration.

boolean | null

Allow removal.

string | null

Approval status.

double | null

Asset quantity.

boolean | null

Is auto renew.

double | null

Auto renewal term.

string | null

Auto renewal type.

double | null

Base cost.

double | null

Base cost override.

double | null

Base extended cost.

double | null

Base extended price.

double | null

Base price.

double | null

Base price override.

string | null

Base price method.

string | null

Billing frequency.

BaseProduct
object
BillingPreference
object
string | null

Billing rule.

BillingPlan
object
BillToAccount
object
string | null

Charge type.

string | null

Classification hierarchy.

string | null

Classification hierarchy info.

string | null

Classification id.

string | null

Comments.

double | null

Commitment quantity.

string | null

Contract numbers.

double | null

Cost.

string | null

Config status.

int32 | null

Copy source bundle number.

int32 | null

Copy source number.

string | null

Coupon code.

boolean | null

Is customizable.

boolean | null

Is read only.

string | null

Description.

double | null

Delta price.

double | null

Delta quantity.

DerivedFrom
object
date-time | null

End date.

double | null

Extended cost.

double | null

Extended price.

string | null

Extended description.

double | null

Extended quantity.

double | null

Flat option price.

string | null

Frequency.

double | null

Group adjustment percent.

string | null

Guidance.

boolean | null

Has attributes.

boolean | null

Has base product.

boolean | null

Has defaults.

boolean

Has incentives.

boolean | null

Has options.

boolean | null

Has tiered price.

Incentive
object
double | null

Incentive adjustment amount.

double | null

Incentive base price.

string | null

Incentive code.

double | null

Incentive extended price.

string | null

Incentive type.

boolean | null

Is asset pricing.

boolean | null

Is custom pricing.

boolean | null

Is hidden.

boolean | null

Is optional.

boolean | null

Is option rollup line.

boolean | null

Is primary line.

boolean | null

Is primary ramp line.

boolean | null

Is quantity modifiable.

boolean | null

Is selling term read only.

boolean | null

Is usage tier modifiable.

int32

Item sequence.

int32

Line number.

int32 | null

Line sequence.

string | null

Line status.

string | null

Line type.

double | null

List price.

double | null

Max price.

double | null

Max usage quantity.

string | null

Min max price applies to.

double | null

Min price.

double | null

Min usage quantity.

double | null

Net adjustment percent.

double | null

Net price.

double | null

Net unit price.

double | null

Option cost.

string | null

Option group label.

double | null

Option price.

int32 | null

Option sequence.

string | null

Order line status.

string | null

Override name.

int32 | null

Parent bundle number.

double | null

Price adjustment.

double | null

Price adjustment amount.

string | null

Price adjustment applies to.

string | null

Price adjustment type.

string | null

Price group.

boolean | null

Price included in bundle.

string | null

Price method.

string | null

Price type.

string | null

Price uom.

date-time | null

Pricing date.

string | null

Pricing guidance.

string | null

Pricing status.

string | null

Pricing steps.

Location
object
PaymentTerm
object
int32

Primary line number.

int32 | null

Primary txn line number.

ProductOption
object
double | null

Product version.

double | null

Related adjustment amount.

string | null

Related adjustment applies to.

string | null

Related adjustment type.

RelatedItem
object
double | null

Related percent.

string | null

Related percent applies to.

double | null

Quantity.

double | null

Renewal adjustment amount.

string | null

Renewal adjustment type.

string | null

Rollup price method.

boolean | null

Rollup price to bundle.

ShipToAccount
object
date-time | null

Start date.

string | null

Selling frequency.

double | null

Selling term.

string | null

Selling uom.

ServiceLocation
object
string | null

Status details.

SummaryGroup
object
boolean | null

Is taxable.

TaxCode
object
boolean | null

Is tax inclusive.

double | null

Term.

TransferPriceLineItem
object
double | null

Total quantity.

int32 | null

Txn parent bundle number.

double | null

Unit cost adjustment.

double | null

Unit price adjustment auto.

double | null

Unit price adjustment manual.

string | null

Uom.

string | null

Category hierarchy ids.

string | null

Parent configuration.

int32 | null

Collaboration parent line number.

string | null

Purchase id.

string | null

Benefit line type.

double | null

Target price.

double | null

Expert price.

double | null

Floor price.

double | null

ACV.

Attribute
object
AssetLineItem
object
Option
object
Product
object
Configuration
object
PriceList
object
PriceListItem
object
RelatedLineItems
array of objects | null

Related line items.

RelatedLineItems
Category
object
CollaborationRequest
object
CreatedBy
object
date-time | null

Created date.

string | null

Id.

ModifiedBy
object
date-time | null

Modified date.

string | null

Name.

string | null

Currency.

string | null

Digest.

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses
200

OK

202

Accepted

500

Internal Server Error

Updated 12 days ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 days ago

Did this page help you?