Here you can find the reference for all of Skrym's API endpoints within the Checkout functionality.
It is divided into three parts:

Checkout API: Get the shipping options, reserve a delivery, and confirm the order payment.
Statistics API: Get data points collected throughout the use of your checkout.
Transport Method Config API: Configure transport method-specific behavior.

If you have any questions or need help, please contact us at .

There two different ways to integrate with Skrym's checkout APIs:

  
    Recommended Approach
    Simplified Approach
  
  
    
  Our Recommended approach of integrating with the Skrym Checkout API consists of three endpoints: 
  
    - `GetShippingOptions`
    - `ReserveShipment`
    - `ConfirmPayment` 

    <MermaidChart
      title="Skrym Checkout API: Recommended Flow"
      subtitle="Interaction Sequence of the Checkout APIs"
      chart={`
        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
      `}
    />

    Each step is responsible for a different part of the process:

    1.  <Mention
          label="Get Shipping Options"
          href="/shipping/checkout/api/checkout-api/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.
    2.  <Mention
          label="Reserve Delivery"
          href="/shipping/checkout/api/checkout-api/reserve-delivery"
        />
        : Reserves the shipping option. This should be called when a user has made
        their final choice of shipping option.
    3.  <Mention
          label="Confirm Payment"
          href="/shipping/checkout/api/checkout-api/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.

  </TabPanel>

   
    A Simplified approach of integrating with the Skrym Checkout API consists of two endpoints: 
      - `GetShippingOptions`
      -  `FinalizeShipment`     

    <MermaidChart
      title="Skrym Checkout API: Simplified Flow"
      subtitle="Interaction Sequence of the Checkout APIs"
      chart={`
        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
          Note over U,P: User completes payment
          P->>+C: Confirm Payment
          C->>+S: Call FinalizeShipment
          S-->>-C: Confirm Order payment and shipping option
      `}
    />

    Each step is responsible for a different part of the process:

    1.  <Mention
          label="Get Shipping Options"
          href="/shipping/checkout/api/checkout-api/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.
    2.  <Mention
          label="Confirm ShippingOption and Payment"
          href="/shipping/checkout/api/checkout-api/reserve-delivery"
        />
        : Confirms the selected shipping option and payment of the order. This should be called when the
        order is paid and ready for fulfillment.

  </TabPanel>

  

To access aggregated metrics from the use of these endpoints, you can use the  or see the charts on .

Checkout

Reference for APIs concerning data insights

These endpoints rely on the  as they only include data after an order is confirmed.
checkout.GetCheckoutStatistics
This endpoint allows you to fetch aggregated data between two dates.
You can also filter by any given Strategy or A/B test.
Please note that the shipping cost is not always available in all checkouts so the profit/loss cannot always be guaranteed.

checkout.GetHourlyCheckoutStatistics
This is similar to the GetCheckoutStatistics endpoint, but returns the data on an hourly basis.

checkout.GetCheckoutStatisticsPerTransportMethod
Similar to the GetCheckoutStatistics endpoint, but it returns the data per transport method.

checkout.GetCheckoutConversionRate
This endpoint returns the conversion rate for the checkouts.
conversion rate is calculated by dividing the number of confirmed payment orders with the number of unique sessions used in fetching the shipping options.

checkout.GetHourlyCheckoutConversionRates
The GetHourlyCheckoutConversionRates endpoint is similar to the GetCheckoutConversionRate endpoint, but it returns the conversion rate on an hourly basis.

checkout.GetCheckoutTransportMethodUsage
This endpoint returns the number of times each transport method has been chosen for confirmed orders.
This is useful to see which transport methods are most popular among your customers.
It allows you to fetch for a specific date range.


Statistics

API reference for configuring transport methods

The following endpoints facilitate the setting, updating, fetching and deleting of transport method codes and maximum cost limits.
Add a Transport Method Configuration
Configuration can be added for one or more transport methods by providing the configuration along with the Skrym transport method ID and the corresponding checkout it is to be used in.

Fetch a Set Transport Method Configuration
There are two ways of fetching configurations, one to get a single configuration and the other to fetch all configurations associated with the authenticated organization.
Single Configuration
A checkout configuration can be fetched for one transport method by providing the Skrym transport method ID and the corresponding checkout the configuration should be fetched for.

Multiple Configurations
Checkout configuration for all transport methods for a given checkout can be fetched by providing corresponding checkout.

Delete a Set Transport Method Configuration
A set configuration can be deleted by providing the Skrym transport method ID and the corresponding checkout the configuration should be deleted for.
