Medusa
Store APIAdmin API
Store APIAdmin API
Discord
Twitter
Linkedin
Github
  1. Schemas
  • Introduction
  • Authentication
  • HTTP Compression
  • Publishable API Key
  • Expanding Fields
  • Selecting Fields
  • Query Parameter Types
  • Pagination
  • Currencies
    • List Currencies
    • Get a Currency
  • Payment Providers
    • List Payment Providers
  • Return Reasons
    • List Return Reasons
    • Get a Return Reason
  • Auth
    • Retrieve Registration JWT Token
    • Authenticate Customer
    • Generate Reset Password Token for Customer
    • Refresh Authentication Token
    • Validate Authentication Callback
    • Delete Authentication Session
    • Set Authentication Session
    • Reset a Customer's Password
  • Collections
    • List Collections
    • Get a Collection
  • Regions
    • List Regions
    • Get a Region
  • Products
    • List Products
    • Get a Product
  • Customers
    • Get Logged-in Customer
    • Update Customer
    • Create Address for Logged-In Customer
    • List Customer's Addresses
    • Get Customer's Address
    • Update Customer's Address
    • Remove Customer's Address
    • Register Customer
  • Product Tags
    • List Product Tags
    • Get a Product Tag
  • Returns
    • Create Return
  • Product Types
    • Get a Product Type
    • List Product Types
  • Product Categories
    • List Product Categories
    • Get a Product Category
  • Carts
    • Create Cart
    • Set Cart's Customer
    • Add Shipping Method to Cart
    • Add Line Item to Cart
    • Calculate Cart Taxes
    • Get a Cart
    • Update a Cart
    • Update a Line Item in a Cart
    • Remove Line Item from Cart
    • Complete Cart
    • Add Promotions to Cart
    • Remove Promotions from Cart
  • Orders
    • List Logged-in Customer's Orders
    • Request Order Transfer
    • Get an Order
    • Cancel Order Transfer
    • Decline Order Transfer
    • Accept Order Transfer
  • Payment Collections
    • Initialize Payment Session of a Payment Collection
    • Create Payment Collection
  • Shipping Options
    • Calculate Shipping Option Price
    • List Shipping Options for Cart
  • Schemas
    • Schemas
      • StoreCollection
      • StoreCurrency
      • StorePaymentProvider
      • StoreProductTag
      • StoreProductType
      • StoreReturnReason
      • BaseOrderSummary
      • BaseOrderTransaction
      • StoreCartAddress
      • StoreCartShippingMethod
      • StoreCartPromotion
      • StoreProductImage
      • BaseRegionCountry
      • AdminPaymentProvider
      • StoreRegion
      • StoreReturnItem
      • StoreReturn
      • AuthResponse
      • StoreOrderFulfillment
      • StoreCustomerAddress
      • StoreCustomer
      • AuthCallbackResponse
      • BaseFulfillmentProvider
      • StoreShippingOptionType
      • StoreShippingOption
      • StoreAddCartLineItem
      • StoreCartAddPromotion
      • StoreCartRemovePromotion
      • StoreUpdateCartLineItem
      • StoreUpdateCustomer
      • StoreCreateCustomer
      • StoreInitializePaymentSession
      • StoreAcceptOrderTransfer
      • StoreRequestOrderTransfer
      • StoreCreatePaymentCollection
      • StoreDeclineOrderTransferRequest
      • BaseCapture
      • BaseCalculatedPriceSet
      • StoreProductOptionValue
      • StoreProductOption
      • StoreProductVariant
      • StoreProduct
      • StoreRegionCountry
      • StoreOrderAddress
      • BaseOrderItemDetail
      • BaseOrderShippingDetail
      • StoreOrderShippingMethod
      • StoreCollectionResponse
      • StoreCurrencyListResponse
      • CreateAddress
      • UpdateAddress
      • UpdateCartData
      • StoreCustomerAddressResponse
      • StoreCurrencyResponse
      • StoreProductTypeListResponse
      • StoreCreateReturnShipping
      • StoreCreateReturnItem
      • StoreCreateReturn
      • StoreProductTagListResponse
      • StoreProductTypeResponse
      • StoreProductTagResponse
      • StoreReturnReasonResponse
      • RefundReason
      • BaseRefund
      • BasePayment
      • StoreCustomerAddressListResponse
      • StoreProductCategory
      • AuthStoreSessionResponse
      • StoreCustomerResponse
      • StoreCalculatedPrice
      • StoreReturnResponse
      • StorePaymentSession
      • StorePaymentCollection
      • StoreCartLineItem
      • StorePriceRule
      • StorePrice
      • StoreCartShippingOption
      • StoreShippingOptionResponse
      • StoreShippingOptionListResponse
      • StoreProductResponse
      • StoreCreateCart
      • StoreCart
      • StoreOrder
      • StoreProductCategoryListResponse
      • StoreProductCategoryResponse
      • StorePaymentCollectionResponse
      • StoreCartResponse
      • StoreOrderResponse
      • Response Error
