01.software Docs

Retrieve a Cart

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

All HTTP operations
POST
/api/carts/retrieve

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)

Request Body

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

Response Body

Retrieve a Cart result

application/json
  1. response
id*string
Length1 <= length
status*string
Value in"active""completed""abandoned"
revision*integer
Range0 <= value <= 9007199254740991
currency*string
Match^[A-Z]{3}$
market*
subtotalMinor*integer
Range0 <= value <= 9007199254740991
discountMinor*integer
Range0 <= value <= 9007199254740991
estimatedTotalMinor*integer
Range0 <= value <= 9007199254740991
discountCodes*array<>
attributes*array<>

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

Itemsitems <= 50
items*array<>
expiresAt*string
Formatdate-time
createdAt*string
Formatdate-time
updatedAt*string
Formatdate-time

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/carts/retrieve' \  -H 'Content-Type: application/json' \  -d '{  "cartToken": "string"}'
Example Response
{  "id": "string",  "status": "active",  "revision": 0,  "currency": "string",  "market": {    "id": "string",    "handle": "string",    "name": "string"  },  "subtotalMinor": 0,  "discountMinor": 0,  "estimatedTotalMinor": 0,  "discountCodes": [    {      "code": "string",      "applicable": true    }  ],  "attributes": [    {      "key": "string",      "value": "string"    }  ],  "items": [    {      "id": "string",      "product": {        "id": "string",        "title": "string",        "handle": "string",        "image": "string"      },      "variant": {        "id": "string",        "title": "string",        "handle": "string",        "image": "string"      },      "admissions": [        {          "eventId": "string",          "occurrenceId": "string",          "admissionTypeId": "string"        }      ],      "quantity": 1,      "unitPriceMinor": 0,      "discountMinor": 0,      "estimatedLineTotalMinor": 0,      "requiresShipping": true    }  ],  "expiresAt": "2019-08-24T14:15:22Z",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}

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": [
        "cartToken"
      ],
      "properties": {
        "cartToken": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      }
    },
    "responseSchema": "PublicCart"
  },
  {
    "security": [
      {
        "publishableKey": [],
        "serverSecretKey": []
      }
    ],
    "requestSchema": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "cartToken"
      ],
      "properties": {
        "cartToken": {
          "type": "string",
          "minLength": 1,
          "maxLength": 512
        }
      }
    },
    "responseSchema": "PublicCart"
  }
]