Commerce

8.4.x

Store and Warehouse Related Object Types

Stores

A store is a single retail storefront.

  • <state>: The store’s state determines the store’s accessibility. The store’s state can be one of three values:

    • 200 - Open
    • 100 - Restricted Access
    • 0 - Under construction

  • <type>: Description of the stores type in 3 characters. Default value is "B2B".

  • <email_sender_name>: The name used on emails sent from the store to customers.

  • <email_sender_address>: Email address used for emails sent from the store to customers.

  • <credit_card_cvv2_enabled>: Enables or disables the use of CVV2 security for credit card verification

Sample XML:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<stores>
    <store enabled="true" code="SLRWORLD">
        <globalization default_currency="USD" default_locale="en" content_encoding="UTF-8" sub_country="WA" country="US" timeZone="PST8PDT"/>
        <url>http://slrworld.elasticpath.com:8080/storefront</url>
        <name>SLR WORLD</name>
        <state>200</state>
        <type>B2B</type>
        <description>A digital SLR camera demo store.</description>
        <catalog>SLRWORLDCATALOG</catalog>
        <display_out_of_stock>true</display_out_of_stock>
        <email_sender_name>CustomerService@SomeDomain.com</email_sender_name>
        <email_sender_address>CustomerService@SomeDomain.com</email_sender_address>
        <credit_card_cvv2_enabled>true</credit_card_cvv2_enabled>
        <store_full_credit_cards>true</store_full_credit_cards>
        <locales>
            <locale>en</locale>
        </locales>
        <currencies>
            <currency>USD</currency>
        </currencies>
        <warehouses>
            <warehouse>USWarehouse1</warehouse>
        </warehouses>
        <tax_codes>
            <guid>502</guid>
            <guid>500</guid>
        </tax_codes>
        <tax_jurisdictions>
            <jurisdiction>FF6E6776-16FB-7BB1-4B7E-DDF2F0D73FE7</jurisdiction>
        </tax_jurisdictions>
        <credit_card_types>
            <type>American Express</type>
            <type>Visa</type>
            <type>MasterCard</type>
        </credit_card_types>
        <payment_provider_configurations>
            <payment_provider_configuration_guid>23456</payment_provider_configuration_guid>
            <payment_provider_configuration_guid>23457</payment_provider_configuration_guid>
        </payment_provider_configurations>
        <cart_types>
            <cart_type>
                <name>default</name>
                <guid>5364a6ef-5f8e-4ea0-ac40-54e6fff10eaa</guid>
                <modifiergroups>
                    <code>multicart</code>
                </modifiergroups>
            </cart_type>
        </cart_types>
    </store>
</stores>

Store Association

A Store association allows customers to be shared between stores. In the Commerce Manager, store associations are defined in the Shared Customer Accounts Tab.

Sample XML:

<store_associations>
    <store_association store_code="SLRWORLD">
        <associated_store_codes>
            <associated_store_code>SNAPITUP</associated_store_code>
        </associated_store_codes>
    </store_association>
</store_associations>

Warehouses

A warehouse is a physical location where your goods are stored.

Sample XML:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<warehouses>
    <warehouse code="UKWarehouse">
        <name>UK Warehouse</name>
        <pick_delay>120</pick_delay>
        <street1>Unit 540, Springfield Industrial Estate</street1>
        <city>Warrington</city>
        <sub_country></sub_country>
        <zip_postal_code>WA12 7J3</zip_postal_code>
        <country>GB</country>
    </warehouse>
</warehouses>

Cart

A cart consists of the items added from the product catalog through a shopping experience, such as a storefront.

modifiergroups

