# Product Delivery scheme import

## Short description

The Shoxl DeliveryScheme import interface allows the import of product delivery schemes into the Shoxl caching layer.\
The interface enables the definition of article specific delivery dates as well as a maximum order date. The interface is intended to be used for short-lived articles.

## Delivery method

**Update Frequency**: Batch at least once a day \
**Incremental or complete set:** Incremental

**Filetype:** Zipped XML

**Filename: \[SHOPNAME]\_Shoxl\_ProductDeliverySchemes**\_**\[INDEXNUMBER]**.xml\
**Transport:** over FTPS, FTPS Vendisto server hosted by INTEGRACE, file will be placed on FTPS server by ERP party.

**Location within FTP root:** \ShoxlPro\XmlImport\\

## Structure XML

### Changes from ProductDeliverySchemes XML 1.1 to 1.2

* The article delivery schemes importer has been moved from the ERP cache to our Shoxl webshop caching layer

```markup
<?xml version="1.0" encoding="utf-8"?>
<Import>
    <ImportSettings>
        <Importer>Shoxl_ProductDeliverySchemes</Importer>
        <Version>1.2</Version>
    </ImportSettings>
    <ProductDeliverySchemes>
        <ProductDeliveryScheme>
            <DeliverySchemeCode></DeliverySchemeCode>
            <ProductNumber></ProductNumber>
            <DeliverySchemes>
                <DeliveryScheme>
                    <DeliveryDate>yyyymmdd</DeliveryDate>
                    <MaximumOrderDate>yyyymmdd</MaximumOrderDate>
                </DeliveryScheme>
                <DeliveryScheme>
                    <DeliveryDate>yyyymmdd</DeliveryDate>
                    <MaximumOrderDate>yyyymmdd</MaximumOrderDate>
                </DeliveryScheme>
            </DeliverySchemes>
        </ProductDeliveryScheme>
        <ProductDeliveryScheme>
            <DeliverySchemeCode></DeliverySchemeCode>
            <ProductNumber></ProductNumber>
            <DeliverySchemes>
                <DeliveryScheme>
                    <DeliveryDate>yyyymmdd</DeliveryDate>
                    <MaximumOrderDate>yyyymmdd</MaximumOrderDate>
                </DeliveryScheme>
                <DeliveryScheme>
                    <DeliveryDate>yyyymmdd</DeliveryDate>
                    <MaximumOrderDate>yyyymmdd</MaximumOrderDate>
                </DeliveryScheme>
            </DeliverySchemes>
        </ProductDeliveryScheme>
    </ProductDeliverySchemes>
</Import>
```

### Changes from ErpCache\_ProductDeliverySchemes XML 1.0 to 1.1

* DeliverySchemeCode was added as a required element.

```markup
<?xml version="1.0" encoding="utf-8"?>
<Import>
    <ImportSettings>
        <Importer>ErpCache_ProductDeliverySchemes</Importer>
        <Version>1.1</Version>
    </ImportSettings>
    <ProductDeliverySchemes>
        <ProductDeliveryScheme>
            <DeliverySchemeCode></DeliverySchemeCode>
            <ProductNumber></ProductNumber>
            <DeliverySchemes>
                <DeliveryScheme>
                    <DeliveryDate>yyyymmdd</DeliveryDate>
                    <MaximumOrderDate>yyyymmdd</MaximumOrderDate>
                </DeliveryScheme>
                <DeliveryScheme>
                    <DeliveryDate>yyyymmdd</DeliveryDate>
                    <MaximumOrderDate>yyyymmdd</MaximumOrderDate>
                </DeliveryScheme>
            </DeliverySchemes>
        </ProductDeliveryScheme>
        <ProductDeliveryScheme>
            <DeliverySchemeCode></DeliverySchemeCode>
            <ProductNumber></ProductNumber>
            <DeliverySchemes>
                <DeliveryScheme>
                    <DeliveryDate>yyyymmdd</DeliveryDate>
                    <MaximumOrderDate>yyyymmdd</MaximumOrderDate>
                </DeliveryScheme>
                <DeliveryScheme>
                    <DeliveryDate>yyyymmdd</DeliveryDate>
                    <MaximumOrderDate>yyyymmdd</MaximumOrderDate>
                </DeliveryScheme>
            </DeliverySchemes>
        </ProductDeliveryScheme>
    </ProductDeliverySchemes>
</Import>

```

## Fields XML

**Import element:**

| Name                   | Description                                        | Type    | Required/Optional |
| ---------------------- | -------------------------------------------------- | ------- | ----------------- |
| ImportSettings         | Container element for importsettings               | Element | Required          |
| ProductDeliverySchemes | Container element for product delivery scheme data | Element | Required          |

**ImportSettings element:**

| Name     | Description                                                                                       | Type | Required/Optional |
| -------- | ------------------------------------------------------------------------------------------------- | ---- | ----------------- |
| Importer | <p>Name of the importer.<br>Should be ErpCache\_ProductDeliveryScheme</p>                         | Text | Required          |
| Version  | <p>Version of the import xml. To be used for backward compatibility issues.</p><p>Must be 1.1</p> | Text | Required          |

**ProductDeliveryScheme element:**

| Name            | Description                           | Type    | Required/Optional |
| --------------- | ------------------------------------- | ------- | ----------------- |
| ProductNumber   | The identifier of a product           | Text    | Required          |
| DeliverySchemes | Container element for DeliveryScheme. | Element | Required          |

**DeliveryScheme element:**

| Name               | Description                                                                                              | Type | Required/Optional |
| ------------------ | -------------------------------------------------------------------------------------------------------- | ---- | ----------------- |
| DeliverySchemeCode | Name of the delivery scheme                                                                              | Text | Required          |
| ProductNumber      | The identifier of a product                                                                              | Text | Required          |
| DeliveryDate       | Date on which the product can be delivered                                                               | Date | Required          |
| MaximumOrderDate   | Maximum date on which that the product can be ordered in order to be delivered on the given DeliveryDate | Date | Optional          |

**Types:**

| Type | Values                                                     |
| ---- | ---------------------------------------------------------- |
| Date | Must be a string of eight positions formatted as: yyyyMMdd |
