Shipping Service

ShippingService is used to manage products. You can add, update and find products in addition to managing follow up sequences, tags and action sets.


ShippingService.getAllShippingOptions

Returns all shipping options configured

Required Parameters

Parameter Name Type Definition
Key string Your Infusionsoft API key

Sample Request

<?xml version='1.0' encoding='UTF-8'?>
<methodCall>
  <methodName>ShippingService.getAllShippingOptions</methodName>
  <params>
    <param>
      <value><string>privateKey</string></value>
    </param>
  </params>
</methodCall>

Sample Response

<?xml version='1.0' encoding='UTF-8'?>
<methodResponse>
  <params>
    <param>
      <value><array><data/></array></value>
    </param>
  </params>
</methodResponse>

PHP iSDK Sample

$app->getAllConfiguredShippingOptions();

Returns the options and values of the flat rate shipping option provided

Required Parameters

Parameter Name Type Definition
Key string Your Infusionsoft API key
optionId int The Id for the shipping option

Sample Request

<?xml version='1.0' encoding='UTF-8'?>
<methodCall>
  <methodName>ShippingService.getFlatRateShippingOption</methodName>
  <params>
    <param>
      <value><string>privateKey</string></value>
    </param>
    <param>
      <value><int>optionId</int></value>
    </param>
  </params>
</methodCall>

Sample Response

<?xml version='1.0' encoding='UTF-8'?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>id</name>
            <value>1</value>
          </member>
          <member>
            <name>price</name>
            <value>0.0</value>
          </member>
          <member>
            <name>description</name>
            <value>test</value>
          </member>
          <member>
            <name>orderBased</name>
            <value>false</value>
          </member>
          <member>
            <name>name</name>
            <value>Flat Rate Per Order</value>
          </member>
          <member>
            <name>international</name>
            <value>false</value>
          </member>
          <member>
            <name>active</name>
            <value>true</value>
          </member>
          <member>
            <name>type</name>
            <value>Flat</value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>

PHP iSDK Sample

$app->getFlatRateShippingOption(1);

Returns the options and values of the order total shipping option provided

Required Parameters

Parameter Name Type Definition
Key string Your Infusionsoft API key
optionId int The Id for the shipping option

Sample Request

<?xml version='1.0' encoding='UTF-8'?>
<methodCall>
  <methodName>ShippingService.getOrderTotalShippingOption</methodName>
  <params>
    <param>
      <value><string>privateKey</string></value>
    </param>
    <param>
      <value><int>optionId</int></value>
    </param>
  </params>
</methodCall>

Sample Response

<?xml version='1.0' encoding='UTF-8'?>
<methodResponse>
  <params>
    <param>
      <value>
        <array>
          <data/>
        </array>
      </value>
    </param>
  </params>
</methodResponse>

PHP iSDK Sample

$app->getOrderTotalShippingOption(1);

Returns the options and values of the order total shipping ranges option provided

Required Parameters

Parameter Name Type Definition
Key string Your Infusionsoft API key
optionId int The Id for the shipping option

Sample Request

<?xml version='1.0' encoding='UTF-8'?>
<methodCall>
  <methodName>ShippingService.getOrderTotalShippingRanges</methodName>
  <params>
    <param>
      <value><string>privateKey</string></value>
    </param>
    <param>
      <value><int>optionId</int></value>
    </param>
  </params>
</methodCall>

Sample Response

<?xml version='1.0' encoding='UTF-8'?>
<methodResponse>
  <params>
    <param>
      <value>
        <array>
          <data/>
        </array>
      </value>
    </param>
  </params>
</methodResponse>

PHP iSDK Sample

$app->getOrderTotalShippingRanges(1);

Returns the options and values of the product based shipping option provided

Required Parameters

Parameter Name Type Definition
Key string Your Infusionsoft API key
optionId int The Id for the shipping option

Sample Request

<?xml version='1.0' encoding='UTF-8'?>
<methodCall>
  <methodName>ShippingService.getProductBasedShippingOption</methodName>
  <params>
    <param>
      <value><string>privateKey</string></value>
    </param>
    <param>
      <value><int>optionId</int></value>
    </param>
  </params>
</methodCall>

Sample Response

<?xml version='1.0' encoding='UTF-8'?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>id</name>
            <value>3</value>
          </member>
          <member>
            <name>description</name>
            <value/>
          </member>
          <member>
            <name>name</name>
            <value>Specific Price Per Product</value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>

