Commerce

Gets all of the stores in the system.

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

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

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

Download OpenAPI description

commerce-v1.json

commerce-v1.yaml

Servers

Mock server

https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/

https://commerce.api.rhythmsoftware.com/

Cancellation Fees

Operations

Cancellations

Operations

Carts

Operations

Coupon Code Gen Processes

Operations

Coupon Codes

Operations

Coupons

Operations

Discount Products

Operations

Entitlement Types

Operations

Entitlements

Operations

Inventory Transactions

Operations

Merchandise

Operations

Orders

Operations

Product Categories

Operations

Product Confirmation Emails

Operations

Product Inventories

Operations

Query Definitions

Operations

Returns

Operations

Settings

Operations

Shared Modifier Options

Operations

Shared Variant Options

Operations

Shipments

Operations

Shipping Configurations

Operations

Shipping Products

Operations

Statistics

Operations

Stores

Operations

Gets all of the stores in the system.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

Query

fieldsstring

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

exclusiveStartKeystring

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

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

Responses

The storeswere retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/jsonArray [

allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

bank_account_idstring(Bank Account)required

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

bill_my_organization_optionsobject(Bill My Organization Options)

bill_my_parent_organization_optionsobject(Bill My Parent Organization Options)

business_unit_idstring(Business Unit)required

The business unit of the store

cancellation_confirmation_settingsobject(Cancellation Confirmation Settings)required

cancellation_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

cancellation_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

category_idsArray of strings(Categories)required

category_inclusionstring(Category Inclusion)

Enum"include all but specified""include all categories""include only specified"

certification_course_optionsobject(Certification Course Options)required

certification_course_options.category_namestring(Category Name)

The optional name of the category

certification_course_options.course_idsArray of Courses (strings)(Courses)>= 0 items

One of:

>= 0 items

certification_course_options.course_restrictionstring(Course Restriction)

Enum"exclude""include""none"

certification_course_options.course_type_idsArray of Course Types (strings)(Course Types)>= 0 items

One of:

>= 0 items

certification_course_options.course_type_restrictionstring(Course Type Restriction)

Enum"exclude""include""none"

certification_exam_optionsobject(Certification Exam Options)required

certification_exam_options.category_namestring(Category Name)

The optional name of the category

certification_exam_options.exam_idsArray of Exams (strings)(Exams)>= 0 items

One of:

>= 0 items

certification_exam_options.exam_restrictionstring(Exam Restriction)

Enum"exclude""include""none"

certification_exam_options.image_uristring(Image Uri)

The image to display in the store for exams

checkout_donation_optionsobject(Checkout Donation Options)required

checkout_donation_options.simple_checkout_donation_optionsSimple Checkout Donation Options (object)(Simple Checkout Donation Options)

One of:

checkout_donation_options.typestring(Type)

Value"simple"

credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

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

credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

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

credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

Enum"disabled""enabled""range"

credit_card_processing_fee_modestring(Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"

credit_card_processing_fee_optionsobject(Credit Card Processing Fee Options)required

credit_card_processing_fee_options.fee_percentagenumber(float)(Fee Percentage)required

The fee percentage to charge for credit card processing

credit_card_processing_fee_options.maximum_feenumber(float)(Maximum Fee)

The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged

credit_card_processing_fee_options.minimum_feenumber(float)(Minimum Fee)

The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged

credit_card_processing_fee_options.product_idstring(Product)required

The misc product to use for the credit card processing

credit_card_processing_fee_options.prompt_sub_textstring(Prompt Sub Text)

Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used

credit_card_processing_fee_options.prompt_textstring(Prompt Text)

The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used

default_certification_course_image_uristring(Default Certification Course Image Uri)

The image to display in the store for courses

default_certification_exam_image_uristring(Default Certification Exam Image Uri)

The image to display in the store for exams

default_event_registration_image_uristring(Default Event Registration Image Uri)

The image to display in the store for event registrations

default_membership_package_image_uristring(Default Membership Package Image Uri)

The image to display in the store for membership

default_merchandise_image_uristring(Default Merchandise Image Uri)

The default image to show for products with no image

default_product_sortstring(Default Product Sort)

Enum"alphabetical ascending""alphabetical descending""newest items""price ascending""price descending""sort order"

disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

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

enable_bill_my_organizationboolean(Enable Bill My Organization)

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

enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

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

enable_donations_at_checkoutboolean(Enable Donations At Checkout)

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

enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

enable_pay_laterboolean(Enable Pay Later)

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

enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

event_registration_optionsobject(Event Registration Options)required

event_registration_options.category_namestring(Category Name)

The optional name of the category

event_registration_options.event_idsArray of Events (strings)(Events)>= 0 items

One of:

>= 0 items

event_registration_options.event_restrictionstring(Event Restriction)

Enum"exclude""include""none"

event_registration_options.event_type_idsArray of Event Types (strings)(Event Types)>= 0 items

One of:

>= 0 items

event_registration_options.event_type_restrictionstring(Event Type Restriction)

Enum"exclude""include""none"

home_category_idstring(Home Category)

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

idstring(ID)^[\w|-]+$required

The unique, string identifier of this store

installment_plan_optionsArray of objectsnon-emptyrequired

installment_plan_options[].additional_costnumber(double)(Additional Cost)

The additional cost of the installment plan

installment_plan_options[].installment_plan_idstring(Installment Plan)required

The installment plan that this product supports

installment_plan_options[].is_defaultboolean(Is Default)

Whether this is the default installment plan option

invoice_payment_terms_idstring(Invoice Payment Terms)

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

invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

invoice_terms_idstring(Invoice Terms)

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

is_activeboolean(Is Active)

Whether or not this store is active

membership_package_optionsobject(Membership Package Options)required

membership_package_options.category_namestring(Category Name)

The optional name of the category

membership_package_options.membership_package_idsArray of Membership Packages (strings)(Membership Packages)>= 0 items

One of:

>= 0 items

membership_package_options.membership_package_restrictionstring(Membership Package Restriction)

Enum"exclude""include""none"

membership_package_options.membership_type_idsArray of Membership Types (strings)(Membership Types)>= 0 items

One of:

>= 0 items

membership_package_options.membership_type_restrictionstring(Membership Type Restriction)

Enum"exclude""include""none"

merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

namestring(Name)required

The name of the store

order_confirmation_settingsobject(Order Confirmation Settings)required

order_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

order_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

override_cancellation_confirmation_emailboolean(Override Cancellation Confirmation Email)

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

override_order_confirmation_emailboolean(Override Order Confirmation Email)

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

override_return_confirmation_emailboolean(Override Return Confirmation Email)

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

override_shipment_confirmation_emailboolean(Override Shipment Confirmation Email)

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

pay_later_optionsobject(Pay Later Options)

restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

return_confirmation_settingsobject(Return Confirmation Settings)required

return_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

return_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

sell_certification_coursesboolean(Sell Certification Courses)

If set, this store sells certification courses

sell_certification_examsboolean(Sell Certification Exams)

If set, this store sells certification exams

sell_event_registration_packagesboolean(Sell Event Registration Packages)

If set, this store sells event registration packages

sell_membership_packagesboolean(Sell Membership Packages)

If set, this store sells membership packages

shipment_confirmation_settingsobject(Shipment Confirmation Settings)required

shipment_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

shipment_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

special_instructionsstring(Special Instructions)

Instructions shown to the user

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

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

]

Response

application/json

[
  {
    "allow_customer_to_choose_installment_plan": true,
    "bank_account_id": "string",
    "bill_my_organization_options": { … },
    "bill_my_parent_organization_options": { … },
    "business_unit_id": "string",
    "cancellation_confirmation_settings": { … },
    "cancellation_fee_product_id": "string",
    "category_ids": [ … ],
    "category_inclusion": "include all but specified",
    "certification_course_options": { … },
    "certification_exam_options": { … },
    "checkout_donation_options": { … },
    "credit_card_minimum_range_end": 0.1,
    "credit_card_minimum_range_start": 0.1,
    "credit_card_mode": "disabled",
    "credit_card_processing_fee_mode": "charge",
    "credit_card_processing_fee_options": { … },
    "default_certification_course_image_uri": "string",
    "default_certification_exam_image_uri": "string",
    "default_event_registration_image_uri": "string",
    "default_membership_package_image_uri": "string",
    "default_merchandise_image_uri": "string",
    "default_product_sort": "alphabetical ascending",
    "disable_electronic_payment_vaulting": true,
    "enable_bill_my_organization": true,
    "enable_bill_my_parent_organization": true,
    "enable_donations_at_checkout": true,
    "enable_electronic_checks": true,
    "enable_pay_later": true,
    "enable_payroll_deduction": true,
    "enable_split_payments": true,
    "event_registration_options": { … },
    "home_category_id": "string",
    "id": "string",
    "installment_plan_options": [ … ],
    "invoice_payment_terms_id": "string",
    "invoice_template_id": "string",
    "invoice_terms_id": "string",
    "is_active": true,
    "membership_package_options": { … },
    "merchant_account_id": "string",
    "name": "string",
    "order_confirmation_settings": { … },
    "override_cancellation_confirmation_email": true,
    "override_order_confirmation_email": true,
    "override_return_confirmation_email": true,
    "override_shipment_confirmation_email": true,
    "pay_later_options": { … },
    "restocking_fee_product_id": "string",
    "return_confirmation_settings": { … },
    "sell_certification_courses": true,
    "sell_certification_exams": true,
    "sell_event_registration_packages": true,
    "sell_membership_packages": true,
    "shipment_confirmation_settings": { … },
    "special_instructions": "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,
    "use_pro_forma_invoices": true
  }
]

Creates a new store record that does not already exist.

Request

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.

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The store that you would like to be saved.

allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

bank_account_idstring(Bank Account)required

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

bill_my_organization_optionsobject(Bill My Organization Options)

bill_my_parent_organization_optionsobject(Bill My Parent Organization Options)

business_unit_idstring(Business Unit)required

The business unit of the store

cancellation_confirmation_settingsobject(Cancellation Confirmation Settings)required

cancellation_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

cancellation_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

category_idsArray of strings(Categories)required

category_inclusionstring(Category Inclusion)

Enum"include all but specified""include all categories""include only specified"

certification_course_optionsobject(Certification Course Options)required

certification_course_options.category_namestring(Category Name)

The optional name of the category

certification_course_options.course_idsArray of Courses (strings)(Courses)>= 0 items

One of:

>= 0 items

certification_course_options.course_restrictionstring(Course Restriction)

Enum"exclude""include""none"

certification_course_options.course_type_idsArray of Course Types (strings)(Course Types)>= 0 items

One of:

>= 0 items

certification_course_options.course_type_restrictionstring(Course Type Restriction)

Enum"exclude""include""none"

certification_exam_optionsobject(Certification Exam Options)required

certification_exam_options.category_namestring(Category Name)

The optional name of the category

certification_exam_options.exam_idsArray of Exams (strings)(Exams)>= 0 items

One of:

>= 0 items

certification_exam_options.exam_restrictionstring(Exam Restriction)

Enum"exclude""include""none"

certification_exam_options.image_uristring(Image Uri)

The image to display in the store for exams

checkout_donation_optionsobject(Checkout Donation Options)required

checkout_donation_options.simple_checkout_donation_optionsSimple Checkout Donation Options (object)(Simple Checkout Donation Options)

One of:

checkout_donation_options.typestring(Type)

Value"simple"

credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

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

credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

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

credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

Enum"disabled""enabled""range"

credit_card_processing_fee_modestring(Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"

credit_card_processing_fee_optionsobject(Credit Card Processing Fee Options)required

credit_card_processing_fee_options.fee_percentagenumber(float)(Fee Percentage)required

The fee percentage to charge for credit card processing

credit_card_processing_fee_options.maximum_feenumber(float)(Maximum Fee)

The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged

credit_card_processing_fee_options.minimum_feenumber(float)(Minimum Fee)

The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged

credit_card_processing_fee_options.product_idstring(Product)required

The misc product to use for the credit card processing

credit_card_processing_fee_options.prompt_sub_textstring(Prompt Sub Text)

Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used

credit_card_processing_fee_options.prompt_textstring(Prompt Text)

The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used

default_certification_course_image_uristring(Default Certification Course Image Uri)

The image to display in the store for courses

default_certification_exam_image_uristring(Default Certification Exam Image Uri)

The image to display in the store for exams

default_event_registration_image_uristring(Default Event Registration Image Uri)

The image to display in the store for event registrations

default_membership_package_image_uristring(Default Membership Package Image Uri)

The image to display in the store for membership

default_merchandise_image_uristring(Default Merchandise Image Uri)

The default image to show for products with no image

default_product_sortstring(Default Product Sort)

Enum"alphabetical ascending""alphabetical descending""newest items""price ascending""price descending""sort order"

disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

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

enable_bill_my_organizationboolean(Enable Bill My Organization)

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

enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

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

enable_donations_at_checkoutboolean(Enable Donations At Checkout)

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

enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

enable_pay_laterboolean(Enable Pay Later)

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

enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

event_registration_optionsobject(Event Registration Options)required

event_registration_options.category_namestring(Category Name)

The optional name of the category

event_registration_options.event_idsArray of Events (strings)(Events)>= 0 items

One of:

>= 0 items

event_registration_options.event_restrictionstring(Event Restriction)

Enum"exclude""include""none"

event_registration_options.event_type_idsArray of Event Types (strings)(Event Types)>= 0 items

One of:

>= 0 items

event_registration_options.event_type_restrictionstring(Event Type Restriction)

Enum"exclude""include""none"

home_category_idstring(Home Category)

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

idstring(ID)^[\w|-]+$required

The unique, string identifier of this store

installment_plan_optionsArray of objectsnon-emptyrequired

installment_plan_options[].additional_costnumber(double)(Additional Cost)

The additional cost of the installment plan

installment_plan_options[].installment_plan_idstring(Installment Plan)required

The installment plan that this product supports

installment_plan_options[].is_defaultboolean(Is Default)

Whether this is the default installment plan option

invoice_payment_terms_idstring(Invoice Payment Terms)

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

invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

invoice_terms_idstring(Invoice Terms)

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

is_activeboolean(Is Active)

Whether or not this store is active

membership_package_optionsobject(Membership Package Options)required

membership_package_options.category_namestring(Category Name)

The optional name of the category

membership_package_options.membership_package_idsArray of Membership Packages (strings)(Membership Packages)>= 0 items

One of:

>= 0 items

membership_package_options.membership_package_restrictionstring(Membership Package Restriction)

Enum"exclude""include""none"

membership_package_options.membership_type_idsArray of Membership Types (strings)(Membership Types)>= 0 items

One of:

>= 0 items

membership_package_options.membership_type_restrictionstring(Membership Type Restriction)

Enum"exclude""include""none"

merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

namestring(Name)required

The name of the store

order_confirmation_settingsobject(Order Confirmation Settings)required

order_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

order_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

override_cancellation_confirmation_emailboolean(Override Cancellation Confirmation Email)

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

override_order_confirmation_emailboolean(Override Order Confirmation Email)

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

override_return_confirmation_emailboolean(Override Return Confirmation Email)

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

override_shipment_confirmation_emailboolean(Override Shipment Confirmation Email)

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

pay_later_optionsobject(Pay Later Options)

restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

return_confirmation_settingsobject(Return Confirmation Settings)required

return_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

return_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

sell_certification_coursesboolean(Sell Certification Courses)

If set, this store sells certification courses

sell_certification_examsboolean(Sell Certification Exams)

If set, this store sells certification exams

sell_event_registration_packagesboolean(Sell Event Registration Packages)

If set, this store sells event registration packages

sell_membership_packagesboolean(Sell Membership Packages)

If set, this store sells membership packages

shipment_confirmation_settingsobject(Shipment Confirmation Settings)required

shipment_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

shipment_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

special_instructionsstring(Special Instructions)

Instructions shown to the user

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

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

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/stores/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "allow_customer_to_choose_installment_plan": true,
    "bank_account_id": "string",
    "bill_my_organization_options": {
      "billing_address": "do not show",
      "purchase_order_number": "do not show",
      "reference_number": "string"
    },
    "bill_my_parent_organization_options": {
      "billing_address": "do not show",
      "purchase_order_number": "do not show",
      "reference_number": "string"
    },
    "business_unit_id": "string",
    "cancellation_confirmation_settings": {
      "email": {
        "bcc": "string",
        "body": "string",
        "cc": "string",
        "from": "string",
        "from_name": "string",
        "reply_to": "string",
        "subject": "string"
      },
      "suppress_email_delivery": true
    },
    "cancellation_fee_product_id": "string",
    "category_ids": [
      "string"
    ],
    "category_inclusion": "include all but specified",
    "certification_course_options": {
      "category_name": "string",
      "course_ids": {
        "0": "string"
      },
      "course_restriction": "exclude",
      "course_type_ids": {
        "0": "string"
      },
      "course_type_restriction": "exclude"
    },
    "certification_exam_options": {
      "category_name": "string",
      "exam_ids": {
        "0": "string"
      },
      "exam_restriction": "exclude",
      "image_uri": "string"
    },
    "checkout_donation_options": {
      "simple_checkout_donation_options": {
        "allow_user_to_specify_custom_amount": true,
        "donation_ask_text": "string",
        "donation_denominations": [
          0.1
        ],
        "donation_information": "string",
        "donation_product_id": "string",
        "override_donation_denominations": true,
        "suggested_donation": 0.1
      },
      "type": "simple"
    },
    "credit_card_minimum_range_end": 0.1,
    "credit_card_minimum_range_start": 0.1,
    "credit_card_mode": "disabled",
    "credit_card_processing_fee_mode": "charge",
    "credit_card_processing_fee_options": {
      "fee_percentage": 0.1,
      "maximum_fee": 0.1,
      "minimum_fee": 0.1,
      "product_id": "string",
      "prompt_sub_text": "string",
      "prompt_text": "string"
    },
    "default_certification_course_image_uri": "string",
    "default_certification_exam_image_uri": "string",
    "default_event_registration_image_uri": "string",
    "default_membership_package_image_uri": "string",
    "default_merchandise_image_uri": "string",
    "default_product_sort": "alphabetical ascending",
    "disable_electronic_payment_vaulting": true,
    "enable_bill_my_organization": true,
    "enable_bill_my_parent_organization": true,
    "enable_donations_at_checkout": true,
    "enable_electronic_checks": true,
    "enable_pay_later": true,
    "enable_payroll_deduction": true,
    "enable_split_payments": true,
    "event_registration_options": {
      "category_name": "string",
      "event_ids": {
        "0": "string"
      },
      "event_restriction": "exclude",
      "event_type_ids": {
        "0": "string"
      },
      "event_type_restriction": "exclude"
    },
    "home_category_id": "string",
    "id": "string",
    "installment_plan_options": [
      {
        "additional_cost": 0.1,
        "installment_plan_id": "string",
        "is_default": true
      }
    ],
    "invoice_payment_terms_id": "string",
    "invoice_template_id": "string",
    "invoice_terms_id": "string",
    "is_active": true,
    "membership_package_options": {
      "category_name": "string",
      "membership_package_ids": {
        "0": "string"
      },
      "membership_package_restriction": "exclude",
      "membership_type_ids": {
        "0": "string"
      },
      "membership_type_restriction": "exclude"
    },
    "merchant_account_id": "string",
    "name": "string",
    "order_confirmation_settings": {
      "email": {
        "bcc": "string",
        "body": "string",
        "cc": "string",
        "from": "string",
        "from_name": "string",
        "reply_to": "string",
        "subject": "string"
      },
      "suppress_email_delivery": true
    },
    "override_cancellation_confirmation_email": true,
    "override_order_confirmation_email": true,
    "override_return_confirmation_email": true,
    "override_shipment_confirmation_email": true,
    "pay_later_options": {
      "billing_address": "do not show",
      "purchase_order_number": "do not show",
      "reference_number": "string"
    },
    "restocking_fee_product_id": "string",
    "return_confirmation_settings": {
      "email": {
        "bcc": "string",
        "body": "string",
        "cc": "string",
        "from": "string",
        "from_name": "string",
        "reply_to": "string",
        "subject": "string"
      },
      "suppress_email_delivery": true
    },
    "sell_certification_courses": true,
    "sell_certification_exams": true,
    "sell_event_registration_packages": true,
    "sell_membership_packages": true,
    "shipment_confirmation_settings": {
      "email": {
        "bcc": "string",
        "body": "string",
        "cc": "string",
        "from": "string",
        "from_name": "string",
        "reply_to": "string",
        "subject": "string"
      },
      "suppress_email_delivery": true
    },
    "special_instructions": "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,
    "use_pro_forma_invoices": true
  }'

Responses

The store was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

bank_account_idstring(Bank Account)required

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

bill_my_organization_optionsobject(Bill My Organization Options)

bill_my_parent_organization_optionsobject(Bill My Parent Organization Options)

business_unit_idstring(Business Unit)required

The business unit of the store

cancellation_confirmation_settingsobject(Cancellation Confirmation Settings)required

cancellation_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

cancellation_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

category_idsArray of strings(Categories)required

category_inclusionstring(Category Inclusion)

Enum"include all but specified""include all categories""include only specified"

certification_course_optionsobject(Certification Course Options)required

certification_course_options.category_namestring(Category Name)

The optional name of the category

certification_course_options.course_idsArray of Courses (strings)(Courses)>= 0 items

One of:

>= 0 items

certification_course_options.course_restrictionstring(Course Restriction)

Enum"exclude""include""none"

certification_course_options.course_type_idsArray of Course Types (strings)(Course Types)>= 0 items

One of:

>= 0 items

certification_course_options.course_type_restrictionstring(Course Type Restriction)

Enum"exclude""include""none"

certification_exam_optionsobject(Certification Exam Options)required

certification_exam_options.category_namestring(Category Name)

The optional name of the category

certification_exam_options.exam_idsArray of Exams (strings)(Exams)>= 0 items

One of:

>= 0 items

certification_exam_options.exam_restrictionstring(Exam Restriction)

Enum"exclude""include""none"

certification_exam_options.image_uristring(Image Uri)

The image to display in the store for exams

checkout_donation_optionsobject(Checkout Donation Options)required

checkout_donation_options.simple_checkout_donation_optionsSimple Checkout Donation Options (object)(Simple Checkout Donation Options)

One of:

checkout_donation_options.typestring(Type)

Value"simple"

credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

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

credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

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

credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

Enum"disabled""enabled""range"

credit_card_processing_fee_modestring(Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"

credit_card_processing_fee_optionsobject(Credit Card Processing Fee Options)required

credit_card_processing_fee_options.fee_percentagenumber(float)(Fee Percentage)required

The fee percentage to charge for credit card processing

credit_card_processing_fee_options.maximum_feenumber(float)(Maximum Fee)

The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged

credit_card_processing_fee_options.minimum_feenumber(float)(Minimum Fee)

The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged

credit_card_processing_fee_options.product_idstring(Product)required

The misc product to use for the credit card processing

credit_card_processing_fee_options.prompt_sub_textstring(Prompt Sub Text)

Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used

credit_card_processing_fee_options.prompt_textstring(Prompt Text)

The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used

default_certification_course_image_uristring(Default Certification Course Image Uri)

The image to display in the store for courses

default_certification_exam_image_uristring(Default Certification Exam Image Uri)

The image to display in the store for exams

default_event_registration_image_uristring(Default Event Registration Image Uri)

The image to display in the store for event registrations

default_membership_package_image_uristring(Default Membership Package Image Uri)

The image to display in the store for membership

default_merchandise_image_uristring(Default Merchandise Image Uri)

The default image to show for products with no image

default_product_sortstring(Default Product Sort)

Enum"alphabetical ascending""alphabetical descending""newest items""price ascending""price descending""sort order"

disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

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

enable_bill_my_organizationboolean(Enable Bill My Organization)

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

enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

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

enable_donations_at_checkoutboolean(Enable Donations At Checkout)

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

enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

enable_pay_laterboolean(Enable Pay Later)

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

enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

event_registration_optionsobject(Event Registration Options)required

event_registration_options.category_namestring(Category Name)

The optional name of the category

event_registration_options.event_idsArray of Events (strings)(Events)>= 0 items

One of:

>= 0 items

event_registration_options.event_restrictionstring(Event Restriction)

Enum"exclude""include""none"

event_registration_options.event_type_idsArray of Event Types (strings)(Event Types)>= 0 items

One of:

>= 0 items

event_registration_options.event_type_restrictionstring(Event Type Restriction)

Enum"exclude""include""none"

home_category_idstring(Home Category)

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

idstring(ID)^[\w|-]+$required

The unique, string identifier of this store

installment_plan_optionsArray of objectsnon-emptyrequired

installment_plan_options[].additional_costnumber(double)(Additional Cost)

The additional cost of the installment plan

installment_plan_options[].installment_plan_idstring(Installment Plan)required

The installment plan that this product supports

installment_plan_options[].is_defaultboolean(Is Default)

Whether this is the default installment plan option

invoice_payment_terms_idstring(Invoice Payment Terms)

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

invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

invoice_terms_idstring(Invoice Terms)

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

is_activeboolean(Is Active)

Whether or not this store is active

membership_package_optionsobject(Membership Package Options)required

membership_package_options.category_namestring(Category Name)

The optional name of the category

membership_package_options.membership_package_idsArray of Membership Packages (strings)(Membership Packages)>= 0 items

One of:

>= 0 items

membership_package_options.membership_package_restrictionstring(Membership Package Restriction)

Enum"exclude""include""none"

membership_package_options.membership_type_idsArray of Membership Types (strings)(Membership Types)>= 0 items

One of:

>= 0 items

membership_package_options.membership_type_restrictionstring(Membership Type Restriction)

Enum"exclude""include""none"

merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

namestring(Name)required

The name of the store

order_confirmation_settingsobject(Order Confirmation Settings)required

order_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

order_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

override_cancellation_confirmation_emailboolean(Override Cancellation Confirmation Email)

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

override_order_confirmation_emailboolean(Override Order Confirmation Email)

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

override_return_confirmation_emailboolean(Override Return Confirmation Email)

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

override_shipment_confirmation_emailboolean(Override Shipment Confirmation Email)

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

pay_later_optionsobject(Pay Later Options)

restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

return_confirmation_settingsobject(Return Confirmation Settings)required

return_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

return_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

sell_certification_coursesboolean(Sell Certification Courses)

If set, this store sells certification courses

sell_certification_examsboolean(Sell Certification Exams)

If set, this store sells certification exams

sell_event_registration_packagesboolean(Sell Event Registration Packages)

If set, this store sells event registration packages

sell_membership_packagesboolean(Sell Membership Packages)

If set, this store sells membership packages

shipment_confirmation_settingsobject(Shipment Confirmation Settings)required

shipment_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

shipment_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

special_instructionsstring(Special Instructions)

Instructions shown to the user

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

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

Response

application/json

{
  "allow_customer_to_choose_installment_plan": true,
  "bank_account_id": "string",
  "bill_my_organization_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "bill_my_parent_organization_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "business_unit_id": "string",
  "cancellation_confirmation_settings": {
    "email": { … },
    "suppress_email_delivery": true
  },
  "cancellation_fee_product_id": "string",
  "category_ids": [
    "string"
  ],
  "category_inclusion": "include all but specified",
  "certification_course_options": {
    "category_name": "string",
    "course_ids": { … },
    "course_restriction": "exclude",
    "course_type_ids": { … },
    "course_type_restriction": "exclude"
  },
  "certification_exam_options": {
    "category_name": "string",
    "exam_ids": { … },
    "exam_restriction": "exclude",
    "image_uri": "string"
  },
  "checkout_donation_options": {
    "simple_checkout_donation_options": { … },
    "type": "simple"
  },
  "credit_card_minimum_range_end": 0.1,
  "credit_card_minimum_range_start": 0.1,
  "credit_card_mode": "disabled",
  "credit_card_processing_fee_mode": "charge",
  "credit_card_processing_fee_options": {
    "fee_percentage": 0.1,
    "maximum_fee": 0.1,
    "minimum_fee": 0.1,
    "product_id": "string",
    "prompt_sub_text": "string",
    "prompt_text": "string"
  },
  "default_certification_course_image_uri": "string",
  "default_certification_exam_image_uri": "string",
  "default_event_registration_image_uri": "string",
  "default_membership_package_image_uri": "string",
  "default_merchandise_image_uri": "string",
  "default_product_sort": "alphabetical ascending",
  "disable_electronic_payment_vaulting": true,
  "enable_bill_my_organization": true,
  "enable_bill_my_parent_organization": true,
  "enable_donations_at_checkout": true,
  "enable_electronic_checks": true,
  "enable_pay_later": true,
  "enable_payroll_deduction": true,
  "enable_split_payments": true,
  "event_registration_options": {
    "category_name": "string",
    "event_ids": { … },
    "event_restriction": "exclude",
    "event_type_ids": { … },
    "event_type_restriction": "exclude"
  },
  "home_category_id": "string",
  "id": "string",
  "installment_plan_options": [
    { … }
  ],
  "invoice_payment_terms_id": "string",
  "invoice_template_id": "string",
  "invoice_terms_id": "string",
  "is_active": true,
  "membership_package_options": {
    "category_name": "string",
    "membership_package_ids": { … },
    "membership_package_restriction": "exclude",
    "membership_type_ids": { … },
    "membership_type_restriction": "exclude"
  },
  "merchant_account_id": "string",
  "name": "string",
  "order_confirmation_settings": {
    "email": { … },
    "suppress_email_delivery": true
  },
  "override_cancellation_confirmation_email": true,
  "override_order_confirmation_email": true,
  "override_return_confirmation_email": true,
  "override_shipment_confirmation_email": true,
  "pay_later_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "restocking_fee_product_id": "string",
  "return_confirmation_settings": {
    "email": { … },
    "suppress_email_delivery": true
  },
  "sell_certification_courses": true,
  "sell_certification_exams": true,
  "sell_event_registration_packages": true,
  "sell_membership_packages": true,
  "shipment_confirmation_settings": {
    "email": { … },
    "suppress_email_delivery": true
  },
  "special_instructions": "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,
  "use_pro_forma_invoices": true
}

Execute Batch Operations

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The batch request

operationsArray of objects

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/stores/{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"
          }
        }
      }
    ]
  }'

