Gets a cart.

1 min

GET

http://localhost:65349//api/episerver/v2.0/carts/{cartId}

Path Parameters

cartIdstring<uuid>required
Description
The cart id.
Format
uuid

Header Parameters

acceptstring
Description
Generated from available response content types
Default
application/json
Allowed
application/jsontext/jsonapplication/xmltext/xml

Responses

200OK

CartApiModel
Description
Represents a cart.
- Idstring<uuid>
  Example
  00000000-0000-0000-0000-000000000000
  Description
  The cart id.
  Format
  uuid
- Namestringrequired
  Description
  The cart name.
- CustomerIdstring<uuid>
  Example
  00000000-0000-0000-0000-000000000000
  Description
  The customer the cart belongs to.
  Format
  uuid
- Marketstringrequired
  Description
  The market in which the cart is valid.
- Currencystringrequired
  Description
  The currency of the market in which the cart is valid.
- LastUpdatedstring<date-time>
  Description
  The last updated timestamp.
  Format
  date-time
- ShipmentsShipmentModel[]
  Description
  The shipments.
  - Idstring<uuid>
    Example
    00000000-0000-0000-0000-000000000000
    Description
    The shipping id.
    Format
    uuid
  - ShippingAddressAddressModel
    Description
    Represents a customer address todo: associate with commerce customers via business foundation? todo: add more properties.
    - FirstNamestring
      Description
      The first name.
    - LastNamestring
      Description
      The last name.
    - Line1string
      Description
      The line1.
    - Line2string
      Description
      The line2.
    - Citystring
      Description
      The city.
    - CountryNamestring
      Description
      The country name.
    - PostalCodestring
      Description
      The postal code
    - RegionNamestring
      Description
      The region name/state
    - Emailstring
      Description
      The email.
    - PhoneNumberstring
      Description
      The phone number.
  - ShippingMethodIdstring<uuid>
    Example
    00000000-0000-0000-0000-000000000000
    Description
    The shipping method id.
    Format
    uuid
  - LineItemsLineItemModel[]
    Description
    the line items that belong to the cart.
    - Idstring<uuid>
      Example
      00000000-0000-0000-0000-000000000000
      Description
      The line item id.
      Format
      uuid
    - ContentIdstring<uuid>
      Example
      00000000-0000-0000-0000-000000000000
      Description
      The content id.
      Format
      uuid
    - Codestring
      Description
      The sku code.
    - PlacedPricenumber<decimal>
      Description
      The placed price.
      Format
      decimal
    - Quantitynumber<decimal>required
      Description
      The quantity.
      Format
      decimal
    - DisplayNamestring
      Description
      The display name.
    - IsGiftboolean
      Description
      Indicates whether the line item is a gift item.
- CouponCodesstring[]
  Description
  The coupon codes.

400Bad Request

403Forbidden

404Not Found

curl

curl --request GET \
     --url http://localhost:65349//api/episerver/v2.0/carts/{cartId} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("http://localhost:65349//api/episerver/v2.0/carts/{cartId}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("http://localhost:65349//api/episerver/v2.0/carts/{cartId}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

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

python

import requests
import json

url = "http://localhost:65349//api/episerver/v2.0/carts/{cartId}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// OK
{
  "Id": "00000000-0000-0000-0000-000000000000",
  "Name": "",
  "CustomerId": "00000000-0000-0000-0000-000000000000",
  "Market": "",
  "Currency": "",
  "LastUpdated": "",
  "Shipments": [
    {
      "Id": "00000000-0000-0000-0000-000000000000",
      "ShippingAddress": {
        "FirstName": "",
        "LastName": "",
        "Line1": "",
        "Line2": "",
        "City": "",
        "CountryName": "",
        "PostalCode": "",
        "RegionName": "",
        "Email": "",
        "PhoneNumber": ""
      },
      "ShippingMethodId": "00000000-0000-0000-0000-000000000000",
      "LineItems": [
        {
          "Id": "00000000-0000-0000-0000-000000000000",
          "ContentId": "00000000-0000-0000-0000-000000000000",
          "Code": "",
          "PlacedPrice": "",
          "Quantity": "",
          "DisplayName": "",
          "IsGift": false
        }
      ]
    }
  ],
  "CouponCodes": [
    ""
  ]
}

400

// Bad Request

403

// Forbidden

404

// Not Found