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.
https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/
https://commerce.api.rhythmsoftware.com/
https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/couponCodes/{tenantId}
https://commerce.api.rhythmsoftware.com/couponCodes/{tenantId}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/couponCodes/{tenantId}?exclusiveStartKey=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "Count": 0, "Items": [ { … } ], "LastEvaluatedKey": "string" }
The coupon code that you would like to be saved.
The criteria to use
The error message to show when the advanced rule fails
If set, only people who have received awards
If set, only people with specific certifications
If set, active members who belong to a committee can purchase
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, then you must have certain entitlements
Whether or not to enable an expression for evaluation
If set, you can restrict organizations
If set, you can restrict by status
If set, only people who have registered for events
The error message to show when the expression fails
Enable the idea that a coupon can be owned by a contact/organization
If true, eligibility criteria is applied to the coupon code
If true, this coupon is restricted only to certain contacts
If true, this coupon is restricted only to certain organizations
The maximum number of total uses
The maximum number of total uses
The maximum number of total uses
The maximum number of total uses for a given customer
The maximum number of total uses for a given customer
The maximum number of total uses for a given customer
The maximum number of total uses per contacts of an organization
The owner of the code
The owner of the code
The owner of the code
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/couponCodes/{tenantId}
https://commerce.api.rhythmsoftware.com/couponCodes/{tenantId}
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/couponCodes/{tenantId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"contact_id": "string",
"coupon_id": "string",
"coupon_type": "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": [
{}
]
}
],
"eligibility_criteria": {
"advanced_rule_error_message": "string",
"advanced_rules": {},
"age_restrictions": {
"maximum_age": 0.1,
"minimum_age": 0.1
},
"award_options": {
"award_ids": [
"string"
],
"award_type_ids": [
"string"
],
"logic_operator": "and"
},
"award_recipients": true,
"by_location": true,
"certificants": true,
"certification_options": {
"logic_operator": "and",
"program_ids": [
"string"
]
},
"committee_member_options": {
"committee_ids": [
"string"
],
"committee_position_ids": [
"string"
],
"committee_type_ids": [
"string"
],
"logic_operator": "and"
},
"committee_members": true,
"custom_logic_options": {
"lambda_function_id": "string"
},
"customer_type": "contact",
"donor_options": {
"donor_club_ids": [
"string"
],
"logic_operator": "and"
},
"donors": true,
"enable_advanced_rules": true,
"enable_age_restrictions": true,
"enable_custom_logic": true,
"enable_entitlement_restrictions": true,
"enable_expression": true,
"enable_organization_restrictions": true,
"enable_status_restriction": true,
"entitlement_restrictions": [
{
"quantity": 0.1,
"type_id": "string"
}
],
"event_registration_options": {
"event_ids": [
"string"
],
"logic_operator": "and",
"registration_category_ids": [
"string"
]
},
"event_registrations": true,
"expression": "string",
"expression_error_message": "string",
"location": {
"countries": [
"string"
],
"negate_logic": true
},
"logic_operator": "and",
"member_options": {
"chapter_member_options": {
"chapter_ids": [
"string"
],
"chapter_type_ids": [
"string"
],
"logic_operator": "and"
},
"chapter_members": true,
"member_package_ids": [
"string"
],
"member_status_reason_ids": [
"string"
],
"member_statuses": [
"active"
],
"member_type_ids": [
"string"
],
"section_member_options": {
"logic_operator": "and",
"section_ids": [
"string"
],
"section_type_ids": [
"string"
]
},
"section_members": true
},
"members": true,
"non_members": true,
"organization_restrictions": {
"contact_role_ids": [
"string"
],
"organization_type_ids": [
"string"
]
},
"status_restrictions": {
"0": "string"
},
"use_organization_for_eligibility": true
},
"enable_coupon_ownership": true,
"enable_eligibility_criteria": true,
"enable_restricted_contacts": true,
"enable_restricted_organizations": true,
"id": "string",
"is_active": true,
"maximum_number_of_total_uses": 1,
"maximum_number_of_uses_per_customer": 1,
"maximum_number_of_uses_per_organization": 1,
"name": "string",
"notes": "string",
"order_id": "string",
"order_line_item_id": "string",
"organization_id": "string",
"owner_type": "contact",
"restricted_contacts": [
{
"contact_id": "string"
}
],
"restricted_organizations": [
{
"organization_id": "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,
"type": "multi use",
"valid_from": "2019-08-24T14:15:22Z",
"valid_until": "2019-08-24T14:15:22Z"
}'The coupon code was saved successfully.
The criteria to use
The error message to show when the advanced rule fails
If set, only people who have received awards
If set, only people with specific certifications
If set, active members who belong to a committee can purchase
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, then you must have certain entitlements
Whether or not to enable an expression for evaluation
If set, you can restrict organizations
If set, you can restrict by status
If set, only people who have registered for events
The error message to show when the expression fails
Enable the idea that a coupon can be owned by a contact/organization
If true, eligibility criteria is applied to the coupon code
If true, this coupon is restricted only to certain contacts
If true, this coupon is restricted only to certain organizations
The maximum number of total uses
The maximum number of total uses
The maximum number of total uses
The maximum number of total uses for a given customer
The maximum number of total uses for a given customer
The maximum number of total uses for a given customer
The maximum number of total uses per contacts of an organization
The owner of the code
The owner of the code
The owner of the code
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
{ "contact_id": "string", "coupon_id": "string", "coupon_type": "string", "custom_field_values": [ { … } ], "eligibility_criteria": { "advanced_rule_error_message": "string", "advanced_rules": {}, "age_restrictions": { … }, "award_options": { … }, "award_recipients": true, "by_location": true, "certificants": true, "certification_options": { … }, "committee_member_options": { … }, "committee_members": true, "custom_logic_options": { … }, "customer_type": "contact", "donor_options": { … }, "donors": true, "enable_advanced_rules": true, "enable_age_restrictions": true, "enable_custom_logic": true, "enable_entitlement_restrictions": true, "enable_expression": true, "enable_organization_restrictions": true, "enable_status_restriction": true, "entitlement_restrictions": [ … ], "event_registration_options": { … }, "event_registrations": true, "expression": "string", "expression_error_message": "string", "location": { … }, "logic_operator": "and", "member_options": { … }, "members": true, "non_members": true, "organization_restrictions": { … }, "status_restrictions": { … }, "use_organization_for_eligibility": true }, "enable_coupon_ownership": true, "enable_eligibility_criteria": true, "enable_restricted_contacts": true, "enable_restricted_organizations": true, "id": "string", "is_active": true, "maximum_number_of_total_uses": 1, "maximum_number_of_uses_per_customer": 1, "maximum_number_of_uses_per_organization": 1, "name": "string", "notes": "string", "order_id": "string", "order_line_item_id": "string", "organization_id": "string", "owner_type": "contact", "restricted_contacts": [ { … } ], "restricted_organizations": [ { … } ], "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, "type": "multi use", "valid_from": "2019-08-24T14:15:22Z", "valid_until": "2019-08-24T14:15:22Z" }
https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/couponCodes/{tenantId}/batch
https://commerce.api.rhythmsoftware.com/couponCodes/{tenantId}/batch
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/couponCodes/{tenantId}/batch' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"operations": [
{
"id": null,
"object": {},
"operation": "create",
"patch_directives": {
"0": {
"op": "add",
"path": "string",
"value": "string"
}
}
}
]
}'{ "error_count": 0.1, "results": [ { … } ], "success_count": 0.1 }
https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/couponCodes/{tenantId}/contact/{contact_id}
https://commerce.api.rhythmsoftware.com/couponCodes/{tenantId}/contact/{contact_id}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/couponCodes/{tenantId}/contact/{contact_id}?exclusiveStartKey=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "Count": 0, "Items": [ { … } ], "LastEvaluatedKey": "string" }
https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/couponCodes/{tenantId}/coupon/{coupon_type}/{coupon_id}
https://commerce.api.rhythmsoftware.com/couponCodes/{tenantId}/coupon/{coupon_type}/{coupon_id}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/couponCodes/{tenantId}/coupon/{coupon_type}/{coupon_id}?exclusiveStartKey=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "Count": 0, "Items": [ { … } ], "LastEvaluatedKey": "string" }
https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/couponCodes/{tenantId}/order/{order_id}
https://commerce.api.rhythmsoftware.com/couponCodes/{tenantId}/order/{order_id}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/couponCodes/{tenantId}/order/{order_id}?exclusiveStartKey=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "Count": 0, "Items": [ { … } ], "LastEvaluatedKey": "string" }
https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/couponCodes/{tenantId}/organization/{organization_id}
https://commerce.api.rhythmsoftware.com/couponCodes/{tenantId}/organization/{organization_id}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/couponCodes/{tenantId}/organization/{organization_id}?exclusiveStartKey=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "Count": 0, "Items": [ { … } ], "LastEvaluatedKey": "string" }
https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/couponCodes/{tenantId}/previewEmail
https://commerce.api.rhythmsoftware.com/couponCodes/{tenantId}/previewEmail
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/couponCodes/{tenantId}/previewEmail' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"cancellation_id": "string",
"coupon_id": "string",
"coupon_type": "string",
"destination_email_address": "string",
"email_template": {
"bcc": "string",
"body": "string",
"cc": "string",
"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string"
},
"order_id": "string",
"order_item_line_number": 0.1,
"return_id": "string",
"shipment_id": "string"
}'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/couponCodes/{tenantId}/{id}
https://commerce.api.rhythmsoftware.com/couponCodes/{tenantId}/{id}
curl -i -X DELETE \
'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/couponCodes/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'"string"
https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/couponCodes/{tenantId}/{id}
https://commerce.api.rhythmsoftware.com/couponCodes/{tenantId}/{id}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/couponCodes/{tenantId}/{id}?consistentRead=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The coupon code was retrieved successfully.
The criteria to use
The error message to show when the advanced rule fails
If set, only people who have received awards
If set, only people with specific certifications
If set, active members who belong to a committee can purchase
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, then you must have certain entitlements
Whether or not to enable an expression for evaluation
If set, you can restrict organizations
If set, you can restrict by status
If set, only people who have registered for events
The error message to show when the expression fails
Enable the idea that a coupon can be owned by a contact/organization
If true, eligibility criteria is applied to the coupon code
If true, this coupon is restricted only to certain contacts
If true, this coupon is restricted only to certain organizations
The maximum number of total uses
The maximum number of total uses
The maximum number of total uses
The maximum number of total uses for a given customer
The maximum number of total uses for a given customer
The maximum number of total uses for a given customer
The maximum number of total uses per contacts of an organization
The owner of the code
The owner of the code
The owner of the code
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
{ "contact_id": "string", "coupon_id": "string", "coupon_type": "string", "custom_field_values": [ { … } ], "eligibility_criteria": { "advanced_rule_error_message": "string", "advanced_rules": {}, "age_restrictions": { … }, "award_options": { … }, "award_recipients": true, "by_location": true, "certificants": true, "certification_options": { … }, "committee_member_options": { … }, "committee_members": true, "custom_logic_options": { … }, "customer_type": "contact", "donor_options": { … }, "donors": true, "enable_advanced_rules": true, "enable_age_restrictions": true, "enable_custom_logic": true, "enable_entitlement_restrictions": true, "enable_expression": true, "enable_organization_restrictions": true, "enable_status_restriction": true, "entitlement_restrictions": [ … ], "event_registration_options": { … }, "event_registrations": true, "expression": "string", "expression_error_message": "string", "location": { … }, "logic_operator": "and", "member_options": { … }, "members": true, "non_members": true, "organization_restrictions": { … }, "status_restrictions": { … }, "use_organization_for_eligibility": true }, "enable_coupon_ownership": true, "enable_eligibility_criteria": true, "enable_restricted_contacts": true, "enable_restricted_organizations": true, "id": "string", "is_active": true, "maximum_number_of_total_uses": 1, "maximum_number_of_uses_per_customer": 1, "maximum_number_of_uses_per_organization": 1, "name": "string", "notes": "string", "order_id": "string", "order_line_item_id": "string", "organization_id": "string", "owner_type": "contact", "restricted_contacts": [ { … } ], "restricted_organizations": [ { … } ], "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, "type": "multi use", "valid_from": "2019-08-24T14:15:22Z", "valid_until": "2019-08-24T14:15:22Z" }
https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/couponCodes/{tenantId}/{id}
https://commerce.api.rhythmsoftware.com/couponCodes/{tenantId}/{id}
curl -i -X PATCH \
'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/couponCodes/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '[
{
"op": "add",
"path": "string",
"value": "string"
}
]'The coupon code was patched successfully.
The criteria to use
The error message to show when the advanced rule fails
If set, only people who have received awards
If set, only people with specific certifications
If set, active members who belong to a committee can purchase
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, then you must have certain entitlements
Whether or not to enable an expression for evaluation
If set, you can restrict organizations
If set, you can restrict by status
If set, only people who have registered for events
The error message to show when the expression fails
Enable the idea that a coupon can be owned by a contact/organization
If true, eligibility criteria is applied to the coupon code
If true, this coupon is restricted only to certain contacts
If true, this coupon is restricted only to certain organizations
The maximum number of total uses
The maximum number of total uses
The maximum number of total uses
The maximum number of total uses for a given customer
The maximum number of total uses for a given customer
The maximum number of total uses for a given customer
The maximum number of total uses per contacts of an organization
The owner of the code
The owner of the code
The owner of the code
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
{ "contact_id": "string", "coupon_id": "string", "coupon_type": "string", "custom_field_values": [ { … } ], "eligibility_criteria": { "advanced_rule_error_message": "string", "advanced_rules": {}, "age_restrictions": { … }, "award_options": { … }, "award_recipients": true, "by_location": true, "certificants": true, "certification_options": { … }, "committee_member_options": { … }, "committee_members": true, "custom_logic_options": { … }, "customer_type": "contact", "donor_options": { … }, "donors": true, "enable_advanced_rules": true, "enable_age_restrictions": true, "enable_custom_logic": true, "enable_entitlement_restrictions": true, "enable_expression": true, "enable_organization_restrictions": true, "enable_status_restriction": true, "entitlement_restrictions": [ … ], "event_registration_options": { … }, "event_registrations": true, "expression": "string", "expression_error_message": "string", "location": { … }, "logic_operator": "and", "member_options": { … }, "members": true, "non_members": true, "organization_restrictions": { … }, "status_restrictions": { … }, "use_organization_for_eligibility": true }, "enable_coupon_ownership": true, "enable_eligibility_criteria": true, "enable_restricted_contacts": true, "enable_restricted_organizations": true, "id": "string", "is_active": true, "maximum_number_of_total_uses": 1, "maximum_number_of_uses_per_customer": 1, "maximum_number_of_uses_per_organization": 1, "name": "string", "notes": "string", "order_id": "string", "order_line_item_id": "string", "organization_id": "string", "owner_type": "contact", "restricted_contacts": [ { … } ], "restricted_organizations": [ { … } ], "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, "type": "multi use", "valid_from": "2019-08-24T14:15:22Z", "valid_until": "2019-08-24T14:15:22Z" }
The updated coupon code that will be saved.
The criteria to use
The error message to show when the advanced rule fails
If set, only people who have received awards
If set, only people with specific certifications
If set, active members who belong to a committee can purchase
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, then you must have certain entitlements
Whether or not to enable an expression for evaluation
If set, you can restrict organizations
If set, you can restrict by status
If set, only people who have registered for events
The error message to show when the expression fails
Enable the idea that a coupon can be owned by a contact/organization
If true, eligibility criteria is applied to the coupon code
If true, this coupon is restricted only to certain contacts
If true, this coupon is restricted only to certain organizations
The maximum number of total uses
The maximum number of total uses
The maximum number of total uses
The maximum number of total uses for a given customer
The maximum number of total uses for a given customer
The maximum number of total uses for a given customer
The maximum number of total uses per contacts of an organization
The owner of the code
The owner of the code
The owner of the code
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/couponCodes/{tenantId}/{id}
https://commerce.api.rhythmsoftware.com/couponCodes/{tenantId}/{id}
curl -i -X PUT \
'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/couponCodes/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"contact_id": "string",
"coupon_id": "string",
"coupon_type": "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": [
{}
]
}
],
"eligibility_criteria": {
"advanced_rule_error_message": "string",
"advanced_rules": {},
"age_restrictions": {
"maximum_age": 0.1,
"minimum_age": 0.1
},
"award_options": {
"award_ids": [
"string"
],
"award_type_ids": [
"string"
],
"logic_operator": "and"
},
"award_recipients": true,
"by_location": true,
"certificants": true,
"certification_options": {
"logic_operator": "and",
"program_ids": [
"string"
]
},
"committee_member_options": {
"committee_ids": [
"string"
],
"committee_position_ids": [
"string"
],
"committee_type_ids": [
"string"
],
"logic_operator": "and"
},
"committee_members": true,
"custom_logic_options": {
"lambda_function_id": "string"
},
"customer_type": "contact",
"donor_options": {
"donor_club_ids": [
"string"
],
"logic_operator": "and"
},
"donors": true,
"enable_advanced_rules": true,
"enable_age_restrictions": true,
"enable_custom_logic": true,
"enable_entitlement_restrictions": true,
"enable_expression": true,
"enable_organization_restrictions": true,
"enable_status_restriction": true,
"entitlement_restrictions": [
{
"quantity": 0.1,
"type_id": "string"
}
],
"event_registration_options": {
"event_ids": [
"string"
],
"logic_operator": "and",
"registration_category_ids": [
"string"
]
},
"event_registrations": true,
"expression": "string",
"expression_error_message": "string",
"location": {
"countries": [
"string"
],
"negate_logic": true
},
"logic_operator": "and",
"member_options": {
"chapter_member_options": {
"chapter_ids": [
"string"
],
"chapter_type_ids": [
"string"
],
"logic_operator": "and"
},
"chapter_members": true,
"member_package_ids": [
"string"
],
"member_status_reason_ids": [
"string"
],
"member_statuses": [
"active"
],
"member_type_ids": [
"string"
],
"section_member_options": {
"logic_operator": "and",
"section_ids": [
"string"
],
"section_type_ids": [
"string"
]
},
"section_members": true
},
"members": true,
"non_members": true,
"organization_restrictions": {
"contact_role_ids": [
"string"
],
"organization_type_ids": [
"string"
]
},
"status_restrictions": {
"0": "string"
},
"use_organization_for_eligibility": true
},
"enable_coupon_ownership": true,
"enable_eligibility_criteria": true,
"enable_restricted_contacts": true,
"enable_restricted_organizations": true,
"id": "string",
"is_active": true,
"maximum_number_of_total_uses": 1,
"maximum_number_of_uses_per_customer": 1,
"maximum_number_of_uses_per_organization": 1,
"name": "string",
"notes": "string",
"order_id": "string",
"order_line_item_id": "string",
"organization_id": "string",
"owner_type": "contact",
"restricted_contacts": [
{
"contact_id": "string"
}
],
"restricted_organizations": [
{
"organization_id": "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,
"type": "multi use",
"valid_from": "2019-08-24T14:15:22Z",
"valid_until": "2019-08-24T14:15:22Z"
}'The coupon code was updated successfully.
The criteria to use
The error message to show when the advanced rule fails
If set, only people who have received awards
If set, only people with specific certifications
If set, active members who belong to a committee can purchase
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, then you must have certain entitlements
Whether or not to enable an expression for evaluation
If set, you can restrict organizations
If set, you can restrict by status
If set, only people who have registered for events
The error message to show when the expression fails
Enable the idea that a coupon can be owned by a contact/organization
If true, eligibility criteria is applied to the coupon code
If true, this coupon is restricted only to certain contacts
If true, this coupon is restricted only to certain organizations
The maximum number of total uses
The maximum number of total uses
The maximum number of total uses
The maximum number of total uses for a given customer
The maximum number of total uses for a given customer
The maximum number of total uses for a given customer
The maximum number of total uses per contacts of an organization
The owner of the code
The owner of the code
The owner of the code
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
{ "contact_id": "string", "coupon_id": "string", "coupon_type": "string", "custom_field_values": [ { … } ], "eligibility_criteria": { "advanced_rule_error_message": "string", "advanced_rules": {}, "age_restrictions": { … }, "award_options": { … }, "award_recipients": true, "by_location": true, "certificants": true, "certification_options": { … }, "committee_member_options": { … }, "committee_members": true, "custom_logic_options": { … }, "customer_type": "contact", "donor_options": { … }, "donors": true, "enable_advanced_rules": true, "enable_age_restrictions": true, "enable_custom_logic": true, "enable_entitlement_restrictions": true, "enable_expression": true, "enable_organization_restrictions": true, "enable_status_restriction": true, "entitlement_restrictions": [ … ], "event_registration_options": { … }, "event_registrations": true, "expression": "string", "expression_error_message": "string", "location": { … }, "logic_operator": "and", "member_options": { … }, "members": true, "non_members": true, "organization_restrictions": { … }, "status_restrictions": { … }, "use_organization_for_eligibility": true }, "enable_coupon_ownership": true, "enable_eligibility_criteria": true, "enable_restricted_contacts": true, "enable_restricted_organizations": true, "id": "string", "is_active": true, "maximum_number_of_total_uses": 1, "maximum_number_of_uses_per_customer": 1, "maximum_number_of_uses_per_organization": 1, "name": "string", "notes": "string", "order_id": "string", "order_line_item_id": "string", "organization_id": "string", "owner_type": "contact", "restricted_contacts": [ { … } ], "restricted_organizations": [ { … } ], "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, "type": "multi use", "valid_from": "2019-08-24T14:15:22Z", "valid_until": "2019-08-24T14:15:22Z" }