Lists active checkout agreements

GET /V1/carts/licence

Lists active checkout agreements.

Responses

200

200 Success.
Hide response attributes Show response attributes object
Interface AgreementInterface
- agreement_id integer Required
  
  Agreement ID.
- name string Required
  
  Agreement name.
- content string Required
  
  Agreement content.
- content_height string
  
  Agreement content height. Otherwise, null.
- checkbox_text string Required
  
  Agreement checkbox text.
- is_active boolean Required
  
  Agreement status.
- is_html boolean Required
  
  true - HTML. * false - plain text.
- mode integer Required
  
  The agreement applied mode.
- extension_attributes object
  
  ExtensionInterface class for @see \Magento\CheckoutAgreements\Api\Data\AgreementInterface
401

401 Unauthorized
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace
default

Unexpected error
Hide response attributes Show response attributes object
- message string Required
  
  Error message
- errors array[object]
  
  Error details
  
  Hide errors attributes Show errors attributes object
  
  Error details
  
  message string
  
  Error message
  
  parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- code integer
  
  Error code
- parameters array[object]
  
  Error parameters item
  
  Hide parameters attributes Show parameters attributes object
  
  Error parameters item
  
  resources string
  
  ACL resource
  
  fieldName string
  
  Missing or invalid field name
  
  fieldValue string
  
  Incorrect field value
- trace string
  
  Stack trace

GET /V1/carts/licence

curl \
 -X GET https://magento2.winkelstraat.mac/rest/all/V1/carts/licence

Response examples (200)

[
  {
    "agreement_id": 42,
    "name": "string",
    "content": "string",
    "content_height": "string",
    "checkbox_text": "string",
    "is_active": true,
    "is_html": true,
    "mode": 42,
    "extension_attributes": {}
  }
]

Response examples (401)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}

Response examples (default)

{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}