Commerce (Orders & Inventory) (v1-2025-04-18)

The Orders & Inventory, or Commerce, API is focused on the processing and fulfillment of Orders. Additionally, you can use this API to manage your inventory, merchandise, and online store.

Like most of the other Rhythm apps, the Commerce API includes endpoints for Query Definitions. These endpoints are commonly used to retrieve saved queries, which can then be executed using the Query endpoints of the System API.

Download OpenAPI description
Languages
Servers
Mock server
https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/
https://commerce.api.rhythmsoftware.com/

Cancellation Fees

Cancellation Fees

Operations

Cancellations

Cancellations

Operations

Carts

Carts

Operations

Coupon Code Gen Processes

Coupon Code Gen Processes

Operations

Coupon Codes

Coupon Codes

Operations

Coupons

Coupons

Operations

Discount Products

Discount Products

Operations

Entitlement Types

Entitlement Types

Operations

Entitlements

Entitlements

Operations

Inventory Transactions

Inventory Transactions

Operations

Merchandise

Merchandise

Operations

Orders

Orders

Operations

Product Categories

Product Categories

Operations

Product Confirmation Emails

Product Confirmation Emails

Operations

Product Inventories

Product Inventories

Operations

Query Definitions

Query Definitions

Operations

Returns

Returns

Operations

Settings

Settings

Operations

Returns a setting from the system by its ID.

Request

This method will delete a setting with the specified ID.

Path
tenantIdstringrequired

The id of the tenant being accessed.

curl -i -X DELETE \
  'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/settings/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The setting was deleted successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
string
Response
application/json
"string"

Returns a setting from the system by its ID.

Request

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

Path
tenantIdstringrequired

The id of the tenant being accessed.

Query
fieldsstring

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

consistentReadstring

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

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/settings/{tenantId}?consistentRead=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The setting was retrieved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
cancellation_confirmation_emailobject(Cancellation Confirmation Email)required
cancellation_confirmation_email.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

cancellation_confirmation_email.​bodystring(Body)required

The email body

cancellation_confirmation_email.​ccstring(Cc)

Anyone that should be cc'ed on the email

cancellation_confirmation_email.​fromstring(From)

From email address

cancellation_confirmation_email.​from_namestring(From Name)

From name

cancellation_confirmation_email.​reply_tostring(Reply To)

The reply to

cancellation_confirmation_email.​subjectstring(Subject)required

The email subject

contact_role_permissionsArray of objects

The contact roles that are allowed to manage this scholarship

custom_field_valuesArray of objects(Custom Field Values)
default_ship_from_addressobject(Address)

A complete address

default_store_idstring(Default Store)

The default store

display_policies_at_checkoutboolean(Display Policies At Checkout)

If set, policies are shown to users at checkout

enable_cancellation_confirmation_emailboolean(Enable Cancellation Confirmation Email)

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

enable_order_confirmation_emailboolean(Enable Order Confirmation Email)

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

enable_retroactive_coupons_in_portalboolean(Enable Retroactive Coupons In Portal)

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

enable_return_confirmation_emailboolean(Enable Return Confirmation Email)

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

enable_shipment_confirmation_emailboolean(Enable Shipment Confirmation Email)

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

notesstring(Notes)

The name of the settings

order_confirmation_emailobject(Order Confirmation Email)required
order_confirmation_email.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

order_confirmation_email.​bodystring(Body)required

The email body

order_confirmation_email.​ccstring(Cc)

Anyone that should be cc'ed on the email

order_confirmation_email.​fromstring(From)

From email address

order_confirmation_email.​from_namestring(From Name)

From name

order_confirmation_email.​reply_tostring(Reply To)

The reply to

order_confirmation_email.​subjectstring(Subject)required

The email subject

policiesobject(Policies)required
policies.​consumer_data_policy_uristring(Consumer Data Policy Uri)required

The default consumer data policy to display to customers when checking out

