commerce/storefront

type: address

Address information to supply for a contact.

type: string

Physical or mailing address line one. Usually includes the street number and street name or it could be a P.O. Box. Max length: 200.

type: string

Physical or mailing address line two. Usually supplements the main street address with apartment, floor, suite, building, or unit information. Max length: 200.

type: string

Physical or mailing address line three. Max length: 200.

type: string

Physical or mailing address line four. Max length: 200.

type: string

The type of address, which is commercial or residential.

type: string

The entered city or town for the address.

type: string

The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US.

type: bool

Indicates if the address has been validated. If true, the address has been verified by an address validation service.

type: string

The entered zip or postal code for an address.

type: string

The entered state or province for an address.

type: bool

Allow fullfillment with no (or less) stock

type: list of locationAttribute

Collection of attributes that may be paged list or a list, depending on the usage per object and API type.

type: attribute

The custom attribute object for the location.

type: string

The administrator name associated with the object/data.

type: string

Merchant-defined code for an extensible attribute. This code may be used to generate an object's fully qualified name, such as for products.

type: string

The fully qualified name of the attribute. The attributeDefiniteId may be used to generate this name.

type: list of attributeMetadataItem

List of metadata key-value pairs defined for an extensible attribute.

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.

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.

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.

type: string

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

type: DateTime

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

type: string

Identifier of the user that updated the entity most recently.

type: DateTime

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

type: attributeLocalizedContent

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.

type: string

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

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.

type: string

The data type of the source product property, typically of type Bool, DateTime, Number, or String.

type: string

Whether the customer or order attribute appears in Admin only, or in both Admin and the website storefront. Possible values are Admin and AdminAndStorefront.

type: int

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

type: string

The type of input selection used to define a value for the attribute, including Yes/No, Date, DateTime, List, TextBox, or TextArea.

type: bool

Indicates if the object or feature is active.

type: bool

If true, the attribute can have more than one value.

type: bool

Flag used to indicate if this attribute definition is read-only. Once an attribute definition is set to read-only this action cannot be undone.

type: bool

Indicates if the property, attribute, product option, or product extra is required. If true, the object must have a defined value.

type: bool

If true, the attribute is visible in its defined display group.

type: string

The namespace for the accessible APIs and source capabilities in the core of Kibo eCommerce APIs.

type: int

Integer that represents the sequence order of the attribute.

type: attributeValidation

Properties used when validating a value entered for an object, including extensible attributes, products attributes, and database entries.

type: DateTime

The latest possible date and time the extensible attribute can be validated.

type: decimal

The maximum number that can be entered as a value for an extensible attribute.

type: int

The maximum character length possible for a string value entered for an extensible attribute.

type: DateTime

The earliest date and time an extensible attribute can be validated.

type: decimal

The minimum numeric value required to validate an extensible attribute.

type: int

The minimum character length possible for a string value entered for an extensible attribute.

type: string

Regular expression used to process and validate an extensible attribute value that require special formatting, such as phone numbers.

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.

type: list of attributeVocabularyValue

List of valid vocabulary values defined for an attribute.

type: attributeValueLocalizedContent

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.

type: string

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

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.

type: bool

Indicates if the object is hidden or breaks inheritance, primarily used by facets, products, and attribute vocabulary values. For example, if true, the attribute vocabulary value does not appear in the list when defining a value for an attribute.

type: int

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

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.

type: int

Unique identifier of the attribute definition.

type: string

Fully qualified name of the attribute for the order or customer.

type: list of object

List of value data for objects.

type: string

The unique identifier of the object.

type: string

The localized description in text for the object, displayed per the locale code. For example, descriptions are used for product descriptions, attributes, and pre-authorization transaction types.

type: string

The fax number associated with this location.

type: list of fulfillmentType

List of order fulfillment types associated with this location. The location can have fulfillment types of direct ship (DS), in-store pickup (SP), or both.

type: string

The unique identifier of the object.

type: string

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

type: coordinates

The geographical coordinates associated with this location.

type: double

The latitude coordinate of the location.

type: double

The longitude coordinate of the location.

type: bool

Locations is disabled (soft delete)

type: list of locationType

List of location types associated with this location. You can associate individual locations with any number of location types.

type: string

The unique identifier of the object.

type: string

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

type: string

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

type: string

User-entered notation content for an object, used to save information such as payment, return, account, and order notes.

type: string

Phone number information for a contact.

type: regularHours

Array list of standard operating hours for each day of the week this location is open for shopper business.

type: hours

The Friday label array describes the range of hours this location is normally open on Fridays. For example: {"Label": "10:00 AM - 6:00 PM"}.

type: string

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

type: hours

The Monday label array describes the range of hours this location is normally open on Mondays. For example: {"Label": "10:00 AM - 6:00 PM"}.

type: string

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

type: hours

The Saturday label array describes the range of hours this location is normally open on Saturdays. For example: {"Label": "10:00 AM - 6:00 PM"}.

type: string

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

type: hours

The Sunday label array describes the range of hours this location is normally open on Sundays. For example: {"Label": "10:00 AM - 6:00 PM"}.

type: string

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

type: hours

The Thursday label array describes the range of hours this location is normally open on Thursdays. For example: {"Label": "10:00 AM - 6:00 PM"}.

type: string

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

type: hours

The Tuesday label array describes the range of hours this location is normally open on Tuesdays. For example: {"Label": "10:00 AM - 6:00 PM"}.

type: string

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

type: hours

The Wednesday label array describes the range of hours this location is normally open on Wednesdays. For example: {"Label": "10:00 AM - 6:00 PM"}.

type: string

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

type: shippingOriginContact

Properties of a fulfillment contact for the shipping origin address associated with a location.

type: string

The company or organization name entered for a customer account.

type: string

The email address for the customer account and contact. This email may be used for login to the storefront, receiving in-stock product notifications, and subscription mailing lists.

type: string

The full first name of a customer or contact name.

type: string

The full last name or surname of a customer or contact name.

type: string

Character string of the middle name or initial for the customer.

type: string

Collection of phone numbers associated with the shipping origin contact.

type: bool

If true, this location maintains its own product inventory. If the location uses the direct ship fulfillment type, it must also support inventory.

type: list of string

List of tenant-defined tags associated with this location.