Freight (Source)

Method to calculate freight on your system

This API is to partners that provide SHIPPING INFORMATION and should be implemented in the parter side to provide to PluggTo information about the shipping cost.

Attention: This answer shoud take 0.200 seconds maximum.

PluggTo will POST to a URL pre-register with the folling information:

Be aware that depending the MarketPlace one or other information maybe will be empty.

AttributeTypeDescription
destination_postalcodestringDestination postal code (CEP)
possible value: 03881-070 OR 03881070
destination_statestringDestination state
user_idnumberPlugg.to user id
origin_postalcodestringOrigin postal code
origin_statestringOrigin state
origin_citystringOrigin city
origin_countrystringOrigin country
productsarrayArray with product information
weightnumberItem Weight
heightnumberItem Height
lengthnumberItem Length
widthnumberItem Width
unit_pricenumberSales price of the product unit
departmentstringDepartment
crossdockingnumberCrossdocking
skustringSimple product SKU or "parent"
categoryarrayCategory
marketplacestringItem category
original_skustringSimple product SKU or variation
idstringProduct pluggto_id
quantitystringQuantity of product to ship

Request body example

{
   "destination_postalcode":"69301-340",
   "destination_state":"RR",
   "user_id":129,
   "origin_postalcode":"05004015",
   "origin_state":"SP",
   "origin_city":"SAO PAULO",
   "origin_country":"BR",
   "products":[
      {
         "weight":0.45,
         "height":3,
         "length":32,
         "width":11,
         "unit_price":54.188,
         "department":null,
         "crossdocking":1,
         "sku":"100",
         "category":[
            {
               "name":"Refis e Elementos Filtrantes",
               "id":"5d938c389b9353c55143b71a"
            },
            {
               "name":"Elementos Filtrantes > Refil",
               "id":"5e5fe2eaab550048b7b2e6b9"
            },
            {
               "name":"Refil",
               "id":"5e5fe2eaab550048b7b2e6ba"
            }
         ],
         "marketplace":null,
         "original_sku":"100",
         "id":"5d938c389b9353c55143b715",
         "quantity":"1"
      }
   ]
}

The success answer should be:

AttributeTypeDescription
methodstring Shipping method
companystringShipping company
delivery_typestringDelivery type
messagestringMessage
pricestringFreight price
estimatenumberEstimated product delivery

Returned exemple

[
   {
      "method":"Service 1",
      "company":"Company Name",
      "delivery_type":"express",
      "message":null,
      "price":"463.46",
      "estimate":6
   },
   {
      "method":"Service 2",
      "company":"Company Name",
      "delivery_type":"standard",
      "message":null,
      "price":"263.97",
      "estimate":9
   }
]

In case of an error in calculating the freight,

Returned exemple

[
{
"mensage": "it was not possible to calculate product shipping"
}
]
Language
Click Try It! to start a request and see the response here!