Store APIAdmin API
Store APIAdmin API
Discord
Twitter
Linkedin
Github
  1. Schemas

StoreCart

The cart's details.

{
    "id": "string",
    "region_id": "string",
    "customer_id": "string",
    "sales_channel_id": "string",
    "email": "user@example.com",
    "currency_code": "usd",
    "metadata": {},
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "original_item_total": 0,
    "original_item_subtotal": 0,
    "original_item_tax_total": 0,
    "item_total": 0,
    "item_subtotal": 0,
    "item_tax_total": 0,
    "original_total": 0,
    "original_subtotal": 0,
    "original_tax_total": 0,
    "total": 0,
    "subtotal": 0,
    "tax_total": 0,
    "discount_total": 0,
    "discount_tax_total": 0,
    "gift_card_total": 0,
    "gift_card_tax_total": 0,
    "shipping_total": 0,
    "shipping_subtotal": 0,
    "shipping_tax_total": 0,
    "original_shipping_total": 0,
    "original_shipping_subtotal": 0,
    "original_shipping_tax_total": 0,
    "shipping_address": {
        "id": "string",
        "customer_id": "string",
        "first_name": "string",
        "last_name": "string",
        "phone": "string",
        "company": "string",
        "address_1": "string",
        "address_2": "string",
        "city": "string",
        "country_code": "us",
        "postal_code": "string",
        "metadata": {},
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "province": "us-ca"
    },
    "billing_address": {
        "id": "string",
        "customer_id": "string",
        "first_name": "string",
        "last_name": "string",
        "phone": "string",
        "company": "string",
        "address_1": "string",
        "address_2": "string",
        "city": "string",
        "country_code": "us",
        "postal_code": "string",
        "metadata": {},
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "province": "us-ca"
    },
    "shipping_methods": [
        {
            "id": "string",
            "cart_id": "string",
            "name": "string",
            "description": "string",
            "amount": 0,
            "is_tax_inclusive": true,
            "shipping_option_id": "string",
            "metadata": {},
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "original_total": 0,
            "original_subtotal": 0,
            "original_tax_total": 0,
            "total": 0,
            "subtotal": 0,
            "tax_total": 0,
            "discount_total": 0,
            "discount_tax_total": 0,
            "data": {},
            "adjustments": [
                {
                    "shipping_method": {},
                    "id": "string",
                    "code": "string",
                    "amount": 0,
                    "cart_id": "string",
                    "description": "string",
                    "promotion_id": "string",
                    "provider_id": "string",
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z"
                }
            ],
            "tax_lines": [
                {
                    "shipping_method": {},
                    "shipping_method_id": "string",
                    "total": 0,
                    "subtotal": 0,
                    "id": "string",
                    "description": "string",
                    "tax_rate_id": "string",
                    "code": "string",
                    "rate": 0,
                    "provider_id": "string",
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z"
                }
            ]
        }
    ],
    "promotions": [
        {
            "id": "string",
            "code": "string",
            "is_automatic": true,
            "application_method": {
                "value": "string",
                "currency_code": "string",
                "type": "fixed"
            }
        }
    ],
    "region": {
        "id": "string",
        "name": "string",
        "currency_code": "usd",
        "automatic_taxes": true,
        "metadata": {},
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "countries": [
            {
                "id": "string",
                "iso_2": "us",
                "iso_3": "usa",
                "num_code": 840,
                "name": "string",
                "display_name": "string"
            }
        ],
        "payment_providers": [
            {
                "id": "string",
                "is_enabled": true
            }
        ]
    },
    "items": [
        {
            "id": "string",
            "title": "string",
            "subtitle": "string",
            "thumbnail": "string",
            "quantity": 0,
            "product_id": "string",
            "product_title": "string",
            "product_description": "string",
            "product_subtitle": "string",
            "product_type": "string",
            "product_collection": "string",
            "product_handle": "string",
            "variant_id": "string",
            "variant_sku": "string",
            "variant_barcode": "string",
            "variant_title": "string",
            "requires_shipping": true,
            "is_discountable": true,
            "is_tax_inclusive": true,
            "compare_at_unit_price": 0,
            "unit_price": 0,
            "cart": {},
            "cart_id": "string",
            "metadata": {},
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "original_total": 0,
            "original_subtotal": 0,
            "original_tax_total": 0,
            "item_total": 0,
            "item_subtotal": 0,
            "item_tax_total": 0,
            "total": 0,
            "subtotal": 0,
            "tax_total": 0,
            "discount_total": 0,
            "discount_tax_total": 0,
            "variant_option_values": {
                "Color": "Red"
            },
            "tax_lines": [
                {
                    "item": {},
                    "item_id": "string",
                    "total": 0,
                    "subtotal": 0,
                    "id": "string",
                    "description": "string",
                    "tax_rate_id": "string",
                    "code": "string",
                    "rate": 0,
                    "provider_id": "string",
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z"
                }
            ],
            "adjustments": [
                {
                    "item": {},
                    "item_id": "string",
                    "id": "string",
                    "code": "string",
                    "amount": 0,
                    "cart_id": "string",
                    "description": "string",
                    "promotion_id": "string",
                    "provider_id": "string",
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z"
                }
            ],
            "variant": {
                "product": {},
                "length": 0,
                "title": "string",
                "metadata": {},
                "id": "string",
                "width": 0,
                "weight": 0,
                "height": 0,
                "origin_country": "string",
                "hs_code": "string",
                "mid_code": "string",
                "material": "string",
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "deleted_at": "2019-08-24T14:15:22Z",
                "product_id": "string",
                "sku": "string",
                "barcode": "string",
                "ean": "string",
                "upc": "string",
                "allow_backorder": true,
                "variant_rank": 0,
                "manage_inventory": true,
                "inventory_quantity": 0,
                "options": [
                    {
                        "id": "string",
                        "value": "string",
                        "option": {},
                        "option_id": "string",
                        "metadata": {},
                        "created_at": "2019-08-24T14:15:22Z",
                        "updated_at": "2019-08-24T14:15:22Z",
                        "deleted_at": "2019-08-24T14:15:22Z"
                    }
                ],
                "calculated_price": {
                    "id": "string",
                    "is_calculated_price_price_list": true,
                    "is_calculated_price_tax_inclusive": true,
                    "calculated_amount": 0,
                    "calculated_amount_with_tax": 0,
                    "calculated_amount_without_tax": 0,
                    "is_original_price_price_list": true,
                    "is_original_price_tax_inclusive": true,
                    "original_amount": 0,
                    "currency_code": "usd",
                    "calculated_price": {},
                    "original_price": {},
                    "original_amount_with_tax": 0,
                    "original_amount_without_tax": 0
                }
            },
            "product": {
                "length": 0,
                "title": "string",
                "description": "string",
                "id": "string",
                "metadata": {},
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "handle": "string",
                "subtitle": "string",
                "is_giftcard": true,
                "thumbnail": "string",
                "width": 0,
                "weight": 0,
                "height": 0,
                "origin_country": "string",
                "hs_code": "string",
                "mid_code": "string",
                "material": "string",
                "collection_id": "string",
                "type_id": "string",
                "discountable": true,
                "external_id": "string",
                "deleted_at": "2019-08-24T14:15:22Z",
                "categories": [
                    {}
                ],
                "status": "draft",
                "images": [
                    {
                        "id": "string",
                        "url": "string",
                        "created_at": "2019-08-24T14:15:22Z",
                        "updated_at": "2019-08-24T14:15:22Z",
                        "deleted_at": "2019-08-24T14:15:22Z",
                        "metadata": {},
                        "rank": 0
                    }
                ],
                "tags": [
                    {
                        "id": "string",
                        "value": "string",
                        "created_at": "2019-08-24T14:15:22Z",
                        "updated_at": "2019-08-24T14:15:22Z",
                        "deleted_at": "2019-08-24T14:15:22Z",
                        "metadata": {}
                    }
                ],
                "collection": {
                    "id": "string",
                    "title": "string",
                    "handle": "string",
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "deleted_at": "2019-08-24T14:15:22Z",
                    "metadata": {},
                    "products": [
                        {}
                    ]
                },
                "type": {
                    "id": "string",
                    "metadata": {},
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "deleted_at": "2019-08-24T14:15:22Z",
                    "value": "string"
                },
                "options": [
                    {
                        "id": "string",
                        "title": "string",
                        "product": {},
                        "product_id": "string",
                        "metadata": {},
                        "created_at": "2019-08-24T14:15:22Z",
                        "updated_at": "2019-08-24T14:15:22Z",
                        "deleted_at": "2019-08-24T14:15:22Z",
                        "values": [
                            {
                                "id": "string",
                                "value": "string",
                                "option": {},
                                "option_id": "string",
                                "metadata": {},
                                "created_at": "2019-08-24T14:15:22Z",
                                "updated_at": "2019-08-24T14:15:22Z",
                                "deleted_at": "2019-08-24T14:15:22Z"
                            }
                        ]
                    }
                ],
                "variants": [
                    {
                        "product": {},
                        "length": 0,
                        "title": "string",
                        "metadata": {},
                        "id": "string",
                        "width": 0,
                        "weight": 0,
                        "height": 0,
                        "origin_country": "string",
                        "hs_code": "string",
                        "mid_code": "string",
                        "material": "string",
                        "created_at": "2019-08-24T14:15:22Z",
                        "updated_at": "2019-08-24T14:15:22Z",
                        "deleted_at": "2019-08-24T14:15:22Z",
                        "product_id": "string",
                        "sku": "string",
                        "barcode": "string",
                        "ean": "string",
                        "upc": "string",
                        "allow_backorder": true,
                        "variant_rank": 0,
                        "manage_inventory": true,
                        "inventory_quantity": 0,
                        "options": [
                            {
                                "id": "string",
                                "value": "string",
                                "option": {},
                                "option_id": "string",
                                "metadata": {},
                                "created_at": "2019-08-24T14:15:22Z",
                                "updated_at": "2019-08-24T14:15:22Z",
                                "deleted_at": "2019-08-24T14:15:22Z"
                            }
                        ],
                        "calculated_price": {
                            "id": "string",
                            "is_calculated_price_price_list": true,
                            "is_calculated_price_tax_inclusive": true,
                            "calculated_amount": 0,
                            "calculated_amount_with_tax": 0,
                            "calculated_amount_without_tax": 0,
                            "is_original_price_price_list": true,
                            "is_original_price_tax_inclusive": true,
                            "original_amount": 0,
                            "currency_code": "usd",
                            "calculated_price": {},
                            "original_price": {},
                            "original_amount_with_tax": 0,
                            "original_amount_without_tax": 0
                        }
                    }
                ]
            }
        }
    ],
    "payment_collection": {
        "id": "string",
        "currency_code": "string",
        "amount": 0,
        "authorized_amount": 0,
        "captured_amount": 0,
        "refunded_amount": 0,
        "completed_at": "2019-08-24T14:15:22Z",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "metadata": {},
        "status": "canceled",
        "payment_providers": [
            {
                "id": "string"
            }
        ],
        "payment_sessions": [
            {
                "id": "string",
                "amount": 0,
                "currency_code": "usd",
                "provider_id": "string",
                "authorized_at": "2019-08-24T14:15:22Z",
                "payment_collection": {},
                "data": {},
                "status": "authorized",
                "context": {
                    "customer": {
                        "id": "cus_123"
                    }
                },
                "payment": {
                    "id": "string",
                    "amount": 0,
                    "authorized_amount": 0,
                    "currency_code": "string",
                    "provider_id": "string",
                    "created_at": "2019-08-24T14:15:22Z",
                    "updated_at": "2019-08-24T14:15:22Z",
                    "captured_at": "2019-08-24T14:15:22Z",
                    "canceled_at": "2019-08-24T14:15:22Z",
                    "captured_amount": 0,
                    "refunded_amount": 0,
                    "payment_collection": {},
                    "payment_session": {},
                    "data": {},
                    "captures": [
                        {
                            "id": "string",
                            "amount": 0,
                            "created_at": "2019-08-24T14:15:22Z",
                            "created_by": "string",
                            "payment": {}
                        }
                    ],
                    "refunds": [
                        {
                            "id": "string",
                            "amount": 0,
                            "refund_reason_id": "string",
                            "note": "string",
                            "created_at": "2019-08-24T14:15:22Z",
                            "created_by": "string",
                            "payment": {},
                            "refund_reason": {
                                "id": "string",
                                "label": "string",
                                "description": "string",
                                "metadata": {},
                                "created_at": "2019-08-24T14:15:22Z",
                                "updated_at": "2019-08-24T14:15:22Z"
                            }
                        }
                    ]
                }
            }
        ],
        "payments": [
            {
                "id": "string",
                "amount": 0,
                "authorized_amount": 0,
                "currency_code": "string",
                "provider_id": "string",
                "created_at": "2019-08-24T14:15:22Z",
                "updated_at": "2019-08-24T14:15:22Z",
                "captured_at": "2019-08-24T14:15:22Z",
                "canceled_at": "2019-08-24T14:15:22Z",
                "captured_amount": 0,
                "refunded_amount": 0,
                "payment_collection": {},
                "payment_session": {},
                "data": {},
                "captures": [
                    {
                        "id": "string",
                        "amount": 0,
                        "created_at": "2019-08-24T14:15:22Z",
                        "created_by": "string",
                        "payment": {}
                    }
                ],
                "refunds": [
                    {
                        "id": "string",
                        "amount": 0,
                        "refund_reason_id": "string",
                        "note": "string",
                        "created_at": "2019-08-24T14:15:22Z",
                        "created_by": "string",
                        "payment": {},
                        "refund_reason": {
                            "id": "string",
                            "label": "string",
                            "description": "string",
                            "metadata": {},
                            "created_at": "2019-08-24T14:15:22Z",
                            "updated_at": "2019-08-24T14:15:22Z"
                        }
                    }
                ]
            }
        ]
    }
}
Built with