Generate ramp periods

post

https://rls.congacloud.com/api/cart/v1/carts/{cartId}/ramp-periods

Generate the ramp periods for the given cart ID

Required Fields:

cartId (route) - required
generateMassPriceRampRequest (body) - required

Responses

200 OK: the ramp periods were generated.
400 Bad Request: the request payload is invalid.
500 Internal Server Error: an unexpected error occurred or price ramps are not enabled.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

cartId

string

required

A unique identifier of the cart

Body Params

Frequency

string | null

Frequency.

Term

int32 | null

Term.

StartDate

date-time | null

Start date.

EndDate

date-time | null

End date.

TermFrequency

string | null

Term frequency.

CartId

string | null

Cart id.

ErrorDetail

string | null

Error detail.

AdditionalDetails

string

Additional details.

IsRestoreRequest

boolean

Is restore request.

StartSyncToCrmOnPriceComplete

boolean

Start sync to crm on price complete.

Cart

object

CartConfigurationSettings

object

CartLDFeatureFlag

object

PricingLDFeatureFlag

object

ConfigLDFeatureFlag

object

CartMetadata

object

TraceContext

string | null

Trace context.

PropertyBag

object | null

Property bag.

SpanContext

object | null

Span context.

IsDebuggerEnabled

boolean

Is debugger enabled.

Context

object

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

500

Internal Server Error

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request