BrainerceCheckout
Brainerce API reference: every checkout operation, with its method, path and a page of its own.
A checkout is the state machine that takes a cart through to a paid order. Endpoints here let you create a checkout from a cart, attach customer + shipping + billing info, apply coupons, choose shipping methods, and complete the purchase (which creates the order). Mutating endpoints honor Idempotency-Key — see /docs/api/idempotency.
Checkout operations
| Method | Endpoint | Operation |
|---|---|---|
POST | /vc/{connectionId}/checkout | Create checkout |
GET | /vc/{connectionId}/pickup-locations | List pickup locations |
GET | /vc/{connectionId}/checkout/address-suggestions | Get address autocomplete suggestions |
GET | /vc/{connectionId}/checkout/address-details | Resolve an address suggestion to a full address + zone coverage |
GET | /vc/{connectionId}/checkout/{checkoutId} | Get checkout (Storefront) |
DELETE | /vc/{connectionId}/checkout/{checkoutId} | Delete checkout |
PATCH | /vc/{connectionId}/checkout/{checkoutId}/customer | Set checkout customer |
PATCH | /vc/{connectionId}/checkout/{checkoutId}/shipping-address | Set shipping address |
GET | /vc/{connectionId}/checkout/{checkoutId}/shipping-rates | List shipping rates |
PATCH | /vc/{connectionId}/checkout/{checkoutId}/shipping-method | Select shipping method (Storefront) |
GET | /vc/{connectionId}/checkout/{checkoutId}/pickup-points | List carrier pickup points (Storefront) |
PUT | /vc/{connectionId}/checkout/{checkoutId}/pickup-point | Choose a carrier pickup point (Storefront) |
PATCH | /vc/{connectionId}/checkout/{checkoutId}/delivery-type | Set delivery type |
PATCH | /vc/{connectionId}/checkout/{checkoutId}/pickup-location | Select pickup location |
PATCH | /vc/{connectionId}/checkout/{checkoutId}/billing-address | Set billing address (Storefront) |
GET | /vc/{connectionId}/checkout/{checkoutId}/custom-fields | List checkout custom fields |
PATCH | /vc/{connectionId}/checkout/{checkoutId}/custom-fields | Set checkout custom fields |
POST | /vc/{connectionId}/checkout/{checkoutId}/coupon | Apply checkout coupon |
DELETE | /vc/{connectionId}/checkout/{checkoutId}/coupon | Remove checkout coupon |
POST | /vc/{connectionId}/checkout/{checkoutId}/gift-card | Apply a gift card to a checkout (Storefront) |
DELETE | /vc/{connectionId}/checkout/{checkoutId}/gift-card/{tenderId} | Remove a gift card from a checkout (Storefront) |
POST | /vc/{connectionId}/gift-cards/balance | Check a gift card balance (Storefront) |
POST | /vc/{connectionId}/checkout/{checkoutId}/complete | Complete checkout |
POST | /vc/{connectionId}/guest-checkout | Create guest checkout |
GET | /vc/{connectionId}/payment/config | Get payment config |
GET | /vc/{connectionId}/payment/providers | List payment providers |
POST | /vc/{connectionId}/payment/intent | Create payment intent |
POST | /vc/{connectionId}/payment/sdk-confirm | Confirm SDK-based payment (Storefront, sdk-confirm) |
POST | /vc/{connectionId}/payment/grow-confirm | Confirm SDK-based payment (Storefront, grow-confirm) |
GET | /vc/{connectionId}/checkout/{checkoutId}/payment-status | List payment status |
GET | /vc/{connectionId}/checkout/{checkoutId}/order | Get order details by checkout |
GET | /vc/{connectionId}/checkout/{checkoutId}/google-customer-reviews | Get Google Customer Reviews survey opt-in data for a completed checkout |
GET | /vc/{connectionId}/checkout/{checkoutId}/bumps | List checkout bumps |