Skip to main content
GET
/
api
/
v1
/
domains
/
{domain}
/
cart
curl --request GET \
  --url https://api.firmly.work/api/v1/domains/staging.luma.gift/cart \
  --header 'x-firmly-authorization: YOUR_TOKEN'
{
  "cart_discount": { 
    "currency": "USD", 
    "value": 0, 
    "symbol": "$", 
    "number": 0 
  },
  "line_items": [
    {
      "base_sku": "WS12",
      "description": "Radiant Tee - Orange XS",
      "image": {
        "url": "https://cdn.staging.luma.gift/products/radiant-tee/orange.jpg"
      },
      "line_item_id": "00000000-0000-0000-0000-000000000000",
      "line_price": { 
        "currency": "USD", 
        "value": 22.00, 
        "symbol": "$", 
        "number": 2200 
      },
      "msrp": { 
        "currency": "USD", 
        "value": 22.00, 
        "symbol": "$", 
        "number": 2200 
      },
      "platform_line_item_id": "4df9941b-bd06-4495-8759-61c6145dc408",
      "price": { 
        "currency": "USD", 
        "value": 22.00, 
        "symbol": "$", 
        "number": 2200 
      },
      "quantity": 1,
      "requires_shipping": true,
      "sku": "WS12-XS-Orange"
    }
  ],
  "payment_method_options": [
    {
      "type": "CreditCard",
      "wallet": "user"
    }
  ],
  "shipping_total": { 
    "currency": "USD", 
    "value": 0, 
    "symbol": "$", 
    "number": 0 
  },
  "sub_total": { 
    "currency": "USD", 
    "value": 869.99, 
    "symbol": "$", 
    "number": 86999 
  },
  "tax": { 
    "currency": "USD", 
    "value": 2.20, 
    "symbol": "$", 
    "number": 220 
  },
  "total": { 
    "currency": "USD", 
    "value": 24.20, 
    "symbol": "$", 
    "number": 2420 
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.firmly.ai/llms.txt

Use this file to discover all available pages before exploring further.

Overview

Gets the current state of the cart with line items and pricing information. Returns an empty cart if no items have been added yet.

Authentication

x-firmly-authorization
string
required
Device authentication token from browser session

Path Parameters

domain
string
required
Merchant domain (e.g., staging.luma.gift)

Query Parameters

fast_mode
string
default:"false"
Set to true for faster response with potentially cached data

Response

Returns the shopping cart with line items, pricing, and available options.

Response Fields

cart_id
string
Unique identifier for the cart
cart_status
string
Current cart status (active, submitted, etc.)
display_name
string
Merchant display name
platform_id
string
E-commerce platform identifier
shop_id
string
Merchant identifier
line_items
array
Array of items in the cart
sub_total
object
Subtotal before shipping and tax
shipping_total
object
Shipping cost (if shipping info has been set)
tax
object
Tax amount
total
object
Grand total including all costs
shipping_info
object
Shipping address (if set)
shipping_method
object
Selected shipping method (if set)
shipping_method_options
array
Available shipping methods (if shipping info has been set)
payment_method_options
array
Available payment methods
notice
array
Array of notice messages (Simple Cart API uses string array)
curl --request GET \
  --url https://api.firmly.work/api/v1/domains/staging.luma.gift/cart \
  --header 'x-firmly-authorization: YOUR_TOKEN'
{
  "cart_discount": { 
    "currency": "USD", 
    "value": 0, 
    "symbol": "$", 
    "number": 0 
  },
  "line_items": [
    {
      "base_sku": "WS12",
      "description": "Radiant Tee - Orange XS",
      "image": {
        "url": "https://cdn.staging.luma.gift/products/radiant-tee/orange.jpg"
      },
      "line_item_id": "00000000-0000-0000-0000-000000000000",
      "line_price": { 
        "currency": "USD", 
        "value": 22.00, 
        "symbol": "$", 
        "number": 2200 
      },
      "msrp": { 
        "currency": "USD", 
        "value": 22.00, 
        "symbol": "$", 
        "number": 2200 
      },
      "platform_line_item_id": "4df9941b-bd06-4495-8759-61c6145dc408",
      "price": { 
        "currency": "USD", 
        "value": 22.00, 
        "symbol": "$", 
        "number": 2200 
      },
      "quantity": 1,
      "requires_shipping": true,
      "sku": "WS12-XS-Orange"
    }
  ],
  "payment_method_options": [
    {
      "type": "CreditCard",
      "wallet": "user"
    }
  ],
  "shipping_total": { 
    "currency": "USD", 
    "value": 0, 
    "symbol": "$", 
    "number": 0 
  },
  "sub_total": { 
    "currency": "USD", 
    "value": 869.99, 
    "symbol": "$", 
    "number": 86999 
  },
  "tax": { 
    "currency": "USD", 
    "value": 2.20, 
    "symbol": "$", 
    "number": 220 
  },
  "total": { 
    "currency": "USD", 
    "value": 24.20, 
    "symbol": "$", 
    "number": 2420 
  }
}

Error Responses

400 Bad Request

Missing or invalid authentication header

404 Not Found

Cart was not found

503 Service Unavailable

Store temporarily unavailable