Carts & Orders

A shopping cart in Arcadier is a piece of software that keeps a record of the items a Consumer has chosen from the Marketplace. This cart saves the items, variants, qty and delivery type that the Consumer has selected, it also the Consumer to make modifications, add additional item, delete items and to select certain items for checkout. 


As you add an item into the cart as a Guest or signed in Consumer, a Cart ID will be created. If you add items of different variant combination into the cart, multiple Cart IDs will be created. This is the same for identical items with different shipping method. You can then select which Cart ID you want to select for checkout. For the checkout, please refer to the checkout section. 



When you add an item into the Cart as a Guest, an Access token and Cart IDs will be created. You can then save this access token into the cookies. When you add an item into the Cart as a signed in Consumer, Cart IDs will be created.  

Property Table

Cart Properties

Property Names Property Type Description
ID

Optional

integer "ID": 21077

The unique cart item id

ItemId

Optional

integer

'ItemId': 5501

Unique identification number of the item.

ItemName

Optional

string

"ItemName": "Nike Epic React Flynit"

The name of the item.

ItemPrice

Optional

number

"ItemPrice": 100

The price of the Item.

ItemQty

Optional

number

"ItemQty": 1

The item quantity selected in cart.

IsAppendQty

Optional

boolean

"IsAppendQty": true

If cart item quantity will be appended to the cart, the value will be true. If cart item quantity will be updating or replace the with the new quantity value then the value is false.

CurrencyCode

Optional

string

"CurrencyCode": "USD"

