v1

latestOpenAPI 3.1.02026-07-242470655.6 KB

Get Cart

get/site/{site_name}/ecommerce/carts/{cart_id}

Path parameters

site_namestring required

The unique identifier for the target site.

cart_idstring required

The unique identifier for the target site.

Response

200

createdstring
currencystring
emailstring
idstring
ip_addressstring
languagestring
metadatastring
modestring
shipping_instructionsstring
statusstring
subtotalnumber
totalnumber
updatedstring
user_agentstring

Example response

{
  "billing_address": {
    "address_1": "string",
    "address_2": "string",
    "city": "string",
    "country": "string",
    "first_name": "string",
    "full_name": "string",
    "last_name": "string",
    "phone": "string",
    "postal_code": "string",
    "region": "string",
    "street_name": "string",
    "street_number": "string",
    "sub_locality": "string"
  },
  "created": "2023-02-01T18:24:26.700Z",
  "currency": "USD",
  "discounts": [
    {
      "id": "e40b1abb-af80-4a4e-b6f0-4746c0e8a90a",
      "name": "15OFF",
      "savings": 42.36,
      "type": "RATE"
    }
  ],
  "email": "john.doe@example.org",
  "id": "e40b1abb-af80-4a4e-b6f0-4746c0e8a90a",
  "ip_address": "1.1.1.1",
  "items": [
    {
      "added": "2023-02-01T18:24:26.700Z",
      "combined_weight": 60.48,
      "discounts": [
        {
          "id": "e40b1abb-af80-4a4e-b6f0-4746c0e8a90a",
          "name": "My discount",
          "savings": 10.25,
          "type": "RATE"
        }
      ],
      "external_product_id": "string",
      "external_variation_id": "string",
      "id": "e40b1abb-af80-4a4e-b6f0-4746c0e8a90a",
      "image": "https://example.org/image.jpg",
      "metadata": "string",
      "name": "My product name",
      "options": [
        {
          "name": "Color",
          "value": "Red"
        }
      ],
      "product_id": "string",
      "quantity": 3,
      "shippable": true,
      "taxes": [
        {
          "amount": 10.25,
          "name": "Federal tax",
          "rate": 0.15
        }
      ],
      "total": 75.96,
      "unit_dimensions": {
        "height": 20,
        "length": 30,
        "width": 30
      },
      "unit_price": 25.35,
      "unit_weight": 20.16,
      "variation_id": "string"
    }
  ],
  "language": "en",
  "metadata": "string",
  "mode": "LIVE",
  "shipping_address": {
    "address_1": "string",
    "address_2": "string",
    "city": "string",
    "country": "string",
    "first_name": "string",
    "full_name": "string",
    "last_name": "string",
    "phone": "string",
    "postal_code": "string",
    "region": "string",
    "street_name": "string",
    "street_number": "string",
    "sub_locality": "string"
  },
  "shipping_instructions": "string",
  "shipping_method": {
    "cost": 12.45,
    "name": "Express shipping"
  },
  "status": "IN_PROGRESS",
  "subtotal": 10.54,
  "taxes": [
    {
      "amount": 10.23,
      "name": "Federal tax",
      "rate": 0.15
    }
  ],
  "total": 10.54,
  "updated": "2023-02-01T18:24:26.700Z",
  "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (HTML, like Gecko) Chrome/105.0.0.0 Safari/537.36"
}