{toc}
h1. Resources
h2. Retrieve User ShippingTypes List
|| Url | .../v1/users/\{userId\}/shippingTypes ||
|| Sample | [http://api.spreadshirt.net/api/v1/users/40000/shippingTypes] ||
|| Type | List ||
|| Method | GET ||
|| Special Status Codes | ||
*Payload:*
{code}
<shippingTypes ...>
<shippingType ...>
<!-- see payload below -->
</shippingType>
...
</shippingTypes>
{code}
See [Shipping Type Representation|#Shipping Type]
h2. Retrieve User ShippingType Entity
|| Url | .../v1/users/\{userId\}/shippingTypes/\{shippingTypeId\} ||
|| Sample | [http://api.spreadshirt.net/api/v1/users/40000/shippingTypes/1] ||
|| Type | Entity ||
|| Method | GET ||
|| Special Status Codes | ||
*Payload:*
{code}
<shippingType ...>
...
</shippingType>
{code}
See [Shipping Type Representation|#Shipping Type]
h2. Retrieve Shop ShippingTypes List
|| Url | .../v1/shops/\{shopId\}/shippingTypes ||
|| Sample | [http://api.spreadshirt.net/api/v1/shops/205909/shippingTypes] ||
|| Type | List ||
|| Method | GET ||
|| Special Status Codes | ||
*Payload:*
{code}
<shippingTypes ...>
<shippingType ...>
<!-- see payload below -->
</shippingType>
...
</shippingTypes>
{code}
See [Shipping Type Representation|#Shipping Type]
h2. Retrieve Shop ShippingType Entity
|| Url | .../v1/shops/\{shopId\}/shippingTypes/\{shippingTypeId\} ||
|| Sample | [http://api.spreadshirt.net/api/v1/shops/205909/shippingTypes/1] ||
|| Type | Entity ||
|| Method | GET ||
|| Special Status Codes | ||
*Payload:*
{code}
<shippingType ...>
...
</shippingType>
{code}
See [Shipping Type Representation|#Shipping Type]
h1. Payload
h2. ShippingType
|| Field || Description ||
| shippingType | Representation of a platform shipping type. |
| shippingType/name | Name of this shipping type, e.g. Standard. |
| shippingType/description | Description of this shipping type. |
| shippingType/trackingLink | A default link to the shipping carriers web site that allows to track the progress of a package delivery, e.g. link to DHL web site. |
| shippingType/shippingCountries | Shipping countries supported by this shipping type, e.g. Germany |
| shippingType/shippingRegions | Shipping regions supported by this shipping type, e.g. shipping region 1 - Western Europe countries |
Example:
{code}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<shippingType xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns="http://api.spreadshirt.net"
id="1" xlink:href="http://api.spreadshirt.net/api/v1/shops/205909/shippingTypes">
<name>Standard</name>
<description>Standard delivery eu</description>
<trackingLink xlink:href="http://dhl.de?idc={trackingCode}"/> <shippingCountries>
...
</shippingCountries>
<shippingRegions>
...
</shippingRegions>
...
</shippingType>
{code}
Explanation:
* shippingType - standard or express in eu; in na more different options
* shippingCountry - the country to be shipped to; links cost group
* shippingRegion - costs for one region
* shippingCost - orderValueFrom and orderValueTo tell you for which ranges which costs apply
h2. ShippingCountry
|| Field || Description ||
| shippingCountry | Representation of a platform shipping country. |
| shippingCountry/name | The name of this shipping country, e.g. Germany. |
| shippingCountry/isoCode | The isoCode of this shipping country, e.g. US, that can be used to set the correct countryCode in a shipping address for example. |
| shippingCountry/shippingRegion | The shipping region this shipping country belongs to, e.g. Germany belongs to shipping region Western Europe. |
| shippingCountry/shippingSupported | Indicates whether shipping is supported to this shipping country for this shipping type, i.e. orders are created via Spreadshirt checkout. |
| shippingCountry/externalFulfillmentSupported | Indicates whether shipping is supported to this shipping country for this shipping type for external fulfillment orders, i.e. orders are created via an external checkout (partner implemented checkout). |
| shippingCountry/trackingLink | A link to the shipping carriers web site that allows to track the progress of a package delivery, e.g. link to DHL web site. |
| shippingCountry/shippingStates | A list of shipping states that belong to the shipping country, e.g. California (CA) belongs to the United States (US). |
Example:
{code}
<shippingCountry id="1">
<name>Germany</name>
<isoCode>DE</isoCode>
<shippingRegion id="1"/>
<shippingSupported>true</shippingSupported>
<externalFulfillmentSupported>true</externalFulfillmentSupported>
<trackingLink xlink:href="http://dhl.de?idc={trackingCode}"/>
</shippingCountry>
{code}
or
{code}
<shippingCountry id="86">
<name>United States</name>
<isoCode>US</isoCode>
<shippingRegion id="1"/>
<shippingSupported>true</shippingSupported>
<externalFulfillmentSupported>true</externalFulfillmentSupported>
<shippingStates>
...
</shippingStates>
</shippingCountry>
{code}
h2. ShippingState
|| Field || Description ||
| shippingState | Representation of a platform shipping state. |
| shippingState/name | The name of this shipping state, e.g. California. |
| shippingState/isoCode | The isoCode of this shipping state, e.g. US, that can be used to set the correct stateCode in a shipping address for example. |
| shippingState/shippingRegion | The shipping region this shipping state belongs to, e.g. California belongs to shipping region North America. |
| shippingState/shippingSupported | Indicates whether shipping is supported to this shipping state for this shipping type, i.e. orders are created via Spreadshirt checkout. |
| shippingState/externalFulfillmentSupported | Indicates whether shipping is supported to this shipping state for this shipping type for external fulfillment orders, i.e. orders are created via an external checkout (partner implemented checkout). |
| shippingState/trackingLink | A link to the shipping carriers web site that allows to track the progress of a package delivery, e.g. link to DHL web site. |
Example:
{code}
<shippingState id="200">
<name>California</name>
<isoCode>CA</isoCode>
<shippingRegion id="1"/>
<shippingSupported>true</shippingSupported>
<externalFulfillmentSupported>true</externalFulfillmentSupported>
</shippingState>
{code}
h2. ShippingRegion
|| Field || Description ||
| shippingRegion | Representation of a platform shipping region. |
| shippingRegion/shippingCosts | Shipping costs for this shipping region for the different order values. |
| shippingRegion/shippingCosts/shippingCost | Shipping costs for a specific order value. |
| shippingRegion/shippingCosts/shippingCost/orderValueRange | The order value range for which the given shipping costs hold. |
| shippingRegion/shippingCosts/shippingCost/cost | The actual costs. |
Example:
{code}
<shippingRegion id="1">
<shippingCosts>
<shippingCost>
<orderValueRange>
<from>0.0</from>
<to>24.89</to>
<currency id="1" xlink:href="http://api.spreadshirt.net/v1/currencies/1"/>
</orderValueRange>
<cost>
<vatIncluded>2.9</vatIncluded>
<currency id="1" xlink:href="http://api.spreadshirt.net/v1/currencies/1"/>
</cost>
</shippingCost>
<shippingCost>
<orderValueRange>
<from>24.90</from>
<to>59.99</to>
<currency id="1" xlink:href="http://api.spreadshirt.net/v1/currencies/1"/>
</orderValueRange>
<cost>
<vatIncluded>3.9</vatIncluded>
<currency id="1" xlink:href="http://api.spreadshirt.net/v1/currencies/1"/>
</cost>
</shippingCost>
<shippingCost>
<orderValueRange>
<from>60.0</from>
<to>500.0</to>
<currency id="1" xlink:href="http://api.spreadshirt.net/v1/currencies/1"/>
</orderValueRange>
<cost>
<vatIncluded>0.0</vatIncluded>
<currency id="1" xlink:href="http://api.spreadshirt.net/v1/currencies/1"/>
</cost>
</shippingCost>
<shippingCost>
<orderValueRange>
<vatIncluded>500.0</vatIncluded>
<currency id="1" xlink:href="http://api.spreadshirt.net/v1/currencies/1"/>
</orderValueRange>
<cost>
<vatIncluded>0.0</vatIncluded>
<currency id="1" xlink:href="http://api.spreadshirt.net/v1/currencies/1"/>
</cost>
</shippingCost>
...
</shippingCosts>
</shippingRegion>
{code}
h1. Resources
h2. Retrieve User ShippingTypes List
|| Url | .../v1/users/\{userId\}/shippingTypes ||
|| Sample | [http://api.spreadshirt.net/api/v1/users/40000/shippingTypes] ||
|| Type | List ||
|| Method | GET ||
|| Special Status Codes | ||
*Payload:*
{code}
<shippingTypes ...>
<shippingType ...>
<!-- see payload below -->
</shippingType>
...
</shippingTypes>
{code}
See [Shipping Type Representation|#Shipping Type]
h2. Retrieve User ShippingType Entity
|| Url | .../v1/users/\{userId\}/shippingTypes/\{shippingTypeId\} ||
|| Sample | [http://api.spreadshirt.net/api/v1/users/40000/shippingTypes/1] ||
|| Type | Entity ||
|| Method | GET ||
|| Special Status Codes | ||
*Payload:*
{code}
<shippingType ...>
...
</shippingType>
{code}
See [Shipping Type Representation|#Shipping Type]
h2. Retrieve Shop ShippingTypes List
|| Url | .../v1/shops/\{shopId\}/shippingTypes ||
|| Sample | [http://api.spreadshirt.net/api/v1/shops/205909/shippingTypes] ||
|| Type | List ||
|| Method | GET ||
|| Special Status Codes | ||
*Payload:*
{code}
<shippingTypes ...>
<shippingType ...>
<!-- see payload below -->
</shippingType>
...
</shippingTypes>
{code}
See [Shipping Type Representation|#Shipping Type]
h2. Retrieve Shop ShippingType Entity
|| Url | .../v1/shops/\{shopId\}/shippingTypes/\{shippingTypeId\} ||
|| Sample | [http://api.spreadshirt.net/api/v1/shops/205909/shippingTypes/1] ||
|| Type | Entity ||
|| Method | GET ||
|| Special Status Codes | ||
*Payload:*
{code}
<shippingType ...>
...
</shippingType>
{code}
See [Shipping Type Representation|#Shipping Type]
h1. Payload
h2. ShippingType
|| Field || Description ||
| shippingType | Representation of a platform shipping type. |
| shippingType/name | Name of this shipping type, e.g. Standard. |
| shippingType/description | Description of this shipping type. |
| shippingType/trackingLink | A default link to the shipping carriers web site that allows to track the progress of a package delivery, e.g. link to DHL web site. |
| shippingType/shippingCountries | Shipping countries supported by this shipping type, e.g. Germany |
| shippingType/shippingRegions | Shipping regions supported by this shipping type, e.g. shipping region 1 - Western Europe countries |
Example:
{code}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<shippingType xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns="http://api.spreadshirt.net"
id="1" xlink:href="http://api.spreadshirt.net/api/v1/shops/205909/shippingTypes">
<name>Standard</name>
<description>Standard delivery eu</description>
<trackingLink xlink:href="http://dhl.de?idc={trackingCode}"/> <shippingCountries>
...
</shippingCountries>
<shippingRegions>
...
</shippingRegions>
...
</shippingType>
{code}
Explanation:
* shippingType - standard or express in eu; in na more different options
* shippingCountry - the country to be shipped to; links cost group
* shippingRegion - costs for one region
* shippingCost - orderValueFrom and orderValueTo tell you for which ranges which costs apply
h2. ShippingCountry
|| Field || Description ||
| shippingCountry | Representation of a platform shipping country. |
| shippingCountry/name | The name of this shipping country, e.g. Germany. |
| shippingCountry/isoCode | The isoCode of this shipping country, e.g. US, that can be used to set the correct countryCode in a shipping address for example. |
| shippingCountry/shippingRegion | The shipping region this shipping country belongs to, e.g. Germany belongs to shipping region Western Europe. |
| shippingCountry/shippingSupported | Indicates whether shipping is supported to this shipping country for this shipping type, i.e. orders are created via Spreadshirt checkout. |
| shippingCountry/externalFulfillmentSupported | Indicates whether shipping is supported to this shipping country for this shipping type for external fulfillment orders, i.e. orders are created via an external checkout (partner implemented checkout). |
| shippingCountry/trackingLink | A link to the shipping carriers web site that allows to track the progress of a package delivery, e.g. link to DHL web site. |
| shippingCountry/shippingStates | A list of shipping states that belong to the shipping country, e.g. California (CA) belongs to the United States (US). |
Example:
{code}
<shippingCountry id="1">
<name>Germany</name>
<isoCode>DE</isoCode>
<shippingRegion id="1"/>
<shippingSupported>true</shippingSupported>
<externalFulfillmentSupported>true</externalFulfillmentSupported>
<trackingLink xlink:href="http://dhl.de?idc={trackingCode}"/>
</shippingCountry>
{code}
or
{code}
<shippingCountry id="86">
<name>United States</name>
<isoCode>US</isoCode>
<shippingRegion id="1"/>
<shippingSupported>true</shippingSupported>
<externalFulfillmentSupported>true</externalFulfillmentSupported>
<shippingStates>
...
</shippingStates>
</shippingCountry>
{code}
h2. ShippingState
|| Field || Description ||
| shippingState | Representation of a platform shipping state. |
| shippingState/name | The name of this shipping state, e.g. California. |
| shippingState/isoCode | The isoCode of this shipping state, e.g. US, that can be used to set the correct stateCode in a shipping address for example. |
| shippingState/shippingRegion | The shipping region this shipping state belongs to, e.g. California belongs to shipping region North America. |
| shippingState/shippingSupported | Indicates whether shipping is supported to this shipping state for this shipping type, i.e. orders are created via Spreadshirt checkout. |
| shippingState/externalFulfillmentSupported | Indicates whether shipping is supported to this shipping state for this shipping type for external fulfillment orders, i.e. orders are created via an external checkout (partner implemented checkout). |
| shippingState/trackingLink | A link to the shipping carriers web site that allows to track the progress of a package delivery, e.g. link to DHL web site. |
Example:
{code}
<shippingState id="200">
<name>California</name>
<isoCode>CA</isoCode>
<shippingRegion id="1"/>
<shippingSupported>true</shippingSupported>
<externalFulfillmentSupported>true</externalFulfillmentSupported>
</shippingState>
{code}
h2. ShippingRegion
|| Field || Description ||
| shippingRegion | Representation of a platform shipping region. |
| shippingRegion/shippingCosts | Shipping costs for this shipping region for the different order values. |
| shippingRegion/shippingCosts/shippingCost | Shipping costs for a specific order value. |
| shippingRegion/shippingCosts/shippingCost/orderValueRange | The order value range for which the given shipping costs hold. |
| shippingRegion/shippingCosts/shippingCost/cost | The actual costs. |
Example:
{code}
<shippingRegion id="1">
<shippingCosts>
<shippingCost>
<orderValueRange>
<from>0.0</from>
<to>24.89</to>
<currency id="1" xlink:href="http://api.spreadshirt.net/v1/currencies/1"/>
</orderValueRange>
<cost>
<vatIncluded>2.9</vatIncluded>
<currency id="1" xlink:href="http://api.spreadshirt.net/v1/currencies/1"/>
</cost>
</shippingCost>
<shippingCost>
<orderValueRange>
<from>24.90</from>
<to>59.99</to>
<currency id="1" xlink:href="http://api.spreadshirt.net/v1/currencies/1"/>
</orderValueRange>
<cost>
<vatIncluded>3.9</vatIncluded>
<currency id="1" xlink:href="http://api.spreadshirt.net/v1/currencies/1"/>
</cost>
</shippingCost>
<shippingCost>
<orderValueRange>
<from>60.0</from>
<to>500.0</to>
<currency id="1" xlink:href="http://api.spreadshirt.net/v1/currencies/1"/>
</orderValueRange>
<cost>
<vatIncluded>0.0</vatIncluded>
<currency id="1" xlink:href="http://api.spreadshirt.net/v1/currencies/1"/>
</cost>
</shippingCost>
<shippingCost>
<orderValueRange>
<vatIncluded>500.0</vatIncluded>
<currency id="1" xlink:href="http://api.spreadshirt.net/v1/currencies/1"/>
</orderValueRange>
<cost>
<vatIncluded>0.0</vatIncluded>
<currency id="1" xlink:href="http://api.spreadshirt.net/v1/currencies/1"/>
</cost>
</shippingCost>
...
</shippingCosts>
</shippingRegion>
{code}