commerce/shipping/admin/profiles

Use the Profiles resource to manage your shipping profiles.

JSON Example

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

code

type: string

The unique identifier of the object.

orderHandlingFeeRules

type: list of handlingFeeRule

A list of order handling fee rules and their details.

handlingFeeRule.appliesTo

type: string

Specifies to what the handling fee rule applies.

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

handlingFeeRule.auditInfo.createBy

type: string

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

handlingFeeRule.auditInfo.createDate

type: DateTime

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

handlingFeeRule.auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

handlingFeeRule.auditInfo.updateDate

type: DateTime

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

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

handlingFeeRule.productTargetRuleCodes

type: list of string

The unique codes of any product rules associated with the handling fee.

handlingFeeRule.sequence

type: int

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

handlingFeeRule.serviceTypes

type: list of serviceType

An array of service type details that are associated with the handling fee.

handlingFeeRule.serviceType.code

type: string

The unique identifier of the object.

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

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

handlingFeeRule.serviceType.serviceTypeLocalizedContent.name

type: string

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

handlingFeeRule.shippingTargetRuleCodes

type: list of string

The unique codes of any shipping target rules associated with the handling fee.

handlingFeeRule.value

type: decimal

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

handlingFeeRule.valueType

type: string

An attribute value type is either predefined vocabulary set by the admin during attribute set up, or user-defined with an appropriate type (AdminEntered or ShopperEntered, depending on the user). These types are used by products and attributes. To use a predefined value, you can set this parameter as "predefined" and whatever the admin entered in the Product Attributes > Create New Attribute interface menu will become the predefined value on the attribute. AdminEntered and ShopperEntered are values that are entered rather than system-supplied and are not stored in the database, but captured during a live commerce operations such as during an order.

productHandlingFeeRules

type: list of handlingFeeRule

A list of product handling fee rules and their details.

handlingFeeRule.appliesTo

type: string

Specifies to what the handling fee rule applies.

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

handlingFeeRule.auditInfo.createBy

type: string

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

handlingFeeRule.auditInfo.createDate

type: DateTime

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

handlingFeeRule.auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

handlingFeeRule.auditInfo.updateDate

type: DateTime

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

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

handlingFeeRule.productTargetRuleCodes

type: list of string

The unique codes of any product rules associated with the handling fee.

handlingFeeRule.sequence

type: int

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

handlingFeeRule.serviceTypes

type: list of serviceType

An array of service type details that are associated with the handling fee.

handlingFeeRule.serviceType.code

type: string

The unique identifier of the object.

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

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

handlingFeeRule.serviceType.serviceTypeLocalizedContent.name

type: string

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

handlingFeeRule.shippingTargetRuleCodes

type: list of string

The unique codes of any shipping target rules associated with the handling fee.

handlingFeeRule.value

type: decimal

The value of a property, used by numerous objects within Kibo eCommerce including facets, attributes, products, localized content, metadata, capabilities (Kibo eCommerce and third-party), location inventory adjustment, and more. The value may be a string, integer, or double. Validation may be run against the entered and saved values depending on the object type.

handlingFeeRule.valueType

type: string

An attribute value type is either predefined vocabulary set by the admin during attribute set up, or user-defined with an appropriate type (AdminEntered or ShopperEntered, depending on the user). These types are used by products and attributes. To use a predefined value, you can set this parameter as "predefined" and whatever the admin entered in the Product Attributes > Create New Attribute interface menu will become the predefined value on the attribute. AdminEntered and ShopperEntered are values that are entered rather than system-supplied and are not stored in the database, but captured during a live commerce operations such as during an order.

shippingInclusionRules

type: list of shippingInclusionRule

A list of shipping inclusion rules and their details.

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

shippingInclusionRule.auditInfo.createBy

type: string

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

shippingInclusionRule.auditInfo.createDate

type: DateTime

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

shippingInclusionRule.auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

shippingInclusionRule.auditInfo.updateDate

type: DateTime

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

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

shippingInclusionRule.productTargetRuleCodes

type: list of string

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

shippingInclusionRule.sequence

type: int

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

shippingInclusionRule.serviceTypes

type: list of serviceType

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

shippingInclusionRule.serviceType.code

type: string

The unique identifier of the object.

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

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

shippingInclusionRule.serviceType.serviceTypeLocalizedContent.name

type: string

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

shippingInclusionRule.shippingTargetRuleCodes

type: list of string

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

targetedSiteIds

type: list of int

A list of unique site identifiers that the shipping profile targets.

Operations

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

Retrieves a list of shipping profiles.