Responses

Request completed successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

error_countnumber(float)(Error Count)

Number of error results

resultsArray of objects

success_countnumber(float)(Success Count)

Number of successful results

Response

application/json

{
  "error_count": 0.1,
  "results": [
    { … }
  ],
  "success_count": 0.1
}

Gets the public store info

Request

Gets the public store info

Path

tenantIdstringrequired

The tenant

idstringrequired

The id of the store

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/stores/{tenantId}/public/{id}'

Responses

The store was retrieved

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

bank_account_idstring(Bank Account)required

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

bill_my_organization_optionsobject(Bill My Organization Options)

bill_my_parent_organization_optionsobject(Bill My Parent Organization Options)

business_unit_idstring(Business Unit)required

The business unit of the store

cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

categoriesArray of objects

category_inclusionstring(Category Inclusion)

Enum"include all but specified""include all categories""include only specified"

certification_course_optionsobject(Certification Course Options)required

certification_course_options.category_namestring(Category Name)

The optional name of the category

certification_course_options.course_idsArray of Courses (strings)(Courses)>= 0 items

One of:

>= 0 items

certification_course_options.course_restrictionstring(Course Restriction)

Enum"exclude""include""none"

certification_course_options.course_type_idsArray of Course Types (strings)(Course Types)>= 0 items

