Settings

Settings

Creates a new setting record that does not already exist.

This method will auto-generate an ID and create a new setting. If an ID is specified for the setting, an error will be thrown.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The setting that you would like to be saved.

Array of objects

The contact roles that are allowed to manage this scholarship

enable_order_confirmation_email
boolean (Enable Order Confirmation Email)

If set, you can enable the text of the confirmation email

required
object (Order Confirmation Email)
enable_shipment_confirmation_email
boolean (Enable Shipment Confirmation Email)

If set, you can enable the text of the shipment email

required
object (Shipment Confirmation Email)
enable_cancellation_confirmation_email
boolean (Enable Cancellation Confirmation Email)

If set, you can enable the text of the confirmation email

required
object (Cancellation Confirmation Email)
enable_return_confirmation_email
boolean (Enable Return Confirmation Email)

If set, you can enable the text of the confirmation email

required
object (Return Confirmation Email)
enable_retroactive_coupons_in_portal
boolean (Enable Retroactive Coupons In Portal)

If true, users can retroactively apply coupons to orders in the portal

restrict_retroactive_coupons_by_time_period
boolean (Restrict Retroactive Coupons By Time Period)

If true, users in the portal can only retroactively apply coupons to orders within a certain time period

retroactive_coupon_allowed_time_period
required
number <float> (Retroactive Coupon Allowed Time Period)

The maximum number of a days after an order is processed that a user can retroactively apply a coupon in the portal

object (Address)

A complete address

notes
string (Notes)

The name of the settings

default_store_id
string (Default Store)

The default store

