Cart Checkout v2

This endpoint processes a signed cart, which has previously been
generated via the /cart/calculate endpoint. For external payments, we will
provide the payment parameters for you to pass in, so that we bypass our internal
payment verification steps.


It is also important to note that if an email confirmation is required, the field email must be non empty in the signed_cart and
an extra field named "send_email_receipt", must be manually added and set to true at the root level of the payload's body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required
≥ 1

Identifier for a given venue (revenue center)

int64
required
≥ 1

Connect's vendor identifier inside for a given vendor (revenue center)

Body Params

Checkout Request -- Send Payload From Cart Endpoint

signed_cart
object

A validated cart that contains items that may have root map nodes

payments
array of objects

A payments block for use when using stored cart functionality. Payments can be passed in both on this field as well as SignedCart.Payments, but if this field is populated, it will be preferred over SignedCart.Payments

payments
uuid

the device order UUID returned as part of CalculateCart's Signed Cart. Supplying this field, along with the sibling payments block, will allow the client to skip passing in the entirety of the signed cart.

boolean

When 'true' is sent for this field, a receipt will be generated and emailed to the address passed in the Customer block

Headers
string

Order Source to provide visibility between the different products where the order is being made from.

string
enum
required

Two versions are available:

  • Version 1: supports taxes, fees, reductions and modifiers.
  • Version 2: supports taxes, fees, reductions and nested modifiers.

    By default if you do not send any value it will be understood that you are using Version 1.

Allowed:
string
enum
Defaults to application/com.appetize.oapi.cart.v2+json

Generated from available response content types

Allowed:
Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/com.appetize.oapi.cart.v2+json
application/com.appetize.oapi.cart.v1+json
application/vnd.appetize+json;version=1
application/json