MICRO-BASE

cart.checkout

This method is used to perform the checkout.

Version

v1

Arguments

This method has the path /cart/<version>/cart.checkout and follows the MicroBase API calling conventions.

Argument Required Type Example Description
cartId yes String H19PRsec The Cart id to assign the address.
shippingAddress no Object
shippingMethod no String
billingAddress no Object/String
paymentId yes String
paymentData yes Object

Shipping Method

Argument Required Type Example Description
title yes String UPS Same Day Shipping method title.
taxCode no String vat-7 Tax code applicable to this shipping method. Defaults to 'default'.
rates yes Object List - List of rates by location.

Rates

Argument Required Type Example Description
locations yes Object List [{ "country": "SP" }] List of locations where this method is applicable.
rates yes Object List [{ "currency": "EUR", "amount": 10.10 }] List of rates.

Response

Returns a Cart object with the selected shipping method and his rate:

{
  "ok": true,
  "cart": {
    ...
    "shippingMethod" : {
        "id" : "SJi0oca4e", 
        "title" : "UPS Same Day", 
        "taxCode" : "default", 
        "rateId": "SJbi0i5aNx",
        "rate": {
            "amount": 10,
            "currency": "EUR"
        }
    }
  }
}

Errors

Expected errors that this method could return. Some errors return additional data.

Error Data Description
validation_error The data causing the error Some validation error
cart_not_found The cart Id The cart was not found
shipping_address_notset - The shipping addres must be set before the shipping method
invalid_shipping_method - The shipping method id is not in the allowed shipping methods for this cart address and currency

Example

curl --request POST \
  --url http://localhost:3000/services/cart/v1/cart.setShippingMethod \
  --header 'authorization: Bearer xxxxx...' \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{ "cartId": "H19PRsec", "methodId": "SJi0oca4e" }'

© MicroBase