Use modifiers to set the configurations for creating new carts in a store. The configurations are set in the modifiergroups schema. The modifier fields in the modifiergroups define the cart identifiers, and the identifiers provide details, such as the cart name or the purpose of the cart. For more information about modifiergroups, see the Creating a Configurable Product section in the Commerce Manager User Guide. The following sample shows the XML schema for modifiergroups:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<modifiergroups>
    <modifiergroup>
        <code>giftCertificate_mobee</code>
        <displayname>
            <value language="en">Gift Certificate</value>
        </displayname>
        <modifierfields>
            <modifierfield>
                <code>giftCertificate.senderName</code>
                <type>ShortText</type>
                <required>true</required>
                <maxSize>255</maxSize>
                <ordering>3</ordering>
                <displayname>
                    <value language="en">Sender Name</value>
                </displayname>
                <options/>
            </modifierfield>
            <modifierfield>
                <code>giftCertificate.message</code>
                <type>ShortText</type>
                <required>false</required>
                <maxSize>500</maxSize>
                <ordering>4</ordering>
                <displayname>
                    <value language="en">Message</value>
                </displayname>
                <options/>
            </modifierfield>
            <modifierfield>
                <code>giftCertificate.recipientEmail</code>
                <type>Email</type>
                <required>true</required>
                <ordering>1</ordering>
                <displayname>
                    <value language="en">Recipient Email</value>
                </displayname>
                <options/>
            </modifierfield>
            <modifierfield>
                <code>giftCertificate.recipientName</code>
                <type>ShortText</type>
                <required>true</required>
                <maxSize>255</maxSize>
                <ordering>2</ordering>
                <displayname>
                    <value language="en">Recipient Name</value>
                </displayname>
                <options/>
            </modifierfield>
        </modifierfields>
    </modifiergroup>
<modifiergroups>

Depending on the cart_types modifier group configuration, the resource identifiers for the cart resource are set. By default, only the name field is set as the identifier for the multicart modifier group in the cart_types group configuration. Depending on the modifier implementation, you can configure any identifier or combination of identifiers for the cart resource. For example, you can use zipcode to identify carts based on the zip code or {name, date} combination to identify carts based on the name and the date of creation. For more information, see the Carts documentation.

modifiergroupfilters

The modifier group filters link a modifier group to the catalog. In Commerce Manager, only the modifier groups associated with a selected catalog are displayed.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<modifiergroupfilters>
    <modifiergroupfilter>
        <modifiercode>giftCertificate_mobee</modifiercode>
        <referenceGuid>MobileCatalog</referenceGuid>
        <type>Catalog</type>
    </modifiergroupfilter>
    <modifiergroupfilter>
        <modifiercode>allFieldTypes</modifiercode>
        <referenceGuid>MobileCatalog</referenceGuid>
        <type>Catalog</type>
    </modifiergroupfilter>
    <modifiergroupfilter>
        <modifiercode>fieldMetadataTest1</modifiercode>
        <referenceGuid>Syndication2StoresCatalog</referenceGuid>
        <type>Catalog</type>
    </modifiergroupfilter>
    <modifiergroupfilter>
        <modifiercode>productTestGroup1</modifiercode>
        <referenceGuid>Syndication2StoresCatalog</referenceGuid>
        <type>Catalog</type>
    </modifiergroupfilter>
    <modifiergroupfilter>
        <modifiercode>productTestGroup2</modifiercode>
        <referenceGuid>Syndication2StoresCatalog</referenceGuid>
        <type>Catalog</type>
    </modifiergroupfilter>
</modifiergroupfilters>

Inventory

Inventory lists the quantity of SKU in a warehouse.

  • <sku code>: The SKU’s unique identifier.
  • <warehouse code>: A unique identifier for the warehouse. No two warehouses can share the same code. The code cannot be changed once the warehouse is created.
  • <onhand>: The quantity of SKU in a warehouse.
  • <available>: The quantity available in a warehouse that can be purchased. For example, if On Hand was 100 and Reserved was 10, Available would be 90.
  • <allocated>: The amount allocated to fulfill current orders.
  • <reserved>: The quantity not available for sale in the store.
  • <reordermin>: Specifies when an item should be included in the Low Stock report (when the On Hand is less than the Re-Order Quantity).
  • <reorderqty>: This field is intended as a visual reminder to the warehouse person to order this amount of stock when the stock On Hand gets low.
  • <expectedrestockdate>: The date when the stock is expected to come in.

