GET cart/list/{cartCollectionKey}?name={name}

Returns an array of carts contained by the collection matching the received "cartCollectionKey". This method can be used for client applications to display a list of carts for the user to select as their current cart for systems which allow multiple carts per user.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
cartCollectionKey

Cart collection key

string

Required

name

Optional filter by name of cart

string

None.

Body Parameters

None.

Response Information

Resource Description

CartListResponse
NameDescriptionTypeAdditional information
CurrentCartId

integer

None.

Carts

Collection of CartResponse

None.

Response Formats

application/json, text/json

Sample:
{
  "CurrentCartId": 1,
  "Carts": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "ExtendedData": "sample string 4",
      "CartItems": [
        {
          "Id": 1,
          "Item": "sample string 2",
          "Quantity": 3,
          "ExtendedData": "sample string 4",
          "Created": "2021-05-13T17:32:19.4066251-04:00",
          "Updated": "2021-05-13T17:32:19.4066251-04:00"
        },
        {
          "Id": 1,
          "Item": "sample string 2",
          "Quantity": 3,
          "ExtendedData": "sample string 4",
          "Created": "2021-05-13T17:32:19.4066251-04:00",
          "Updated": "2021-05-13T17:32:19.4066251-04:00"
        }
      ],
      "CartCheckoutInfo": {
        "PONumber": "sample string 1",
        "EndUserPO": "sample string 2",
        "RequestedDeliveryDate": "2021-05-13T17:32:19.4066251-04:00",
        "ShipMethodServiceLevelCode": "sample string 3",
        "ServiceLevelDescription": "sample string 4",
        "ShippingAccountNumber": "sample string 5",
        "FreightForwarderNumber": "sample string 6",
        "ShipComplete": true,
        "Memo": "sample string 8",
        "PayorId": "sample string 9",
        "ShippingAddress": {
          "Name": "sample string 1",
          "Street1": "sample string 2",
          "Street2": "sample string 3",
          "City": "sample string 4",
          "State": "sample string 5",
          "PostalCode": "sample string 6",
          "Country": "sample string 7"
        },
        "Carrier": {
          "CarrierAddress": {
            "Name": "sample string 1",
            "Street1": "sample string 2",
            "Street2": "sample string 3",
            "City": "sample string 4",
            "State": "sample string 5",
            "PostalCode": "sample string 6",
            "Country": "sample string 7"
          },
          "Phone": "sample string 1"
        },
        "Created": "2021-05-13T17:32:19.4066251-04:00",
        "Updated": "2021-05-13T17:32:19.4066251-04:00"
      },
      "Created": "2021-05-13T17:32:19.4066251-04:00",
      "Updated": "2021-05-13T17:32:19.4066251-04:00"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Description": "sample string 3",
      "ExtendedData": "sample string 4",
      "CartItems": [
        {
          "Id": 1,
          "Item": "sample string 2",
          "Quantity": 3,
          "ExtendedData": "sample string 4",
          "Created": "2021-05-13T17:32:19.4066251-04:00",
          "Updated": "2021-05-13T17:32:19.4066251-04:00"
        },
        {
          "Id": 1,
          "Item": "sample string 2",
          "Quantity": 3,
          "ExtendedData": "sample string 4",
          "Created": "2021-05-13T17:32:19.4066251-04:00",
          "Updated": "2021-05-13T17:32:19.4066251-04:00"
        }
      ],
      "CartCheckoutInfo": {
        "PONumber": "sample string 1",
        "EndUserPO": "sample string 2",
        "RequestedDeliveryDate": "2021-05-13T17:32:19.4066251-04:00",
        "ShipMethodServiceLevelCode": "sample string 3",
        "ServiceLevelDescription": "sample string 4",
        "ShippingAccountNumber": "sample string 5",
        "FreightForwarderNumber": "sample string 6",
        "ShipComplete": true,
        "Memo": "sample string 8",
        "PayorId": "sample string 9",
        "ShippingAddress": {
          "Name": "sample string 1",
          "Street1": "sample string 2",
          "Street2": "sample string 3",
          "City": "sample string 4",
          "State": "sample string 5",
          "PostalCode": "sample string 6",
          "Country": "sample string 7"
        },
        "Carrier": {
          "CarrierAddress": {
            "Name": "sample string 1",
            "Street1": "sample string 2",
            "Street2": "sample string 3",
            "City": "sample string 4",
            "State": "sample string 5",
            "PostalCode": "sample string 6",
            "Country": "sample string 7"
          },
          "Phone": "sample string 1"
        },
        "Created": "2021-05-13T17:32:19.4066251-04:00",
        "Updated": "2021-05-13T17:32:19.4066251-04:00"
      },
      "Created": "2021-05-13T17:32:19.4066251-04:00",
      "Updated": "2021-05-13T17:32:19.4066251-04:00"
    }
  ]
}

application/xml, text/xml

