Stores

Stores

Creates a new store record that does not already exist.

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The store that you would like to be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this store

invoice_terms_id
string (Invoice Terms)

Default invoice terms for non-electronic payments made to the store

home_category_id
string (Home Category)

The "home" category of products to display when someone lands on the store

default_merchandise_image_uri
string (Default Merchandise Image Uri)

The default image to show for products with no image

name
required
string (Name)

The name of the store

category_inclusion
string (Category Inclusion)
Enum: "include all categories" "include only specified" "include all but specified"
category_ids
required
Array of strings (Categories)
sell_membership_packages
boolean (Sell Membership Packages)

If set, this store sells membership packages

required
object (Membership Package Options)
sell_certification_courses
boolean (Sell Certification Courses)

If set, this store sells certification courses

required
object (Certification Course Options)
sell_certification_exams
boolean (Sell Certification Exams)

If set, this store sells certification exams

required
object (Certification Exam Options)
sell_event_registration_packages
boolean (Sell Event Registration Packages)

If set, this store sells event registration packages

required
object (Event Registration Options)
default_membership_package_image_uri
string (Default Membership Package Image Uri)

The image to display in the store for membership

default_certification_course_image_uri
string (Default Certification Course Image Uri)

The image to display in the store for courses

default_certification_exam_image_uri
string (Default Certification Exam Image Uri)

The image to display in the store for exams

default_event_registration_image_uri
string (Default Event Registration Image Uri)

The image to display in the store for event registrations

is_active
boolean (Is Active)

Whether or not this store is active

override_order_confirmation_email
boolean (Override Order Confirmation Email)

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

required
object (Order Confirmation Settings)
default_product_sort
string (Default Product Sort)
Enum: "sort order" "price ascending" "price descending" "alphabetical ascending" "alphabetical descending" "newest items"
override_shipment_confirmation_email
boolean (Override Shipment Confirmation Email)

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

required
object (Shipment Confirmation Settings)
override_cancellation_confirmation_email
boolean (Override Cancellation Confirmation Email)

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

required
object (Cancellation Confirmation Settings)
override_return_confirmation_email
boolean (Override Return Confirmation Email)

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

required
object (Return Confirmation Settings)
business_unit_id
required
string (Business Unit)

The business unit of the store

merchant_account_id
required
string (Merchant Account)

The merchant account that the store should use to receive payments

bank_account_id
required
string (Bank Account)

The default bank account that the store should use to receive payments

enable_split_payments
boolean (Enable Split Payments)

If set, users are allowed to split payments

enable_electronic_checks
boolean (Enable Electronic Checks)

If set, electronic checks are allowed

enable_payroll_deduction
boolean (Enable Payroll Deduction)

If set, payroll deduction is allowed

enable_pay_later
boolean (Enable Pay Later)

If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed

enable_bill_my_organization
boolean (Enable Bill My Organization)

If set, the user has the option to bill their organization

enable_bill_my_parent_organization
boolean (Enable Bill My Parent Organization)

If set, the user has the option to bill their organization's parent organization

use_pro_forma_invoices
boolean (Use Pro Forma Invoices)

Whether to use pro forma invoices when user elects to pay later

enable_donations_at_checkout
boolean (Enable Donations At Checkout)

If selected, users will be prompted to make a donation upon checking out

restocking_fee_product_id
string (Restocking Fee Product)

The ID of the product used for restocking fees

cancellation_fee_product_id
string (Cancellation Fee Product)

The ID of the product used for cancellation fees

special_instructions
string (Special Instructions)

Instructions shown to the user

object (Pay Later Options)
object (Bill My Organization Options)
object (Bill My Parent Organization Options)
credit_card_mode
string (Credit Card Mode)

Determines whether or not credit cards are accepted

Enum: "enabled" "disabled" "range"
credit_card_minimum_range_start
number <float> (Credit Card Minimum Range Start)

If set, the minimum amount for which credit cards can be taken

credit_card_minimum_range_end
number <float> (Credit Card Minimum Range End)

If set, the maximum amount for which credit cards can be taken

