Download OpenAPI specification:Download
Converts a cart into a sales order by executing a number of checkout steps in sequence.
Key Features:
Key Benefits:
This endpoint triggers a checkout for a given cart or for a given quote. Customer must be active while checkout is proceed. Checkout is an atomic operation either it succeeds or fails. When a checkout request fails a proper validation message will be returned. Depending of the issue the checkout payload or cart content can be corrected to satisfy the validation rules and the request can be retried.
The checkout process performs the following operations:
Schema for triggering a checkout.
The request was successful. A unique order ID is returned.
Request was syntactically incorrect. Details are be provided within the response payload.
Access forbidden. The authorization token has expired.
Authorization token's scopes do not match scopes required by the endpoint.
Selected delivery window does not have available capacity
Some server side exception occurred which prevented it from correctly returning the result.
{- "cartId": "9b36757a-5ea1-4689-9ed3-fb630eb5048c",
- "paymentMethods": [
- {
- "provider": "payment-gateway",
- "customAttributes": {
- "customer": "635544345",
- "modeId": "9a33c7a5-9535-42af-a936-2fa6ece27579"
}, - "method": "invoice"
}
], - "currency": "EUR",
- "shipping": {
- "methodId": "4-more_hours_timeframe",
- "zoneId": "deliveryarea",
- "methodName": "Delivery method name",
- "amount": 10,
- "shippingTaxCode": "STANDARD"
}, - "deliveryWindowId": "cbda2a28-f0cc-11ed-a05b-0242ac120003",
- "addresses": [
- {
- "contactName": "John Doe",
- "companyName": "Emporix",
- "street": "Fritz-Elsaas",
- "streetNumber": "20",
- "streetAppendix": "",
- "zipCode": "70173",
- "city": "Stuttgart",
- "country": "DE",
- "state": "",
- "contactPhone": "123456789",
- "type": "SHIPPING",
- "metadata": {
- "mixins": { }
}, - "mixins": { }
}, - {
- "contactName": "John Doe",
- "companyName": "Emporix",
- "street": "Fritz-Elsaas",
- "streetNumber": "20",
- "streetAppendix": "",
- "zipCode": "70173",
- "city": "Stuttgart",
- "country": "DE",
- "state": "",
- "contactPhone": "123456789",
- "type": "BILLING",
- "metadata": {
- "mixins": { }
}, - "mixins": { }
}
], - "customer": {
- "id": "8765472",
- "title": "MR",
- "firstName": "John",
- "middleName": "",
- "lastName": "Doe",
- "contactPhone": "56432245",
- "email": "test@doc.com",
- "company": "Emporix",
- "metadata": {
- "mixins": { }
}, - "mixins": { }
}
}
{- "orderId": "B702231",
- "paymentDetails": null,
- "checkoutId": ""
}