ShoppingCart

Add items to cart

Changed on Nov 6, 2026

Adds the specified item to the shopping cart

post/v3/checkout/shoppingCarts/{shoppingCartId}/items

Request

Base URL
https://marketplace.appdirect.com/api
Auth
none declared
TypeScript
https://skmtc.dev/appdirect/apis/companies/docs/v3/checkout/shoppingCarts/:shoppingCartId/items/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

shoppingCartIdstring required

Shopping cart ID

Request body

idstring

Item UUID

referenceIdstring

A 'local' ID for the item, which can be used in requests instead of the full UUID. Use the ref:{referenceId} format.

subscriptionIdstring

Existing subscription UUID.

pricingPlanIdstring

ID of the pricing plan that the user is going to purchase

discountCodestring

Discount applied to the product

discountIdstring

Discount ID

Example request

{
  "id": "45ae34b7-ffc1-4d74-be78-dce34008cd2e",
  "referenceId": "45",
  "subscriptionId": "83407ce8-373f-11e6-ac61-9e71128cae77",
  "pricingPlanId": "3dcc468d-fd4c-41ce-b700-f88c0c74561f",
  "serviceConfiguration": {
    "date": "2010-10-19T00:00:00.000Z"
  },
  "billingConfiguration": {
    "date": "1546300800000",
    "strategy": "CUSTOM"
  },
  "discountCode": "DISCOUNT",
  "discountId": "30",
  "customPrices": [
    {
      "costId": "9742e09a-e1b4-4b9e-b1a7-66df3e41cebe",
      "price": 20
    }
  ],
  "units": [
    {
      "quantity": "8",
      "unit": "USER"
    }
  ],
  "customAttributes": {
    "vendorRequiredFields": {
      "customAttributes": {
        "preferredColours": [
          "key_red",
          "key_white"
        ],
        "preferredTime": "12:00"
      }
    },
    "subscription": {
      "customAttributes": {
        "preferredColours": [
          "key_red",
          "key_white"
        ],
        "preferredTime": "12:00"
      }
    }
  },
  "customContractConfiguration": {
    "minimumServiceLengthUnit": "MONTHLY",
    "endOfContractGracePeriodUnit": "INFINITY",
    "contractCancellationPeriodUnit": "NONE",
    "terminationFeeGracePeriodUnit": "INFINITY"
  }
}

Response