Create CheckoutSession

Starts the checkout process, identifying the customer, optionally the cashier and obtaining a session.
This is the entry point of each transaction. The identification of the customer can be done trough several methods, specifying IdentifierMethod, IdentifierCode (and thirdPartySystemId if it applies) Wapping.Checkout.Api.Models.Enum.IdentifierMethodTypes
The other important part is the OrderCode, it has to identify univocally the code of the order in the system. This is usually a code that the POS gives to each order, or the same with ecommerce.
*There are cases in wich the code is not generated until the order is done, in some ecommerce for example. In that case, a temporal unique identifier has to be specified, and confirmed with the final one in the Commit.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request data to create a new checkout session.

A request session identify from where (shop-pos) and who (customer) request the transaction with Wapping platform.
This information is neccesary to init a checkout session.

date-time

Datetime from request origin

cashier
object

Information about cashier in physical store.

int32
enum
required

Unknown = 0
QR = 1
Mobile = 2
Mail = 3
Token = 4
Customer identifier from third party = 5
Barcode = 6
Image = 7

string

Identifier code, it depends on the identifier method selected

int32

Third Party System Id from request.

string

Code to vinculate the thirdpartysystemcustom.

string
required

Order identifier within business

Headers
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json