GET portal/sync

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
api_key	string	Required
time_from	date	Required
time_to	date	None.

Request Formats

application/json, text/json

Sample:

{
  "api_key": "sample string 1",
  "time_from": "2024-10-06T10:16:06.8639651-06:00",
  "time_to": "2024-10-06T10:16:06.8639651-06:00"
}

text/xml

Sample:

<SyncRequestParamModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPI.API.Models.PortalModels">
  <api_key>sample string 1</api_key>
  <time_from>2024-10-06T10:16:06.8639651-06:00</time_from>
  <time_to>2024-10-06T10:16:06.8639651-06:00</time_to>
</SyncRequestParamModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SyncRequestParamModel'.

Response Information

Resource Description

SyncResponse

Name	Type	Additional information
created_parts	integer	None.
updated_parts	integer	None.
deleted_parts	integer	None.
create	Collection of SyncCreateInformation	None.
update	Collection of SyncUpdateInformation	None.
delete	Collection of SyncDeleteInformation	None.
status	string	None.
request_length	decimal number	None.
message	string	None.
ipaddress	string	None.

Response Formats

application/json, text/json

Sample:

{
  "created_parts": 1,
  "updated_parts": 2,
  "deleted_parts": 3,
  "create": [
    {
      "sku": 1,
      "name": "sample string 2",
      "regular_price": 3.0,
      "stock_quantity": 4,
      "attributes": [
        {
          "name": "sample string 1",
          "options": [
            "sample string 1",
            "sample string 2"
          ],
          "visible": true
        },
        {
          "name": "sample string 1",
          "options": [
            "sample string 1",
            "sample string 2"
          ],
          "visible": true
        }
      ],
      "categories": "sample string 5",
      "description": "sample string 6"
    },
    {
      "sku": 1,
      "name": "sample string 2",
      "regular_price": 3.0,
      "stock_quantity": 4,
      "attributes": [
        {
          "name": "sample string 1",
          "options": [
            "sample string 1",
            "sample string 2"
          ],
          "visible": true
        },
        {
          "name": "sample string 1",
          "options": [
            "sample string 1",
            "sample string 2"
          ],
          "visible": true
        }
      ],
      "categories": "sample string 5",
      "description": "sample string 6"
    }
  ],
  "update": [
    {
      "sku": 1,
      "name": "sample string 2",
      "regular_price": 3.0,
      "stock_quantity": 4,
      "attributes": [
        {
          "name": "sample string 1",
          "options": [
            "sample string 1",
            "sample string 2"
          ],
          "visible": true
        },
        {
          "name": "sample string 1",
          "options": [
            "sample string 1",
            "sample string 2"
          ],
          "visible": true
        }
      ],
      "categories": "sample string 5",
      "description": "sample string 6"
    },
    {
      "sku": 1,
      "name": "sample string 2",
      "regular_price": 3.0,
      "stock_quantity": 4,
      "attributes": [
        {
          "name": "sample string 1",
          "options": [
            "sample string 1",
            "sample string 2"
          ],
          "visible": true
        },
        {
          "name": "sample string 1",
          "options": [
            "sample string 1",
            "sample string 2"
          ],
          "visible": true
        }
      ],
      "categories": "sample string 5",
      "description": "sample string 6"
    }
  ],
  "delete": [
    {
      "sku": 1
    },
    {
      "sku": 1
    }
  ],
  "status": "sample string 4",
  "request_length": 5.1,
  "message": "sample string 6",
  "ipaddress": "sample string 7"
}

text/xml

Sample:

<result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPI.API.Models.PortalModels">
  <ipaddress xmlns="http://schemas.datacontract.org/2004/07/TPI.API.Models">sample string 7</ipaddress>
  <message xmlns="http://schemas.datacontract.org/2004/07/TPI.API.Models">sample string 6</message>
  <request_length xmlns="http://schemas.datacontract.org/2004/07/TPI.API.Models">5.1</request_length>
  <status xmlns="http://schemas.datacontract.org/2004/07/TPI.API.Models">sample string 4</status>
  <create>
    <sync_create_information>
      <attributes>
        <attributes_information>
          <name>sample string 1</name>
          <options xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </options>
          <visible>true</visible>
        </attributes_information>
        <attributes_information>
          <name>sample string 1</name>
          <options xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </options>
          <visible>true</visible>
        </attributes_information>
      </attributes>
      <categories>sample string 5</categories>
      <description>sample string 6</description>
      <name>sample string 2</name>
      <regular_price>3</regular_price>
      <sku>1</sku>
      <stock_quantity>4</stock_quantity>
    </sync_create_information>
    <sync_create_information>
      <attributes>
        <attributes_information>
          <name>sample string 1</name>
          <options xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </options>
          <visible>true</visible>
        </attributes_information>
        <attributes_information>
          <name>sample string 1</name>
          <options xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </options>
          <visible>true</visible>
        </attributes_information>
      </attributes>
      <categories>sample string 5</categories>
      <description>sample string 6</description>
      <name>sample string 2</name>
      <regular_price>3</regular_price>
      <sku>1</sku>
      <stock_quantity>4</stock_quantity>
    </sync_create_information>
  </create>
  <created_parts>1</created_parts>
  <delete>
    <sync_delete_information>
      <sku>1</sku>
    </sync_delete_information>
    <sync_delete_information>
      <sku>1</sku>
    </sync_delete_information>
  </delete>
  <deleted_parts>3</deleted_parts>
  <update>
    <sync_update_information>
      <attributes>
        <attributes_information>
          <name>sample string 1</name>
          <options xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </options>
          <visible>true</visible>
        </attributes_information>
        <attributes_information>
          <name>sample string 1</name>
          <options xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </options>
          <visible>true</visible>
        </attributes_information>
      </attributes>
      <categories>sample string 5</categories>
      <description>sample string 6</description>
      <name>sample string 2</name>
      <regular_price>3</regular_price>
      <sku>1</sku>
      <stock_quantity>4</stock_quantity>
    </sync_update_information>
    <sync_update_information>
      <attributes>
        <attributes_information>
          <name>sample string 1</name>
          <options xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </options>
          <visible>true</visible>
        </attributes_information>
        <attributes_information>
          <name>sample string 1</name>
          <options xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>sample string 1</d6p1:string>
            <d6p1:string>sample string 2</d6p1:string>
          </options>
          <visible>true</visible>
        </attributes_information>
      </attributes>
      <categories>sample string 5</categories>
      <description>sample string 6</description>
      <name>sample string 2</name>
      <regular_price>3</regular_price>
      <sku>1</sku>
      <stock_quantity>4</stock_quantity>
    </sync_update_information>
  </update>
  <updated_parts>2</updated_parts>
</result>