Sample:
<CartListResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CurrentCartId>1</CurrentCartId>
  <Carts>
    <CartResponse>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Description>sample string 3</Description>
      <ExtendedData>sample string 4</ExtendedData>
      <CartItems>
        <CartItemResponse>
          <Id>1</Id>
          <Item>sample string 2</Item>
          <Quantity>3</Quantity>
          <ExtendedData>sample string 4</ExtendedData>
          <Created>2021-05-13T17:32:19.4066251-04:00</Created>
          <Updated>2021-05-13T17:32:19.4066251-04:00</Updated>
        </CartItemResponse>
        <CartItemResponse>
          <Id>1</Id>
          <Item>sample string 2</Item>
          <Quantity>3</Quantity>
          <ExtendedData>sample string 4</ExtendedData>
          <Created>2021-05-13T17:32:19.4066251-04:00</Created>
          <Updated>2021-05-13T17:32:19.4066251-04:00</Updated>
        </CartItemResponse>
      </CartItems>
      <CartCheckoutInfo>
        <PONumber>sample string 1</PONumber>
        <EndUserPO>sample string 2</EndUserPO>
        <RequestedDeliveryDate>2021-05-13T17:32:19.4066251-04:00</RequestedDeliveryDate>
        <ShipMethodServiceLevelCode>sample string 3</ShipMethodServiceLevelCode>
        <ServiceLevelDescription>sample string 4</ServiceLevelDescription>
        <ShippingAccountNumber>sample string 5</ShippingAccountNumber>
        <FreightForwarderNumber>sample string 6</FreightForwarderNumber>
        <ShipComplete>true</ShipComplete>
        <Memo>sample string 8</Memo>
        <PayorId>sample string 9</PayorId>
        <ShippingAddress>
          <Name>sample string 1</Name>
          <Street1>sample string 2</Street1>
          <Street2>sample string 3</Street2>
          <City>sample string 4</City>
          <State>sample string 5</State>
          <PostalCode>sample string 6</PostalCode>
          <Country>sample string 7</Country>
        </ShippingAddress>
        <Carrier>
          <CarrierAddress>
            <Name>sample string 1</Name>
            <Street1>sample string 2</Street1>
            <Street2>sample string 3</Street2>
            <City>sample string 4</City>
            <State>sample string 5</State>
            <PostalCode>sample string 6</PostalCode>
            <Country>sample string 7</Country>
          </CarrierAddress>
          <Phone>sample string 1</Phone>
        </Carrier>
        <Created>2021-05-13T17:32:19.4066251-04:00</Created>
        <Updated>2021-05-13T17:32:19.4066251-04:00</Updated>
      </CartCheckoutInfo>
      <Created>2021-05-13T17:32:19.4066251-04:00</Created>
      <Updated>2021-05-13T17:32:19.4066251-04:00</Updated>
    </CartResponse>
    <CartResponse>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Description>sample string 3</Description>
      <ExtendedData>sample string 4</ExtendedData>
      <CartItems>
        <CartItemResponse>
          <Id>1</Id>
          <Item>sample string 2</Item>
          <Quantity>3</Quantity>
          <ExtendedData>sample string 4</ExtendedData>
          <Created>2021-05-13T17:32:19.4066251-04:00</Created>
          <Updated>2021-05-13T17:32:19.4066251-04:00</Updated>
        </CartItemResponse>
        <CartItemResponse>
          <Id>1</Id>
          <Item>sample string 2</Item>
          <Quantity>3</Quantity>
          <ExtendedData>sample string 4</ExtendedData>
          <Created>2021-05-13T17:32:19.4066251-04:00</Created>
          <Updated>2021-05-13T17:32:19.4066251-04:00</Updated>
        </CartItemResponse>
      </CartItems>
      <CartCheckoutInfo>
        <PONumber>sample string 1</PONumber>
        <EndUserPO>sample string 2</EndUserPO>
        <RequestedDeliveryDate>2021-05-13T17:32:19.4066251-04:00</RequestedDeliveryDate>
        <ShipMethodServiceLevelCode>sample string 3</ShipMethodServiceLevelCode>
        <ServiceLevelDescription>sample string 4</ServiceLevelDescription>
        <ShippingAccountNumber>sample string 5</ShippingAccountNumber>
        <FreightForwarderNumber>sample string 6</FreightForwarderNumber>
        <ShipComplete>true</ShipComplete>
        <Memo>sample string 8</Memo>
        <PayorId>sample string 9</PayorId>
        <ShippingAddress>
          <Name>sample string 1</Name>
          <Street1>sample string 2</Street1>
          <Street2>sample string 3</Street2>
          <City>sample string 4</City>
          <State>sample string 5</State>
          <PostalCode>sample string 6</PostalCode>
          <Country>sample string 7</Country>
        </ShippingAddress>
        <Carrier>
          <CarrierAddress>
            <Name>sample string 1</Name>
            <Street1>sample string 2</Street1>
            <Street2>sample string 3</Street2>
            <City>sample string 4</City>
            <State>sample string 5</State>
            <PostalCode>sample string 6</PostalCode>
            <Country>sample string 7</Country>
          </CarrierAddress>
          <Phone>sample string 1</Phone>
        </Carrier>
        <Created>2021-05-13T17:32:19.4066251-04:00</Created>
        <Updated>2021-05-13T17:32:19.4066251-04:00</Updated>
      </CartCheckoutInfo>
      <Created>2021-05-13T17:32:19.4066251-04:00</Created>
      <Updated>2021-05-13T17:32:19.4066251-04:00</Updated>
    </CartResponse>
  </Carts>
</CartListResponse>