Skip to main content
POST
/
billing
/
cart
/
{cart_id}
/
items
Add Item To Cart
curl --request POST \
  --url https://api.decodahealth.com/billing/cart/{cart_id}/items \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "itemId": "<string>",
  "packageId": "<string>",
  "quantity": 1,
  "unitPrice": 123,
  "discountAmount": 0,
  "discountPercentage": 0,
  "notes": "<string>"
}
'
{
  "id": "<string>",
  "patient": {
    "id": "<string>",
    "type": "PROVIDER",
    "createdDate": "2023-11-07T05:31:56Z",
    "firstName": "<string>",
    "lastName": "<string>",
    "phoneNumber": "<string>",
    "email": "<string>",
    "locationId": "<string>",
    "externalId": "<string>",
    "address": "<string>",
    "addressLineTwo": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zipCode": "<string>",
    "country": "<string>",
    "addressValid": true,
    "meta": {},
    "isArchived": true,
    "primaryLocationId": "<string>",
    "gender": "<string>",
    "dateOfBirth": "2023-12-25",
    "patientMedications": [
      "<string>"
    ],
    "patientSource": "SELF_SCHEDULING",
    "leadSource": "<string>",
    "onSchedulingBlacklist": true,
    "surchargeDisabled": true,
    "tags": [
      {
        "id": "<string>",
        "name": "<string>",
        "isActive": true,
        "createdDate": "2023-11-07T05:31:56Z",
        "emoji": "<string>",
        "color": "<string>",
        "updatedDate": "2023-11-07T05:31:56Z"
      }
    ],
    "creditBalance": 123,
    "preferredProviderId": "<string>",
    "dosespotPatientId": "<string>"
  },
  "status": "DRAFT",
  "discountAmount": 123,
  "discountPercentage": 123,
  "taxAmount": 123,
  "total": 123,
  "subtotal": 123,
  "creator": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "createdDate": "2023-11-07T05:31:56Z"
  },
  "items": [],
  "quotes": [
    {
      "id": "<string>",
      "patientId": "<string>",
      "status": "DRAFT",
      "discountAmount": 123,
      "discountPercentage": 123,
      "taxAmount": 123,
      "total": 123,
      "creatorId": "<string>",
      "cartId": "<string>",
      "title": "<string>",
      "itemCount": 0,
      "packageCount": 0,
      "createdDate": "2023-11-07T05:31:56Z",
      "updatedDate": "2023-11-07T05:31:56Z",
      "validUntilDate": "2023-11-07T05:31:56Z",
      "sentDate": "2023-11-07T05:31:56Z",
      "viewedDate": "2023-11-07T05:31:56Z",
      "respondedDate": "2023-11-07T05:31:56Z",
      "internalNotes": "<string>",
      "creator": {
        "id": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "createdDate": "2023-11-07T05:31:56Z"
      },
      "patient": {
        "id": "<string>",
        "type": "PROVIDER",
        "createdDate": "2023-11-07T05:31:56Z",
        "firstName": "<string>",
        "lastName": "<string>",
        "phoneNumber": "<string>",
        "email": "<string>",
        "locationId": "<string>",
        "externalId": "<string>",
        "address": "<string>",
        "addressLineTwo": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zipCode": "<string>",
        "country": "<string>",
        "addressValid": true,
        "meta": {},
        "isArchived": true,
        "primaryLocationId": "<string>",
        "gender": "<string>",
        "dateOfBirth": "2023-12-25",
        "patientMedications": [
          "<string>"
        ],
        "patientSource": "SELF_SCHEDULING",
        "leadSource": "<string>",
        "onSchedulingBlacklist": true,
        "surchargeDisabled": true,
        "tags": [
          {
            "id": "<string>",
            "name": "<string>",
            "isActive": true,
            "createdDate": "2023-11-07T05:31:56Z",
            "emoji": "<string>",
            "color": "<string>",
            "updatedDate": "2023-11-07T05:31:56Z"
          }
        ],
        "creditBalance": 123,
        "preferredProviderId": "<string>",
        "dosespotPatientId": "<string>"
      }
    }
  ],
  "createdDate": "2023-11-07T05:31:56Z",
  "updatedDate": "2023-11-07T05:31:56Z",
  "expiresDate": "2023-11-07T05:31:56Z",
  "notes": "<string>",
  "convertedChargeId": "<string>"
}

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Path Parameters

​
cart_id
string
required

Body

application/json

Schema for creating cart items (can be either items or packages).

​
itemId
string | null

ID of the item to add to cart

​
packageId
string | null

ID of the package to add to cart

​
quantity
number
default:1

Quantity of the item/package

​
unitPrice
integer | null

Custom unit price in cents (if different from item/package price)

​
discountAmount
integer
default:0

Discount amount in cents

​
discountPercentage
number
default:0

Discount percentage (0-100)

​
notes
string | null

Notes about this item/package

Response

Successful Response

Summary schema for cart with basic details.

​
id
string
required

Cart ID

​
patient
PatientSummary · object
required

Patient details

​
status
enum<string>
required

Cart status

Available options:
DRAFT,
ABANDONED,
ACCEPTED,
REJECTED,
CONVERTED,
EXPIRED
​
discountAmount
integer
required

Total discount in cents

​
discountPercentage
number
required

Overall discount percentage

​
taxAmount
integer
required

Total tax in cents

​
total
integer
required

Final total in cents

​
subtotal
integer
required

Calculate subtotal from items after item-level discounts.

​
creator
ProviderTiny · object

Creator details

​
items
CartItem · object[]

Items and packages in the cart

​
quotes
QuoteSummary · object[]

Quotes created from this cart

​
createdDate
string<date-time> | null

Date the cart was created

​
updatedDate
string<date-time> | null

Date the cart was last updated

​
expiresDate
string<date-time> | null

When the cart expires

​
notes
string | null

Notes about the cart

​
convertedChargeId
string | null

ID of charge if cart was converted