commerce/settings/shipping

Use the shipping subresource to manage settings for the site shipping information, such as origin address information, carrier shipping methods, shipping rate providers, and regions available for shipping.

JSON Example

SiteShippingSettings Properties

Property Description
auditInfo

type: auditInfo

Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data.

auditInfo.createBy

type: string

Identifier of the user that created the object. System created and read only.

auditInfo.createDate

type: DateTime

The date and time in UTC format set when the object was created.

auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

auditInfo.updateDate

type: DateTime

The date and time in UTC format the object was updated most recently.

orderHandlingFee

type: siteShippingHandlingFee

The combined price for all items in the order, including all selected options but excluding any discounts.

siteShippingHandlingFee.amount

type: decimal

The amount of the order-level adjustment, which can be a positive or negative amount.

signatureRequirement

type: siteShippingSignatureRequirement

Properties of the package signature requirements for the site.

siteShippingSignatureRequirement.isSignatureRequired

type: bool

If true, this site requires signatures on shipments for orders that exceed the minimum value threshold.

siteShippingSignatureRequirement.minimumValueThreshold

type: decimal

The minimum order amount that requires a signature on shipments. For example, if you want to require customer signatures on all orders over $5,000, the MinimumValueThreshold would be 5001.

Operations

Operation Name Request URI Description
GetSiteShippingSettings GET %3fresponseFields%3d%7bresponseFields%7d

Retrieves a list of the shipping settings configured for a site.