Add a variant

Path Parameters

Parameter	Details
basketId required	string Example: fySXbTJxa9q_xu_t8edGOHYeJSpaxe7A

Query Parameters

Parameter	Details
campaignKey	string Example: e6413f96-b47c-4be1-be61-d2206adeae71
includeItemsWithoutProductData	boolean Example: true
pricePromotionKey	string Example: promotion-key-123
skipAvailabilityCheck	boolean Example: true
with	Array of strings string Example: [ "items.product.attributes" ]
shopId	integer Example: 10001

Header Parameters

Parameter	Details
X-Shop-Id	integer Example: 10001
X-Order-Custom-Data	string Example: YWJjMTIz
X-Customer-Token	string Example: yJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3O DkwIi
X-Access-Token required	string Example: f36POk6yJV_adQssw5c

Request body

Parameter	Details
quantity required	integer
variantId required	integer
promotionId	string
promotionCode	string
customData	object pricePromotionKey string
displayData	object meta object name object identifier object attribute-1 object attribute-2 object attribute-3 object
itemGroup required nullable	object id string MaxLength: 8 isMainItem boolean isRequired boolean

Responses

201

The variant was added to the Basket with all of the request quantity.

application/json

Success

keyrequired

string

required

Array of object

required

object

required

Array of object

206

The variant was added to the Basket however with a reduced quantity.

application/json

Success

400

Required query parameter missing / invalid

application/json

Error

401

Authentication information is missing or invalid

application/json

Error

404

The specified resource was not found

application/json

Error

409

Basket item for the given variant already exists.

application/json

Error

412

The variant is out of stock.

application/json

Error

413

Attempt to place an item in a basket with quantity value that is larger than maximum allowed value per item.

application/json

Error

423

Dependency is currently locked due to another request, please retry.

application/json

Error

424

The API Request failed due to an underlying dependency error.

application/json

Error

429

Triggered when a client exceeds the API request limit.

application/json

Error

POST/v1/baskets/{basketId}/items