checkout

Read where a payment session stands

The stage of the checkout a payment session led to: awaiting_checkout, checkout_started, paid, label_ready (with the tracking number), delivered or refunded. Reads SMKlog order records only, no carrier call. Sessions live 30 days; an unknown or expired id answers 404 session_not_found. The answer never carries names, addresses or emails.

get/agent/checkout-session/{session_id}

Request

  • Base URL: https://quote-api.smklog.com
  • URL: https://quote-api.smklog.com/agent/checkout-session/{session_id}
  • Auth: one of:
    • none
    • OAuth 2 (client credentials, token URL https://quote-api.smklog.com/oauth/token, scopes: quote)

Path parameters

session_idstring required

The session_id returned by createPaymentSession.

Response

session_id, status, created_at, expires_at, amount, currency, service, checkout (order_id, paid, label_ready, carrier, service, tracking_number, tracking_status, estimated_delivery, delivered_at) and next.

session_idstring required

The session asked about

status'awaiting_checkout' | 'checkout_started' | 'paid' | 'label_ready' | 'delivered' | 'refunded' required

Stage, in that order

created_atstring date-time

When the session was made

expires_atstring date-time

When the session stops answering

amountnumber

The amount the session was anchored to, USD

currency'USD'

ISO currency, USD

servicestring

The service the session was anchored to

quote_reusedboolean

Whether the session reused a quote_id

nextstring

What, if anything, the agent should do now

Changes

No recorded changes to this operation across all 1 revision of this API.