POST v3/products/excel/preview

Request Information

URI Parameters

None.

Body Parameters

AppProductPreviewRequest
NameDescriptionTypeAdditional information
products

Collection of AppProductDTO

None.

Request Formats

application/json, text/json

Sample:
{
  "products": [
    {
      "companyId": "sample string 1",
      "externalId": 2,
      "referenceCode": "sample string 3",
      "colorCode": "sample string 4",
      "color": "sample string 5",
      "title": "sample string 6",
      "description": "sample string 7",
      "htmlDescription": "sample string 8",
      "productType": "sample string 9",
      "size": "sample string 10",
      "brand": "sample string 11",
      "model": "sample string 12",
      "style": "sample string 13",
      "family": "sample string 14",
      "subFamily": "sample string 15",
      "gender": "sample string 16",
      "price": 17.0,
      "discountPrice": 18.0,
      "stock": 19,
      "isVisible": true,
      "weight": 21.0,
      "customValueA": "sample string 22",
      "customValueB": "sample string 23",
      "customValueC": "sample string 24",
      "customValueD": "sample string 25",
      "isArchived": true,
      "isSingleImage": true,
      "keywords": "sample string 28",
      "discountTimerShow": true,
      "discountTimerEnd": "2022-10-07T12:51:16.6613182-06:00",
      "discountTimerPrice": 30.0,
      "position": 31,
      "barCode": "sample string 32"
    },
    {
      "companyId": "sample string 1",
      "externalId": 2,
      "referenceCode": "sample string 3",
      "colorCode": "sample string 4",
      "color": "sample string 5",
      "title": "sample string 6",
      "description": "sample string 7",
      "htmlDescription": "sample string 8",
      "productType": "sample string 9",
      "size": "sample string 10",
      "brand": "sample string 11",
      "model": "sample string 12",
      "style": "sample string 13",
      "family": "sample string 14",
      "subFamily": "sample string 15",
      "gender": "sample string 16",
      "price": 17.0,
      "discountPrice": 18.0,
      "stock": 19,
      "isVisible": true,
      "weight": 21.0,
      "customValueA": "sample string 22",
      "customValueB": "sample string 23",
      "customValueC": "sample string 24",
      "customValueD": "sample string 25",
      "isArchived": true,
      "isSingleImage": true,
      "keywords": "sample string 28",
      "discountTimerShow": true,
      "discountTimerEnd": "2022-10-07T12:51:16.6613182-06:00",
      "discountTimerPrice": 30.0,
      "position": 31,
      "barCode": "sample string 32"
    }
  ]
}

application/xml, text/xml

Sample:
<AppProductPreviewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Blumev3.Models">
  <products>
    <AppProductDTO>
      <barCode>sample string 32</barCode>
      <brand>sample string 11</brand>
      <color>sample string 5</color>
      <colorCode>sample string 4</colorCode>
      <companyId>sample string 1</companyId>
      <customValueA>sample string 22</customValueA>
      <customValueB>sample string 23</customValueB>
      <customValueC>sample string 24</customValueC>
      <customValueD>sample string 25</customValueD>
      <description>sample string 7</description>
      <discountPrice>18</discountPrice>
      <discountTimerEnd>2022-10-07T12:51:16.6613182-06:00</discountTimerEnd>
      <discountTimerPrice>30</discountTimerPrice>
      <discountTimerShow>true</discountTimerShow>
      <externalId>2</externalId>
      <family>sample string 14</family>
      <gender>sample string 16</gender>
      <htmlDescription>sample string 8</htmlDescription>
      <isArchived>true</isArchived>
      <isSingleImage>true</isSingleImage>
      <isVisible>true</isVisible>
      <keywords>sample string 28</keywords>
      <model>sample string 12</model>
      <position>31</position>
      <price>17</price>
      <productType>sample string 9</productType>
      <referenceCode>sample string 3</referenceCode>
      <size>sample string 10</size>
      <stock>19</stock>
      <style>sample string 13</style>
      <subFamily>sample string 15</subFamily>
      <title>sample string 6</title>
      <weight>21</weight>
    </AppProductDTO>
    <AppProductDTO>
      <barCode>sample string 32</barCode>
      <brand>sample string 11</brand>
      <color>sample string 5</color>
      <colorCode>sample string 4</colorCode>
      <companyId>sample string 1</companyId>
      <customValueA>sample string 22</customValueA>
      <customValueB>sample string 23</customValueB>
      <customValueC>sample string 24</customValueC>
      <customValueD>sample string 25</customValueD>
      <description>sample string 7</description>
      <discountPrice>18</discountPrice>
      <discountTimerEnd>2022-10-07T12:51:16.6613182-06:00</discountTimerEnd>
      <discountTimerPrice>30</discountTimerPrice>
      <discountTimerShow>true</discountTimerShow>
      <externalId>2</externalId>
      <family>sample string 14</family>
      <gender>sample string 16</gender>
      <htmlDescription>sample string 8</htmlDescription>
      <isArchived>true</isArchived>
      <isSingleImage>true</isSingleImage>
      <isVisible>true</isVisible>
      <keywords>sample string 28</keywords>
      <model>sample string 12</model>
      <position>31</position>
      <price>17</price>
      <productType>sample string 9</productType>
      <referenceCode>sample string 3</referenceCode>
      <size>sample string 10</size>
      <stock>19</stock>
      <style>sample string 13</style>
      <subFamily>sample string 15</subFamily>
      <title>sample string 6</title>
      <weight>21</weight>
    </AppProductDTO>
  </products>
</AppProductPreviewRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AppProductPreviewResponse
NameDescriptionTypeAdditional information
apiStatus

string

None.

isApproved

boolean

None.

data

AppProductUpdatePreviewDTO

None.

Response Formats

application/json, text/json

Sample:
{
  "apiStatus": "sample string 1",
  "isApproved": true,
  "data": {
    "toRemove": [
      {
        "companyId": "sample string 1",
        "externalId": 2,
        "referenceCode": "sample string 3",
        "colorCode": "sample string 4",
        "color": "sample string 5",
        "title": "sample string 6",
        "description": "sample string 7",
        "htmlDescription": "sample string 8",
        "productType": "sample string 9",
        "size": "sample string 10",
        "brand": "sample string 11",
        "model": "sample string 12",
        "style": "sample string 13",
        "family": "sample string 14",
        "subFamily": "sample string 15",
        "gender": "sample string 16",
        "price": 17.0,
        "discountPrice": 18.0,
        "stock": 19,
        "isVisible": true,
        "weight": 21.0,
        "customValueA": "sample string 22",
        "customValueB": "sample string 23",
        "customValueC": "sample string 24",
        "customValueD": "sample string 25",
        "isArchived": true,
        "isSingleImage": true,
        "keywords": "sample string 28",
        "discountTimerShow": true,
        "discountTimerEnd": "2022-10-07T12:51:16.6769853-06:00",
        "discountTimerPrice": 30.0,
        "position": 31,
        "barCode": "sample string 32"
      },
      {
        "companyId": "sample string 1",
        "externalId": 2,
        "referenceCode": "sample string 3",
        "colorCode": "sample string 4",
        "color": "sample string 5",
        "title": "sample string 6",
        "description": "sample string 7",
        "htmlDescription": "sample string 8",
        "productType": "sample string 9",
        "size": "sample string 10",
        "brand": "sample string 11",
        "model": "sample string 12",
        "style": "sample string 13",
        "family": "sample string 14",
        "subFamily": "sample string 15",
        "gender": "sample string 16",
        "price": 17.0,
        "discountPrice": 18.0,
        "stock": 19,
        "isVisible": true,
        "weight": 21.0,
        "customValueA": "sample string 22",
        "customValueB": "sample string 23",
        "customValueC": "sample string 24",
        "customValueD": "sample string 25",
        "isArchived": true,
        "isSingleImage": true,
        "keywords": "sample string 28",
        "discountTimerShow": true,
        "discountTimerEnd": "2022-10-07T12:51:16.6769853-06:00",
        "discountTimerPrice": 30.0,
        "position": 31,
        "barCode": "sample string 32"
      }
    ],
    "toUpdate": [
      {
        "companyId": "sample string 1",
        "externalId": 2,
        "referenceCode": "sample string 3",
        "colorCode": "sample string 4",
        "color": "sample string 5",
        "title": "sample string 6",
        "description": "sample string 7",
        "htmlDescription": "sample string 8",
        "productType": "sample string 9",
        "size": "sample string 10",
        "brand": "sample string 11",
        "model": "sample string 12",
        "style": "sample string 13",
        "family": "sample string 14",
        "subFamily": "sample string 15",
        "gender": "sample string 16",
        "price": 17.0,
        "discountPrice": 18.0,
        "stock": 19,
        "isVisible": true,
        "weight": 21.0,
        "customValueA": "sample string 22",
        "customValueB": "sample string 23",
        "customValueC": "sample string 24",
        "customValueD": "sample string 25",
        "isArchived": true,
        "isSingleImage": true,
        "keywords": "sample string 28",
        "discountTimerShow": true,
        "discountTimerEnd": "2022-10-07T12:51:16.6769853-06:00",
        "discountTimerPrice": 30.0,
        "position": 31,
        "barCode": "sample string 32"
      },
      {
        "companyId": "sample string 1",
        "externalId": 2,
        "referenceCode": "sample string 3",
        "colorCode": "sample string 4",
        "color": "sample string 5",
        "title": "sample string 6",
        "description": "sample string 7",
        "htmlDescription": "sample string 8",
        "productType": "sample string 9",
        "size": "sample string 10",
        "brand": "sample string 11",
        "model": "sample string 12",
        "style": "sample string 13",
        "family": "sample string 14",
        "subFamily": "sample string 15",
        "gender": "sample string 16",
        "price": 17.0,
        "discountPrice": 18.0,
        "stock": 19,
        "isVisible": true,
        "weight": 21.0,
        "customValueA": "sample string 22",
        "customValueB": "sample string 23",
        "customValueC": "sample string 24",
        "customValueD": "sample string 25",
        "isArchived": true,
        "isSingleImage": true,
        "keywords": "sample string 28",
        "discountTimerShow": true,
        "discountTimerEnd": "2022-10-07T12:51:16.6769853-06:00",
        "discountTimerPrice": 30.0,
        "position": 31,
        "barCode": "sample string 32"
      }
    ],
    "toAdd": [
      {
        "companyId": "sample string 1",
        "externalId": 2,
        "referenceCode": "sample string 3",
        "colorCode": "sample string 4",
        "color": "sample string 5",
        "title": "sample string 6",
        "description": "sample string 7",
        "htmlDescription": "sample string 8",
        "productType": "sample string 9",
        "size": "sample string 10",
        "brand": "sample string 11",
        "model": "sample string 12",
        "style": "sample string 13",
        "family": "sample string 14",
        "subFamily": "sample string 15",
        "gender": "sample string 16",
        "price": 17.0,
        "discountPrice": 18.0,
        "stock": 19,
        "isVisible": true,
        "weight": 21.0,
        "customValueA": "sample string 22",
        "customValueB": "sample string 23",
        "customValueC": "sample string 24",
        "customValueD": "sample string 25",
        "isArchived": true,
        "isSingleImage": true,
        "keywords": "sample string 28",
        "discountTimerShow": true,
        "discountTimerEnd": "2022-10-07T12:51:16.6769853-06:00",
        "discountTimerPrice": 30.0,
        "position": 31,
        "barCode": "sample string 32"
      },
      {
        "companyId": "sample string 1",
        "externalId": 2,
        "referenceCode": "sample string 3",
        "colorCode": "sample string 4",
        "color": "sample string 5",
        "title": "sample string 6",
        "description": "sample string 7",
        "htmlDescription": "sample string 8",
        "productType": "sample string 9",
        "size": "sample string 10",
        "brand": "sample string 11",
        "model": "sample string 12",
        "style": "sample string 13",
        "family": "sample string 14",
        "subFamily": "sample string 15",
        "gender": "sample string 16",
        "price": 17.0,
        "discountPrice": 18.0,
        "stock": 19,
        "isVisible": true,
        "weight": 21.0,
        "customValueA": "sample string 22",
        "customValueB": "sample string 23",
        "customValueC": "sample string 24",
        "customValueD": "sample string 25",
        "isArchived": true,
        "isSingleImage": true,
        "keywords": "sample string 28",
        "discountTimerShow": true,
        "discountTimerEnd": "2022-10-07T12:51:16.6769853-06:00",
        "discountTimerPrice": 30.0,
        "position": 31,
        "barCode": "sample string 32"
      }
    ]
  }
}

