Add session item

Appends a new product item to the cart of an existing order session.

Path Params
string
required

The unique identifier for the checkout instance, in the format store-id/checkout-id (e.g., fastspring/main).

Note: Target a specific checkout path to route the session to a single buyer experience and ensure accurate pricing. Stores frequently run multiple checkout variations simultaneously.

string
required
length ≤ 64

The unique identifier of the order session.

Body Params

Details a specific line item being added or modified within a cart.

string
required
length ≤ 256

The unique identifier of the catalog product to add.

integer

The total volume of units to purchase. Defaults to 1 if omitted.

string

Indicates whether the buyer is allowed to modify the item quantity during checkout. Requires an authenticated request.

integer

The default quantity presented at checkout. Requires an authenticated request.

descriptions
object

Specifies localized descriptive fields for a product. Requires an authenticated request to modify.

customPrice
object

Overrides the base catalog price with a custom defined pricing structure. Requires an authenticated request.

attributes
object

A key-value map of custom metadata tied specifically to this order item. Requires an authenticated request.

subscriptionOverrides
object

Custom subscription configurations that override the base catalog setup for this specific line item. Requires an authenticated request.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json