credit_card_processing_fee_mode
string (Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum: "do not charge" "charge" "prompt user"
required
object (Credit Card Processing Fee Options)
invoice_template_id
string (Invoice Template)

The template to use for invoices created during this process

invoice_payment_terms_id
string (Invoice Payment Terms)

The payment terms for invoices; if left blank, default is used

allow_customer_to_choose_installment_plan
boolean (Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

disable_electronic_payment_vaulting
boolean (Disable Electronic Payment Vaulting)

If set, in the portal people are not allowed to save credit cards

required
Array of objects non-empty
required
object (Checkout Donation Options)
sys_deleted_by_id
string (Sys Deleted By)

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

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

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

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

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

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

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

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

sys_locked
boolean (Sys Locked)

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

sys_bulk_load_pk
string (Sys Bulk Load Pk)

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

sys_bulk_load_at
string (Sys Bulk Load At)

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

sys_bulk_load_id
string (Sys Bulk Load)

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

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

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

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_version
string (Sys Last Bulk Data Operation Sys Version)

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

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

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

sys_has_files_in_s3
boolean (Sys Has Files In S3)

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

sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

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

sys_last_security_context
object (Sys Last Security Context)

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

Array of objects
Responses
200The store was saved successfully.
400The store you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The store could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add store based on tenant limits.
500General server error.
post/stores/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "invoice_terms_id": "string",
  • "home_category_id": "string",
  • "default_merchandise_image_uri": "string",
  • "name": "string",
  • "category_inclusion": "include all categories",
  • "category_ids": [
    ],
  • "sell_membership_packages": true,
  • "membership_package_options": {
    },
  • "sell_certification_courses": true,
  • "certification_course_options": {
    },
  • "sell_certification_exams": true,
  • "certification_exam_options": {
    },
  • "sell_event_registration_packages": true,
  • "event_registration_options": {
    },
  • "default_membership_package_image_uri": "string",
  • "default_certification_course_image_uri": "string",
  • "default_certification_exam_image_uri": "string",
  • "default_event_registration_image_uri": "string",
  • "is_active": true,
  • "override_order_confirmation_email": true,
  • "order_confirmation_settings": {
    },
  • "default_product_sort": "sort order",
  • "override_shipment_confirmation_email": true,
  • "shipment_confirmation_settings": {
    },
  • "override_cancellation_confirmation_email": true,
  • "cancellation_confirmation_settings": {
    },
  • "override_return_confirmation_email": true,
  • "return_confirmation_settings": {
    },
  • "business_unit_id": "string",
  • "merchant_account_id": "string",
  • "bank_account_id": "string",
  • "enable_split_payments": true,
  • "enable_electronic_checks": true,
  • "enable_payroll_deduction": true,
  • "enable_pay_later": true,
  • "enable_bill_my_organization": true,
  • "enable_bill_my_parent_organization": true,
  • "use_pro_forma_invoices": true,
  • "enable_donations_at_checkout": true,
  • "restocking_fee_product_id": "string",
  • "cancellation_fee_product_id": "string",
  • "special_instructions": "string",
  • "pay_later_options": {
    },
  • "bill_my_organization_options": {
    },
  • "bill_my_parent_organization_options": {
    },
  • "credit_card_mode": "enabled",
  • "credit_card_minimum_range_start": 0,
  • "credit_card_minimum_range_end": 0,
  • "credit_card_processing_fee_mode": "do not charge",
  • "credit_card_processing_fee_options": {
    },
  • "invoice_template_id": "string",
  • "invoice_payment_terms_id": "string",
  • "allow_customer_to_choose_installment_plan": true,
  • "disable_electronic_payment_vaulting": true,
  • "installment_plan_options": [
    ],
  • "checkout_donation_options": {
    },
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "invoice_terms_id": "string",
  • "home_category_id": "string",
  • "default_merchandise_image_uri": "string",
  • "name": "string",
  • "category_inclusion": "include all categories",
  • "category_ids": [
    ],
  • "sell_membership_packages": true,
  • "membership_package_options": {
    },
  • "sell_certification_courses": true,
  • "certification_course_options": {
    },
  • "sell_certification_exams": true,
  • "certification_exam_options": {
    },
  • "sell_event_registration_packages": true,
  • "event_registration_options": {
    },
  • "default_membership_package_image_uri": "string",
  • "default_certification_course_image_uri": "string",
  • "default_certification_exam_image_uri": "string",
  • "default_event_registration_image_uri": "string",
  • "is_active": true,
  • "override_order_confirmation_email": true,
  • "order_confirmation_settings": {
    },
  • "default_product_sort": "sort order",
  • "override_shipment_confirmation_email": true,
  • "shipment_confirmation_settings": {
    },
  • "override_cancellation_confirmation_email": true,
  • "cancellation_confirmation_settings": {
    },
  • "override_return_confirmation_email": true,
  • "return_confirmation_settings": {
    },
  • "business_unit_id": "string",
  • "merchant_account_id": "string",
  • "bank_account_id": "string",
  • "enable_split_payments": true,
  • "enable_electronic_checks": true,
  • "enable_payroll_deduction": true,
  • "enable_pay_later": true,
  • "enable_bill_my_organization": true,
  • "enable_bill_my_parent_organization": true,
  • "use_pro_forma_invoices": true,
  • "enable_donations_at_checkout": true,
  • "restocking_fee_product_id": "string",
  • "cancellation_fee_product_id": "string",
  • "special_instructions": "string",
  • "pay_later_options": {
    },
  • "bill_my_organization_options": {
    },
  • "bill_my_parent_organization_options": {
    },
  • "credit_card_mode": "enabled",
  • "credit_card_minimum_range_start": 0,
  • "credit_card_minimum_range_end": 0,
  • "credit_card_processing_fee_mode": "do not charge",
  • "credit_card_processing_fee_options": {
    },
  • "invoice_template_id": "string",
  • "invoice_payment_terms_id": "string",
  • "allow_customer_to_choose_installment_plan": true,
  • "disable_electronic_payment_vaulting": true,
  • "installment_plan_options": [
    ],
  • "checkout_donation_options": {
    },
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Gets all of the stores in the system.

This method will scan all stores and and return them to the caller.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

query Parameters
fields
string

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

exclusiveStartKey
string

The start key, if you're making a subsequent request

Responses
200The storeswere retrieved successfully.
400The request was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
429Limit exceeded... unable to add contact role based on tenant limits.
500General server error.
get/stores/{tenantId}
Request samples
curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/stores/:tenantId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Returns a store from the system by its ID.

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the store to return.

query Parameters
fields
string

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

consistentRead
string

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

Responses
200The store was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The store could not be found.
429Limit exceeded... unable to retrieve store based on tenant limits.
500General server error.
get/stores/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://commerce.api.756794052567.rhythmsoftware.com/stores/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "invoice_terms_id": "string",
  • "home_category_id": "string",
  • "default_merchandise_image_uri": "string",
  • "name": "string",
  • "category_inclusion": "include all categories",
  • "category_ids": [
    ],
  • "sell_membership_packages": true,
  • "membership_package_options": {
    },
  • "sell_certification_courses": true,
  • "certification_course_options": {
    },
  • "sell_certification_exams": true,
  • "certification_exam_options": {
    },
  • "sell_event_registration_packages": true,
  • "event_registration_options": {
    },
  • "default_membership_package_image_uri": "string",
  • "default_certification_course_image_uri": "string",
  • "default_certification_exam_image_uri": "string",
  • "default_event_registration_image_uri": "string",
  • "is_active": true,
  • "override_order_confirmation_email": true,
  • "order_confirmation_settings": {
    },
  • "default_product_sort": "sort order",
  • "override_shipment_confirmation_email": true,
  • "shipment_confirmation_settings": {
    },
  • "override_cancellation_confirmation_email": true,
  • "cancellation_confirmation_settings": {
    },
  • "override_return_confirmation_email": true,
  • "return_confirmation_settings": {
    },
  • "business_unit_id": "string",
  • "merchant_account_id": "string",
  • "bank_account_id": "string",
  • "enable_split_payments": true,
  • "enable_electronic_checks": true,
  • "enable_payroll_deduction": true,
  • "enable_pay_later": true,
  • "enable_bill_my_organization": true,
  • "enable_bill_my_parent_organization": true,
  • "use_pro_forma_invoices": true,
  • "enable_donations_at_checkout": true,
  • "restocking_fee_product_id": "string",
  • "cancellation_fee_product_id": "string",
  • "special_instructions": "string",
  • "pay_later_options": {
    },
  • "bill_my_organization_options": {
    },
  • "bill_my_parent_organization_options": {
    },
  • "credit_card_mode": "enabled",
  • "credit_card_minimum_range_start": 0,
  • "credit_card_minimum_range_end": 0,
  • "credit_card_processing_fee_mode": "do not charge",
  • "credit_card_processing_fee_options": {
    },
  • "invoice_template_id": "string",
  • "invoice_payment_terms_id": "string",
  • "allow_customer_to_choose_installment_plan": true,
  • "disable_electronic_payment_vaulting": true,
  • "installment_plan_options": [
    ],
  • "checkout_donation_options": {
    },
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Updates a store with the specified ID.

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the store to update.

Request Body schema: application/json

The updated store that will be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this store

invoice_terms_id
string (Invoice Terms)

Default invoice terms for non-electronic payments made to the store

home_category_id
string (Home Category)

The "home" category of products to display when someone lands on the store

default_merchandise_image_uri
string (Default Merchandise Image Uri)

The default image to show for products with no image

name
required
string (Name)

The name of the store

category_inclusion
string (Category Inclusion)
Enum: "include all categories" "include only specified" "include all but specified"
category_ids
required
Array of strings (Categories)
sell_membership_packages
boolean (Sell Membership Packages)

If set, this store sells membership packages

required
object (Membership Package Options)
sell_certification_courses
boolean (Sell Certification Courses)

If set, this store sells certification courses

required
object (Certification Course Options)
sell_certification_exams
boolean (Sell Certification Exams)

If set, this store sells certification exams

required
object (Certification Exam Options)
sell_event_registration_packages
boolean (Sell Event Registration Packages)

If set, this store sells event registration packages

required
object (Event Registration Options)
default_membership_package_image_uri
string (Default Membership Package Image Uri)

The image to display in the store for membership

default_certification_course_image_uri
string (Default Certification Course Image Uri)

The image to display in the store for courses

default_certification_exam_image_uri
string (Default Certification Exam Image Uri)

The image to display in the store for exams

default_event_registration_image_uri
string (Default Event Registration Image Uri)

The image to display in the store for event registrations

is_active
boolean (Is Active)

Whether or not this store is active

override_order_confirmation_email
boolean (Override Order Confirmation Email)

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

required
object (Order Confirmation Settings)
default_product_sort
string (Default Product Sort)
Enum: "sort order" "price ascending" "price descending" "alphabetical ascending" "alphabetical descending" "newest items"
override_shipment_confirmation_email
boolean (Override Shipment Confirmation Email)

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

required
object (Shipment Confirmation Settings)
override_cancellation_confirmation_email
boolean (Override Cancellation Confirmation Email)

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

required
object (Cancellation Confirmation Settings)
override_return_confirmation_email
boolean (Override Return Confirmation Email)

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

required
object (Return Confirmation Settings)
business_unit_id
required
string (Business Unit)

The business unit of the store

merchant_account_id
required
string (Merchant Account)

The merchant account that the store should use to receive payments

bank_account_id
required
string (Bank Account)

The default bank account that the store should use to receive payments

enable_split_payments
boolean (Enable Split Payments)

If set, users are allowed to split payments

enable_electronic_checks
boolean (Enable Electronic Checks)

If set, electronic checks are allowed

enable_payroll_deduction
boolean (Enable Payroll Deduction)

If set, payroll deduction is allowed

enable_pay_later
boolean (Enable Pay Later)

If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed

enable_bill_my_organization
boolean (Enable Bill My Organization)

If set, the user has the option to bill their organization

enable_bill_my_parent_organization
boolean (Enable Bill My Parent Organization)

If set, the user has the option to bill their organization's parent organization

use_pro_forma_invoices
boolean (Use Pro Forma Invoices)

Whether to use pro forma invoices when user elects to pay later

enable_donations_at_checkout
boolean (Enable Donations At Checkout)

If selected, users will be prompted to make a donation upon checking out

restocking_fee_product_id
string (Restocking Fee Product)

The ID of the product used for restocking fees

cancellation_fee_product_id
string (Cancellation Fee Product)

The ID of the product used for cancellation fees

special_instructions
string (Special Instructions)

Instructions shown to the user

object (Pay Later Options)
object (Bill My Organization Options)
object (Bill My Parent Organization Options)
credit_card_mode
string (Credit Card Mode)

Determines whether or not credit cards are accepted

Enum: "enabled" "disabled" "range"
credit_card_minimum_range_start
number <float> (Credit Card Minimum Range Start)

If set, the minimum amount for which credit cards can be taken

credit_card_minimum_range_end
number <float> (Credit Card Minimum Range End)

If set, the maximum amount for which credit cards can be taken

credit_card_processing_fee_mode
string (Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum: "do not charge" "charge" "prompt user"
required
object (Credit Card Processing Fee Options)
invoice_template_id
string (Invoice Template)

The template to use for invoices created during this process

invoice_payment_terms_id
string (Invoice Payment Terms)

The payment terms for invoices; if left blank, default is used

allow_customer_to_choose_installment_plan
boolean (Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

disable_electronic_payment_vaulting
boolean (Disable Electronic Payment Vaulting)

If set, in the portal people are not allowed to save credit cards

required
Array of objects non-empty
required
object (Checkout Donation Options)
sys_deleted_by_id
string (Sys Deleted By)

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

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

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

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

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

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

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

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

sys_locked
boolean (Sys Locked)

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

sys_bulk_load_pk
string (Sys Bulk Load Pk)

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

sys_bulk_load_at
string (Sys Bulk Load At)

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

sys_bulk_load_id
string (Sys Bulk Load)

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

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

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

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_version
string (Sys Last Bulk Data Operation Sys Version)

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

sys_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <float> (Sys Snapshot Base Version)

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

sys_has_files_in_s3
boolean (Sys Has Files In S3)

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

sys_configuration_snapshot_id
string (Sys Configuration Snapshot)

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

sys_last_security_context
object (Sys Last Security Context)

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

Array of objects
Responses
200The store was updated successfully.
400The store supplied was not valid.
401Unauthorized.
403Forbidden.
404The store could not be found.
409The store could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve store based on tenant limits.
500General server error.
put/stores/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "invoice_terms_id": "string",
  • "home_category_id": "string",
  • "default_merchandise_image_uri": "string",
  • "name": "string",
  • "category_inclusion": "include all categories",
  • "category_ids": [
    ],
  • "sell_membership_packages": true,
  • "membership_package_options": {
    },
  • "sell_certification_courses": true,
  • "certification_course_options": {
    },
  • "sell_certification_exams": true,
  • "certification_exam_options": {
    },
  • "sell_event_registration_packages": true,
  • "event_registration_options": {
    },
  • "default_membership_package_image_uri": "string",
  • "default_certification_course_image_uri": "string",
  • "default_certification_exam_image_uri": "string",
  • "default_event_registration_image_uri": "string",
  • "is_active": true,
  • "override_order_confirmation_email": true,
  • "order_confirmation_settings": {
    },
  • "default_product_sort": "sort order",
  • "override_shipment_confirmation_email": true,
  • "shipment_confirmation_settings": {
    },
  • "override_cancellation_confirmation_email": true,
  • "cancellation_confirmation_settings": {
    },
  • "override_return_confirmation_email": true,
  • "return_confirmation_settings": {
    },
  • "business_unit_id": "string",
  • "merchant_account_id": "string",
  • "bank_account_id": "string",
  • "enable_split_payments": true,
  • "enable_electronic_checks": true,
  • "enable_payroll_deduction": true,
  • "enable_pay_later": true,
  • "enable_bill_my_organization": true,
  • "enable_bill_my_parent_organization": true,
  • "use_pro_forma_invoices": true,
  • "enable_donations_at_checkout": true,
  • "restocking_fee_product_id": "string",
  • "cancellation_fee_product_id": "string",
  • "special_instructions": "string",
  • "pay_later_options": {
    },
  • "bill_my_organization_options": {
    },
  • "bill_my_parent_organization_options": {
    },
  • "credit_card_mode": "enabled",
  • "credit_card_minimum_range_start": 0,
  • "credit_card_minimum_range_end": 0,
  • "credit_card_processing_fee_mode": "do not charge",
  • "credit_card_processing_fee_options": {
    },
  • "invoice_template_id": "string",
  • "invoice_payment_terms_id": "string",
  • "allow_customer_to_choose_installment_plan": true,
  • "disable_electronic_payment_vaulting": true,
  • "installment_plan_options": [
    ],
  • "checkout_donation_options": {
    },
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "invoice_terms_id": "string",
  • "home_category_id": "string",
  • "default_merchandise_image_uri": "string",
  • "name": "string",
  • "category_inclusion": "include all categories",
  • "category_ids": [
    ],
  • "sell_membership_packages": true,
  • "membership_package_options": {
    },
  • "sell_certification_courses": true,
  • "certification_course_options": {
    },
  • "sell_certification_exams": true,
  • "certification_exam_options": {
    },
  • "sell_event_registration_packages": true,
  • "event_registration_options": {
    },
  • "default_membership_package_image_uri": "string",
  • "default_certification_course_image_uri": "string",
  • "default_certification_exam_image_uri": "string",
  • "default_event_registration_image_uri": "string",
  • "is_active": true,
  • "override_order_confirmation_email": true,
  • "order_confirmation_settings": {
    },
  • "default_product_sort": "sort order",
  • "override_shipment_confirmation_email": true,
  • "shipment_confirmation_settings": {
    },
  • "override_cancellation_confirmation_email": true,
  • "cancellation_confirmation_settings": {
    },
  • "override_return_confirmation_email": true,
  • "return_confirmation_settings": {
    },
  • "business_unit_id": "string",
  • "merchant_account_id": "string",
  • "bank_account_id": "string",
  • "enable_split_payments": true,
  • "enable_electronic_checks": true,
  • "enable_payroll_deduction": true,
  • "enable_pay_later": true,
  • "enable_bill_my_organization": true,
  • "enable_bill_my_parent_organization": true,
  • "use_pro_forma_invoices": true,
  • "enable_donations_at_checkout": true,
  • "restocking_fee_product_id": "string",
  • "cancellation_fee_product_id": "string",
  • "special_instructions": "string",
  • "pay_later_options": {
    },
  • "bill_my_organization_options": {
    },
  • "bill_my_parent_organization_options": {
    },
  • "credit_card_mode": "enabled",
  • "credit_card_minimum_range_start": 0,
  • "credit_card_minimum_range_end": 0,
  • "credit_card_processing_fee_mode": "do not charge",
  • "credit_card_processing_fee_options": {
    },
  • "invoice_template_id": "string",
  • "invoice_payment_terms_id": "string",
  • "allow_customer_to_choose_installment_plan": true,
  • "disable_electronic_payment_vaulting": true,
  • "installment_plan_options": [
    ],
  • "checkout_donation_options": {
    },
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Partially updates a store with the specified ID.

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the store to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array
op
required
string (Op)

The operation

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

The JSON path

value
string (Value)
Responses
200The store was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The store could not be found.
409The store could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve store based on tenant limits.
500General server error.
patch/stores/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "invoice_terms_id": "string",
  • "home_category_id": "string",
  • "default_merchandise_image_uri": "string",
  • "name": "string",
  • "category_inclusion": "include all categories",
  • "category_ids": [
    ],
  • "sell_membership_packages": true,
  • "membership_package_options": {
    },
  • "sell_certification_courses": true,
  • "certification_course_options": {
    },
  • "sell_certification_exams": true,
  • "certification_exam_options": {
    },
  • "sell_event_registration_packages": true,
  • "event_registration_options": {
    },
  • "default_membership_package_image_uri": "string",
  • "default_certification_course_image_uri": "string",
  • "default_certification_exam_image_uri": "string",
  • "default_event_registration_image_uri": "string",
  • "is_active": true,
  • "override_order_confirmation_email": true,
  • "order_confirmation_settings": {
    },
  • "default_product_sort": "sort order",
  • "override_shipment_confirmation_email": true,
  • "shipment_confirmation_settings": {
    },
  • "override_cancellation_confirmation_email": true,
  • "cancellation_confirmation_settings": {
    },
  • "override_return_confirmation_email": true,
  • "return_confirmation_settings": {
    },
  • "business_unit_id": "string",
  • "merchant_account_id": "string",
  • "bank_account_id": "string",
  • "enable_split_payments": true,
  • "enable_electronic_checks": true,
  • "enable_payroll_deduction": true,
  • "enable_pay_later": true,
  • "enable_bill_my_organization": true,
  • "enable_bill_my_parent_organization": true,
  • "use_pro_forma_invoices": true,
  • "enable_donations_at_checkout": true,
  • "restocking_fee_product_id": "string",
  • "cancellation_fee_product_id": "string",
  • "special_instructions": "string",
  • "pay_later_options": {
    },
  • "bill_my_organization_options": {
    },
  • "bill_my_parent_organization_options": {
    },
  • "credit_card_mode": "enabled",
  • "credit_card_minimum_range_start": 0,
  • "credit_card_minimum_range_end": 0,
  • "credit_card_processing_fee_mode": "do not charge",
  • "credit_card_processing_fee_options": {
    },
  • "invoice_template_id": "string",
  • "invoice_payment_terms_id": "string",
  • "allow_customer_to_choose_installment_plan": true,
  • "disable_electronic_payment_vaulting": true,
  • "installment_plan_options": [
    ],
  • "checkout_donation_options": {
    },
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Returns a store from the system by its ID.

This method will delete a store with the specified ID.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the store to delete.

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

Gets the public store info

Gets the public store info

Request
path Parameters
tenantId
required
string

The tenant

id
required
string

The id of the store

Responses
200The store was retrieved
400The request was not valid.
401Unauthorized
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/stores/{tenantId}/public/{id}
Request samples
curl -i -X GET \
  https://commerce.api.756794052567.rhythmsoftware.com/stores/:tenantId/public/:id
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "home_category_id": "string",
  • "default_merchandise_image_uri": "string",
  • "currency_code": "string",
  • "currency_symbol": "string",
  • "category_inclusion": "include all categories",
  • "default_product_sort": "sort order",
  • "categories": [
    ],
  • "sell_membership_packages": true,
  • "membership_package_options": {
    },
  • "sell_certification_courses": true,
  • "certification_course_options": {
    },
  • "sell_certification_exams": true,
  • "certification_exam_options": {
    },
  • "sell_event_registration_packages": true,
  • "event_registration_options": {
    },
  • "default_membership_package_image_uri": "string",
  • "default_certification_course_image_uri": "string",
  • "default_certification_exam_image_uri": "string",
  • "default_event_registration_image_uri": "string",
  • "business_unit_id": "string",
  • "merchant_account_id": "string",
  • "bank_account_id": "string",
  • "enable_split_payments": true,
  • "enable_electronic_checks": true,
  • "enable_payroll_deduction": true,
  • "enable_pay_later": true,
  • "enable_bill_my_organization": true,
  • "enable_bill_my_parent_organization": true,
  • "use_pro_forma_invoices": true,
  • "enable_donations_at_checkout": true,
  • "restocking_fee_product_id": "string",
  • "cancellation_fee_product_id": "string",
  • "special_instructions": "string",
  • "pay_later_options": {
    },
  • "bill_my_organization_options": {
    },
  • "bill_my_parent_organization_options": {
    },
  • "credit_card_mode": "enabled",
  • "credit_card_minimum_range_start": 0,
  • "credit_card_minimum_range_end": 0,
  • "credit_card_processing_fee_mode": "do not charge",
  • "credit_card_processing_fee_options": {
    },
  • "invoice_template_id": "string",
  • "invoice_payment_terms_id": "string",
  • "allow_customer_to_choose_installment_plan": true,
  • "disable_electronic_payment_vaulting": true,
  • "installment_plan_options": [
    ],
  • "checkout_donation_options": {
    }
}

Execute Batch Operations

TAllows you to perform up to 100 parallel patch/delete operations

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The batch request

Array of objects
Responses
200Request completed successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The store could not be found.
429Limit exceeded... unable to retrieve store based on tenant limits.
500General server error.
post/stores/{tenantId}/batch
Request samples
    1 more
    Python
application/json
{
  • "operations": [
    ]
}
Response samples
application/json
{
  • "success_count": 0,
  • "error_count": 0,
  • "results": [
    ]
}