updateCheckout( )

Updates a checkout.

The updateCheckout() function returns a Promise that resolves to the updated checkout when the specified properties are updated.

Notes:

  • If nothing is passed in the request, the call will fail.
  • The checkout.buyerInfo.email may not be removed once it is set.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Stores - all permissions
Manage Restaurants - all permissions
Manage eCommerce - all permissions
Manage Orders
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
_idstringRequired

Checkout ID.

checkoutUpdateCheckoutRequired
optionsUpdateCheckoutOptions

Checkout update options.

Returns
Return Type:Promise<Checkout>
Was this helpful?
Yes
No