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/coupons/{tenantId}
https://commerce.api.rhythmsoftware.com/coupons/{tenantId}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/coupons/{tenantId}?exclusiveStartKey=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The couponswere retrieved successfully.
Whether or not this coupon applies to career center packages
Whether or not this coupon applies to misc products
The product uses for the discount code when it is at the order level
Limit purchase to particular product categories
The maximum number of times this coupon can be used by a particular customer
The optional maximum discount that this coupon can yield, irrespective of its configuration
Minimum a customer must purchase to qualify for coupon
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
The type of discount to apply
[ { "amount": 0.1, "applies_to_career_center_packages": true, "applies_to_miscellaneous_products": true, "code_generation_html": "string", "custom_field_values": [ … ], "discount_product_id": "string", "expiration_date": "2019-08-24T14:15:22Z", "id": "string", "is_active": true, "limit_to_product_categories": [ … ], "limit_to_products": [ … ], "limit_total_uses": 0, "limit_uses_per_customer": 0, "maximum_discount": 0.1, "minimum_purchase": 0.1, "name": "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, "type": "fixed amount off each item" } ]
The coupon that you would like to be saved.
Whether or not this coupon applies to career center packages
Whether or not this coupon applies to misc products
The product uses for the discount code when it is at the order level
Limit purchase to particular product categories
The maximum number of times this coupon can be used by a particular customer
The optional maximum discount that this coupon can yield, irrespective of its configuration
Minimum a customer must purchase to qualify for coupon
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/coupons/{tenantId}
https://commerce.api.rhythmsoftware.com/coupons/{tenantId}
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/coupons/{tenantId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"amount": 0.1,
"applies_to_career_center_packages": true,
"applies_to_miscellaneous_products": true,
"code_generation_html": "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": [
{}
]
}
],
"discount_product_id": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"id": "string",
"is_active": true,
"limit_to_product_categories": [
"string"
],
"limit_to_products": [
"string"
],
"limit_total_uses": 0,
"limit_uses_per_customer": 0,
"maximum_discount": 0.1,
"minimum_purchase": 0.1,
"name": "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": "fixed amount off each item"
}'The coupon was saved successfully.
Whether or not this coupon applies to career center packages
Whether or not this coupon applies to misc products
The product uses for the discount code when it is at the order level
Limit purchase to particular product categories
The maximum number of times this coupon can be used by a particular customer
The optional maximum discount that this coupon can yield, irrespective of its configuration
Minimum a customer must purchase to qualify for coupon
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
{ "amount": 0.1, "applies_to_career_center_packages": true, "applies_to_miscellaneous_products": true, "code_generation_html": "string", "custom_field_values": [ { … } ], "discount_product_id": "string", "expiration_date": "2019-08-24T14:15:22Z", "id": "string", "is_active": true, "limit_to_product_categories": [ "string" ], "limit_to_products": [ "string" ], "limit_total_uses": 0, "limit_uses_per_customer": 0, "maximum_discount": 0.1, "minimum_purchase": 0.1, "name": "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, "type": "fixed amount off each item" }
https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/coupons/{tenantId}/batch
https://commerce.api.rhythmsoftware.com/coupons/{tenantId}/batch
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/coupons/{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/coupons/{tenantId}/{id}
https://commerce.api.rhythmsoftware.com/coupons/{tenantId}/{id}
curl -i -X DELETE \
'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/coupons/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'"string"
https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/coupons/{tenantId}/{id}
https://commerce.api.rhythmsoftware.com/coupons/{tenantId}/{id}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/coupons/{tenantId}/{id}?consistentRead=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The coupon was retrieved successfully.
Whether or not this coupon applies to career center packages
Whether or not this coupon applies to misc products
The product uses for the discount code when it is at the order level
Limit purchase to particular product categories
The maximum number of times this coupon can be used by a particular customer
The optional maximum discount that this coupon can yield, irrespective of its configuration
Minimum a customer must purchase to qualify for coupon
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
{ "amount": 0.1, "applies_to_career_center_packages": true, "applies_to_miscellaneous_products": true, "code_generation_html": "string", "custom_field_values": [ { … } ], "discount_product_id": "string", "expiration_date": "2019-08-24T14:15:22Z", "id": "string", "is_active": true, "limit_to_product_categories": [ "string" ], "limit_to_products": [ "string" ], "limit_total_uses": 0, "limit_uses_per_customer": 0, "maximum_discount": 0.1, "minimum_purchase": 0.1, "name": "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, "type": "fixed amount off each item" }
https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/coupons/{tenantId}/{id}
https://commerce.api.rhythmsoftware.com/coupons/{tenantId}/{id}
curl -i -X PATCH \
'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/coupons/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '[
{
"op": "add",
"path": "string",
"value": "string"
}
]'The coupon was patched successfully.
Whether or not this coupon applies to career center packages
Whether or not this coupon applies to misc products
The product uses for the discount code when it is at the order level
Limit purchase to particular product categories
The maximum number of times this coupon can be used by a particular customer
The optional maximum discount that this coupon can yield, irrespective of its configuration
Minimum a customer must purchase to qualify for coupon
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
{ "amount": 0.1, "applies_to_career_center_packages": true, "applies_to_miscellaneous_products": true, "code_generation_html": "string", "custom_field_values": [ { … } ], "discount_product_id": "string", "expiration_date": "2019-08-24T14:15:22Z", "id": "string", "is_active": true, "limit_to_product_categories": [ "string" ], "limit_to_products": [ "string" ], "limit_total_uses": 0, "limit_uses_per_customer": 0, "maximum_discount": 0.1, "minimum_purchase": 0.1, "name": "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, "type": "fixed amount off each item" }
The updated coupon that will be saved.
Whether or not this coupon applies to career center packages
Whether or not this coupon applies to misc products
The product uses for the discount code when it is at the order level
Limit purchase to particular product categories
The maximum number of times this coupon can be used by a particular customer
The optional maximum discount that this coupon can yield, irrespective of its configuration
Minimum a customer must purchase to qualify for coupon
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/coupons/{tenantId}/{id}
https://commerce.api.rhythmsoftware.com/coupons/{tenantId}/{id}
curl -i -X PUT \
'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/coupons/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"amount": 0.1,
"applies_to_career_center_packages": true,
"applies_to_miscellaneous_products": true,
"code_generation_html": "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": [
{}
]
}
],
"discount_product_id": "string",
"expiration_date": "2019-08-24T14:15:22Z",
"id": "string",
"is_active": true,
"limit_to_product_categories": [
"string"
],
"limit_to_products": [
"string"
],
"limit_total_uses": 0,
"limit_uses_per_customer": 0,
"maximum_discount": 0.1,
"minimum_purchase": 0.1,
"name": "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": "fixed amount off each item"
}'The coupon was updated successfully.
Whether or not this coupon applies to career center packages
Whether or not this coupon applies to misc products
The product uses for the discount code when it is at the order level
Limit purchase to particular product categories
The maximum number of times this coupon can be used by a particular customer
The optional maximum discount that this coupon can yield, irrespective of its configuration
Minimum a customer must purchase to qualify for coupon
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
{ "amount": 0.1, "applies_to_career_center_packages": true, "applies_to_miscellaneous_products": true, "code_generation_html": "string", "custom_field_values": [ { … } ], "discount_product_id": "string", "expiration_date": "2019-08-24T14:15:22Z", "id": "string", "is_active": true, "limit_to_product_categories": [ "string" ], "limit_to_products": [ "string" ], "limit_total_uses": 0, "limit_uses_per_customer": 0, "maximum_discount": 0.1, "minimum_purchase": 0.1, "name": "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, "type": "fixed amount off each item" }