commerce/shipping/admin/profiles/ShippingInclusionRules

Use the ShippingInclusionRules sub-resource to manage your shipping inclusion rules that are associated with a specific shipping profile.

JSON Example

ShippingInclusionRule 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.

id

type: string

Unique identifier of the source property, such as a catalog, discount, order, or email template.

For a product field it will be the name of the field.

For a category ID, must be a positive integer not greater than 2000000. By default, Kibo eCommerce auto-generates a category ID when categories are created. If you want to specify an ID during creation (which preserves category link relationships when migrating tenant data from one sandbox to another), you must also include the useProvidedId query string in the endpoint. For example, api/commerce/catalog/admin/categories/?useProvidedId=true. Then, use the id property to specify the desired category ID.

For a product attribute it will be the Attribute FQN.

For a document, the ID must be specified as a 32 character, case-insensitive, alphanumeric string. You can specify the ID as 32 sequential characters or as groups separated by dashes in the format 8-4-4-4-12. For example, bba0a1a885e2413bb097ceacf7bac366
or
bba0a1a8-85e2-413b-b097-ceacf7bac366.

For email templates, the ID must be one of the following values:
BackInStock
OrderChanged
OrderShipped
OrderFulfillmentDetailsChanged
ShopperLoginCreated
ShopperPasswordReset
ReturnCreated
ReturnAuthorized
ReturnUpdated
ReturnRejected
ReturnCancelled
ReturnClosed
RefundCreated
StoreCreditCreated
StoreCreditUpdated
GiftCardCreated

productTargetRuleCodes

type: list of string

The unique codes of any product target rules associated with the shipping inclusion rule.

sequence

type: int

The numeric order of objects, used by a vocabulary value defined for an extensible attribute, images, and categories.

serviceTypes

type: list of serviceType

An array of service type details that are associated with the shipping inclusion rule.

serviceType.code

type: string

The unique identifier of the object.

serviceType.content

type: serviceTypeLocalizedContent

Localizable content (such as a name and/or description) for an attribute. The content may be localized when displayed according to the locale code specified by the master catalog. Content can include descriptive text for product extensible attributes, catalog-level descriptions (displayed if isContentOverriden is true), product bundles, and customer account notes.

serviceType.serviceTypeLocalizedContent.localeCode

type: string

The two character locale code, per the country code provided. This code determines the localized content to use and display.

serviceType.serviceTypeLocalizedContent.name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

shippingTargetRuleCodes

type: list of string

The unique codes of any shipping target rules associated with the shipping inclusion rule.

Operations

Operation Name Request URI Description
CreateShippingInclusionRule POST %7bprofilecode%7d%2frules%2fshippinginclusions%3fresponseFields%3d%7bresponseFields%7d

Creates a new shipping inclusion rule.

DeleteShippingInclusionRule DELETE %7bprofilecode%7d%2frules%2fshippinginclusions%2f%7bid%7d

Deletes the specified shipping inclusion rule.

GetShippingInclusionRule GET %7bprofilecode%7d%2frules%2fshippinginclusions%2f%7bid%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of the specified shipping inclusion rule.

GetShippingInclusionRules GET %7bprofilecode%7d%2frules%2fshippinginclusions%3fresponseFields%3d%7bresponseFields%7d

Retrieves a list of shipping inclusion rules and their details.

UpdateShippingInclusionRule PUT %7bprofilecode%7d%2frules%2fshippinginclusions%2f%7bid%7d%3fresponseFields%3d%7bresponseFields%7d

Updates the details of the specified shipping inclusion rule.