get
https://www.locally.com/api/v2/cart/
Retrieves all of the data for a specific cart.
Request Parameters
🏷️ header · 🔗 path · unmarked parameters are query params
| Parameter | Type | Required | Description |
|---|---|---|---|
Locally-Api-Token 🏷️ | string | No | Locally issued API key. Defaults to ea432b8935xxx459be4gf147b33ae3uf0cae2337. |
cart_hash 🔗 | string | Yes | Unique identifier for a cart. Defaults to QE3QL6. |
Example Request
curl 'https://www.locally.com/api/v2/cart/{{CART_HASH}}' \
--header 'Locally-Api-Token: {{API_TOKEN}}'const response = await fetch('https://www.locally.com/api/v2/cart/{{CART_HASH}}', {
headers: {
'Locally-Api-Token': '{{API_TOKEN}}'
}
});
const cart = await response.json();import requests
response = requests.get(
"https://www.locally.com/api/v2/cart/{{CART_HASH}}",
headers={"Locally-Api-Token": "{{API_TOKEN}}"},
)
cart = response.json()Example Response
{
"status": true,
"properties": {
"date_time": "2022-02-03 11:11:18",
"type": "HOLD",
"hash": "QE3QL6",
"ordered_at": "2022-02-03 11:07:42",
"updated_at": "2022-02-03 11:09:43",
"delivery_status": "",
"invoice": "https://www.locally.com/order/QE3QL6/S615W9CDQK7M?print=1"
},
"customer": {
"first_name": "John",
"last_name": "Doe",
"address_1": "509 N Carrollton Ave",
"address_2": "",
"city": "New Orleans",
"state": "LA",
"zip": "21541",
"country": "US",
"email": "[email protected]",
"phone": "",
"marketing_active_consent": "answer_yes"
},
"store": {
"name": "Locally Test Store Netherlands",
"phone": "",
"address": "1012 KN",
"address_2": "",
"city": "Amsterdam",
"state": "",
"zip": "9V9R+RV",
"country": "NL",
"store_id": 245728,
"vendor_id": 0
},
"items": [
{
"status": "Ordered",
"sts_status": false,
"product_id": 967586,
"qty": 1,
"brand": "Trek",
"upc": "601842495575",
"name": "Bontrager Circuit Road Cycling Shoe",
"attrib_1": "US Men 4/Women 5.5/EU 37",
"attrib_2": "",
"currency": "EUR",
"msrp": "100.00",
"product_price": "100.00",
"product_price_less_vat": "100.00",
"subtotal": "100.00",
"tax": "0.00",
"tax_rate": "0.00",
"tax_is_vat": true,
"tax_remitted": false,
"commission": "3.50",
"stripe_fee": "3.20",
"total": "100.00",
"disbursement": "96.80",
"order_resolution": "",
"resolution_notes": "",
"messages": [
{
"sender": "retailer",
"description": "test message",
"created_at": "2022-02-03 11:09:41"
},
{
"sender": "customer",
"description": "test message to store",
"created_at": "2022-02-03 11:58:21"
}
]
}
]
}{
"status": true,
"properties": {
"date_time": "2026-01-29 10:58:49",
"type": "DELIVERY",
"hash": "EX2",
"pickup_window": "",
"ordered_at": "2026-01-29 08:50:36",
"updated_at": "2026-01-29 10:17:56",
"delivery_status": "Delivery to destination complete",
"invoice": "https://www.locally.com/order/EX2/SYOYG5FQK?print=1"
},
"customer": {
"first_name": "TEST",
"last_name": "USER",
"address_1": "2020 W Willow St",
"address_2": "",
"city": "Chicago",
"state": "IL",
"zip": "60647",
"country": "US",
"email": "[email protected]",
"phone": "3125551234",
"marketing_active_consent": "answer_yes"
},
"store": {
"name": "Arc'teryx Chicago",
"phone": "(773) 555-0134",
"address": "1630 N Damen Ave",
"address_2": "",
"city": "Chicago",
"state": "IL",
"zip": "60647",
"country": "US",
"store_id": 37175,
"vendor_id": 0
},
"items": [
{
"status": "Confirmed",
"status_code": 35,
"sts_status": false,
"product_id": 548303,
"qty": 1,
"brand": "Arc'teryx",
"upc": "686487455948",
"alias": [],
"name": "Gamma SL Hoody Men's",
"attrib_1": "L",
"attrib_2": "",
"currency": "USD",
"msrp": "225.00",
"product_price": "225.00",
"product_price_less_vat": "225.00",
"subtotal": "225.00",
"tax": "23.06",
"tax_rate": "10.25",
"tax_is_vat": false,
"tax_remitted": true,
"shipping_cost": "0.00",
"commission": "7.88",
"stripe_fee": "7.49",
"total": "248.06",
"order_resolution": "",
"resolution_notes": "",
"messages": [
{
"sender": "locally",
"description": "A Postmates driver will be coming to pick up Gamma SL Hoody Men's",
"created_at": "2026-01-29 10:11:24"
},
{
"sender": "locally",
"description": "Package the item. Copy the tracking ID and affix it to the package",
"created_at": "2026-01-29 10:14:37"
},
{
"sender": "locally",
"description": "Delivery is complete! We thanked your customer for shopping at your store.",
"created_at": "2026-01-29 10:17:56"
}
],
"disbursement": "240.57"
}
],
"delivery": {
"delivery_type": "API",
"carrier_id": 2,
"status": 5,
"carrier_name": "Postmates",
"customer_fee": "6.00",
"carrier_fee": "6.00",
"tracking_url": "https://delivery.uber.com/orders/62105936-e413-40d5-aecd-4c335c3cd3c2",
"estimated_pickup_at": "2026-01-29 16:15:13",
"estimated_dropoff_at": "2026-01-29 16:17:56",
"signature_url": "https://www.example.com/signature.jpg",
"dropoff_photo_url": "https://www.example.com/picture.jpg",
"address": {
"first_name": "TEST",
"last_name": "USER",
"address_1": "2020 W Willow St",
"address_2": "",
"city": "Chicago",
"state": "IL",
"zip": "60647",
"country": "US"
},
"driver": {
"name": "TEST DRIVER",
"vehicle_description": "Red Toyota Camry",
"photo_url": "https://via.placeholder.com/150",
"location": {
"lat": 41.91136867,
"lng": -87.67771437
}
}
}
}Response Explanation
properties.date_time— Timestamp of when this response was generated (server time), not an order event; useordered_atandupdated_atfor order timing.properties.type— Fulfillment type:HOLD(reservation, pay in store),ORDER(paid in-store pickup),DELIVERY(local delivery), orSHIPMENT(ship-to-store).properties.hash— Unique cart identifier — pass it as thecart_hashpath parameter on other Cart API calls such as Update a Cart Item.properties.pickup_window— Pickup time slot the shopper selected for an in-store pickup order; empty string when none was chosen.properties.delivery_status— Human-readable progress of a delivery order (e.g.Delivery to destination complete); empty string for non-delivery carts or before the delivery process starts.items[].status— Item state label, paired with the numericstatus_code. All values and their end states are listed in Cart Item Statuses.items[].sts_status— Ship-to-Store only:falseunless the item is a ship-to-store order, otherwise a stage slug such asconfirm-store,confirm-brand,processing,shipped,ready-for-pickup, orpicked-up.items[].alias— Alternate item codes (UPC aliases, such as your SKUs) registered with Locally for this UPC; an empty array when none exist.items[].disbursement— Net amount paid out to the retailer for this item after Locally'scommissionand thestripe_feeprocessing fee. Money fields are decimal strings incurrencyunits.delivery— Present only onDELIVERYcarts:tracking_urlis the live tracking link anddriverstaysnulluntil a courier is assigned.