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:

<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>
    <payment_gateways>
        <gateway>GiftCertificate</gateway>
        <gateway>DemoPaymentProcessor</gateway>
    </payment_gateways>
    <credit_card_types>
        <type>American Express</type>
        <type>Visa</type>
        <type>MasterCard</type>
    </credit_card_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:

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

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

Sample XML:

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