Shipping Type(s)

Version 3.1 by Shop Team on 2019/08/01 11:05


Method

URL

Example

GET

/api/v1/shops/<shopId>/shippingTypes


This resource will list all available shipping types for the given shop.


Example Payload
{
  "offset":0,
  "limit":50,
  "count":3,
  "sortField":"default",
  "sortOrder":"default",
  "shippingTypes":[
      {
        "href":"https://api.spreadshirt.net/api/v1/shops/100488332/shippingTypes/1",
        "id":"1"
      },
      {
        "href":"https://api.spreadshirt.net/api/v1/shops/100488332/shippingTypes/12",
        "id":"12"
      },
      {
        "href":"https://api.spreadshirt.net/api/v1/shops/100488332/shippingTypes/18",
        "id":"18"
      }
   ],
  "href":"https://api.spreadshirt.net/api/v1/shops/100488332/shippingTypes"
}


Method

URL

Example

GET

/api/v1/shops/<shopId>/shippingTypes/<shippingTypeId>


This resource will return all required information to calculate shipping costs for the given shipping type.


Example Payload
{
  "href":"https://api.spreadshirt.net/api/v1/shops/100488332/shippingTypes/1",
  "id":"1",
  "lifeCycleState":"ACTIVATED",
  "weight":1.0,
  "isExpress":false,
  "phoneNumberRequired":false,
  "supportsPackstation":true,
  "name":"Standard",
  "description":"Tracking and delivery date not guaranteed. May be mailed via envelope.",
  "trackingLink":{
     "href":"http://nolp.dhl.de/nextt-online-public/set_identcodes.do?lang=de&idc={trackingCode}&rfn=&extendedSearch=true"
   },
  "shippingProviderId":"@home",
  "shippingAccountId":"@HOME",
  "shippingCountries":[
      {
        "id":"60",
        "created":"1970-01-02T23:00:00.000+0000",
        "modified":"2019-02-19T09:18:47.000+0000",
        "lifeCycleState":"ACTIVATED",
        "name":"Bahamas",
        "isoCode":"BS",
        "shippingRegion":{
           "id":"5"
         },
        "shippingSupported":true,
        "externalFulfillmentSupported":true,
        "shippingStates":[

         ],
        "customs":true
      },
      {
        "id":"279",
        "created":"1970-01-02T23:00:00.000+0000",
        "modified":"2019-02-19T09:18:49.000+0000",
        "lifeCycleState":"ACTIVATED",
        "name":"British Virgin Islands",
        "isoCode":"VG",
        "shippingRegion":{
           "id":"5"
         },
        "shippingSupported":true,
        "externalFulfillmentSupported":true,
        "shippingStates":[

         ],
        "customs":true
      },
      {
        "id":"286",
        "created":"1970-01-02T23:00:00.000+0000",
        "modified":"2019-02-19T09:18:49.000+0000",
        "lifeCycleState":"ACTIVATED",
        "name":"Cayman Islands",
        "isoCode":"KY",
        "shippingRegion":{
           "id":"5"
         },
        "shippingSupported":true,
        "externalFulfillmentSupported":true,
        "shippingStates":[

         ],
        "customs":true
      },
   ],
  "shippingRegions":[
      {
        "id":"1",
        "shippingCosts":[
            {
              "orderValueRange":{
                 "from":0.00,
                 "to":0.01,
                 "currency":{
                    "href":"https://api.spreadshirt.net/api/v1/currencies/1",
                    "id":"1"
                  }
               },
              "cost":{
                 "vatExcluded":0.00,
                 "vatIncluded":0.00,
                 "vat":19.00,
                 "currency":{
                    "href":"https://api.spreadshirt.net/api/v1/currencies/1",
                    "id":"1"
                  }
               },
              "vatGroupId":"1"
            },
            {
              "orderValueRange":{
                 "from":0.01,
                 "to":24.99,
                 "currency":{
                    "href":"https://api.spreadshirt.net/api/v1/currencies/1",
                    "id":"1"
                  }
               },
              "cost":{
                 "vatExcluded":3.35,
                 "vatIncluded":3.99,
                 "vat":19.00,
                 "currency":{
                    "href":"https://api.spreadshirt.net/api/v1/currencies/1",
                    "id":"1"
                  }
               },
              "vatGroupId":"1"
            },
            {
              "orderValueRange":{
                 "from":24.99,
                 "to":59.99,
                 "currency":{
                    "href":"https://api.spreadshirt.net/api/v1/currencies/1",
                    "id":"1"
                  }
               },
              "cost":{
                 "vatExcluded":4.19,
                 "vatIncluded":4.99,
                 "vat":19.00,
                 "currency":{
                    "href":"https://api.spreadshirt.net/api/v1/currencies/1",
                    "id":"1"
                  }
               },
              "vatGroupId":"1"
            },
            {
              "orderValueRange":{
                 "from":59.99,
                 "currency":{
                    "href":"https://api.spreadshirt.net/api/v1/currencies/1",
                    "id":"1"
                  }
               },
              "cost":{
                 "vatExcluded":5.87,
                 "vatIncluded":6.99,
                 "vat":19.00,
                 "currency":{
                    "href":"https://api.spreadshirt.net/api/v1/currencies/1",
                    "id":"1"
                  }
               },
              "vatGroupId":"1"
            }
         ]
      },
      {
        "id":"2",
        "shippingCosts":[
            {
              "orderValueRange":{
                 "from":0.00,
                 "to":0.01,
                 "currency":{
                    "href":"https://api.spreadshirt.net/api/v1/currencies/1",
                    "id":"1"
                  }
               },
              "cost":{
                 "vatExcluded":0.00,
                 "vatIncluded":0.00,
                 "vat":19.00,
                 "currency":{
                    "href":"https://api.spreadshirt.net/api/v1/currencies/1",
                    "id":"1"
                  }
               },
              "vatGroupId":"1"
            },
            {
              "orderValueRange":{
                 "from":0.01,
                 "to":24.99,
                 "currency":{
                    "href":"https://api.spreadshirt.net/api/v1/currencies/1",
                    "id":"1"
                  }
               },
              "cost":{
                 "vatExcluded":3.35,
                 "vatIncluded":3.99,
                 "vat":19.00,
                 "currency":{
                    "href":"https://api.spreadshirt.net/api/v1/currencies/1",
                    "id":"1"
                  }
               },
              "vatGroupId":"1"
            },
            {
              "orderValueRange":{
                 "from":24.99,
                 "to":59.99,
                 "currency":{
                    "href":"https://api.spreadshirt.net/api/v1/currencies/1",
                    "id":"1"
                  }
               },
              "cost":{
                 "vatExcluded":5.03,
                 "vatIncluded":5.99,
                 "vat":19.00,
                 "currency":{
                    "href":"https://api.spreadshirt.net/api/v1/currencies/1",
                    "id":"1"
                  }
               },
              "vatGroupId":"1"
            },
            {
              "orderValueRange":{
                 "from":59.99,
                 "currency":{
                    "href":"https://api.spreadshirt.net/api/v1/currencies/1",
                    "id":"1"
                  }
               },
              "cost":{
                 "vatExcluded":6.71,
                 "vatIncluded":7.99,
                 "vat":19.00,
                 "currency":{
                    "href":"https://api.spreadshirt.net/api/v1/currencies/1",
                    "id":"1"
                  }
               },
              "vatGroupId":"1"
            }
         ]
      },
   ]
}



Tags:
Created by Shop Team on 2019/08/01 10:56
    

Navigation