GET v1/store/login/user/orders/cart?listID={listID}

Gets the general cart information of the current user.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
listID

globally unique identifier

Optional

Body Parameters

None.

Response Information

Resource Description

Returns the general cart information of the current user.

CartModel
NameDescriptionTypeAdditional information
OrderApproval

The order approval information. Can be null if there is no approval.

OrderApprovalModel

None.

CheckoutUrl

The URL to the first page of the checkout wizard.

string

None.

Items

The list of the items in the cart.

Collection of CartItemModel

None.

Description

The text that will be displayed in the Shopping Cart.

string

None.

Activities

Active background tasks of the current user, related to the shopping cart

Collection of globally unique identifier

None.

OrderID

The unique ID of the order.

globally unique identifier

None.

OrderFriendlyID

The friendly ID of the order.

integer

None.

OrderLegacyID

The legacy ID of the order.

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "OrderApproval": {
    "OriginalOrderFriendlyID": 1,
    "OriginalOrderID": "06d80472-bee2-4410-9c16-e54b068c8471"
  },
  "CheckoutUrl": "sample string 1",
  "Items": [
    {
      "OrderItemID": "1b836a57-6a92-4879-8ead-6651af1cf5f5",
      "OrderItemFriendlyID": 2,
      "Product": {
        "ProductID": "e35d9480-7d9f-4110-b0e5-4c90a01cd6ae",
        "Name": "sample string 2",
        "CatalogNumber": "sample string 3",
        "Unit": {
          "ItemQuantity": 1,
          "ItemType": {
            "Name": "sample string 1",
            "PluralName": "sample string 2"
          },
          "PackType": {
            "Name": "sample string 1",
            "PluralName": "sample string 2"
          }
        },
        "HasPricing": true
      },
      "Nickname": "sample string 3",
      "Checked": true,
      "OriginalOrderFriendlyID": 1,
      "EditUrl": "sample string 5",
      "QuantityPerRecipient": 1,
      "NumRecipients": 6,
      "Quantity": 7,
      "Properties": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2",
          "ComponentRange": "sample string 3",
          "ComponentName": "sample string 4",
          "ConvertToClientTimeZone": true
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2",
          "ComponentRange": "sample string 3",
          "ComponentName": "sample string 4",
          "ConvertToClientTimeZone": true
        }
      ],
      "SubItems": [
        {
          "Product": {
            "ProductID": "e35d9480-7d9f-4110-b0e5-4c90a01cd6ae",
            "Name": "sample string 2",
            "CatalogNumber": "sample string 3",
            "Unit": {
              "ItemQuantity": 1,
              "ItemType": {
                "Name": "sample string 1",
                "PluralName": "sample string 2"
              },
              "PackType": {
                "Name": "sample string 1",
                "PluralName": "sample string 2"
              }
            },
            "HasPricing": true
          },
          "Quantity": 1
        },
        {
          "Product": {
            "ProductID": "e35d9480-7d9f-4110-b0e5-4c90a01cd6ae",
            "Name": "sample string 2",
            "CatalogNumber": "sample string 3",
            "Unit": {
              "ItemQuantity": 1,
              "ItemType": {
                "Name": "sample string 1",
                "PluralName": "sample string 2"
              },
              "PackType": {
                "Name": "sample string 1",
                "PluralName": "sample string 2"
              }
            },
            "HasPricing": true
          },
          "Quantity": 1
        }
      ],
      "Thumbnail": {
        "Url": "sample string 1"
      },
      "ProofStatus": 1,
      "Attributes": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    },
    {
      "OrderItemID": "1b836a57-6a92-4879-8ead-6651af1cf5f5",
      "OrderItemFriendlyID": 2,
      "Product": {
        "ProductID": "e35d9480-7d9f-4110-b0e5-4c90a01cd6ae",
        "Name": "sample string 2",
        "CatalogNumber": "sample string 3",
        "Unit": {
          "ItemQuantity": 1,
          "ItemType": {
            "Name": "sample string 1",
            "PluralName": "sample string 2"
          },
          "PackType": {
            "Name": "sample string 1",
            "PluralName": "sample string 2"
          }
        },
        "HasPricing": true
      },
      "Nickname": "sample string 3",
      "Checked": true,
      "OriginalOrderFriendlyID": 1,
      "EditUrl": "sample string 5",
      "QuantityPerRecipient": 1,
      "NumRecipients": 6,
      "Quantity": 7,
      "Properties": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2",
          "ComponentRange": "sample string 3",
          "ComponentName": "sample string 4",
          "ConvertToClientTimeZone": true
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2",
          "ComponentRange": "sample string 3",
          "ComponentName": "sample string 4",
          "ConvertToClientTimeZone": true
        }
      ],
      "SubItems": [
        {
          "Product": {
            "ProductID": "e35d9480-7d9f-4110-b0e5-4c90a01cd6ae",
            "Name": "sample string 2",
            "CatalogNumber": "sample string 3",
            "Unit": {
              "ItemQuantity": 1,
              "ItemType": {
                "Name": "sample string 1",
                "PluralName": "sample string 2"
              },
              "PackType": {
                "Name": "sample string 1",
                "PluralName": "sample string 2"
              }
            },
            "HasPricing": true
          },
          "Quantity": 1
        },
        {
          "Product": {
            "ProductID": "e35d9480-7d9f-4110-b0e5-4c90a01cd6ae",
            "Name": "sample string 2",
            "CatalogNumber": "sample string 3",
            "Unit": {
              "ItemQuantity": 1,
              "ItemType": {
                "Name": "sample string 1",
                "PluralName": "sample string 2"
              },
              "PackType": {
                "Name": "sample string 1",
                "PluralName": "sample string 2"
              }
            },
            "HasPricing": true
          },
          "Quantity": 1
        }
      ],
      "Thumbnail": {
        "Url": "sample string 1"
      },
      "ProofStatus": 1,
      "Attributes": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    }
  ],
  "Description": "sample string 2",
  "Activities": [
    "40ac2ea8-dede-4458-ad8c-30a9fd0d166d",
    "9eb2bafd-bc26-43e5-9350-4e40edc595e9"
  ],
  "OrderID": "f6832e53-3405-42e8-b22b-47cb7e6c6969",
  "OrderFriendlyID": 4,
  "OrderLegacyID": 5
}