Array of objects (Custom Field Values)
sys_deleted_by_id
string (Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

The date/time that this record was created, expressed in ISO-8601 date format

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

The ID that a record has from an external system or data import

sys_locked
boolean (Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_bulk_load_pk
string (Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_at
string (Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_id
string (Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_version
string (Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_has_files_in_s3
boolean (Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_last_security_context
object (Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

Array of objects
Responses
200The setting was saved successfully.
400The setting you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The setting could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add setting based on tenant limits.
500General server error.
post/settings/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "contact_role_permissions": [
    ],
  • "enable_order_confirmation_email": true,
  • "order_confirmation_email": {
    },
  • "enable_shipment_confirmation_email": true,
  • "shipment_confirmation_email": {
    },
  • "enable_cancellation_confirmation_email": true,
  • "cancellation_confirmation_email": {
    },
  • "enable_return_confirmation_email": true,
  • "return_confirmation_email": {
    },
  • "enable_retroactive_coupons_in_portal": true,
  • "restrict_retroactive_coupons_by_time_period": true,
  • "retroactive_coupon_allowed_time_period": 0,
  • "default_ship_from_address": {
    },
  • "notes": "string",
  • "default_store_id": "string",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{
  • "contact_role_permissions": [
    ],
  • "enable_order_confirmation_email": true,
  • "order_confirmation_email": {
    },
  • "enable_shipment_confirmation_email": true,
  • "shipment_confirmation_email": {
    },
  • "enable_cancellation_confirmation_email": true,
  • "cancellation_confirmation_email": {
    },
  • "enable_return_confirmation_email": true,
  • "return_confirmation_email": {
    },
  • "enable_retroactive_coupons_in_portal": true,
  • "restrict_retroactive_coupons_by_time_period": true,
  • "retroactive_coupon_allowed_time_period": 0,
  • "default_ship_from_address": {
    },
  • "notes": "string",
  • "default_store_id": "string",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Returns a setting from the system by its ID.

This method will look up a setting by the specified ID and return it back.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

query Parameters
fields
string

The fields that you want to retrieve; if omitted, the entire object is returned.

consistentRead
string

Indicates the API should force a consistent read on the data source.

Responses
200The setting was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The setting could not be found.
429Limit exceeded... unable to retrieve setting based on tenant limits.
500General server error.
get/settings/{tenantId}
Request samples
curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/settings/:tenantId?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "contact_role_permissions": [
    ],
  • "enable_order_confirmation_email": true,
  • "order_confirmation_email": {
    },
  • "enable_shipment_confirmation_email": true,
  • "shipment_confirmation_email": {
    },
  • "enable_cancellation_confirmation_email": true,
  • "cancellation_confirmation_email": {
    },
  • "enable_return_confirmation_email": true,
  • "return_confirmation_email": {
    },
  • "enable_retroactive_coupons_in_portal": true,
  • "restrict_retroactive_coupons_by_time_period": true,
  • "retroactive_coupon_allowed_time_period": 0,
  • "default_ship_from_address": {
    },
  • "notes": "string",
  • "default_store_id": "string",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Updates a setting with the specified ID.

This method will update an existing setting with the specified ID.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The updated setting that will be saved.

Array of objects

The contact roles that are allowed to manage this scholarship

enable_order_confirmation_email
boolean (Enable Order Confirmation Email)

If set, you can enable the text of the confirmation email

required
object (Order Confirmation Email)
enable_shipment_confirmation_email
boolean (Enable Shipment Confirmation Email)

If set, you can enable the text of the shipment email

required
object (Shipment Confirmation Email)
enable_cancellation_confirmation_email
boolean (Enable Cancellation Confirmation Email)

If set, you can enable the text of the confirmation email

required
object (Cancellation Confirmation Email)
enable_return_confirmation_email
boolean (Enable Return Confirmation Email)

If set, you can enable the text of the confirmation email

required
object (Return Confirmation Email)
enable_retroactive_coupons_in_portal
boolean (Enable Retroactive Coupons In Portal)

If true, users can retroactively apply coupons to orders in the portal

restrict_retroactive_coupons_by_time_period
boolean (Restrict Retroactive Coupons By Time Period)

If true, users in the portal can only retroactively apply coupons to orders within a certain time period

retroactive_coupon_allowed_time_period
required
number <float> (Retroactive Coupon Allowed Time Period)

The maximum number of a days after an order is processed that a user can retroactively apply a coupon in the portal

object (Address)

A complete address

notes
string (Notes)

The name of the settings

default_store_id
string (Default Store)

The default store

Array of objects (Custom Field Values)
sys_deleted_by_id
string (Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

The date/time that this record was created, expressed in ISO-8601 date format

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

The ID that a record has from an external system or data import

sys_locked
boolean (Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_bulk_load_pk
string (Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_at
string (Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_id
string (Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_version
string (Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_has_files_in_s3
boolean (Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_last_security_context
object (Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

Array of objects
Responses
200The setting was updated successfully.
400The setting supplied was not valid.
401Unauthorized.
403Forbidden.
404The setting could not be found.
409The setting could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve setting based on tenant limits.
500General server error.
put/settings/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "contact_role_permissions": [
    ],
  • "enable_order_confirmation_email": true,
  • "order_confirmation_email": {
    },
  • "enable_shipment_confirmation_email": true,
  • "shipment_confirmation_email": {
    },
  • "enable_cancellation_confirmation_email": true,
  • "cancellation_confirmation_email": {
    },
  • "enable_return_confirmation_email": true,
  • "return_confirmation_email": {
    },
  • "enable_retroactive_coupons_in_portal": true,
  • "restrict_retroactive_coupons_by_time_period": true,
  • "retroactive_coupon_allowed_time_period": 0,
  • "default_ship_from_address": {
    },
  • "notes": "string",
  • "default_store_id": "string",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{
  • "contact_role_permissions": [
    ],
  • "enable_order_confirmation_email": true,
  • "order_confirmation_email": {
    },
  • "enable_shipment_confirmation_email": true,
  • "shipment_confirmation_email": {
    },
  • "enable_cancellation_confirmation_email": true,
  • "cancellation_confirmation_email": {
    },
  • "enable_return_confirmation_email": true,
  • "return_confirmation_email": {
    },
  • "enable_retroactive_coupons_in_portal": true,
  • "restrict_retroactive_coupons_by_time_period": true,
  • "retroactive_coupon_allowed_time_period": 0,
  • "default_ship_from_address": {
    },
  • "notes": "string",
  • "default_store_id": "string",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Partially updates a setting with the specified ID.

This method will patch an existing setting with the specified ID, using the HTTP PATCH specification.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array
op
required
string (Op)

The operation

Enum: "add" "remove" "replace" "move" "copy" "test"
path
required
string (Path)

The JSON path

value
string (Value)
Responses
200The setting was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The setting could not be found.
409The setting could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve setting based on tenant limits.
500General server error.
patch/settings/{tenantId}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "contact_role_permissions": [
    ],
  • "enable_order_confirmation_email": true,
  • "order_confirmation_email": {
    },
  • "enable_shipment_confirmation_email": true,
  • "shipment_confirmation_email": {
    },
  • "enable_cancellation_confirmation_email": true,
  • "cancellation_confirmation_email": {
    },
  • "enable_return_confirmation_email": true,
  • "return_confirmation_email": {
    },
  • "enable_retroactive_coupons_in_portal": true,
  • "restrict_retroactive_coupons_by_time_period": true,
  • "retroactive_coupon_allowed_time_period": 0,
  • "default_ship_from_address": {
    },
  • "notes": "string",
  • "default_store_id": "string",
  • "custom_field_values": [
    ],
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Returns a setting from the system by its ID.

This method will delete a setting with the specified ID.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Responses
200The setting was deleted successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The setting could not be found.
409The setting could not be deleted because other objects refers to/depends on this one.
429Limit exceeded... unable to delete setting based on tenant limits.
500General server error.
delete/settings/{tenantId}
Request samples
curl -i -X DELETE \
  https://commerce.api.756794052567.rhythmsoftware.com/settings/:tenantId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
"string"