Checkout
Skrym checkout API reference
Last updated 24 Jun 2024
There two different ways to integrate with Skrym's checkout APIs:
Our Recommended approach of integrating with the Skrym Checkout API consists of three endpoints:
GetShippingOptionsReserveShipmentConfirmPayment
Skrym Checkout API: Recommended Flow
sequenceDiagram
autonumber
participant C as Checkout
participant S as Skrym API
participant U as User
participant P as Payment Provider
C->>+S: Call GetShippingOptionss
S-->>-C: Return Shipping Options
Note over C,U: Shipping options displayed
U->>+C: Select Shipping Option
C->>+S: Call ReserveShipment
S-->>-C: Confirm Reservation of shipping option
Note over U,P: User completes payment
P->>+C: Confirm Payment
C->>+S: Call ConfirmPayment
S-->>-C: Confirm Order payment
Interaction Sequence of the Checkout APIs
Each step is responsible for a different part of the process:
- Get Shipping Options : Returns the available shipping options. Whenever a user enters the checkout or makes any change to the order or delivery location, this endpoint should be called to get the updated shipping options.
- Reserve Delivery : Reserves the shipping option. This should be called when a user has made their final choice of shipping option.
- Confirm Payment : Confirms the previously reserved shipping option and payment of the order. This should be called when the order is paid and ready for fulfillment.
To access aggregated metrics from the use of these endpoints, you can use the statistics APIs or see the charts on Scope.
Available APIs