One of:

>= 0 items

certification_course_options.course_type_restrictionstring(Course Type Restriction)

Enum"exclude""include""none"

certification_exam_optionsobject(Certification Exam Options)required

certification_exam_options.category_namestring(Category Name)

The optional name of the category

certification_exam_options.exam_idsArray of Exams (strings)(Exams)>= 0 items

One of:

>= 0 items

certification_exam_options.exam_restrictionstring(Exam Restriction)

Enum"exclude""include""none"

certification_exam_options.image_uristring(Image Uri)

The image to display in the store for exams

checkout_donation_optionsobject(Checkout Donation Options)required

checkout_donation_options.simple_checkout_donation_optionsSimple Checkout Donation Options (object)(Simple Checkout Donation Options)

One of:

checkout_donation_options.typestring(Type)

Value"simple"

credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

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

credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

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

credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

Enum"disabled""enabled""range"

credit_card_processing_fee_modestring(Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"

credit_card_processing_fee_optionsobject(Credit Card Processing Fee Options)required

credit_card_processing_fee_options.fee_percentagenumber(float)(Fee Percentage)required

The fee percentage to charge for credit card processing

credit_card_processing_fee_options.maximum_feenumber(float)(Maximum Fee)

The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged

credit_card_processing_fee_options.minimum_feenumber(float)(Minimum Fee)

The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged

credit_card_processing_fee_options.product_idstring(Product)required

The misc product to use for the credit card processing

credit_card_processing_fee_options.prompt_sub_textstring(Prompt Sub Text)

Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used

credit_card_processing_fee_options.prompt_textstring(Prompt Text)

The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used

currency_codestring(Currency Code)

The store currency code

currency_symbolstring(Currency Symbol)

The store currency symbol

default_certification_course_image_uristring(Default Certification Course Image Uri)

The image to display in the store for courses

default_certification_exam_image_uristring(Default Certification Exam Image Uri)

The image to display in the store for exams

default_event_registration_image_uristring(Default Event Registration Image Uri)

The image to display in the store for event registrations

default_membership_package_image_uristring(Default Membership Package Image Uri)

The image to display in the store for membership

default_merchandise_image_uristring(Default Merchandise Image Uri)

The default merchandise image

default_product_sortstring(Default Product Sort)

Enum"alphabetical ascending""alphabetical descending""newest items""price ascending""price descending""sort order"

disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

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

enable_bill_my_organizationboolean(Enable Bill My Organization)

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

enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

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

enable_donations_at_checkoutboolean(Enable Donations At Checkout)

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

enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

enable_pay_laterboolean(Enable Pay Later)

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

enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

event_registration_optionsobject(Event Registration Options)required

event_registration_options.category_namestring(Category Name)

The optional name of the category

event_registration_options.event_idsArray of Events (strings)(Events)>= 0 items

One of:

>= 0 items

event_registration_options.event_restrictionstring(Event Restriction)

Enum"exclude""include""none"

event_registration_options.event_type_idsArray of Event Types (strings)(Event Types)>= 0 items

One of:

>= 0 items

event_registration_options.event_type_restrictionstring(Event Type Restriction)

Enum"exclude""include""none"

home_category_idstring(Home Category)

The home category

idstring(ID)

The id of hte store

installment_plan_optionsArray of objectsnon-emptyrequired

installment_plan_options[].additional_costnumber(double)(Additional Cost)

The additional cost of the installment plan

installment_plan_options[].installment_plan_idstring(Installment Plan)required

The installment plan that this product supports

installment_plan_options[].is_defaultboolean(Is Default)

Whether this is the default installment plan option

invoice_payment_terms_idstring(Invoice Payment Terms)

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

invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

membership_package_optionsobject(Membership Package Options)required

membership_package_options.category_namestring(Category Name)

The optional name of the category

membership_package_options.membership_package_idsArray of Membership Packages (strings)(Membership Packages)>= 0 items

One of:

>= 0 items

membership_package_options.membership_package_restrictionstring(Membership Package Restriction)

Enum"exclude""include""none"

membership_package_options.membership_type_idsArray of Membership Types (strings)(Membership Types)>= 0 items

One of:

>= 0 items

membership_package_options.membership_type_restrictionstring(Membership Type Restriction)

Enum"exclude""include""none"

merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

namestring(Name)

The name of the store

pay_later_optionsobject(Pay Later Options)

restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

sell_certification_coursesboolean(Sell Certification Courses)

If set, this store sells certification courses

sell_certification_examsboolean(Sell Certification Exams)

If set, this store sells certification exams

sell_event_registration_packagesboolean(Sell Event Registration Packages)

If set, this store sells event registration packages

sell_membership_packagesboolean(Sell Membership Packages)

If set, this store sells membership packages

special_instructionsstring(Special Instructions)

Instructions shown to the user

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

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

Response

application/json

{
  "allow_customer_to_choose_installment_plan": true,
  "bank_account_id": "string",
  "bill_my_organization_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "bill_my_parent_organization_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "business_unit_id": "string",
  "cancellation_fee_product_id": "string",
  "categories": [
    { … }
  ],
  "category_inclusion": "include all but specified",
  "certification_course_options": {
    "category_name": "string",
    "course_ids": { … },
    "course_restriction": "exclude",
    "course_type_ids": { … },
    "course_type_restriction": "exclude"
  },
  "certification_exam_options": {
    "category_name": "string",
    "exam_ids": { … },
    "exam_restriction": "exclude",
    "image_uri": "string"
  },
  "checkout_donation_options": {
    "simple_checkout_donation_options": { … },
    "type": "simple"
  },
  "credit_card_minimum_range_end": 0.1,
  "credit_card_minimum_range_start": 0.1,
  "credit_card_mode": "disabled",
  "credit_card_processing_fee_mode": "charge",
  "credit_card_processing_fee_options": {
    "fee_percentage": 0.1,
    "maximum_fee": 0.1,
    "minimum_fee": 0.1,
    "product_id": "string",
    "prompt_sub_text": "string",
    "prompt_text": "string"
  },
  "currency_code": "string",
  "currency_symbol": "string",
  "default_certification_course_image_uri": "string",
  "default_certification_exam_image_uri": "string",
  "default_event_registration_image_uri": "string",
  "default_membership_package_image_uri": "string",
  "default_merchandise_image_uri": "string",
  "default_product_sort": "alphabetical ascending",
  "disable_electronic_payment_vaulting": true,
  "enable_bill_my_organization": true,
  "enable_bill_my_parent_organization": true,
  "enable_donations_at_checkout": true,
  "enable_electronic_checks": true,
  "enable_pay_later": true,
  "enable_payroll_deduction": true,
  "enable_split_payments": true,
  "event_registration_options": {
    "category_name": "string",
    "event_ids": { … },
    "event_restriction": "exclude",
    "event_type_ids": { … },
    "event_type_restriction": "exclude"
  },
  "home_category_id": "string",
  "id": "string",
  "installment_plan_options": [
    { … }
  ],
  "invoice_payment_terms_id": "string",
  "invoice_template_id": "string",
  "membership_package_options": {
    "category_name": "string",
    "membership_package_ids": { … },
    "membership_package_restriction": "exclude",
    "membership_type_ids": { … },
    "membership_type_restriction": "exclude"
  },
  "merchant_account_id": "string",
  "name": "string",
  "pay_later_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "restocking_fee_product_id": "string",
  "sell_certification_courses": true,
  "sell_certification_exams": true,
  "sell_event_registration_packages": true,
  "sell_membership_packages": true,
  "special_instructions": "string",
  "use_pro_forma_invoices": true
}

Returns a store from the system by its ID.

Request

This method will delete a store with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the store to delete.

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

Responses

The store was deleted successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

string

Response

application/json

"string"

Returns a store from the system by its ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the store to return.

Query

fieldsstring

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

consistentReadstring

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

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

Responses

The store was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

bank_account_idstring(Bank Account)required

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

bill_my_organization_optionsobject(Bill My Organization Options)

bill_my_parent_organization_optionsobject(Bill My Parent Organization Options)

business_unit_idstring(Business Unit)required

The business unit of the store

cancellation_confirmation_settingsobject(Cancellation Confirmation Settings)required

cancellation_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

cancellation_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

category_idsArray of strings(Categories)required

category_inclusionstring(Category Inclusion)

Enum"include all but specified""include all categories""include only specified"

certification_course_optionsobject(Certification Course Options)required

certification_course_options.category_namestring(Category Name)

The optional name of the category

certification_course_options.course_idsArray of Courses (strings)(Courses)>= 0 items

One of:

>= 0 items

certification_course_options.course_restrictionstring(Course Restriction)

Enum"exclude""include""none"

certification_course_options.course_type_idsArray of Course Types (strings)(Course Types)>= 0 items

One of:

>= 0 items

certification_course_options.course_type_restrictionstring(Course Type Restriction)

Enum"exclude""include""none"

certification_exam_optionsobject(Certification Exam Options)required

certification_exam_options.category_namestring(Category Name)

The optional name of the category

certification_exam_options.exam_idsArray of Exams (strings)(Exams)>= 0 items

One of:

>= 0 items

certification_exam_options.exam_restrictionstring(Exam Restriction)

Enum"exclude""include""none"

certification_exam_options.image_uristring(Image Uri)

The image to display in the store for exams

checkout_donation_optionsobject(Checkout Donation Options)required

checkout_donation_options.simple_checkout_donation_optionsSimple Checkout Donation Options (object)(Simple Checkout Donation Options)

One of:

checkout_donation_options.typestring(Type)

Value"simple"

credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

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

credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

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

credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

Enum"disabled""enabled""range"

credit_card_processing_fee_modestring(Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"

credit_card_processing_fee_optionsobject(Credit Card Processing Fee Options)required

credit_card_processing_fee_options.fee_percentagenumber(float)(Fee Percentage)required

The fee percentage to charge for credit card processing

credit_card_processing_fee_options.maximum_feenumber(float)(Maximum Fee)

The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged

credit_card_processing_fee_options.minimum_feenumber(float)(Minimum Fee)

The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged

credit_card_processing_fee_options.product_idstring(Product)required

The misc product to use for the credit card processing

credit_card_processing_fee_options.prompt_sub_textstring(Prompt Sub Text)

Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used

credit_card_processing_fee_options.prompt_textstring(Prompt Text)

The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used

default_certification_course_image_uristring(Default Certification Course Image Uri)

The image to display in the store for courses

default_certification_exam_image_uristring(Default Certification Exam Image Uri)

The image to display in the store for exams

default_event_registration_image_uristring(Default Event Registration Image Uri)

The image to display in the store for event registrations

default_membership_package_image_uristring(Default Membership Package Image Uri)

The image to display in the store for membership

default_merchandise_image_uristring(Default Merchandise Image Uri)

The default image to show for products with no image

default_product_sortstring(Default Product Sort)

Enum"alphabetical ascending""alphabetical descending""newest items""price ascending""price descending""sort order"

disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

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

enable_bill_my_organizationboolean(Enable Bill My Organization)

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

enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

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

enable_donations_at_checkoutboolean(Enable Donations At Checkout)

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

enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

enable_pay_laterboolean(Enable Pay Later)

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

enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

event_registration_optionsobject(Event Registration Options)required

event_registration_options.category_namestring(Category Name)

The optional name of the category

event_registration_options.event_idsArray of Events (strings)(Events)>= 0 items

One of:

>= 0 items

event_registration_options.event_restrictionstring(Event Restriction)

Enum"exclude""include""none"

event_registration_options.event_type_idsArray of Event Types (strings)(Event Types)>= 0 items

One of:

>= 0 items

event_registration_options.event_type_restrictionstring(Event Type Restriction)

Enum"exclude""include""none"

home_category_idstring(Home Category)

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

idstring(ID)^[\w|-]+$required

The unique, string identifier of this store

installment_plan_optionsArray of objectsnon-emptyrequired

installment_plan_options[].additional_costnumber(double)(Additional Cost)

The additional cost of the installment plan

installment_plan_options[].installment_plan_idstring(Installment Plan)required

The installment plan that this product supports

installment_plan_options[].is_defaultboolean(Is Default)

Whether this is the default installment plan option

invoice_payment_terms_idstring(Invoice Payment Terms)

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

invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

invoice_terms_idstring(Invoice Terms)

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

is_activeboolean(Is Active)

Whether or not this store is active

membership_package_optionsobject(Membership Package Options)required

membership_package_options.category_namestring(Category Name)

The optional name of the category

membership_package_options.membership_package_idsArray of Membership Packages (strings)(Membership Packages)>= 0 items

One of:

>= 0 items

membership_package_options.membership_package_restrictionstring(Membership Package Restriction)

Enum"exclude""include""none"

membership_package_options.membership_type_idsArray of Membership Types (strings)(Membership Types)>= 0 items

One of:

>= 0 items

membership_package_options.membership_type_restrictionstring(Membership Type Restriction)

Enum"exclude""include""none"

merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

namestring(Name)required

The name of the store

order_confirmation_settingsobject(Order Confirmation Settings)required

order_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

order_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

override_cancellation_confirmation_emailboolean(Override Cancellation Confirmation Email)

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

override_order_confirmation_emailboolean(Override Order Confirmation Email)

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

override_return_confirmation_emailboolean(Override Return Confirmation Email)

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

override_shipment_confirmation_emailboolean(Override Shipment Confirmation Email)

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

pay_later_optionsobject(Pay Later Options)

restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

return_confirmation_settingsobject(Return Confirmation Settings)required

return_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

return_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

sell_certification_coursesboolean(Sell Certification Courses)

If set, this store sells certification courses

sell_certification_examsboolean(Sell Certification Exams)

If set, this store sells certification exams

sell_event_registration_packagesboolean(Sell Event Registration Packages)

If set, this store sells event registration packages

sell_membership_packagesboolean(Sell Membership Packages)

If set, this store sells membership packages

shipment_confirmation_settingsobject(Shipment Confirmation Settings)required

shipment_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

shipment_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

special_instructionsstring(Special Instructions)

Instructions shown to the user

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

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

Response

application/json

{
  "allow_customer_to_choose_installment_plan": true,
  "bank_account_id": "string",
  "bill_my_organization_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "bill_my_parent_organization_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "business_unit_id": "string",
  "cancellation_confirmation_settings": {
    "email": { … },
    "suppress_email_delivery": true
  },
  "cancellation_fee_product_id": "string",
  "category_ids": [
    "string"
  ],
  "category_inclusion": "include all but specified",
  "certification_course_options": {
    "category_name": "string",
    "course_ids": { … },
    "course_restriction": "exclude",
    "course_type_ids": { … },
    "course_type_restriction": "exclude"
  },
  "certification_exam_options": {
    "category_name": "string",
    "exam_ids": { … },
    "exam_restriction": "exclude",
    "image_uri": "string"
  },
  "checkout_donation_options": {
    "simple_checkout_donation_options": { … },
    "type": "simple"
  },
  "credit_card_minimum_range_end": 0.1,
  "credit_card_minimum_range_start": 0.1,
  "credit_card_mode": "disabled",
  "credit_card_processing_fee_mode": "charge",
  "credit_card_processing_fee_options": {
    "fee_percentage": 0.1,
    "maximum_fee": 0.1,
    "minimum_fee": 0.1,
    "product_id": "string",
    "prompt_sub_text": "string",
    "prompt_text": "string"
  },
  "default_certification_course_image_uri": "string",
  "default_certification_exam_image_uri": "string",
  "default_event_registration_image_uri": "string",
  "default_membership_package_image_uri": "string",
  "default_merchandise_image_uri": "string",
  "default_product_sort": "alphabetical ascending",
  "disable_electronic_payment_vaulting": true,
  "enable_bill_my_organization": true,
  "enable_bill_my_parent_organization": true,
  "enable_donations_at_checkout": true,
  "enable_electronic_checks": true,
  "enable_pay_later": true,
  "enable_payroll_deduction": true,
  "enable_split_payments": true,
  "event_registration_options": {
    "category_name": "string",
    "event_ids": { … },
    "event_restriction": "exclude",
    "event_type_ids": { … },
    "event_type_restriction": "exclude"
  },
  "home_category_id": "string",
  "id": "string",
  "installment_plan_options": [
    { … }
  ],
  "invoice_payment_terms_id": "string",
  "invoice_template_id": "string",
  "invoice_terms_id": "string",
  "is_active": true,
  "membership_package_options": {
    "category_name": "string",
    "membership_package_ids": { … },
    "membership_package_restriction": "exclude",
    "membership_type_ids": { … },
    "membership_type_restriction": "exclude"
  },
  "merchant_account_id": "string",
  "name": "string",
  "order_confirmation_settings": {
    "email": { … },
    "suppress_email_delivery": true
  },
  "override_cancellation_confirmation_email": true,
  "override_order_confirmation_email": true,
  "override_return_confirmation_email": true,
  "override_shipment_confirmation_email": true,
  "pay_later_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "restocking_fee_product_id": "string",
  "return_confirmation_settings": {
    "email": { … },
    "suppress_email_delivery": true
  },
  "sell_certification_courses": true,
  "sell_certification_exams": true,
  "sell_event_registration_packages": true,
  "sell_membership_packages": true,
  "shipment_confirmation_settings": {
    "email": { … },
    "suppress_email_delivery": true
  },
  "special_instructions": "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,
  "use_pro_forma_invoices": true
}

Partially updates a store with the specified ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the store to patch.

Bodyapplication/jsonrequired

The patch directives conforming to RFC 6902.

Array [

opstring(Op)required

The operation

Enum"add""copy""move""remove""replace""test"

pathstring(Path)required

The JSON path

valuestring(Value)

]

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

Responses

The store was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

bank_account_idstring(Bank Account)required

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

bill_my_organization_optionsobject(Bill My Organization Options)

bill_my_parent_organization_optionsobject(Bill My Parent Organization Options)

business_unit_idstring(Business Unit)required

The business unit of the store

cancellation_confirmation_settingsobject(Cancellation Confirmation Settings)required

cancellation_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

cancellation_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

category_idsArray of strings(Categories)required

category_inclusionstring(Category Inclusion)

Enum"include all but specified""include all categories""include only specified"

certification_course_optionsobject(Certification Course Options)required

certification_course_options.category_namestring(Category Name)

The optional name of the category

certification_course_options.course_idsArray of Courses (strings)(Courses)>= 0 items

One of:

>= 0 items

certification_course_options.course_restrictionstring(Course Restriction)

Enum"exclude""include""none"

certification_course_options.course_type_idsArray of Course Types (strings)(Course Types)>= 0 items

One of:

>= 0 items

certification_course_options.course_type_restrictionstring(Course Type Restriction)

Enum"exclude""include""none"

certification_exam_optionsobject(Certification Exam Options)required

certification_exam_options.category_namestring(Category Name)

The optional name of the category

certification_exam_options.exam_idsArray of Exams (strings)(Exams)>= 0 items

One of:

>= 0 items

certification_exam_options.exam_restrictionstring(Exam Restriction)

Enum"exclude""include""none"

certification_exam_options.image_uristring(Image Uri)

The image to display in the store for exams

checkout_donation_optionsobject(Checkout Donation Options)required

checkout_donation_options.simple_checkout_donation_optionsSimple Checkout Donation Options (object)(Simple Checkout Donation Options)

One of:

checkout_donation_options.typestring(Type)

Value"simple"

credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

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

credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

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

credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

Enum"disabled""enabled""range"

credit_card_processing_fee_modestring(Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"

credit_card_processing_fee_optionsobject(Credit Card Processing Fee Options)required

credit_card_processing_fee_options.fee_percentagenumber(float)(Fee Percentage)required

The fee percentage to charge for credit card processing

credit_card_processing_fee_options.maximum_feenumber(float)(Maximum Fee)

The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged

credit_card_processing_fee_options.minimum_feenumber(float)(Minimum Fee)

The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged

credit_card_processing_fee_options.product_idstring(Product)required

The misc product to use for the credit card processing

credit_card_processing_fee_options.prompt_sub_textstring(Prompt Sub Text)

Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used

credit_card_processing_fee_options.prompt_textstring(Prompt Text)

The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used

default_certification_course_image_uristring(Default Certification Course Image Uri)

The image to display in the store for courses

default_certification_exam_image_uristring(Default Certification Exam Image Uri)

The image to display in the store for exams

default_event_registration_image_uristring(Default Event Registration Image Uri)

The image to display in the store for event registrations

default_membership_package_image_uristring(Default Membership Package Image Uri)

The image to display in the store for membership

default_merchandise_image_uristring(Default Merchandise Image Uri)

The default image to show for products with no image

default_product_sortstring(Default Product Sort)

Enum"alphabetical ascending""alphabetical descending""newest items""price ascending""price descending""sort order"

disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

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

enable_bill_my_organizationboolean(Enable Bill My Organization)

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

enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

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

enable_donations_at_checkoutboolean(Enable Donations At Checkout)

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

enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

enable_pay_laterboolean(Enable Pay Later)

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

enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

event_registration_optionsobject(Event Registration Options)required

event_registration_options.category_namestring(Category Name)

The optional name of the category

event_registration_options.event_idsArray of Events (strings)(Events)>= 0 items

One of:

>= 0 items

event_registration_options.event_restrictionstring(Event Restriction)

Enum"exclude""include""none"

event_registration_options.event_type_idsArray of Event Types (strings)(Event Types)>= 0 items

One of:

>= 0 items

event_registration_options.event_type_restrictionstring(Event Type Restriction)

Enum"exclude""include""none"

home_category_idstring(Home Category)

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

idstring(ID)^[\w|-]+$required

The unique, string identifier of this store

installment_plan_optionsArray of objectsnon-emptyrequired

installment_plan_options[].additional_costnumber(double)(Additional Cost)

The additional cost of the installment plan

installment_plan_options[].installment_plan_idstring(Installment Plan)required

The installment plan that this product supports

installment_plan_options[].is_defaultboolean(Is Default)

Whether this is the default installment plan option

invoice_payment_terms_idstring(Invoice Payment Terms)

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

invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

invoice_terms_idstring(Invoice Terms)

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

is_activeboolean(Is Active)

Whether or not this store is active

membership_package_optionsobject(Membership Package Options)required

membership_package_options.category_namestring(Category Name)

The optional name of the category

membership_package_options.membership_package_idsArray of Membership Packages (strings)(Membership Packages)>= 0 items

One of:

>= 0 items

membership_package_options.membership_package_restrictionstring(Membership Package Restriction)

Enum"exclude""include""none"

membership_package_options.membership_type_idsArray of Membership Types (strings)(Membership Types)>= 0 items

One of:

>= 0 items

membership_package_options.membership_type_restrictionstring(Membership Type Restriction)

Enum"exclude""include""none"

merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

namestring(Name)required

The name of the store

order_confirmation_settingsobject(Order Confirmation Settings)required

order_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

order_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

override_cancellation_confirmation_emailboolean(Override Cancellation Confirmation Email)

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

override_order_confirmation_emailboolean(Override Order Confirmation Email)

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

override_return_confirmation_emailboolean(Override Return Confirmation Email)

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

override_shipment_confirmation_emailboolean(Override Shipment Confirmation Email)

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

pay_later_optionsobject(Pay Later Options)

restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

return_confirmation_settingsobject(Return Confirmation Settings)required

return_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

return_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

sell_certification_coursesboolean(Sell Certification Courses)

If set, this store sells certification courses

sell_certification_examsboolean(Sell Certification Exams)

If set, this store sells certification exams

sell_event_registration_packagesboolean(Sell Event Registration Packages)

If set, this store sells event registration packages

sell_membership_packagesboolean(Sell Membership Packages)

If set, this store sells membership packages

shipment_confirmation_settingsobject(Shipment Confirmation Settings)required

shipment_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

shipment_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

special_instructionsstring(Special Instructions)

Instructions shown to the user

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

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

Response

application/json

{
  "allow_customer_to_choose_installment_plan": true,
  "bank_account_id": "string",
  "bill_my_organization_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "bill_my_parent_organization_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "business_unit_id": "string",
  "cancellation_confirmation_settings": {
    "email": { … },
    "suppress_email_delivery": true
  },
  "cancellation_fee_product_id": "string",
  "category_ids": [
    "string"
  ],
  "category_inclusion": "include all but specified",
  "certification_course_options": {
    "category_name": "string",
    "course_ids": { … },
    "course_restriction": "exclude",
    "course_type_ids": { … },
    "course_type_restriction": "exclude"
  },
  "certification_exam_options": {
    "category_name": "string",
    "exam_ids": { … },
    "exam_restriction": "exclude",
    "image_uri": "string"
  },
  "checkout_donation_options": {
    "simple_checkout_donation_options": { … },
    "type": "simple"
  },
  "credit_card_minimum_range_end": 0.1,
  "credit_card_minimum_range_start": 0.1,
  "credit_card_mode": "disabled",
  "credit_card_processing_fee_mode": "charge",
  "credit_card_processing_fee_options": {
    "fee_percentage": 0.1,
    "maximum_fee": 0.1,
    "minimum_fee": 0.1,
    "product_id": "string",
    "prompt_sub_text": "string",
    "prompt_text": "string"
  },
  "default_certification_course_image_uri": "string",
  "default_certification_exam_image_uri": "string",
  "default_event_registration_image_uri": "string",
  "default_membership_package_image_uri": "string",
  "default_merchandise_image_uri": "string",
  "default_product_sort": "alphabetical ascending",
  "disable_electronic_payment_vaulting": true,
  "enable_bill_my_organization": true,
  "enable_bill_my_parent_organization": true,
  "enable_donations_at_checkout": true,
  "enable_electronic_checks": true,
  "enable_pay_later": true,
  "enable_payroll_deduction": true,
  "enable_split_payments": true,
  "event_registration_options": {
    "category_name": "string",
    "event_ids": { … },
    "event_restriction": "exclude",
    "event_type_ids": { … },
    "event_type_restriction": "exclude"
  },
  "home_category_id": "string",
  "id": "string",
  "installment_plan_options": [
    { … }
  ],
  "invoice_payment_terms_id": "string",
  "invoice_template_id": "string",
  "invoice_terms_id": "string",
  "is_active": true,
  "membership_package_options": {
    "category_name": "string",
    "membership_package_ids": { … },
    "membership_package_restriction": "exclude",
    "membership_type_ids": { … },
    "membership_type_restriction": "exclude"
  },
  "merchant_account_id": "string",
  "name": "string",
  "order_confirmation_settings": {
    "email": { … },
    "suppress_email_delivery": true
  },
  "override_cancellation_confirmation_email": true,
  "override_order_confirmation_email": true,
  "override_return_confirmation_email": true,
  "override_shipment_confirmation_email": true,
  "pay_later_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "restocking_fee_product_id": "string",
  "return_confirmation_settings": {
    "email": { … },
    "suppress_email_delivery": true
  },
  "sell_certification_courses": true,
  "sell_certification_exams": true,
  "sell_event_registration_packages": true,
  "sell_membership_packages": true,
  "shipment_confirmation_settings": {
    "email": { … },
    "suppress_email_delivery": true
  },
  "special_instructions": "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,
  "use_pro_forma_invoices": true
}

Updates a store with the specified ID.

Request

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

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the store to update.

Bodyapplication/jsonrequired

The updated store that will be saved.

allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

bank_account_idstring(Bank Account)required

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

bill_my_organization_optionsobject(Bill My Organization Options)

bill_my_parent_organization_optionsobject(Bill My Parent Organization Options)

business_unit_idstring(Business Unit)required

The business unit of the store

cancellation_confirmation_settingsobject(Cancellation Confirmation Settings)required

cancellation_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

cancellation_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

category_idsArray of strings(Categories)required

category_inclusionstring(Category Inclusion)

Enum"include all but specified""include all categories""include only specified"

certification_course_optionsobject(Certification Course Options)required

certification_course_options.category_namestring(Category Name)

The optional name of the category

certification_course_options.course_idsArray of Courses (strings)(Courses)>= 0 items

One of:

>= 0 items

certification_course_options.course_restrictionstring(Course Restriction)

Enum"exclude""include""none"

certification_course_options.course_type_idsArray of Course Types (strings)(Course Types)>= 0 items

One of:

>= 0 items

certification_course_options.course_type_restrictionstring(Course Type Restriction)

Enum"exclude""include""none"

certification_exam_optionsobject(Certification Exam Options)required

certification_exam_options.category_namestring(Category Name)

The optional name of the category

certification_exam_options.exam_idsArray of Exams (strings)(Exams)>= 0 items

One of:

>= 0 items

certification_exam_options.exam_restrictionstring(Exam Restriction)

Enum"exclude""include""none"

certification_exam_options.image_uristring(Image Uri)

The image to display in the store for exams

checkout_donation_optionsobject(Checkout Donation Options)required

checkout_donation_options.simple_checkout_donation_optionsSimple Checkout Donation Options (object)(Simple Checkout Donation Options)

One of:

checkout_donation_options.typestring(Type)

Value"simple"

credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

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

credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

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

credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

Enum"disabled""enabled""range"

credit_card_processing_fee_modestring(Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"

credit_card_processing_fee_optionsobject(Credit Card Processing Fee Options)required

credit_card_processing_fee_options.fee_percentagenumber(float)(Fee Percentage)required

The fee percentage to charge for credit card processing

credit_card_processing_fee_options.maximum_feenumber(float)(Maximum Fee)

The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged

credit_card_processing_fee_options.minimum_feenumber(float)(Minimum Fee)

The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged

credit_card_processing_fee_options.product_idstring(Product)required

The misc product to use for the credit card processing

credit_card_processing_fee_options.prompt_sub_textstring(Prompt Sub Text)

Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used

credit_card_processing_fee_options.prompt_textstring(Prompt Text)

The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used

default_certification_course_image_uristring(Default Certification Course Image Uri)

The image to display in the store for courses

default_certification_exam_image_uristring(Default Certification Exam Image Uri)

The image to display in the store for exams

default_event_registration_image_uristring(Default Event Registration Image Uri)

The image to display in the store for event registrations

default_membership_package_image_uristring(Default Membership Package Image Uri)

The image to display in the store for membership

default_merchandise_image_uristring(Default Merchandise Image Uri)

The default image to show for products with no image

default_product_sortstring(Default Product Sort)

Enum"alphabetical ascending""alphabetical descending""newest items""price ascending""price descending""sort order"

disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

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

enable_bill_my_organizationboolean(Enable Bill My Organization)

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

enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

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

enable_donations_at_checkoutboolean(Enable Donations At Checkout)

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

enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

enable_pay_laterboolean(Enable Pay Later)

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

enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

event_registration_optionsobject(Event Registration Options)required

event_registration_options.category_namestring(Category Name)

The optional name of the category

event_registration_options.event_idsArray of Events (strings)(Events)>= 0 items

One of:

>= 0 items

event_registration_options.event_restrictionstring(Event Restriction)

Enum"exclude""include""none"

event_registration_options.event_type_idsArray of Event Types (strings)(Event Types)>= 0 items

One of:

>= 0 items

event_registration_options.event_type_restrictionstring(Event Type Restriction)

Enum"exclude""include""none"

home_category_idstring(Home Category)

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

idstring(ID)^[\w|-]+$required

The unique, string identifier of this store

installment_plan_optionsArray of objectsnon-emptyrequired

installment_plan_options[].additional_costnumber(double)(Additional Cost)

The additional cost of the installment plan

installment_plan_options[].installment_plan_idstring(Installment Plan)required

The installment plan that this product supports

installment_plan_options[].is_defaultboolean(Is Default)

Whether this is the default installment plan option

invoice_payment_terms_idstring(Invoice Payment Terms)

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

invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

invoice_terms_idstring(Invoice Terms)

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

is_activeboolean(Is Active)

Whether or not this store is active

membership_package_optionsobject(Membership Package Options)required

membership_package_options.category_namestring(Category Name)

The optional name of the category

membership_package_options.membership_package_idsArray of Membership Packages (strings)(Membership Packages)>= 0 items

One of:

>= 0 items

membership_package_options.membership_package_restrictionstring(Membership Package Restriction)

Enum"exclude""include""none"

membership_package_options.membership_type_idsArray of Membership Types (strings)(Membership Types)>= 0 items

One of:

>= 0 items

membership_package_options.membership_type_restrictionstring(Membership Type Restriction)

Enum"exclude""include""none"

merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

namestring(Name)required

The name of the store

order_confirmation_settingsobject(Order Confirmation Settings)required

order_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

order_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

override_cancellation_confirmation_emailboolean(Override Cancellation Confirmation Email)

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

override_order_confirmation_emailboolean(Override Order Confirmation Email)

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

override_return_confirmation_emailboolean(Override Return Confirmation Email)

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

override_shipment_confirmation_emailboolean(Override Shipment Confirmation Email)

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

pay_later_optionsobject(Pay Later Options)

restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

return_confirmation_settingsobject(Return Confirmation Settings)required

return_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

return_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

sell_certification_coursesboolean(Sell Certification Courses)

If set, this store sells certification courses

sell_certification_examsboolean(Sell Certification Exams)

If set, this store sells certification exams

sell_event_registration_packagesboolean(Sell Event Registration Packages)

If set, this store sells event registration packages

sell_membership_packagesboolean(Sell Membership Packages)

If set, this store sells membership packages

shipment_confirmation_settingsobject(Shipment Confirmation Settings)required

shipment_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

shipment_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

special_instructionsstring(Special Instructions)

Instructions shown to the user

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

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

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/commerce/commerce-v1/stores/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "allow_customer_to_choose_installment_plan": true,
    "bank_account_id": "string",
    "bill_my_organization_options": {
      "billing_address": "do not show",
      "purchase_order_number": "do not show",
      "reference_number": "string"
    },
    "bill_my_parent_organization_options": {
      "billing_address": "do not show",
      "purchase_order_number": "do not show",
      "reference_number": "string"
    },
    "business_unit_id": "string",
    "cancellation_confirmation_settings": {
      "email": {
        "bcc": "string",
        "body": "string",
        "cc": "string",
        "from": "string",
        "from_name": "string",
        "reply_to": "string",
        "subject": "string"
      },
      "suppress_email_delivery": true
    },
    "cancellation_fee_product_id": "string",
    "category_ids": [
      "string"
    ],
    "category_inclusion": "include all but specified",
    "certification_course_options": {
      "category_name": "string",
      "course_ids": {
        "0": "string"
      },
      "course_restriction": "exclude",
      "course_type_ids": {
        "0": "string"
      },
      "course_type_restriction": "exclude"
    },
    "certification_exam_options": {
      "category_name": "string",
      "exam_ids": {
        "0": "string"
      },
      "exam_restriction": "exclude",
      "image_uri": "string"
    },
    "checkout_donation_options": {
      "simple_checkout_donation_options": {
        "allow_user_to_specify_custom_amount": true,
        "donation_ask_text": "string",
        "donation_denominations": [
          0.1
        ],
        "donation_information": "string",
        "donation_product_id": "string",
        "override_donation_denominations": true,
        "suggested_donation": 0.1
      },
      "type": "simple"
    },
    "credit_card_minimum_range_end": 0.1,
    "credit_card_minimum_range_start": 0.1,
    "credit_card_mode": "disabled",
    "credit_card_processing_fee_mode": "charge",
    "credit_card_processing_fee_options": {
      "fee_percentage": 0.1,
      "maximum_fee": 0.1,
      "minimum_fee": 0.1,
      "product_id": "string",
      "prompt_sub_text": "string",
      "prompt_text": "string"
    },
    "default_certification_course_image_uri": "string",
    "default_certification_exam_image_uri": "string",
    "default_event_registration_image_uri": "string",
    "default_membership_package_image_uri": "string",
    "default_merchandise_image_uri": "string",
    "default_product_sort": "alphabetical ascending",
    "disable_electronic_payment_vaulting": true,
    "enable_bill_my_organization": true,
    "enable_bill_my_parent_organization": true,
    "enable_donations_at_checkout": true,
    "enable_electronic_checks": true,
    "enable_pay_later": true,
    "enable_payroll_deduction": true,
    "enable_split_payments": true,
    "event_registration_options": {
      "category_name": "string",
      "event_ids": {
        "0": "string"
      },
      "event_restriction": "exclude",
      "event_type_ids": {
        "0": "string"
      },
      "event_type_restriction": "exclude"
    },
    "home_category_id": "string",
    "id": "string",
    "installment_plan_options": [
      {
        "additional_cost": 0.1,
        "installment_plan_id": "string",
        "is_default": true
      }
    ],
    "invoice_payment_terms_id": "string",
    "invoice_template_id": "string",
    "invoice_terms_id": "string",
    "is_active": true,
    "membership_package_options": {
      "category_name": "string",
      "membership_package_ids": {
        "0": "string"
      },
      "membership_package_restriction": "exclude",
      "membership_type_ids": {
        "0": "string"
      },
      "membership_type_restriction": "exclude"
    },
    "merchant_account_id": "string",
    "name": "string",
    "order_confirmation_settings": {
      "email": {
        "bcc": "string",
        "body": "string",
        "cc": "string",
        "from": "string",
        "from_name": "string",
        "reply_to": "string",
        "subject": "string"
      },
      "suppress_email_delivery": true
    },
    "override_cancellation_confirmation_email": true,
    "override_order_confirmation_email": true,
    "override_return_confirmation_email": true,
    "override_shipment_confirmation_email": true,
    "pay_later_options": {
      "billing_address": "do not show",
      "purchase_order_number": "do not show",
      "reference_number": "string"
    },
    "restocking_fee_product_id": "string",
    "return_confirmation_settings": {
      "email": {
        "bcc": "string",
        "body": "string",
        "cc": "string",
        "from": "string",
        "from_name": "string",
        "reply_to": "string",
        "subject": "string"
      },
      "suppress_email_delivery": true
    },
    "sell_certification_courses": true,
    "sell_certification_exams": true,
    "sell_event_registration_packages": true,
    "sell_membership_packages": true,
    "shipment_confirmation_settings": {
      "email": {
        "bcc": "string",
        "body": "string",
        "cc": "string",
        "from": "string",
        "from_name": "string",
        "reply_to": "string",
        "subject": "string"
      },
      "suppress_email_delivery": true
    },
    "special_instructions": "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,
    "use_pro_forma_invoices": true
  }'

Responses

The store was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

bank_account_idstring(Bank Account)required

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

bill_my_organization_optionsobject(Bill My Organization Options)

bill_my_parent_organization_optionsobject(Bill My Parent Organization Options)

business_unit_idstring(Business Unit)required

The business unit of the store

cancellation_confirmation_settingsobject(Cancellation Confirmation Settings)required

cancellation_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

cancellation_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

category_idsArray of strings(Categories)required

category_inclusionstring(Category Inclusion)

Enum"include all but specified""include all categories""include only specified"

certification_course_optionsobject(Certification Course Options)required

certification_course_options.category_namestring(Category Name)

The optional name of the category

certification_course_options.course_idsArray of Courses (strings)(Courses)>= 0 items

One of:

>= 0 items

certification_course_options.course_restrictionstring(Course Restriction)

Enum"exclude""include""none"

certification_course_options.course_type_idsArray of Course Types (strings)(Course Types)>= 0 items

One of:

>= 0 items

certification_course_options.course_type_restrictionstring(Course Type Restriction)

Enum"exclude""include""none"

certification_exam_optionsobject(Certification Exam Options)required

certification_exam_options.category_namestring(Category Name)

The optional name of the category

certification_exam_options.exam_idsArray of Exams (strings)(Exams)>= 0 items

One of:

>= 0 items

certification_exam_options.exam_restrictionstring(Exam Restriction)

Enum"exclude""include""none"

certification_exam_options.image_uristring(Image Uri)

The image to display in the store for exams

checkout_donation_optionsobject(Checkout Donation Options)required

checkout_donation_options.simple_checkout_donation_optionsSimple Checkout Donation Options (object)(Simple Checkout Donation Options)

One of:

checkout_donation_options.typestring(Type)

Value"simple"

credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

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

credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

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

credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

Enum"disabled""enabled""range"

credit_card_processing_fee_modestring(Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"

credit_card_processing_fee_optionsobject(Credit Card Processing Fee Options)required

credit_card_processing_fee_options.fee_percentagenumber(float)(Fee Percentage)required

The fee percentage to charge for credit card processing

credit_card_processing_fee_options.maximum_feenumber(float)(Maximum Fee)

The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged

credit_card_processing_fee_options.minimum_feenumber(float)(Minimum Fee)

The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged

credit_card_processing_fee_options.product_idstring(Product)required

The misc product to use for the credit card processing

credit_card_processing_fee_options.prompt_sub_textstring(Prompt Sub Text)

Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used

credit_card_processing_fee_options.prompt_textstring(Prompt Text)

The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used

default_certification_course_image_uristring(Default Certification Course Image Uri)

The image to display in the store for courses

default_certification_exam_image_uristring(Default Certification Exam Image Uri)

The image to display in the store for exams

default_event_registration_image_uristring(Default Event Registration Image Uri)

The image to display in the store for event registrations

default_membership_package_image_uristring(Default Membership Package Image Uri)

The image to display in the store for membership

default_merchandise_image_uristring(Default Merchandise Image Uri)

The default image to show for products with no image

default_product_sortstring(Default Product Sort)

Enum"alphabetical ascending""alphabetical descending""newest items""price ascending""price descending""sort order"

disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

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

enable_bill_my_organizationboolean(Enable Bill My Organization)

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

enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

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

enable_donations_at_checkoutboolean(Enable Donations At Checkout)

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

enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

enable_pay_laterboolean(Enable Pay Later)

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

enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

event_registration_optionsobject(Event Registration Options)required

event_registration_options.category_namestring(Category Name)

The optional name of the category

event_registration_options.event_idsArray of Events (strings)(Events)>= 0 items

One of:

>= 0 items

event_registration_options.event_restrictionstring(Event Restriction)

Enum"exclude""include""none"

event_registration_options.event_type_idsArray of Event Types (strings)(Event Types)>= 0 items

One of:

>= 0 items

event_registration_options.event_type_restrictionstring(Event Type Restriction)

Enum"exclude""include""none"

home_category_idstring(Home Category)

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

idstring(ID)^[\w|-]+$required

The unique, string identifier of this store

installment_plan_optionsArray of objectsnon-emptyrequired

installment_plan_options[].additional_costnumber(double)(Additional Cost)

The additional cost of the installment plan

installment_plan_options[].installment_plan_idstring(Installment Plan)required

The installment plan that this product supports

installment_plan_options[].is_defaultboolean(Is Default)

Whether this is the default installment plan option

invoice_payment_terms_idstring(Invoice Payment Terms)

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

invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

invoice_terms_idstring(Invoice Terms)

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

is_activeboolean(Is Active)

Whether or not this store is active

membership_package_optionsobject(Membership Package Options)required

membership_package_options.category_namestring(Category Name)

The optional name of the category

membership_package_options.membership_package_idsArray of Membership Packages (strings)(Membership Packages)>= 0 items

One of:

>= 0 items

membership_package_options.membership_package_restrictionstring(Membership Package Restriction)

Enum"exclude""include""none"

membership_package_options.membership_type_idsArray of Membership Types (strings)(Membership Types)>= 0 items

One of:

>= 0 items

membership_package_options.membership_type_restrictionstring(Membership Type Restriction)

Enum"exclude""include""none"

merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

namestring(Name)required

The name of the store

order_confirmation_settingsobject(Order Confirmation Settings)required

order_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

order_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

override_cancellation_confirmation_emailboolean(Override Cancellation Confirmation Email)

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

override_order_confirmation_emailboolean(Override Order Confirmation Email)

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

override_return_confirmation_emailboolean(Override Return Confirmation Email)

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

override_shipment_confirmation_emailboolean(Override Shipment Confirmation Email)

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

pay_later_optionsobject(Pay Later Options)

restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

return_confirmation_settingsobject(Return Confirmation Settings)required

return_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

return_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

sell_certification_coursesboolean(Sell Certification Courses)

If set, this store sells certification courses

sell_certification_examsboolean(Sell Certification Exams)

If set, this store sells certification exams

sell_event_registration_packagesboolean(Sell Event Registration Packages)

If set, this store sells event registration packages

sell_membership_packagesboolean(Sell Membership Packages)

If set, this store sells membership packages

shipment_confirmation_settingsobject(Shipment Confirmation Settings)required

shipment_confirmation_settings.emailEmail (object)(Email)

The email template to send

One of:

The email template to send

shipment_confirmation_settings.suppress_email_deliveryboolean(Suppress Email Delivery)

If true, emails are not sent

special_instructionsstring(Special Instructions)

Instructions shown to the user

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects

sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

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

Response

application/json

{
  "allow_customer_to_choose_installment_plan": true,
  "bank_account_id": "string",
  "bill_my_organization_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "bill_my_parent_organization_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "business_unit_id": "string",
  "cancellation_confirmation_settings": {
    "email": { … },
    "suppress_email_delivery": true
  },
  "cancellation_fee_product_id": "string",
  "category_ids": [
    "string"
  ],
  "category_inclusion": "include all but specified",
  "certification_course_options": {
    "category_name": "string",
    "course_ids": { … },
    "course_restriction": "exclude",
    "course_type_ids": { … },
    "course_type_restriction": "exclude"
  },
  "certification_exam_options": {
    "category_name": "string",
    "exam_ids": { … },
    "exam_restriction": "exclude",
    "image_uri": "string"
  },
  "checkout_donation_options": {
    "simple_checkout_donation_options": { … },
    "type": "simple"
  },
  "credit_card_minimum_range_end": 0.1,
  "credit_card_minimum_range_start": 0.1,
  "credit_card_mode": "disabled",
  "credit_card_processing_fee_mode": "charge",
  "credit_card_processing_fee_options": {
    "fee_percentage": 0.1,
    "maximum_fee": 0.1,
    "minimum_fee": 0.1,
    "product_id": "string",
    "prompt_sub_text": "string",
    "prompt_text": "string"
  },
  "default_certification_course_image_uri": "string",
  "default_certification_exam_image_uri": "string",
  "default_event_registration_image_uri": "string",
  "default_membership_package_image_uri": "string",
  "default_merchandise_image_uri": "string",
  "default_product_sort": "alphabetical ascending",
  "disable_electronic_payment_vaulting": true,
  "enable_bill_my_organization": true,
  "enable_bill_my_parent_organization": true,
  "enable_donations_at_checkout": true,
  "enable_electronic_checks": true,
  "enable_pay_later": true,
  "enable_payroll_deduction": true,
  "enable_split_payments": true,
  "event_registration_options": {
    "category_name": "string",
    "event_ids": { … },
    "event_restriction": "exclude",
    "event_type_ids": { … },
    "event_type_restriction": "exclude"
  },
  "home_category_id": "string",
  "id": "string",
  "installment_plan_options": [
    { … }
  ],
  "invoice_payment_terms_id": "string",
  "invoice_template_id": "string",
  "invoice_terms_id": "string",
  "is_active": true,
  "membership_package_options": {
    "category_name": "string",
    "membership_package_ids": { … },
    "membership_package_restriction": "exclude",
    "membership_type_ids": { … },
    "membership_type_restriction": "exclude"
  },
  "merchant_account_id": "string",
  "name": "string",
  "order_confirmation_settings": {
    "email": { … },
    "suppress_email_delivery": true
  },
  "override_cancellation_confirmation_email": true,
  "override_order_confirmation_email": true,
  "override_return_confirmation_email": true,
  "override_shipment_confirmation_email": true,
  "pay_later_options": {
    "billing_address": "do not show",
    "purchase_order_number": "do not show",
    "reference_number": "string"
  },
  "restocking_fee_product_id": "string",
  "return_confirmation_settings": {
    "email": { … },
    "suppress_email_delivery": true
  },
  "sell_certification_courses": true,
  "sell_certification_exams": true,
  "sell_event_registration_packages": true,
  "sell_membership_packages": true,
  "shipment_confirmation_settings": {
    "email": { … },
    "suppress_email_delivery": true
  },
  "special_instructions": "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,
  "use_pro_forma_invoices": true
}

Tax Classes

Operations

Tax Configurations

Operations

Tax Products

Operations

Warehouse Bins

Operations

Warehouses

Operations

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

Cancellation Fees

Cancellations

Carts

Coupon Code Gen Processes

Coupon Codes

Coupons

Discount Products

Entitlement Types

Entitlements

Inventory Transactions

Merchandise

Orders

Product Categories

Product Confirmation Emails

Product Inventories

Query Definitions

Returns

Settings

Shared Modifier Options

Shared Variant Options

Shipments

Shipping Configurations

Shipping Products

Statistics

Stores

Gets all of the stores in the system.

Request

Responses

Was this helpful?

Creates a new store record that does not already exist.

RequestExpand all

Responses

Was this helpful?

Execute Batch Operations

RequestExpand all

Responses

Was this helpful?

Gets the public store info

Request

Responses

Was this helpful?

Returns a store from the system by its ID.

Request

Responses

Was this helpful?

Returns a store from the system by its ID.

Request

Responses

Was this helpful?

Partially updates a store with the specified ID.

Request

Responses

Was this helpful?

Updates a store with the specified ID.

RequestExpand all

Responses

Was this helpful?

Tax Classes

Tax Configurations

Tax Products

Warehouse Bins

Warehouses

Request

Request

Request