Response [200 Ok]

Uri /api/v2/cart?_shorturis=
UriDescription Shopping Cart
EndpointType Cart
Locator Cart
LocatorType Object

Cart [1 of 1]
/api/v2/cart

Uri /api/v2/cart
UriDescription Shopping Cart
BuyerCurrency CAD
CartLockStatus false
CouponTotal 0
GrandTotal 0
GrandTotalMoney
Array [3]
Amount 0.00
Currency CAD
UnitValue 0
GrandTotalUSD 0
HasApplicableCoupons false
HasOtherCurrency false
HasStrictShipping false
HasVAT false
IsPayPalFlow false
ItemCount 0
ItemTotal 0
ProcessingFee 0
ProofDelay false
ShippingTotal 0
TaxTotal 0
ValidCurrencyForCard true
WebUri https://destinationarcticcircle.smugmug.com/cart/

Uris

ApplyCoupon /api/v2/cart!applycoupon
BillingAddress /api/v2/cart!billingaddress
CartBilling /api/v2/cart/billing
CartCoupons /api/v2/cart!coupons
CartItems /api/v2/cart!items
CartShipments /api/v2/cart!shipments
CartUsers /api/v2/cart!users
ChangeCurrency /api/v2/cart!changecurrency
EmptyCart /api/v2/cart!empty
ShippingAddress /api/v2/cart!shippingaddress

Timing

Total

cycles 1
objects 0
time 0.12663

Config

{
    "expand_method": "ref",
    "shorturis": true
}

Options

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

Output Fields

BuyerCurrency select
  • USD
  • CAD
  • GBP
  • EUR
  • AUD
  • MXN
  • JPY
  • CHF
  • NZD
  • NOK
  • SEK
  • HKD
  • INR
  • SGD
 3 character currency code
CartLockStatus boolean
CouponTotal floatingpoint Total of all coupons in cart. Value is 0 or Positive Float.
CouponType text
GrandTotal floatingpoint Sums all the totals and subtracts the coupon total
GrandTotalMoney money The grand total as a money object
GrandTotalUSD floatingpoint
HasApplicableCoupons boolean
HasOtherCurrency boolean
HasStrictShipping boolean
HasVAT boolean
IsPayPalFlow boolean
ItemCount integer
ItemTotal floatingpoint
ProcessingFee floatingpoint Download Processing Fee
ProofDelay boolean Will be set to true if any item in the Cart is in proof delay
ShippingTotal floatingpoint
TaxLabel text
TaxTotal floatingpoint
ValidCurrencyForCard boolean

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/cart?_shorturis=&_verbosity=3"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET"
        ],
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ],
        "Output": [
            {
                "Name": "BuyerCurrency",
                "Description": "3 character currency code",
                "Type": "Select",
                "OPTIONS": [
                    "USD",
                    "CAD",
                    "GBP",
                    "EUR",
                    "AUD",
                    "MXN",
                    "JPY",
                    "CHF",
                    "NZD",
                    "NOK",
                    "SEK",
                    "HKD",
                    "INR",
                    "SGD"
                ],
                "MIN_COUNT": 1,
                "MAX_COUNT": 1
            },
            {
                "Name": "ValidCurrencyForCard",
                "Type": "Boolean"
            },
            {
                "Name": "ItemCount",
                "Type": "Integer",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "ItemTotal",
                "Type": "FloatingPoint",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "ShippingTotal",
                "Type": "FloatingPoint",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "CouponTotal",
                "Description": "Total of all coupons in cart. Value is 0 or Positive Float. ",
                "Type": "FloatingPoint",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "TaxTotal",
                "Type": "FloatingPoint",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "TaxLabel",
                "Type": "Varchar",
                "MIN_CHARS": 0,
                "MAX_CHARS": 20
            },
            {
                "Name": "GrandTotal",
                "Description": "Sums all the totals and subtracts the coupon total",
                "Type": "FloatingPoint",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "GrandTotalMoney",
                "Description": "The grand total as a money object",
                "Type": "Money"
            },
            {
                "Name": "ProcessingFee",
                "Description": "Download Processing Fee",
                "Type": "FloatingPoint",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            },
            {
                "Name": "CartLockStatus",
                "Type": "Boolean"
            },
            {
                "Name": "HasOtherCurrency",
                "Type": "Boolean"
            },
            {
                "Name": "HasVAT",
                "Type": "Boolean"
            },
            {
                "Name": "HasApplicableCoupons",
                "Type": "Boolean"
            },
            {
                "Name": "IsPayPalFlow",
                "Type": "Boolean"
            },
            {
                "Name": "CouponType",
                "Type": "Text",
                "MIN_CHARS": 0,
                "MAX_CHARS": "INFINITY"
            },
            {
                "Name": "ProofDelay",
                "Description": "Will be set to true if any item in the Cart is in proof delay",
                "Type": "Boolean"
            },
            {
                "Name": "HasStrictShipping",
                "Type": "Boolean"
            },
            {
                "Name": "GrandTotalUSD",
                "Type": "FloatingPoint",
                "MIN_VALUE": "NEGATIVE_INFINITY",
                "MAX_VALUE": "POSITIVE_INFINITY"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/cart?_shorturis=",
        "Locator": "Cart",
        "LocatorType": "Object",
        "Cart": {
            "BuyerCurrency": "CAD",
            "ValidCurrencyForCard": true,
            "ItemCount": 0,
            "ItemTotal": 0,
            "ShippingTotal": 0,
            "CouponTotal": 0,
            "TaxTotal": 0,
            "GrandTotal": 0,
            "GrandTotalMoney": {
                "Currency": "CAD",
                "Amount": "0.00",
                "UnitValue": 0
            },
            "ProcessingFee": 0,
            "CartLockStatus": false,
            "HasOtherCurrency": false,
            "HasVAT": false,
            "HasApplicableCoupons": false,
            "IsPayPalFlow": false,
            "ProofDelay": false,
            "HasStrictShipping": false,
            "GrandTotalUSD": 0,
            "Uri": "/api/v2/cart",
            "WebUri": "https://destinationarcticcircle.smugmug.com/cart/",
            "UriDescription": "Shopping Cart",
            "Uris": {
                "ApplyCoupon": "/api/v2/cart!applycoupon",
                "BillingAddress": "/api/v2/cart!billingaddress",
                "CartBilling": "/api/v2/cart/billing",
                "CartCoupons": "/api/v2/cart!coupons",
                "CartItems": "/api/v2/cart!items",
                "CartShipments": "/api/v2/cart!shipments",
                "CartUsers": "/api/v2/cart!users",
                "ChangeCurrency": "/api/v2/cart!changecurrency",
                "EmptyCart": "/api/v2/cart!empty",
                "ShippingAddress": "/api/v2/cart!shippingaddress"
            }
        },
        "UriDescription": "Shopping Cart",
        "EndpointType": "Cart",
        "Timing": {
            "Total": {
                "time": 0.12663,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}

Contents

  1. Response
  2. Request
  3. Config
  4. Options
    1. Methods
    2. Available Media Types
    3. Output Fields
  5. JSON