PHP iSDK Sample

$app->getProductBasedShippingOption(1);

Returns the options and values of the order quantity shipping option provided

Required Parameters

Parameter Name Type Definition
Key string Your Infusionsoft API key
optionId int The Id for the shipping option

Sample Request

<?xml version='1.0' encoding='UTF-8'?>
<methodCall>
  <methodName>ShippingService.getOrderQuantityShippingOption</methodName>
  <params>
    <param>
      <value><string>privateKey</string></value>
    </param>
    <param>
      <value><int>optionId</int></value>
    </param>
  </params>
</methodCall>

Sample Response

<?xml version='1.0' encoding='UTF-8'?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>id</name>
            <value>7</value>
          </member>
          <member>
            <name>baseShippingPrice</name>
            <value>1.0</value>
          </member>
          <member>
            <name>pricePerItem</name>
            <value>1.0</value>
          </member>
          <member>
            <name>description</name>
            <value/>
          </member>
          <member>
            <name>orderBased</name>
            <value>false</value>
          </member>
          <member>
            <name>name</name>
            <value>test quan</value>
          </member>
          <member>
            <name>international</name>
            <value>false</value>
          </member>
          <member>
            <name>active</name>
            <value>true</value>
          </member>
          <member>
            <name>type</name>
            <value>Quantity</value>
          </member>
          <member>
            <name>minimumShippingPrice</name>
            <value>1.0</value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>

PHP iSDK Sample

$app->getOrderQuantityShippingOption(1);

Returns the options and values of the weight based shipping option provided

Required Parameters

Parameter Name Type Definition
Key string Your Infusionsoft API key
optionId int The Id for the shipping option

Sample Request

<?xml version='1.0' encoding='UTF-8'?>
<methodCall>
  <methodName>ShippingService.getWeightBasedShippingOption</methodName>
  <params>
    <param>
      <value><string>privateKey</string></value>
    </param>
    <param>
      <value><int>optionId</int></value>
    </param>
  </params>
</methodCall>

Sample Response

<?xml version='1.0' encoding='UTF-8'?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>id</name>
            <value>11</value>
          </member>
          <member>
            <name>description</name>
            <value/>
          </member>
          <member>
            <name>name</name>
            <value>Ship by Weight</value>
          </member>
          <member>
            <name>orderBased</name>
            <value>true</value>
          </member>
          <member>
            <name>international</name>
            <value>false</value>
          </member>
          <member>
            <name>active</name>
            <value>true</value>
          </member>
          <member>
            <name>type</name>
            <value>Weight</value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>

PHP iSDK Sample

$app->getWeightBasedShippingOption(1);

ShippingService.getUpsShippingOption

Returns the options and values of the ups shipping option provided

Required Parameters

Parameter Name Type Definition
Key string Your Infusionsoft API key
optionId int The Id for the shipping option

Sample Request

<?xml version='1.0' encoding='UTF-8'?>
<methodCall>
  <methodName>ShippingService.getUpsShippingOption</methodName>
  <params>
    <param>
      <value><string>privateKey</string></value>
    </param>
    <param>
      <value><int> optionId </int></value>
    </param>
  </params>
</methodCall>

Sample Response

<?xml version='1.0' encoding='UTF-8'?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>deliveryType</name>
            <value>01,03,07</value>
          </member>
          <member>
            <name>orderBased</name>
            <value>false</value>
          </member>
          <member>
            <name>international</name>
            <value>false</value>
          </member>
          <member>
            <name>accessLicenseNumber</name>
            <value>niewonfidso</value>
          </member>
          <member>
            <name>type</name>
            <value>UPS</value>
          </member>
          <member>
            <name>pickupType</name>
            <value>01</value>
          </member>
          <member>
            <name>id</name>
            <value>13</value>
          </member>
          <member>
            <name>accountNumber</name>
            <value>39208234</value>
          </member>
          <member>
            <name>accessPassword</name>
            <value>ronald11</value>
          </member>
          <member>
            <name>destinationType</name>
            <value>0</value>
          </member>
          <member>
            <name>description</name>
            <value/>
          </member>
          <member>
            <name>packagingType</name>
            <value>01</value>
          </member>
          <member>
            <name>name</name>
            <value>UPS</value>
          </member>
          <member>
            <name>active</name>
            <value>true</value>
          </member>
          <member>
            <name>accessUserId</name>
            <value>ron</value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>

PHP iSDK Sample

$app->getUpsShippingOption(1);