Checkout Endpoints

All checkout endpoints are prefixed with /shop/checkout/.

---

Get initial values

GET /shop/checkout/get-init-values

Returns all data needed to initialise the checkout form — customer defaults, address, saved methods, cart summary.

Response: JSON object with checkout initialisation payload.

---

Get shipping methods

GET /shop/checkout/get-shipping-methods

Returns available shipping methods for a given delivery country.

Query parameters:

Parameter	Description
code	ISO 3166-1 alpha-2 country code (e.g. SK, DE)

Response:

{
  "success": true,
  "shipping_methods": [
    { "id": 3, "name": "DPD Standard", "price": 3.90, "... ": "..." }
  ]
}

---

Get payment methods

GET /shop/checkout/get-payment-methods

Returns payment methods available for the selected shipping method and country.

Query parameters:

Parameter	Description
code	Country code
shipping-method	Selected shipping method identifier (format: type:handle:id)

Response:

{
  "success": true,
  "payment_methods": [
    { "id": 1, "name": "Card", "... ": "..." }
  ]
}

---

Get delivery slots

GET /shop/checkout/get-shipping-delivery-slots

Returns available delivery time slots for a given date (requires Delivery Time Manager).

Query parameters:

Parameter	Description
date	Date string (YYYY-MM-DD)

Response:

{
  "success": true,
  "slots": [
    { "id": 1, "label": "09:00 – 12:00", "available": true }
  ]
}

---

Validate VAT number

POST /shop/checkout/validate-vat

Validates a VAT ID against the VIES service (format + existence check).

Body parameters:

Parameter	Type	Description
vatId	string	VAT number including country prefix (e.g. SK2024123456)
country	string	ISO 3166-1 alpha-2 country code

Response:

{ "success": true, "valid": true, "message": null }
{ "success": true, "valid": false, "message": "Invalid VAT ID." }

note

Only active when salesValidateVAT is enabled and salesValidateVATType is format_existence.

---

Save checkout data

POST /shop/checkout/save

Persists the checkout form data (billing address, shipping address, notes, etc.) to the current quote.

---

Save shipping method

POST /shop/checkout/save-shipping-method

Sets the selected shipping method on the current quote.

---

Save payment method

POST /shop/checkout/save-payment-method

Sets the selected payment method on the current quote.

---

Place order

POST /shop/checkout/place-order

Submits the checkout and creates an order. Redirects to the payment gateway or the success/failed page depending on the payment method.

---

Process payment

POST /shop/checkout/process-payment/{orderNumber}
GET  /shop/checkout/process-payment

Processes the payment gateway response after a redirect from the gateway. Called automatically by the gateway redirect — not invoked directly.

---

Success page

GET /shop/checkout/success

Renders the order confirmation page. Requires a valid completed order in the session.

---

Failed page

GET /shop/checkout/failed

Renders the payment failed page.

---

Guest order view

GET /shop/order/view/{orderNumber}

Allows a guest to view their order without logging in, using the order number from the confirmation email.

---

Guest order pay

GET /shop/order/pay/{orderNumber}

Allows a guest to retry payment for a pending order.