Skip to content
Commerce
/
/
Gets the public store inf...

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_exam_optionsobject(Certification Exam Options)required
checkout_donation_optionsobject(Checkout Donation Options)required
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
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
home_category_idstring(Home Category)

The home category

idstring(ID)

The id of hte store

installment_plan_optionsArray of objects, non-emptyrequired
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
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
{
  "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
}