commerce/shipping/admin/carriers

Use the Carriers resource to configure and manage your supported shipping carrier configurations.

JSON Example

CarrierConfiguration Properties

Property Description
areCredentialsSet

type: bool

Specifies whether credentials for the carrier are set.

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.

customTableRates

type: list of customTableRate

A list of any custom table rates for the carrier.

customTableRate.content

type: customTableRateContent

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.

customTableRate.customTableRateContent.localeCode

type: string

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

customTableRate.customTableRateContent.name

type: string

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

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

customTableRate.rateType

type: string

The type of the custom rate.

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

enabled

type: bool

Indicates if a capability, function tied to an Arc.js action, application, or price list is enabled for the tenant/site. If true, the capability/application/function/price list is enabled for the tenant. System-supplied and read-only with the exception of functions tied to an Arc.js action and price lists.

enabledForReturns

type: bool

Specifies whether the carrier is enabled for creating RMA labels.

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

settings

type: list of setting

Wrapper for a group of properties such as a label that includes a value and a locale code, audit information, and a key-value pair.

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

setting.auditInfo.createBy

type: string

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

setting.auditInfo.createDate

type: DateTime

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

setting.auditInfo.updateBy

type: string

Identifier of the user that updated the entity most recently.

setting.auditInfo.updateDate

type: DateTime

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

setting.key

type: string

Key used for metadata defined for objects, including extensible attributes, custom attributes associated with a shipping provider, and search synonyms definitions. This content may be user-defined depending on the object and usage.

For search synonym definitions, refer to Synonym Expansion Types for more information about the key usage.

setting.label

type: localizableString

Descriptive text used as a label for objects, such as field names, facets, date ranges, contact information, and package information.

setting.localizableString.localeCode

type: string

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

setting.localizableString.value

type: string

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.

setting.value

type: string

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.

Operations

Operation Name Request URI Description
CreateConfiguration POST %7bcarrierId%7d%3fresponseFields%3d%7bresponseFields%7d

Creates a new carrier configuration.

DeleteConfiguration DELETE %7bcarrierId%7d

Deletes the specified carrier configuration.

GetConfiguration GET %7bcarrierId%7d%3fresponseFields%3d%7bresponseFields%7d

Retrieves the details of the specified carrier configuration.

GetConfigurations GET %3fstartIndex%3d%7bstartIndex%7d%26pageSize%3d%7bpageSize%7d%26sortBy%3d%7bsortBy%7d%26filter%3d%7bfilter%7d%26responseFields%3d%7bresponseFields%7d

Retrieves a list of carrier configurations and their details according to any specified facets, filter criteria, and sort options.

UpdateConfiguration PUT %7bcarrierId%7d%3fresponseFields%3d%7bresponseFields%7d

Updates the details of the specified carrier configuration.