Skip to main content
GET
/
billing
/
cart
/
list
Get Carts List
curl --request GET \
  --url https://api.decodahealth.com/billing/cart/list \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "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

Query Parameters

​
patient_id
string | null

Filter by patient ID

​
status
enum<string> | null

Filter by cart status Status of a patient cart.

Available options:
DRAFT,
ABANDONED,
ACCEPTED,
REJECTED,
CONVERTED,
EXPIRED

Response

Successful Response

​
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