The following XML schema provides an example:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<inventory>
    <sku code="GR-DVX507A">
        <warehouse code="USWarehouse1">
            <onhand>106</onhand>
            <available>96</available>
            <allocated>0</allocated>
            <reserved>10</reserved>
            <reordermin>33</reordermin>
            <reorderqty>3</reorderqty>
            <expectedrestockdate>2008-03-16T00:00:00-07:00</expectedrestockdate>
        </warehouse>
        <warehouse code="UKWarehouse">
            <onhand>106</onhand>
            <available>96</available>
            <allocated>0</allocated>
            <reserved>10</reserved>
            <reordermin>33</reordermin>
            <reorderqty>3</reorderqty>
        </warehouse>
    </sku>
    <sku code="PV-DC352">
        <warehouse code="USWarehouse1">
            <onhand>111</onhand>
            <available>101</available>
            <allocated>0</allocated>
            <reserved>10</reserved>
            <reordermin>20</reordermin>
            <reorderqty>3</reorderqty>
            <expectedrestockdate>2008-03-16T00:00:00-07:00</expectedrestockdate>
        </warehouse>
        <warehouse code="UKWarehouse">
            <onhand>111</onhand>
            <available>101</available>
            <allocated>0</allocated>
            <reserved>10</reserved>
            <reordermin>20</reordermin>
            <reorderqty>3</reorderqty>
        </warehouse>
    </sku>
</inventory>

Attribute Policy

Attribute policy defines the permissions that are associated to a policy.

  • <guid>: A globally unique identifier for the attribute policy.
  • <policy_key>: The key of the targeted policy. This value must be a valid PolicyKey enumeration.
  • <policy_permission>: The policy permission mapping. This value must be a valid PolicyPermission enumeration.

The following XML schema provides an example:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<attribute_policies>
    <attribute_policy>
        <guid>hidden-none</guid>
        <policy_key>HIDDEN</policy_key>
        <policy_permission>NONE</policy_permission>
    </attribute_policy>
    <attribute_policy>
        <guid>visible-emit</guid>
        <policy_key>READ_ONLY</policy_key>
        <policy_permission>EMIT</policy_permission>
    </attribute_policy>
    <attribute_policy>
        <guid>default-emit</guid>
        <policy_key>DEFAULT</policy_key>
        <policy_permission>EMIT</policy_permission>
    </attribute_policy>
    <attribute_policy>
        <guid>default-edit</guid>
        <policy_key>DEFAULT</policy_key>
        <policy_permission>EDIT</policy_permission>
    </attribute_policy>
</attribute_policies>

Store Customer Attribute

Store customer attributes associate customer attributes to a particular store and define which permissions policy must be assigned.

Field definitions:

  • <guid>: A globally unique identifier for the store to customer attribute policy.
  • <storecode>: The code for the targeted store.
  • <attribute_key>: The key of the targeted customer attribute.
  • <policy_key>: The key of the targeted policy.

The following XML schema provides an example:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<store_customer_attributes>
    <store_customer_attribute>
        <guid>c2178474-769f-4119-a0e7-a69f1bbbfe76</guid>
        <storecode>MOBEE</storecode>
        <attribute_key>CP_PREF_LOCALE</attribute_key>
        <policy_key>DEFAULT</policy_key>
    </store_customer_attribute>
    <store_customer_attribute>
        <guid>2bc63fdb-2ece-4e0c-afdd-55cc69c96050</guid>
        <storecode>MOBEE</storecode>
        <attribute_key>CP_TAX_EXEMPTION_ID</attribute_key>
        <policy_key>DEFAULT</policy_key>
    </store_customer_attribute>
</store_customer_attributes>
Last updated on 6/1/2024
← Shipping and TaxExporting Data →