01.software Docs

Retrieve a Checkout

Use the SDK for application integration. This read-only reference covers Commerce, Customer Auth, Membership and Events.

All HTTP operations
POST
/api/checkouts/detail

One canonical transport with credential-specific request and response variants. Server bodies require the admitted server credential; browser/customer bodies retain their capability boundary.

Authorization

headerX-Publishable-Key<token>

Tenant publishable key for authentication (sent via X-Publishable-Key header)

Header Parameters

Accept?"application/vnd.01software.credit-funding.v1+json"

Exact whole-value opt-in after trimming whitespace, case-insensitive. Lists, wildcards and parameters (including q/charset) retain legacy JSON. Success only: vendor Content-Type and private, no-store. Accept never grants money or authorization. Missing funding means unknown support, not zero credit. Purchase total semantics are unchanged.

Value in"application/vnd.01software.credit-funding.v1+json"

Request Body

application/json
  1. body
checkoutToken*string
Length1 <= length <= 512

Response Body

Retrieve a Checkout result

  1. response
id*string
Length1 <= length
amounts*
customerSnapshot*
expiresAt*string
Formatdate-time
createdAt*string
Formatdate-time
updatedAt*string
Formatdate-time
items*array<>
Items1 <= items
shippingAddress*||
attributes*array<>

Attribute keys must be unique. OpenAPI 3.0 cannot express uniqueness by one object property, so servers enforce this rule.

Itemsitems <= 50
status*"open"
Value in"open"
paymentState*
order*|
Value innull

Examples may be generated from schemas; they are illustrative, not recorded successful API calls. Example snippets may omit required authentication headers.

Example Request
curl -X POST 'https://api.01.software/api/checkouts/detail' \  -H 'Content-Type: application/json' \  -d '{  "checkoutToken": "string"}'
Example Response
{  "id": "string",  "amounts": {    "currency": "string",    "subtotalMinor": 0,    "shippingMinor": 0,    "discountMinor": 0,    "totalMinor": 0  },  "customerSnapshot": {    "email": "user@example.com",    "name": "string",    "phone": "string"  },  "expiresAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "items": [    {      "id": "string",      "product": {        "id": "string",        "title": "string",        "handle": "string",        "image": "string"      },      "variant": {        "id": "string",        "title": "string",        "handle": "string",        "image": "string"      },      "productTitle": "string",      "variantTitle": "string",      "sku": "string",      "admissions": [        {          "eventId": "string",          "occurrenceId": "string",          "admissionTypeId": "string"        }      ],      "quantity": 1,      "unitPriceMinor": 0,      "discountMinor": 0,      "lineTotalMinor": 0,      "requiresShipping": true    }  ],  "shippingAddress": {    "recipientName": "string",    "phone": "string",    "countryCode": "st",    "regionCode": "string",    "postalCode": "string",    "address": "string",    "detailAddress": "string",    "deliveryMessage": "string"  },  "attributes": [    {      "key": "string",      "value": "string"    }  ],  "status": "open",  "paymentState": {    "activePaymentSession": {      "id": "string",      "provider": "toss",      "providerStatus": "requires_payment_method"    }  },  "order": null}

Credential variants

Credential-specific requirements from the public OpenAPI projection: Full response schemas appear in Response Body.

[
  {
    "security": [
      {
        "publishableKey": []
      },
      {
        "publishableKey": [],
        "customerBearerAuth": []
      }
    ],
    "requestSchema": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "checkoutToken"
      ],
      "properties": {
        "checkoutToken": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      }
    },
    "responseSchema": "PublicCheckout"
  },
  {
    "security": [
      {
        "publishableKey": [],
        "serverSecretKey": []
      }
    ],
    "requestSchema": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "checkoutId"
      ],
      "properties": {
        "checkoutId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 255
        }
      }
    },
    "responseSchema": "ServerCheckout"
  }
]