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>"
}
'

import requests

url = "https://api.decodahealth.com/billing/cart/{cart_id}/items"

payload = {
    "itemId": "<string>",
    "packageId": "<string>",
    "quantity": 1,
    "unitPrice": 123,
    "discountAmount": 0,
    "discountPercentage": 0,
    "notes": "<string>"
}
headers = {
    "TENANT": "<tenant>",
    "API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    itemId: '<string>',
    packageId: '<string>',
    quantity: 1,
    unitPrice: 123,
    discountAmount: 0,
    discountPercentage: 0,
    notes: '<string>'
  })
};

fetch('https://api.decodahealth.com/billing/cart/{cart_id}/items', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.decodahealth.com/billing/cart/{cart_id}/items",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'itemId' => '<string>',
    'packageId' => '<string>',
    'quantity' => 1,
    'unitPrice' => 123,
    'discountAmount' => 0,
    'discountPercentage' => 0,
    'notes' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "API-KEY: <api-key>",
    "Content-Type: application/json",
    "TENANT: <tenant>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.decodahealth.com/billing/cart/{cart_id}/items"

	payload := strings.NewReader("{\n  \"itemId\": \"<string>\",\n  \"packageId\": \"<string>\",\n  \"quantity\": 1,\n  \"unitPrice\": 123,\n  \"discountAmount\": 0,\n  \"discountPercentage\": 0,\n  \"notes\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("TENANT", "<tenant>")
	req.Header.Add("API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.decodahealth.com/billing/cart/{cart_id}/items")
  .header("TENANT", "<tenant>")
  .header("API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"itemId\": \"<string>\",\n  \"packageId\": \"<string>\",\n  \"quantity\": 1,\n  \"unitPrice\": 123,\n  \"discountAmount\": 0,\n  \"discountPercentage\": 0,\n  \"notes\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.decodahealth.com/billing/cart/{cart_id}/items")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"itemId\": \"<string>\",\n  \"packageId\": \"<string>\",\n  \"quantity\": 1,\n  \"unitPrice\": 123,\n  \"discountAmount\": 0,\n  \"discountPercentage\": 0,\n  \"notes\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "patient": {
    "id": "<string>",
    "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>"
    ],
    "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>"
  },
  "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>",
      "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>",
        "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>"
        ],
        "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>"
      }
    }
  ],
  "createdDate": "2023-11-07T05:31:56Z",
  "updatedDate": "2023-11-07T05:31:56Z",
  "expiresDate": "2023-11-07T05:31:56Z",
  "notes": "<string>",
  "convertedChargeId": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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>"
}
'

import requests

url = "https://api.decodahealth.com/billing/cart/{cart_id}/items"

payload = {
    "itemId": "<string>",
    "packageId": "<string>",
    "quantity": 1,
    "unitPrice": 123,
    "discountAmount": 0,
    "discountPercentage": 0,
    "notes": "<string>"
}
headers = {
    "TENANT": "<tenant>",
    "API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    itemId: '<string>',
    packageId: '<string>',
    quantity: 1,
    unitPrice: 123,
    discountAmount: 0,
    discountPercentage: 0,
    notes: '<string>'
  })
};

fetch('https://api.decodahealth.com/billing/cart/{cart_id}/items', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.decodahealth.com/billing/cart/{cart_id}/items",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'itemId' => '<string>',
    'packageId' => '<string>',
    'quantity' => 1,
    'unitPrice' => 123,
    'discountAmount' => 0,
    'discountPercentage' => 0,
    'notes' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "API-KEY: <api-key>",
    "Content-Type: application/json",
    "TENANT: <tenant>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.decodahealth.com/billing/cart/{cart_id}/items"

	payload := strings.NewReader("{\n  \"itemId\": \"<string>\",\n  \"packageId\": \"<string>\",\n  \"quantity\": 1,\n  \"unitPrice\": 123,\n  \"discountAmount\": 0,\n  \"discountPercentage\": 0,\n  \"notes\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("TENANT", "<tenant>")
	req.Header.Add("API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.decodahealth.com/billing/cart/{cart_id}/items")
  .header("TENANT", "<tenant>")
  .header("API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"itemId\": \"<string>\",\n  \"packageId\": \"<string>\",\n  \"quantity\": 1,\n  \"unitPrice\": 123,\n  \"discountAmount\": 0,\n  \"discountPercentage\": 0,\n  \"notes\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.decodahealth.com/billing/cart/{cart_id}/items")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"itemId\": \"<string>\",\n  \"packageId\": \"<string>\",\n  \"quantity\": 1,\n  \"unitPrice\": 123,\n  \"discountAmount\": 0,\n  \"discountPercentage\": 0,\n  \"notes\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "patient": {
    "id": "<string>",
    "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>"
    ],
    "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>"
  },
  "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>",
      "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>",
        "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>"
        ],
        "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>"
      }
    }
  ],
  "createdDate": "2023-11-07T05:31:56Z",
  "updatedDate": "2023-11-07T05:31:56Z",
  "expiresDate": "2023-11-07T05:31:56Z",
  "notes": "<string>",
  "convertedChargeId": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<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.

string

required

Cart ID

patient

PatientSummary · object

required

Patient details

Show child attributes

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

read-only

Calculate subtotal from items after item-level discounts.

creator

ProviderTiny · object | null

Creator details

Show child attributes

items

CartItem · object[]

Items and packages in the cart

Show child attributes

quotes

QuoteSummary · object[]

Quotes created from this cart

Show child attributes

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

Acknowledge Cash Balance Discrepancy Add Item To Quote

Getting Started

API Guides

API

Tenant

Patient Portal

Webhook

Add Item To Cart

Headers

Path Parameters

Body

Response