Cart

Get User Cart

Retrieves the details of the user's cart from the user ID.Shoppers are not allowed to execute this call. If this ever changes, then auth logic will need to be added

get/commerce/carts/user/{userId}

Request

  • Base URL
    https://t1000000.sb.usc1.gcp.kibocommerce.com/api
  • URL
    https://t1000000.sb.usc1.gcp.kibocommerce.com/api/commerce/carts/user/{userId}
  • Auth
    HTTP bearer

Path parameters

userIdstring required

Unique identifier of the user.

Query parameters

accountIdinteger

Unique identifier of the customer account.

responseFieldsstring

limits which fields are returned in the response body

Response

OK

channelCodestring nullable

Unique identifier of the channel for this item.

couponCodesstring[] nullable

Coupon codes associated with this order. Only set on order import.

currencyCodestring nullable

ISO Currency Code. Currently, only USD is supported.

customerInteractionTypestring nullable

Determines the interaction type that a customer will use to create this object. Valid values are: Website, Store, Call, Unknown

dataobject nullable

Custom data for a given vendor set within the commerce process.

discountTotalnumber double nullable

Amount of the discounts applied to all items in the cart. This is a negative number. This also includes the order level discounts.

discountedSubtotalnumber double nullable

Combined price for all cart items, including all selected options as well as any discounts.

discountedTotalnumber double nullable

Subtotal minus the discounted total

expirationDatestring date-time nullable

When the order will no longer be active. That is, the order is considered abandoned. Orders of anonymous shoppers expire after 14 days of inactivity. An order never expires for shoppers who are logged into their account. Date in UTC Date/Time.

feeTotalnumber double nullable

Not implemented. Total cost of fees for all items in the cart.

handlingAmountnumber double nullable

Order level handling fees excluding any discounts.

handlingSubTotalnumber double nullable

Handling fees for the Order as well as CartItems (e.g. if the Cart has a $5 handling fee and an CartItem has a $2 handling fee per item quantity and the quantity of items is 2 then the value in this property would be $9)

handlingTaxTotalnumber double nullable

Total tax on handling

handlingTotalnumber double nullable

Handling fees including any discounts.

idstring nullable

Unique identifier of the CommerceAggregate object (e.g. order, cart, wishlist, etc.).

itemTaxTotalnumber double nullable

Not implemented. Tax does not appear on cart.

lastValidationDatestring date-time nullable

Occasionally the commerce runtime may validate that item/product names, descriptions, and prices have not changed. If changed, it updates LastValidationDate.

lineItemSubtotalWithOrderAdjustmentsnumber double nullable

Line Item Subtotals with Order Adjustments

priceListCodestring nullable

Pricelist code

reservationIdstring nullable

Inventory Reservation id for a cart.

shippingAmountBeforeDiscountsAndAdjustmentsnumber double nullable

Shipping Amount before discount and adjustments

shippingSubTotalnumber double nullable

Shipping total without discounts applied.

shippingTaxTotalnumber double nullable

Not implemented. Tax does not appear on cart.

shippingTotalnumber double nullable

Shipping does not appear on cart.

siteIdinteger nullable

Unique identifier of the Site.

subtotalnumber double nullable

Combined price for all cart items, including all selected options but excluding any discounts.

taxDataobject nullable

Storage for any additional/custom tax data.

taxTotalnumber double nullable

Tax does not appear on cart.

tenantIdinteger nullable

Unique identifier of the Tenant.

totalnumber double nullable

Final total amount of the order including all discounts, shipping, and tax.

userIdstring nullable

Unique identifier of the shopper who created the cart.

visitIdstring nullable

Identifies the Visit ID that was current when the order was placed or when the cart was last updated.

webSessionIdstring nullable

Identifies the web session used to place the order or last update the cart.

zipCodestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.