application/xml, text/xml

Sample:
<AppProductPreviewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Blumev3.Models">
  <apiStatus>sample string 1</apiStatus>
  <data>
    <toAdd>
      <AppProductDTO>
        <barCode>sample string 32</barCode>
        <brand>sample string 11</brand>
        <color>sample string 5</color>
        <colorCode>sample string 4</colorCode>
        <companyId>sample string 1</companyId>
        <customValueA>sample string 22</customValueA>
        <customValueB>sample string 23</customValueB>
        <customValueC>sample string 24</customValueC>
        <customValueD>sample string 25</customValueD>
        <description>sample string 7</description>
        <discountPrice>18</discountPrice>
        <discountTimerEnd>2022-10-07T12:51:16.6769853-06:00</discountTimerEnd>
        <discountTimerPrice>30</discountTimerPrice>
        <discountTimerShow>true</discountTimerShow>
        <externalId>2</externalId>
        <family>sample string 14</family>
        <gender>sample string 16</gender>
        <htmlDescription>sample string 8</htmlDescription>
        <isArchived>true</isArchived>
        <isSingleImage>true</isSingleImage>
        <isVisible>true</isVisible>
        <keywords>sample string 28</keywords>
        <model>sample string 12</model>
        <position>31</position>
        <price>17</price>
        <productType>sample string 9</productType>
        <referenceCode>sample string 3</referenceCode>
        <size>sample string 10</size>
        <stock>19</stock>
        <style>sample string 13</style>
        <subFamily>sample string 15</subFamily>
        <title>sample string 6</title>
        <weight>21</weight>
      </AppProductDTO>
      <AppProductDTO>
        <barCode>sample string 32</barCode>
        <brand>sample string 11</brand>
        <color>sample string 5</color>
        <colorCode>sample string 4</colorCode>
        <companyId>sample string 1</companyId>
        <customValueA>sample string 22</customValueA>
        <customValueB>sample string 23</customValueB>
        <customValueC>sample string 24</customValueC>
        <customValueD>sample string 25</customValueD>
        <description>sample string 7</description>
        <discountPrice>18</discountPrice>
        <discountTimerEnd>2022-10-07T12:51:16.6769853-06:00</discountTimerEnd>
        <discountTimerPrice>30</discountTimerPrice>
        <discountTimerShow>true</discountTimerShow>
        <externalId>2</externalId>
        <family>sample string 14</family>
        <gender>sample string 16</gender>
        <htmlDescription>sample string 8</htmlDescription>
        <isArchived>true</isArchived>
        <isSingleImage>true</isSingleImage>
        <isVisible>true</isVisible>
        <keywords>sample string 28</keywords>
        <model>sample string 12</model>
        <position>31</position>
        <price>17</price>
        <productType>sample string 9</productType>
        <referenceCode>sample string 3</referenceCode>
        <size>sample string 10</size>
        <stock>19</stock>
        <style>sample string 13</style>
        <subFamily>sample string 15</subFamily>
        <title>sample string 6</title>
        <weight>21</weight>
      </AppProductDTO>
    </toAdd>
    <toRemove>
      <AppProductDTO>
        <barCode>sample string 32</barCode>
        <brand>sample string 11</brand>
        <color>sample string 5</color>
        <colorCode>sample string 4</colorCode>
        <companyId>sample string 1</companyId>
        <customValueA>sample string 22</customValueA>
        <customValueB>sample string 23</customValueB>
        <customValueC>sample string 24</customValueC>
        <customValueD>sample string 25</customValueD>
        <description>sample string 7</description>
        <discountPrice>18</discountPrice>
        <discountTimerEnd>2022-10-07T12:51:16.6769853-06:00</discountTimerEnd>
        <discountTimerPrice>30</discountTimerPrice>
        <discountTimerShow>true</discountTimerShow>
        <externalId>2</externalId>
        <family>sample string 14</family>
        <gender>sample string 16</gender>
        <htmlDescription>sample string 8</htmlDescription>
        <isArchived>true</isArchived>
        <isSingleImage>true</isSingleImage>
        <isVisible>true</isVisible>
        <keywords>sample string 28</keywords>
        <model>sample string 12</model>
        <position>31</position>
        <price>17</price>
        <productType>sample string 9</productType>
        <referenceCode>sample string 3</referenceCode>
        <size>sample string 10</size>
        <stock>19</stock>
        <style>sample string 13</style>
        <subFamily>sample string 15</subFamily>
        <title>sample string 6</title>
        <weight>21</weight>
      </AppProductDTO>
      <AppProductDTO>
        <barCode>sample string 32</barCode>
        <brand>sample string 11</brand>
        <color>sample string 5</color>
        <colorCode>sample string 4</colorCode>
        <companyId>sample string 1</companyId>
        <customValueA>sample string 22</customValueA>
        <customValueB>sample string 23</customValueB>
        <customValueC>sample string 24</customValueC>
        <customValueD>sample string 25</customValueD>
        <description>sample string 7</description>
        <discountPrice>18</discountPrice>
        <discountTimerEnd>2022-10-07T12:51:16.6769853-06:00</discountTimerEnd>
        <discountTimerPrice>30</discountTimerPrice>
        <discountTimerShow>true</discountTimerShow>
        <externalId>2</externalId>
        <family>sample string 14</family>
        <gender>sample string 16</gender>
        <htmlDescription>sample string 8</htmlDescription>
        <isArchived>true</isArchived>
        <isSingleImage>true</isSingleImage>
        <isVisible>true</isVisible>
        <keywords>sample string 28</keywords>
        <model>sample string 12</model>
        <position>31</position>
        <price>17</price>
        <productType>sample string 9</productType>
        <referenceCode>sample string 3</referenceCode>
        <size>sample string 10</size>
        <stock>19</stock>
        <style>sample string 13</style>
        <subFamily>sample string 15</subFamily>
        <title>sample string 6</title>
        <weight>21</weight>
      </AppProductDTO>
    </toRemove>
    <toUpdate>
      <AppProductDTO>
        <barCode>sample string 32</barCode>
        <brand>sample string 11</brand>
        <color>sample string 5</color>
        <colorCode>sample string 4</colorCode>
        <companyId>sample string 1</companyId>
        <customValueA>sample string 22</customValueA>
        <customValueB>sample string 23</customValueB>
        <customValueC>sample string 24</customValueC>
        <customValueD>sample string 25</customValueD>
        <description>sample string 7</description>
        <discountPrice>18</discountPrice>
        <discountTimerEnd>2022-10-07T12:51:16.6769853-06:00</discountTimerEnd>
        <discountTimerPrice>30</discountTimerPrice>
        <discountTimerShow>true</discountTimerShow>
        <externalId>2</externalId>
        <family>sample string 14</family>
        <gender>sample string 16</gender>
        <htmlDescription>sample string 8</htmlDescription>
        <isArchived>true</isArchived>
        <isSingleImage>true</isSingleImage>
        <isVisible>true</isVisible>
        <keywords>sample string 28</keywords>
        <model>sample string 12</model>
        <position>31</position>
        <price>17</price>
        <productType>sample string 9</productType>
        <referenceCode>sample string 3</referenceCode>
        <size>sample string 10</size>
        <stock>19</stock>
        <style>sample string 13</style>
        <subFamily>sample string 15</subFamily>
        <title>sample string 6</title>
        <weight>21</weight>
      </AppProductDTO>
      <AppProductDTO>
        <barCode>sample string 32</barCode>
        <brand>sample string 11</brand>
        <color>sample string 5</color>
        <colorCode>sample string 4</colorCode>
        <companyId>sample string 1</companyId>
        <customValueA>sample string 22</customValueA>
        <customValueB>sample string 23</customValueB>
        <customValueC>sample string 24</customValueC>
        <customValueD>sample string 25</customValueD>
        <description>sample string 7</description>
        <discountPrice>18</discountPrice>
        <discountTimerEnd>2022-10-07T12:51:16.6769853-06:00</discountTimerEnd>
        <discountTimerPrice>30</discountTimerPrice>
        <discountTimerShow>true</discountTimerShow>
        <externalId>2</externalId>
        <family>sample string 14</family>
        <gender>sample string 16</gender>
        <htmlDescription>sample string 8</htmlDescription>
        <isArchived>true</isArchived>
        <isSingleImage>true</isSingleImage>
        <isVisible>true</isVisible>
        <keywords>sample string 28</keywords>
        <model>sample string 12</model>
        <position>31</position>
        <price>17</price>
        <productType>sample string 9</productType>
        <referenceCode>sample string 3</referenceCode>
        <size>sample string 10</size>
        <stock>19</stock>
        <style>sample string 13</style>
        <subFamily>sample string 15</subFamily>
        <title>sample string 6</title>
        <weight>21</weight>
      </AppProductDTO>
    </toUpdate>
  </data>
  <isApproved>true</isApproved>
</AppProductPreviewResponse>