| Action | Method | Resource | Description |
|---|---|---|---|
| Get all | GET | /checkoutfields | Get all checkout fields. |
| Get | GET | /checkoutfields/:checkoutfield_id | Get checkout field with id checkoutfield_id. |
| Create | POST | /checkoutfields | Create a checkout field. |
| Update | PUT | /checkoutfields/:checkoutfield_id | Update checkout field with checkoutfield_id. |
| Delete | DELETE | /checkoutfields/:checkoutfield_id | Delete checkout field with checkoutfield_id. |
The checkout field model is composed of the following attributes:
| Attribute | Type | Required | Description | Whereable |
|---|---|---|---|---|
| name | string | no, required on create | The checkout field's name. | Yes |
| type | string | no, required on create | The checkout field's type. | Yes |
| required | boolean | no, required on create | If the checkout field is required. | Yes |
| enabled | boolean | no, required in create | If the checkout field is active. | Yes |
Only the user type Administrator can create, update or remove checkout fields.