Skip to content
You are reading the pinned copy of v1.0, which is also the latest release. Read the latest.

Checkout (admin API)

Admin routes of the checkout module. Every route needs a staff session and the permission named on it; send X-Resolve-Locale: false to receive every locale of a translatable field for editing.

Get checkout settings

Responses:

  • 200: Settings retrieved.

Update checkout settings

Request body: UpdateCheckoutSettingsDto.

Responses:

  • 200: Settings updated.
  • 400: Invalid input.
  • guestCheckoutEnabled (boolean, optional).
  • requiredFields (array of "billingAddress", "company", "email", "note", "phone", "shippingAddress", optional).
  • termsOfServiceUrl (string, uri, max length 500, nullable, optional).
  • postPurchaseRedirectUrl (string, uri, max length 500, nullable, optional).
  • checkoutMessage (string, max length 500, nullable, optional).
As seen on Open Source Alternatives The Merchant Engine badge