Site Settings Overview

The Site Settings APIs are a collection of resources used to manage settings for sites, checkout, installed applications, locations, shipping, and general settings for a site. For more information about site settings and the associated configurations in the Unified Commerce Admin interface, see the Settings user guides.

Some tips for using different resources of the Site Settings APIs:

  • Use the Cart resource to manage settings for the cart, such as whether to include handling fees in the cost calculations.
  • Use the Checkout Settings resource to specify the site-wide settings that define checkout and order processing behavior. This resource includes subresources for payment settings, customer checkout settings, and order processing settings.
  • Use the Fulfillment Settings resource to define site-wide fulfillment options such as the default backorder duration, rejection actions, and BPM configurations.
  • Use the General Settings resource to define global site settings such as the site name, shipping and email addresses, and logo images. You can block undesirable IP addresses using this resource as well as configure custom routes.
  • Use the Inventory Settings resource to enable or disable inventory jobs and set a preferred time of day for the jobs to run at.
  • Use the Return Settings resource to specify the default return options for processing fees, shipping locations, and label generation.
  • Use the Shipping resource to manage settings for the site shipping information, such as origin address information, carrier shipping methods, shipping rate providers, and regions available for shipping.