The currency code of the item price based on ISO 4217
(https://en.wikipedia.org/wiki/ISO_4217)

ItemImageUrl

Optional

string

"ItemImageUrl": "images/items/items-7781-epicreact.jpg"

The item image url link. This image url used as cover image.

SubTotal

Optional

number

"SubTotal": 100

The total of item price X quantity

Freight

Optional

number

"Freight": 0

Additional delivery cost

SellerId

Optional

integer

"SellerId": 7781

The merchant id

OrderID

Optional

integer

"OrderID": 18232

The unique order id

DeliveryId

Optional

integer "DeliveryId":  6601

The id of the delivery
DeliveryType

Optional

string

"DeliveryType":  "delivery"

The type of delivery, for self pickup it will be shown as pickup while delivery will be shown as delivery

MarketPlaceTemplateType

Optional

string

"MarketPlaceTemplateType": "Bespoke"

The template name of the marketplace. The value is either "Bespoke" or "Spacetime"

IsShipping

Optional

boolean

"IsShipping": true

If item could be shipped value is true else it will be false.

Variants

Optional

Array[Variant Object]

"Variants": [
     {
         "ID": 4201,
         "Name": "Green",
         "VariantGroupId": 4200,
         "PriceChange": "15",
         "SortOrder": 1,
         "Active": true
      } ,
      {
         "ID": 4301,
         "Name": "US 10",
         "VariantGroupId": 4300,
         "PriceChange": "15",
         "SortOrder": 2,
         "Active": true
      }
]

The list of variants related to the item added to the cart.

ItemVariants

Optional

Array[Item Variant object]

"ItemVariants": [
     {
         "ItemId": 5501,
         "Id": 4201,
         "Name": "Green",
         "VariantGroupId": 4200,
         "VariantGroupName": "Colour"
      } ,
      {
         "ItemId": 5501,
         "Id": 4301,
         "Name": "US 10",
         "VariantGroupId": 4300,
         "VariantGroupName": "Size"
      }
]

List of item variants that is tied to the item added to the cart.

ShippingMethod

Optional

ShippingMethod Object

"ShippingMethod": {
    "Id": 6601,
    "Description": "Q-Express",
    "CurrencyCode": "USD",
    "Price": 4,
    "CombinedPrice": 3,
    "DeliveryType": "delivery"
}

The selected shipping method for the item in the cart

PickupAddress

Optional

PickupAddress Object

"PickupAddress" {
 "Id": 8010 ,
   "Address": "26 Rosewood St. Malden, MA 02148" ,
   "DeliveryType": "pickup"
}

The selected pickup address

ShippingMethods

Optional

Array[ShippingMethod Object]

"ShippingMethods": [
 {
    "Id": 6601,
    "Description": "Q-Express",
    "CurrencyCode": "USD",
    "Price": 4,
    "CombinedPrice": 3,
    "DeliveryType": "delivery"
 }
]

The list of shipping methods available for the item

PickupAddresses

Optional

Array[PickupAddress Object]

"PickupAddresses": [
{
   "Id": 8010 ,
   "Address": "26 Rosewood St. Malden, MA 02148" ,
   "DeliveryType": "pickup"
}
]
The list of pickup addresses available for the item

CartItemType

Optional

string

"CartItemType": "delivery"

Buyer has selected either delivery or pickup method for item in the cart. If it is null, there is no shipping or pickup method selected.

ItemVariants Properties

Property Names Property Type Description
Id

Optional

integer

"Id": 5513

Unique identification number of the item variants.

ItemName

Optional

string

"ItemName": "Nike Epic React Flynit"

The name of the item with variants.

Price

Optional

number

"Price": 20

Item's variant combination surcharge price. Price and PriceChange have the same meaning in ItemVariants Properties.

PriceChange

Optional

number

"PriceChange": 20

Item's variant combination surcharge price. Price and PriceChange have the same meaning in ItemVariants Properties.

PriceUnit

Optional

string

"PriceUnit": "per Item"

The price unit of the item i.e 30 per hour. This is only available for Spacetime Items.

StockLimited

Optional

boolean

"StockLimited": true

The stock of the item is is limited when value is true while it is unlimited when value is false.

StockQuantity

Optional

number

"StockQuantity": 1000

The quantity of item stock. If the items have variants, the value will be 0. If item stock is unlimited, the value will be 0.

MaxQty

Optional

number

"MaxQty": 1000

MaxQty will derived its value from StockQuantity if the value of StockLimited is true. It StockLimited is false, the MaxQty will be set to 99.

This is the value in the qty selector in the item details page.  

CurrencyCode

Optional

string

"CurrencyCode": "USD"

The currency code of the item price based on ISO 4217
(https://en.wikipedia.org/wiki/ISO_4217)

ImageUrl

Optional

string

"ImageUrl": "images/items/items-limited-epicreact.jpg"

The variant item image url link.

Variants

Optional

Array[Variant Group]

"Variants": [
 {
   "Id": "4401",
   "Name": "Off-white",
   "VariantGroupId": "4400",
   "VariantGroupName": "Edition"
 }
]

The list of variant object that is related to the Item Variant

ShippingMethod Properties

Property Names Property Type Description
Id

Optional

string

"Id": 6601

Unique identification number of the shipping method.

Description

Optional

string

"Description": "Q-Express"

The name of the shipping method.

CurrencyCode

Optional

string

"CurrencyCode": "USD"

The currency code of the shipping method price based on ISO 4217
(https://en.wikipedia.org/wiki/ISO_4217)

Price

Optional

number

"Price": 4

The shipping method surcharge price.

CombinedPrice

Optional

number

"CombinedPrice": 3

The surcharge price of shipping method if it is being shipping with other item.

Please refer to https://support.arcadier.com/hc/en-us/articles/115001373274-Bulk-shipping for detailed explanation.

DeliveryType

Optional

string

"DeliveryType": "delivery"

The type of delivery method

Active

Optional

boolean

"Active": true

Status of the shipping method. If the shipping method is active, the value is true else value will be false. When value is false, it means that the shipping method is not available to be selected in the marketplace but it still exist in the marketplace database.

Pickup Method Properties

Property Names Property Type Description
Id

Optional

integer

"Id": 8010

Unique identification number of the pick up method/ address.

Active

Optional

boolean

"Active": true

Address status. Value equal to true mean it is available while false mean it is soft delete from the system. Soft delete of the address will mean that address will not be shown available in the marketplace but it still exist in the marketplace database.

Address

Optional

string

"Address": "26 Rosewood St. Malden, MA 02148"

The pick up address.

AddressName

Optional

string

"AddressName": "Tony | Jai"

For Bespoke Marketplace, the address name used for delivery receipt if it is different from the person paying for the item.The address name will shown as “Addressee First Name | Addressee Last Name”.

Line1

Optional

string

"Line1": "26 Rosewood"

Street Address Name - line 1.

Line2

Optional

string

"Line2": "St. Malden, MA"

Street Address Name - line 2.

PostCode

Optional

string

"PostCode": "02148"

Postal code or Zip code of the address.

Latitude

Optional

number

"Latitude": 42.4326041

The latitude coordinate of the address.

Longitude

Optional

number

"Longitude": -71.05571959999997

The longitude coordinate of the address.

CountryCode

Optional

string

"CountryCode": "US"

The address country code based on ISO 3166 alpha-2
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

CountryName

Optional

string

"CountryName": "United States"

The address's country name

StateName

Optional

string

"StateName": "Massachusetts"

The address's state name

Delivery

Optional

boolean

"Delivery": true

The address is use as the delivery address when the value is true else the value should be false

DeliveryDefault

Optional

boolean

"DeliveryDefault": true

We are currently not using this

Pickup

Optional

boolean

"Pickup": true

The address is use as the pickup address when the value is true else the value should be false

DeliveryType

Optional

string

"DeliveryType": "pickup"

The delivery type should be either pickup or delivery

Was this article helpful?
0 out of 0 found this helpful