policies.​refund_policy_uristring(Refund Policy Uri)required

The refund policy to display to customers when checking out

policies.​secure_checkout_policy_uristring(Secure Checkout Policy Uri)required

The default secure checkout policy to display to customers when checking out

policies.​terms_of_service_uristring(Terms Of Service Uri)required

The default TOS policy to display to customers when checking out

restrict_retroactive_coupons_by_time_periodboolean(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_periodnumber(float)(Retroactive Coupon Allowed Time Period)required

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

return_confirmation_emailobject(Return Confirmation Email)required
return_confirmation_email.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

return_confirmation_email.​bodystring(Body)required

The email body

return_confirmation_email.​ccstring(Cc)

Anyone that should be cc'ed on the email

return_confirmation_email.​fromstring(From)

From email address

return_confirmation_email.​from_namestring(From Name)

From name

return_confirmation_email.​reply_tostring(Reply To)

The reply to

return_confirmation_email.​subjectstring(Subject)required

The email subject

shipment_confirmation_emailobject(Shipment Confirmation Email)required
shipment_confirmation_email.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

shipment_confirmation_email.​bodystring(Body)required

The email body

shipment_confirmation_email.​ccstring(Cc)

Anyone that should be cc'ed on the email

shipment_confirmation_email.​fromstring(From)

From email address

shipment_confirmation_email.​from_namestring(From Name)

From name

shipment_confirmation_email.​reply_tostring(Reply To)

The reply to

shipment_confirmation_email.​subjectstring(Subject)required

The email subject

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

Response
application/json
{ "cancellation_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "contact_role_permissions": [ {} ], "custom_field_values": [ {} ], "default_ship_from_address": { "city": "string", "country": "string", "country_name": "string", "county": "string", "latitude": 0.1, "line1": "string", "line2": "string", "line3": "string", "longitude": 0.1, "postal_code": "string", "state": "string", "time_zone_id": "string" }, "default_store_id": "string", "display_policies_at_checkout": true, "enable_cancellation_confirmation_email": true, "enable_order_confirmation_email": true, "enable_retroactive_coupons_in_portal": true, "enable_return_confirmation_email": true, "enable_shipment_confirmation_email": true, "notes": "string", "order_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "policies": { "consumer_data_policy_uri": "string", "refund_policy_uri": "string", "secure_checkout_policy_uri": "string", "terms_of_service_uri": "string" }, "restrict_retroactive_coupons_by_time_period": true, "retroactive_coupon_allowed_time_period": 0.1, "return_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "shipment_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ {} ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1 }

Partially updates a setting with the specified ID.

Request

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

Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The patch directives conforming to RFC 6902.

Array [
opstring(Op)required

The operation

Enum"add""copy""move""remove""replace""test"
pathstring(Path)required

The JSON path

valuestring(Value)
]
curl -i -X PATCH \
  'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/settings/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The setting was patched successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
cancellation_confirmation_emailobject(Cancellation Confirmation Email)required
cancellation_confirmation_email.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

cancellation_confirmation_email.​bodystring(Body)required

The email body

cancellation_confirmation_email.​ccstring(Cc)

Anyone that should be cc'ed on the email

cancellation_confirmation_email.​fromstring(From)

From email address

cancellation_confirmation_email.​from_namestring(From Name)

From name

cancellation_confirmation_email.​reply_tostring(Reply To)

The reply to

cancellation_confirmation_email.​subjectstring(Subject)required

The email subject

contact_role_permissionsArray of objects

The contact roles that are allowed to manage this scholarship

custom_field_valuesArray of objects(Custom Field Values)
default_ship_from_addressobject(Address)

A complete address

default_store_idstring(Default Store)

The default store

display_policies_at_checkoutboolean(Display Policies At Checkout)

If set, policies are shown to users at checkout

enable_cancellation_confirmation_emailboolean(Enable Cancellation Confirmation Email)

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

enable_order_confirmation_emailboolean(Enable Order Confirmation Email)

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

enable_retroactive_coupons_in_portalboolean(Enable Retroactive Coupons In Portal)

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

enable_return_confirmation_emailboolean(Enable Return Confirmation Email)

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

enable_shipment_confirmation_emailboolean(Enable Shipment Confirmation Email)

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

notesstring(Notes)

The name of the settings

order_confirmation_emailobject(Order Confirmation Email)required
order_confirmation_email.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

order_confirmation_email.​bodystring(Body)required

The email body

order_confirmation_email.​ccstring(Cc)

Anyone that should be cc'ed on the email

order_confirmation_email.​fromstring(From)

From email address

order_confirmation_email.​from_namestring(From Name)

From name

order_confirmation_email.​reply_tostring(Reply To)

The reply to

order_confirmation_email.​subjectstring(Subject)required

The email subject

policiesobject(Policies)required
policies.​consumer_data_policy_uristring(Consumer Data Policy Uri)required

The default consumer data policy to display to customers when checking out

policies.​refund_policy_uristring(Refund Policy Uri)required

The refund policy to display to customers when checking out

policies.​secure_checkout_policy_uristring(Secure Checkout Policy Uri)required

The default secure checkout policy to display to customers when checking out

policies.​terms_of_service_uristring(Terms Of Service Uri)required

The default TOS policy to display to customers when checking out

restrict_retroactive_coupons_by_time_periodboolean(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_periodnumber(float)(Retroactive Coupon Allowed Time Period)required

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

return_confirmation_emailobject(Return Confirmation Email)required
return_confirmation_email.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

return_confirmation_email.​bodystring(Body)required

The email body

return_confirmation_email.​ccstring(Cc)

Anyone that should be cc'ed on the email

return_confirmation_email.​fromstring(From)

From email address

return_confirmation_email.​from_namestring(From Name)

From name

return_confirmation_email.​reply_tostring(Reply To)

The reply to

return_confirmation_email.​subjectstring(Subject)required

The email subject

shipment_confirmation_emailobject(Shipment Confirmation Email)required
shipment_confirmation_email.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

shipment_confirmation_email.​bodystring(Body)required

The email body

shipment_confirmation_email.​ccstring(Cc)

Anyone that should be cc'ed on the email

shipment_confirmation_email.​fromstring(From)

From email address

shipment_confirmation_email.​from_namestring(From Name)

From name

shipment_confirmation_email.​reply_tostring(Reply To)

The reply to

shipment_confirmation_email.​subjectstring(Subject)required

The email subject

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

Response
application/json
{ "cancellation_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "contact_role_permissions": [ {} ], "custom_field_values": [ {} ], "default_ship_from_address": { "city": "string", "country": "string", "country_name": "string", "county": "string", "latitude": 0.1, "line1": "string", "line2": "string", "line3": "string", "longitude": 0.1, "postal_code": "string", "state": "string", "time_zone_id": "string" }, "default_store_id": "string", "display_policies_at_checkout": true, "enable_cancellation_confirmation_email": true, "enable_order_confirmation_email": true, "enable_retroactive_coupons_in_portal": true, "enable_return_confirmation_email": true, "enable_shipment_confirmation_email": true, "notes": "string", "order_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "policies": { "consumer_data_policy_uri": "string", "refund_policy_uri": "string", "secure_checkout_policy_uri": "string", "terms_of_service_uri": "string" }, "restrict_retroactive_coupons_by_time_period": true, "retroactive_coupon_allowed_time_period": 0.1, "return_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "shipment_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ {} ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1 }

Creates a new setting record that does not already exist.

Request

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.

Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The setting that you would like to be saved.

cancellation_confirmation_emailobject(Cancellation Confirmation Email)required
cancellation_confirmation_email.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

cancellation_confirmation_email.​bodystring(Body)required

The email body

cancellation_confirmation_email.​ccstring(Cc)

Anyone that should be cc'ed on the email

cancellation_confirmation_email.​fromstring(From)

From email address

cancellation_confirmation_email.​from_namestring(From Name)

From name

cancellation_confirmation_email.​reply_tostring(Reply To)

The reply to

cancellation_confirmation_email.​subjectstring(Subject)required

The email subject

contact_role_permissionsArray of objects

The contact roles that are allowed to manage this scholarship

custom_field_valuesArray of objects(Custom Field Values)
default_ship_from_addressobject(Address)

A complete address

default_store_idstring(Default Store)

The default store

display_policies_at_checkoutboolean(Display Policies At Checkout)

If set, policies are shown to users at checkout

enable_cancellation_confirmation_emailboolean(Enable Cancellation Confirmation Email)

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

enable_order_confirmation_emailboolean(Enable Order Confirmation Email)

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

enable_retroactive_coupons_in_portalboolean(Enable Retroactive Coupons In Portal)

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

enable_return_confirmation_emailboolean(Enable Return Confirmation Email)

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

enable_shipment_confirmation_emailboolean(Enable Shipment Confirmation Email)

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

notesstring(Notes)

The name of the settings

order_confirmation_emailobject(Order Confirmation Email)required
order_confirmation_email.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

order_confirmation_email.​bodystring(Body)required

The email body

order_confirmation_email.​ccstring(Cc)

Anyone that should be cc'ed on the email

order_confirmation_email.​fromstring(From)

From email address

order_confirmation_email.​from_namestring(From Name)

From name

order_confirmation_email.​reply_tostring(Reply To)

The reply to

order_confirmation_email.​subjectstring(Subject)required

The email subject

policiesobject(Policies)required
policies.​consumer_data_policy_uristring(Consumer Data Policy Uri)required

The default consumer data policy to display to customers when checking out

policies.​refund_policy_uristring(Refund Policy Uri)required

The refund policy to display to customers when checking out

policies.​secure_checkout_policy_uristring(Secure Checkout Policy Uri)required

The default secure checkout policy to display to customers when checking out

policies.​terms_of_service_uristring(Terms Of Service Uri)required

The default TOS policy to display to customers when checking out

restrict_retroactive_coupons_by_time_periodboolean(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_periodnumber(float)(Retroactive Coupon Allowed Time Period)required

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

return_confirmation_emailobject(Return Confirmation Email)required
return_confirmation_email.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

return_confirmation_email.​bodystring(Body)required

The email body

return_confirmation_email.​ccstring(Cc)

Anyone that should be cc'ed on the email

return_confirmation_email.​fromstring(From)

From email address

return_confirmation_email.​from_namestring(From Name)

From name

return_confirmation_email.​reply_tostring(Reply To)

The reply to

return_confirmation_email.​subjectstring(Subject)required

The email subject

shipment_confirmation_emailobject(Shipment Confirmation Email)required
shipment_confirmation_email.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

shipment_confirmation_email.​bodystring(Body)required

The email body

shipment_confirmation_email.​ccstring(Cc)

Anyone that should be cc'ed on the email

shipment_confirmation_email.​fromstring(From)

From email address

shipment_confirmation_email.​from_namestring(From Name)

From name

shipment_confirmation_email.​reply_tostring(Reply To)

The reply to

shipment_confirmation_email.​subjectstring(Subject)required

The email subject

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/settings/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "cancellation_confirmation_email": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "contact_role_permissions": [
      {
        "manage_coupon_codes": true,
        "role_id": "string"
      }
    ],
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "default_ship_from_address": {
      "city": "string",
      "country": "string",
      "country_name": "string",
      "county": "string",
      "latitude": 0.1,
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "longitude": 0.1,
      "postal_code": "string",
      "state": "string",
      "time_zone_id": "string"
    },
    "default_store_id": "string",
    "display_policies_at_checkout": true,
    "enable_cancellation_confirmation_email": true,
    "enable_order_confirmation_email": true,
    "enable_retroactive_coupons_in_portal": true,
    "enable_return_confirmation_email": true,
    "enable_shipment_confirmation_email": true,
    "notes": "string",
    "order_confirmation_email": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "policies": {
      "consumer_data_policy_uri": "string",
      "refund_policy_uri": "string",
      "secure_checkout_policy_uri": "string",
      "terms_of_service_uri": "string"
    },
    "restrict_retroactive_coupons_by_time_period": true,
    "retroactive_coupon_allowed_time_period": 0.1,
    "return_confirmation_email": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "shipment_confirmation_email": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1
  }'

Responses

The setting was saved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
cancellation_confirmation_emailobject(Cancellation Confirmation Email)required
cancellation_confirmation_email.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

cancellation_confirmation_email.​bodystring(Body)required

The email body

cancellation_confirmation_email.​ccstring(Cc)

Anyone that should be cc'ed on the email

cancellation_confirmation_email.​fromstring(From)

From email address

cancellation_confirmation_email.​from_namestring(From Name)

From name

cancellation_confirmation_email.​reply_tostring(Reply To)

The reply to

cancellation_confirmation_email.​subjectstring(Subject)required

The email subject

contact_role_permissionsArray of objects

The contact roles that are allowed to manage this scholarship

custom_field_valuesArray of objects(Custom Field Values)
default_ship_from_addressobject(Address)

A complete address

default_store_idstring(Default Store)

The default store

display_policies_at_checkoutboolean(Display Policies At Checkout)

If set, policies are shown to users at checkout

enable_cancellation_confirmation_emailboolean(Enable Cancellation Confirmation Email)

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

enable_order_confirmation_emailboolean(Enable Order Confirmation Email)

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

enable_retroactive_coupons_in_portalboolean(Enable Retroactive Coupons In Portal)

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

enable_return_confirmation_emailboolean(Enable Return Confirmation Email)

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

enable_shipment_confirmation_emailboolean(Enable Shipment Confirmation Email)

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

notesstring(Notes)

The name of the settings

order_confirmation_emailobject(Order Confirmation Email)required
order_confirmation_email.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

order_confirmation_email.​bodystring(Body)required

The email body

order_confirmation_email.​ccstring(Cc)

Anyone that should be cc'ed on the email

order_confirmation_email.​fromstring(From)

From email address

order_confirmation_email.​from_namestring(From Name)

From name

order_confirmation_email.​reply_tostring(Reply To)

The reply to

order_confirmation_email.​subjectstring(Subject)required

The email subject

policiesobject(Policies)required
policies.​consumer_data_policy_uristring(Consumer Data Policy Uri)required

The default consumer data policy to display to customers when checking out

policies.​refund_policy_uristring(Refund Policy Uri)required

The refund policy to display to customers when checking out

policies.​secure_checkout_policy_uristring(Secure Checkout Policy Uri)required

The default secure checkout policy to display to customers when checking out

policies.​terms_of_service_uristring(Terms Of Service Uri)required

The default TOS policy to display to customers when checking out

restrict_retroactive_coupons_by_time_periodboolean(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_periodnumber(float)(Retroactive Coupon Allowed Time Period)required

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

return_confirmation_emailobject(Return Confirmation Email)required
return_confirmation_email.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

return_confirmation_email.​bodystring(Body)required

The email body

return_confirmation_email.​ccstring(Cc)

Anyone that should be cc'ed on the email

return_confirmation_email.​fromstring(From)

From email address

return_confirmation_email.​from_namestring(From Name)

From name

return_confirmation_email.​reply_tostring(Reply To)

The reply to

return_confirmation_email.​subjectstring(Subject)required

The email subject

shipment_confirmation_emailobject(Shipment Confirmation Email)required
shipment_confirmation_email.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

shipment_confirmation_email.​bodystring(Body)required

The email body

shipment_confirmation_email.​ccstring(Cc)

Anyone that should be cc'ed on the email

shipment_confirmation_email.​fromstring(From)

From email address

shipment_confirmation_email.​from_namestring(From Name)

From name

shipment_confirmation_email.​reply_tostring(Reply To)

The reply to

shipment_confirmation_email.​subjectstring(Subject)required

The email subject

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

Response
application/json
{ "cancellation_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "contact_role_permissions": [ {} ], "custom_field_values": [ {} ], "default_ship_from_address": { "city": "string", "country": "string", "country_name": "string", "county": "string", "latitude": 0.1, "line1": "string", "line2": "string", "line3": "string", "longitude": 0.1, "postal_code": "string", "state": "string", "time_zone_id": "string" }, "default_store_id": "string", "display_policies_at_checkout": true, "enable_cancellation_confirmation_email": true, "enable_order_confirmation_email": true, "enable_retroactive_coupons_in_portal": true, "enable_return_confirmation_email": true, "enable_shipment_confirmation_email": true, "notes": "string", "order_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "policies": { "consumer_data_policy_uri": "string", "refund_policy_uri": "string", "secure_checkout_policy_uri": "string", "terms_of_service_uri": "string" }, "restrict_retroactive_coupons_by_time_period": true, "retroactive_coupon_allowed_time_period": 0.1, "return_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "shipment_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ {} ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1 }

Updates a setting with the specified ID.

Request

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

Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The updated setting that will be saved.

cancellation_confirmation_emailobject(Cancellation Confirmation Email)required
cancellation_confirmation_email.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

cancellation_confirmation_email.​bodystring(Body)required

The email body

cancellation_confirmation_email.​ccstring(Cc)

Anyone that should be cc'ed on the email

cancellation_confirmation_email.​fromstring(From)

From email address

cancellation_confirmation_email.​from_namestring(From Name)

From name

cancellation_confirmation_email.​reply_tostring(Reply To)

The reply to

cancellation_confirmation_email.​subjectstring(Subject)required

The email subject

contact_role_permissionsArray of objects

The contact roles that are allowed to manage this scholarship

custom_field_valuesArray of objects(Custom Field Values)
default_ship_from_addressobject(Address)

A complete address

default_store_idstring(Default Store)

The default store

display_policies_at_checkoutboolean(Display Policies At Checkout)

If set, policies are shown to users at checkout

enable_cancellation_confirmation_emailboolean(Enable Cancellation Confirmation Email)

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

enable_order_confirmation_emailboolean(Enable Order Confirmation Email)

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

enable_retroactive_coupons_in_portalboolean(Enable Retroactive Coupons In Portal)

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

enable_return_confirmation_emailboolean(Enable Return Confirmation Email)

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

enable_shipment_confirmation_emailboolean(Enable Shipment Confirmation Email)

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

notesstring(Notes)

The name of the settings

order_confirmation_emailobject(Order Confirmation Email)required
order_confirmation_email.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

order_confirmation_email.​bodystring(Body)required

The email body

order_confirmation_email.​ccstring(Cc)

Anyone that should be cc'ed on the email

order_confirmation_email.​fromstring(From)

From email address

order_confirmation_email.​from_namestring(From Name)

From name

order_confirmation_email.​reply_tostring(Reply To)

The reply to

order_confirmation_email.​subjectstring(Subject)required

The email subject

policiesobject(Policies)required
policies.​consumer_data_policy_uristring(Consumer Data Policy Uri)required

The default consumer data policy to display to customers when checking out

policies.​refund_policy_uristring(Refund Policy Uri)required

The refund policy to display to customers when checking out

policies.​secure_checkout_policy_uristring(Secure Checkout Policy Uri)required

The default secure checkout policy to display to customers when checking out

policies.​terms_of_service_uristring(Terms Of Service Uri)required

The default TOS policy to display to customers when checking out

restrict_retroactive_coupons_by_time_periodboolean(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_periodnumber(float)(Retroactive Coupon Allowed Time Period)required

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

return_confirmation_emailobject(Return Confirmation Email)required
return_confirmation_email.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

return_confirmation_email.​bodystring(Body)required

The email body

return_confirmation_email.​ccstring(Cc)

Anyone that should be cc'ed on the email

return_confirmation_email.​fromstring(From)

From email address

return_confirmation_email.​from_namestring(From Name)

From name

return_confirmation_email.​reply_tostring(Reply To)

The reply to

return_confirmation_email.​subjectstring(Subject)required

The email subject

shipment_confirmation_emailobject(Shipment Confirmation Email)required
shipment_confirmation_email.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

shipment_confirmation_email.​bodystring(Body)required

The email body

shipment_confirmation_email.​ccstring(Cc)

Anyone that should be cc'ed on the email

shipment_confirmation_email.​fromstring(From)

From email address

shipment_confirmation_email.​from_namestring(From Name)

From name

shipment_confirmation_email.​reply_tostring(Reply To)

The reply to

shipment_confirmation_email.​subjectstring(Subject)required

The email subject

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/settings/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "cancellation_confirmation_email": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "contact_role_permissions": [
      {
        "manage_coupon_codes": true,
        "role_id": "string"
      }
    ],
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "default_ship_from_address": {
      "city": "string",
      "country": "string",
      "country_name": "string",
      "county": "string",
      "latitude": 0.1,
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "longitude": 0.1,
      "postal_code": "string",
      "state": "string",
      "time_zone_id": "string"
    },
    "default_store_id": "string",
    "display_policies_at_checkout": true,
    "enable_cancellation_confirmation_email": true,
    "enable_order_confirmation_email": true,
    "enable_retroactive_coupons_in_portal": true,
    "enable_return_confirmation_email": true,
    "enable_shipment_confirmation_email": true,
    "notes": "string",
    "order_confirmation_email": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "policies": {
      "consumer_data_policy_uri": "string",
      "refund_policy_uri": "string",
      "secure_checkout_policy_uri": "string",
      "terms_of_service_uri": "string"
    },
    "restrict_retroactive_coupons_by_time_period": true,
    "retroactive_coupon_allowed_time_period": 0.1,
    "return_confirmation_email": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "shipment_confirmation_email": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1
  }'

Responses

The setting was updated successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
cancellation_confirmation_emailobject(Cancellation Confirmation Email)required
cancellation_confirmation_email.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

cancellation_confirmation_email.​bodystring(Body)required

The email body

cancellation_confirmation_email.​ccstring(Cc)

Anyone that should be cc'ed on the email

cancellation_confirmation_email.​fromstring(From)

From email address

cancellation_confirmation_email.​from_namestring(From Name)

From name

cancellation_confirmation_email.​reply_tostring(Reply To)

The reply to

cancellation_confirmation_email.​subjectstring(Subject)required

The email subject

contact_role_permissionsArray of objects

The contact roles that are allowed to manage this scholarship

custom_field_valuesArray of objects(Custom Field Values)
default_ship_from_addressobject(Address)

A complete address

default_store_idstring(Default Store)

The default store

display_policies_at_checkoutboolean(Display Policies At Checkout)

If set, policies are shown to users at checkout

enable_cancellation_confirmation_emailboolean(Enable Cancellation Confirmation Email)

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

enable_order_confirmation_emailboolean(Enable Order Confirmation Email)

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

enable_retroactive_coupons_in_portalboolean(Enable Retroactive Coupons In Portal)

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

enable_return_confirmation_emailboolean(Enable Return Confirmation Email)

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

enable_shipment_confirmation_emailboolean(Enable Shipment Confirmation Email)

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

notesstring(Notes)

The name of the settings

order_confirmation_emailobject(Order Confirmation Email)required
order_confirmation_email.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

order_confirmation_email.​bodystring(Body)required

The email body

order_confirmation_email.​ccstring(Cc)

Anyone that should be cc'ed on the email

order_confirmation_email.​fromstring(From)

From email address

order_confirmation_email.​from_namestring(From Name)

From name

order_confirmation_email.​reply_tostring(Reply To)

The reply to

order_confirmation_email.​subjectstring(Subject)required

The email subject

policiesobject(Policies)required
policies.​consumer_data_policy_uristring(Consumer Data Policy Uri)required

The default consumer data policy to display to customers when checking out

policies.​refund_policy_uristring(Refund Policy Uri)required

The refund policy to display to customers when checking out

policies.​secure_checkout_policy_uristring(Secure Checkout Policy Uri)required

The default secure checkout policy to display to customers when checking out

policies.​terms_of_service_uristring(Terms Of Service Uri)required

The default TOS policy to display to customers when checking out

restrict_retroactive_coupons_by_time_periodboolean(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_periodnumber(float)(Retroactive Coupon Allowed Time Period)required

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

return_confirmation_emailobject(Return Confirmation Email)required
return_confirmation_email.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

return_confirmation_email.​bodystring(Body)required

The email body

return_confirmation_email.​ccstring(Cc)

Anyone that should be cc'ed on the email

return_confirmation_email.​fromstring(From)

From email address

return_confirmation_email.​from_namestring(From Name)

From name

return_confirmation_email.​reply_tostring(Reply To)

The reply to

return_confirmation_email.​subjectstring(Subject)required

The email subject

shipment_confirmation_emailobject(Shipment Confirmation Email)required
shipment_confirmation_email.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

shipment_confirmation_email.​bodystring(Body)required

The email body

shipment_confirmation_email.​ccstring(Cc)

Anyone that should be cc'ed on the email

shipment_confirmation_email.​fromstring(From)

From email address

shipment_confirmation_email.​from_namestring(From Name)

From name

shipment_confirmation_email.​reply_tostring(Reply To)

The reply to

shipment_confirmation_email.​subjectstring(Subject)required

The email subject

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(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_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

sys_created_atstring(date-time)(Sys Created At)required

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(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_last_bulk_data_operation_idstring(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_versionstring(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_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(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_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

Response
application/json
{ "cancellation_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "contact_role_permissions": [ {} ], "custom_field_values": [ {} ], "default_ship_from_address": { "city": "string", "country": "string", "country_name": "string", "county": "string", "latitude": 0.1, "line1": "string", "line2": "string", "line3": "string", "longitude": 0.1, "postal_code": "string", "state": "string", "time_zone_id": "string" }, "default_store_id": "string", "display_policies_at_checkout": true, "enable_cancellation_confirmation_email": true, "enable_order_confirmation_email": true, "enable_retroactive_coupons_in_portal": true, "enable_return_confirmation_email": true, "enable_shipment_confirmation_email": true, "notes": "string", "order_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "policies": { "consumer_data_policy_uri": "string", "refund_policy_uri": "string", "secure_checkout_policy_uri": "string", "terms_of_service_uri": "string" }, "restrict_retroactive_coupons_by_time_period": true, "retroactive_coupon_allowed_time_period": 0.1, "return_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "shipment_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ {} ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1 }

Shared Modifier Options

Shared Modifier Options

Operations

Shared Variant Options

Shared Variant Options

Operations

Shipments

Shipments

Operations

Shipping Configurations

Shipping Configurations

Operations

Shipping Products

Shipping Products

Operations

Statistics

Statistics

Operations

Stores

Stores

Operations

Tax Classes

Tax Classes

Operations

Tax Configurations

Tax Configurations

Operations

Tax Products

Tax Products

Operations

Warehouse Bins

Warehouse Bins

Operations

Warehouses

Warehouses

Operations