GetShippingQuote

Endpoint URL https://www.yournetosite.com.au/do/WS/NetoAPI
Method POST
XML Headers
NETOAPI_ACTION GetShippingQuote
NETOAPI_USERNAME Your Neto Username (generate this in your Neto control panel)
NETOAPI_KEY Your Neto API Secure Key (generate this in your Neto control panel)
JSON Headers
NETOAPI_ACTION GetShippingQuote
NETOAPI_USERNAME Your Neto Username (generate this in your Neto control panel)
NETOAPI_KEY Your Neto API Secure Key (generate this in your Neto control panel)
Accept application/json
Description
XSD Schema GetShippingQuote XSD   |   GetShippingQuote Response XSD

GetShippingQuote Post

You must specify at least one filter and one OutputSelector in your GetShippingQuote request. These will determine the results returned.

XML POST

<?xml version="1.0" encoding="utf-8"?>
<GetShippingQuote>
   <ShippingQuote> 
    <ShipStreetLine1>(String)</ShipStreetLine1>    
    <ShipStreetLine2>(String)</ShipStreetLine2>    
    <ShipPostCode>(String)</ShipPostCode>    
    <ShipCountry>(String)</ShipCountry>    
    <ShipCity>(String)</ShipCity>    
    <ShipState>(String)</ShipState>    
    <ShipPOBox>(Boolean)</ShipPOBox>    
    <TaxInclusive>(Boolean)</TaxInclusive>    
     <OrderLines> 
       <OrderLine> 
        <SKU>(String)</SKU>        
        <Quantity>(Integer)</Quantity>        
        <UnitPrice>(Decimal)</UnitPrice>        
       </OrderLine>      
     </OrderLines>     <ShippingMethod> 
      <ID>(Integer)</ID>      
     </ShippingMethod>   </ShippingQuote>
</GetShippingQuote>

JSON POST

{
  "ShippingQuote": {
    "ShipStreetLine1":"String",
    "ShipStreetLine2":"String",
    "ShipPostCode":"String",
    "ShipCountry":"String",
    "ShipCity":"String",
    "ShipState":"String",
    "ShipPOBox":"Boolean",
    "TaxInclusive":"Boolean",
    "OrderLines": {
      "OrderLine": [ {
        "SKU":"String",
        "Quantity":"Integer",
        "UnitPrice":"Decimal" 
} ]  
} ,    "ShippingMethod": {
      "ID":"Integer" 
}  
} 
}

<ShippingQuote>

Element Name Required Field Type / Options
ShipStreetLine1 Optional String(50)
ShipStreetLine2 Optional String(50)
ShipPostCode Required String(15)
ShipCountry Required String(2)
ShipCity Required String(50)
ShipState Required String(50)
ShipPOBox Required Boolean(True, False)
TaxInclusive Optional Boolean(True, False)
OrderLines Optional OrderLinesType
ShippingMethod Optional ShippingMethodType

<OrderLines>

Element Name Required Field Type / Options
OrderLine Optional
Supports Multiple Elements
OrderLineType

<OrderLine>

Element Name Required Field Type / Options
SKU Required String(25)
Quantity Required Integer
UnitPrice Optional Decimal

<ShippingMethod>

Element Name Required Field Type / Options
ID Required Integer

GetShippingQuote Responses

XML Response

<?xml version="1.0" encoding="utf-8"?>
<GetShippingQuote>
   <ShippingQuotes> 
     <ShippingQuote> 
      <PickUp>(Boolean)</PickUp>      
      <ShipPOBox>(Boolean)</ShipPOBox>      
      <DeliveryTime>(Integer)</DeliveryTime>      
      <ShippingCost>(Decimal)</ShippingCost>      
      <TaxInclusive>(Boolean)</TaxInclusive>      
       <ShippingMethod> 
        <ID>(Integer)</ID>        
        <Name>(String)</Name>        
        <Description>(String)</Description>        
       </ShippingMethod>     </ShippingQuote>    
   </ShippingQuotes>  
   <Messages> 
     <Error> 
      <Message>(String)</Message>      
      <SeverityCode>(String)</SeverityCode>      
      <Description>(String)</Description>      
     </Error>    
     <Warning> 
      <Message>(String)</Message>      
      <SeverityCode>(String)</SeverityCode>      
     </Warning>    
   </Messages>
</GetShippingQuote>

JSON Response

{
  "ShippingQuotes": [ {
    "ShippingQuote": [ {
      "PickUp":"Boolean",
      "ShipPOBox":"Boolean",
      "DeliveryTime":"Integer",
      "ShippingCost":"Decimal",
      "TaxInclusive":"Boolean",
      "ShippingMethod": {
        "ID":"Integer",
        "Name":"String",
        "Description":"String" 
}  
} ]  
} ] ,  "Messages": {
    "Error": [ {
      "Message":"String",
      "SeverityCode":"String",
      "Description":"String" 
} ] ,    "Warning": [ {
      "Message":"String",
      "SeverityCode":"String" 
} ]  
} 
}

<ShippingQuotes>

Element Name Field Type
ShippingQuote ShippingQuoteType

<ShippingQuote>

Element Name Field Type
PickUp Boolean
ShipPOBox Boolean
DeliveryTime Integer
ShippingCost Decimal
TaxInclusive Boolean
ShippingMethod ShippingMethodType

<ShippingMethod>

Element Name Field Type
ID Integer
Name String
Description String

<Messages>

Element Name Field Type
Error ErrorType
Warning WarningType

<Error>

Element Name Field Type
Message String
SeverityCode String
Description String

<Warning>

Element Name Field Type
Message String
SeverityCode String

If you are a vendor creating an integration with Neto by Maropost, we would like to hear from you!

Contact Us

Was this article useful?

Be notified when this page is updated. Optional.