UpdateOrder

Endpoint URL https://www.yournetosite.com.au/do/WS/NetoAPI
Method POST
XML Headers
NETOAPI_ACTION UpdateOrder
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 UpdateOrder
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 Use this call to update orders/invoices. A successful call to UpdateOrder returns the unique identifier (OrderID) for the updated order, and the date and time the order was updated (CurrentTime)
XSD Schema UpdateOrder XSD   |   UpdateOrder Response XSD

Examples

Mark an order as dispatched and add shipping tracking details

Shipping tracking details are added on an orderline level so that you can ship orderlines with different shipping methods. Note: the shipping method you define must match an existing service in Neto.

Go to: Neto control panel > shipping > shipping services and rates for a list of available services.

Post

XML

<?xml version="1.0" encoding="utf-8"?>
<UpdateOrder>
    <Order>
        <OrderID>N1000</OrderID>
        <OrderStatus>Dispatched</OrderStatus>
         <SendOrderEmail>tracking</SendOrderEmail>
        <OrderLine>
            <SKU>ABC-123</SKU>
            <TrackingDetails>
                <ShippingMethod>Australia Post eParcel</ShippingMethod>
                <TrackingNumber>C123345767765</TrackingNumber>
                <DateShipped>2014-01-03 02:40:10</DateShipped>
            </TrackingDetails>
        </OrderLine>
         <OrderLine>
            <SKU>HYS-97462</SKU>
            <TrackingDetails>
                <ShippingMethod>Australia Post eParcel</ShippingMethod>
                <TrackingNumber>C123345767765</TrackingNumber>
                <DateShipped>2014-01-03 02:40:10</DateShipped>
            </TrackingDetails>
        </OrderLine>
    </Order>
</UpdateOrder>

JSON

<script type="syntaxhighlighter" class="brush: js"><![CDATA[
{
  "Order": {
    "OrderID": "N1000",
    "OrderStatus": "Dispatched",
    "SendOrderEmail": "tracking",
    "OrderLine": [
      {
        "SKU": "ABC-123",
        "TrackingDetails": {
          "ShippingMethod": "Australia Post eParcel",
          "TrackingNumber": "C123345767765",
          "DateShipped": "2014-01-03 02:40:10"
        }
      },
      {
        "SKU": "HYS-97462",
        "TrackingDetails": {
          "ShippingMethod": "Australia Post eParcel",
          "TrackingNumber": "C123345767765",
          "DateShipped": "2014-01-03 02:40:10"
        }
      }
    ]
  }
}

Response (Success)

XML

<?xml version="1.0" encoding="utf-8"?>
<UpdateOrderResponse>
   <Order>
      <OrderID>N1000</OrderID>
   </Order>
   <CurrentTime>2014-01-03 02:47:37</CurrentTime>
   <Ack>Success</Ack>
</UpdateOrderResponse>

JSON

{
    "Order": {
        "OrderID": "N1000"
    },
    "CurrentTime": "2014-12-02 04:20:40",
    "Ack": "Success"
}

UpdateOrder Post

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

XML POST

<?xml version="1.0" encoding="utf-8"?>
<UpdateOrder>
   <Order> 
    <OrderID>(String)</OrderID>    
    <PurchaseOrderNumber>(String)</PurchaseOrderNumber>    
    <OnHoldType></OnHoldType>    
    <Email>(String)</Email>    
    <BillFirstName>(String)</BillFirstName>    
    <BillLastName>(String)</BillLastName>    
    <BillCompany>(String)</BillCompany>    
    <BillStreet1>(String)</BillStreet1>    
    <BillStreet2>(String)</BillStreet2>    
    <BillCity>(String)</BillCity>    
    <BillState>(String)</BillState>    
    <BillPostCode>(String)</BillPostCode>    
    <BillContactPhone>(String)</BillContactPhone>    
    <BillCountry>(String)</BillCountry>    
    <ShipFirstName>(String)</ShipFirstName>    
    <ShipLastName>(String)</ShipLastName>    
    <ShipCompany>(String)</ShipCompany>    
    <ShipStreet1>(String)</ShipStreet1>    
    <ShipStreet2>(String)</ShipStreet2>    
    <ShipCity>(String)</ShipCity>    
    <ShipState>(String)</ShipState>    
    <ShipPostCode>(String)</ShipPostCode>    
    <ShipContactPhone>(String)</ShipContactPhone>    
    <ShipCountry>(String)</ShipCountry>    
    <EnableAddressValidation>(Boolean)</EnableAddressValidation>    
    <DeduceWarehouse>(Boolean)</DeduceWarehouse>    
    <Operator>(String)</Operator>    
    <OperatorDateUpdated>(DateTime)</OperatorDateUpdated>    
    <DateRequired>(DateTime)</DateRequired>    
    <DateRequiredUTC>(DateTime)</DateRequiredUTC>    
    <SalesPerson>(String)</SalesPerson>    
    <CustomerRef1>(String)</CustomerRef1>    
    <CustomerRef2>(String)</CustomerRef2>    
    <CustomerRef3>(String)</CustomerRef3>    
    <CustomerRef4>(String)</CustomerRef4>    
    <CustomerRef5>(String)</CustomerRef5>    
    <CustomerRef6>(String)</CustomerRef6>    
    <CustomerRef7>(String)</CustomerRef7>    
    <CustomerRef8>(String)</CustomerRef8>    
    <CustomerRef9>(String)</CustomerRef9>    
    <CustomerRef10>(String)</CustomerRef10>    
    <SalesChannel>(String)</SalesChannel>    
    <ShipInstructions>(String)</ShipInstructions>    
    <InternalOrderNotes>(String)</InternalOrderNotes>    
    <OrderStatus></OrderStatus>    
    <OrderApproval>(Boolean)</OrderApproval>    
    <PickStatus></PickStatus>    
    <ExportStatus></ExportStatus>    
    <ExportedToWMS></ExportedToWMS>    
    <SendOrderEmail>(String)</SendOrderEmail>    
    <StickyNoteTitle>(String)</StickyNoteTitle>    
    <StickyNote>(String)</StickyNote>    
     <StickyNotes> 
       <StickyNote> 
        <StickyNoteID>20</StickyNoteID>        
        <Title>(String)</Title>        
        <Description>(String)</Description>        
       </StickyNote>      
     </StickyNotes>     <OrderLine> 
      <OrderLineID>(Integer)</OrderLineID>      
      <OrderLineNumber>(Integer)</OrderLineNumber>      
      <WarehouseID>(Integer)</WarehouseID>      
      <QuantityShipped>(Integer)</QuantityShipped>      
      <WarehouseName>(String)</WarehouseName>      
      <WarehouseReference>(String)</WarehouseReference>      
      <ExternalSystemIdentifier>(String)</ExternalSystemIdentifier>      
      <ExternalOrderReference>(String)</ExternalOrderReference>      
      <ExternalOrderLineReference>(String)</ExternalOrderLineReference>      
      <SKU>(String)</SKU>      
      <ItemNotes>(String)</ItemNotes>      
      <ItemDescription>(String)</ItemDescription>      
      <ItemSerialNumber>(String)</ItemSerialNumber>      
       <TrackingDetails> 
        <ShippingMethod>(String)</ShippingMethod>        
        <TrackingNumber>(String)</TrackingNumber>        
        <DateShipped>(DateTime)</DateShipped>        
       </TrackingDetails>     </OrderLine>    
    <OrderRounding>(Decimal)</OrderRounding>    
   </Order>  

</UpdateOrder>

JSON POST

{
  "Order": [ {
    "OrderID":"String",
    "PurchaseOrderNumber":"String",
    "OnHoldType":"Enumeration",
    "Email":"String",
    "BillFirstName":"String",
    "BillLastName":"String",
    "BillCompany":"String",
    "BillStreet1":"String",
    "BillStreet2":"String",
    "BillCity":"String",
    "BillState":"String",
    "BillPostCode":"String",
    "BillContactPhone":"String",
    "BillCountry":"String",
    "ShipFirstName":"String",
    "ShipLastName":"String",
    "ShipCompany":"String",
    "ShipStreet1":"String",
    "ShipStreet2":"String",
    "ShipCity":"String",
    "ShipState":"String",
    "ShipPostCode":"String",
    "ShipContactPhone":"String",
    "ShipCountry":"String",
    "EnableAddressValidation":"Boolean",
    "DeduceWarehouse":"Boolean",
    "Operator":"String",
    "OperatorDateUpdated":"DateTime",
    "DateRequired":"DateTime",
    "DateRequiredUTC":"DateTime",
    "SalesPerson":"String",
    "CustomerRef1":"String",
    "CustomerRef2":"String",
    "CustomerRef3":"String",
    "CustomerRef4":"String",
    "CustomerRef5":"String",
    "CustomerRef6":"String",
    "CustomerRef7":"String",
    "CustomerRef8":"String",
    "CustomerRef9":"String",
    "CustomerRef10":"String",
    "SalesChannel":"String",
    "ShipInstructions":"String",
    "InternalOrderNotes":"String",
    "OrderStatus":"Enumeration",
    "OrderApproval":"Boolean",
    "PickStatus":"Enumeration",
    "ExportStatus":"Enumeration",
    "ExportedToWMS":"Enumeration",
    "SendOrderEmail":"String",
    "StickyNoteTitle":"String",
    "StickyNote":"String",
    "StickyNotes": {
      "StickyNote": [ {
        "StickyNoteID":"Integer",
        "Title":"String",
        "Description":"String" 
} ]  
} ,    "OrderLine": [ {
      "OrderLineID":"Integer",
      "OrderLineNumber":"Integer",
      "WarehouseID":"Integer",
      "QuantityShipped":"Integer",
      "WarehouseName":"String",
      "WarehouseReference":"String",
      "ExternalSystemIdentifier":"String",
      "ExternalOrderReference":"String",
      "ExternalOrderLineReference":"String",
      "SKU":"String",
      "ItemNotes":"String",
      "ItemDescription":"String",
      "ItemSerialNumber":"String",
      "TrackingDetails": {
        "ShippingMethod":"String",
        "TrackingNumber":"String",
        "DateShipped":"DateTime" 
}  
} ] ,    "OrderRounding":"Decimal" 
} ] 
}

<Order>

Element Name Required Field Type / Options
OrderID Optional String(15)
PurchaseOrderNumber Optional String(50)
OnHoldType Optional Enumeration(On Hold, Layby)
Email Required String(250)
BillFirstName Required String(50)
BillLastName Required String(50)
BillCompany Required String(50)
BillStreet1 Required String(50)
BillStreet2 Required String(50)
BillCity Required String(50)
BillState Optional String(50)
BillPostCode Optional String(15)
BillContactPhone Optional String(30)
BillCountry Required String(2)
ShipFirstName Required String(50)
ShipLastName Required String(50)
ShipCompany Required String(50)
ShipStreet1 Required String(50)
ShipStreet2 Required String(50)
ShipCity Required String(50)
ShipState Optional String(50)
ShipPostCode Optional String(15)
ShipContactPhone Optional String(30)
ShipCountry Optional String(2)
EnableAddressValidation Optional Boolean(True, False)
DeduceWarehouse Optional Boolean(True, False)
Operator Optional String(25)
OperatorDateUpdated Optional DateTime
DateRequired Optional DateTime
DateRequiredUTC Optional DateTime
SalesPerson Optional String(25)
CustomerRef1 Optional String(50)
CustomerRef2 Optional String(50)
CustomerRef3 Optional String(1000)
CustomerRef4 Optional String(1000)
CustomerRef5 Optional String(1000)
CustomerRef6 Optional String(1000)
CustomerRef7 Optional String(1000)
CustomerRef8 Optional String(1000)
CustomerRef9 Optional String(1000)
CustomerRef10 Optional String(1000)
SalesChannel Optional String(15)
ShipInstructions Optional String
InternalOrderNotes Optional String
OrderStatus Optional Enumeration(Quote, New, New Backorder, Backorder Approved, Pick, Pack, Pending Pickup, Pending Dispatch, Dispatched, Cancelled, Uncommitted, On Hold)
OrderApproval Optional Boolean(True, False)
PickStatus Optional Enumeration(Complete, Incomplete)
ExportStatus Optional Enumeration(Pending, Exported)
ExportedToWMS Optional Enumeration(Pending, Exported)
SendOrderEmail Optional String
StickyNoteTitle Optional String(150)
StickyNote Optional String(5)
StickyNotes Optional StickyNotesType
OrderLine Optional
Supports Multiple Elements		 OrderLineType
OrderRounding Optional Decimal

<StickyNotes>

Element Name Required Field Type / Options
StickyNote Optional
Supports Multiple Elements		 StickyNoteType

<StickyNote>

Element Name Required Field Type / Options
StickyNoteID Optional Integer
Title Required String(150)
Description Required String(5000)

<OrderLine>

Element Name Required Field Type / Options
OrderLineID Optional Integer
OrderLineNumber Optional Integer
WarehouseID Optional Integer
QuantityShipped Optional Integer
WarehouseName Optional String
WarehouseReference Optional String
ExternalSystemIdentifier Optional String
ExternalOrderReference Optional String(50)
ExternalOrderLineReference Optional String(50)
SKU Optional String(25)
ItemNotes Optional String(255)
ItemDescription Optional String(255)
ItemSerialNumber Optional String(50)
TrackingDetails Optional TrackingDetailsType

<TrackingDetails>

Element Name Required Field Type / Options
ShippingMethod Optional String(50)
TrackingNumber Optional String
DateShipped Optional DateTime

UpdateOrder Responses

XML Response

<?xml version="1.0" encoding="utf-8"?>
<UpdateOrder>
   <Order> 
    <OrderID>(String)</OrderID>    
   </Order>  
   <Messages> 
     <Error> 
      <Message>(String)</Message>      
      <SeverityCode>(String)</SeverityCode>      
      <Description>(String)</Description>      
     </Error>    
     <Warning> 
      <Message>(String)</Message>      
      <SeverityCode>(String)</SeverityCode>      
     </Warning>    
   </Messages>
</UpdateOrder>

JSON Response

{
  "Order": [ {
    "OrderID":"String" 
} ] ,  "Messages": {
    "Error": [ {
      "Message":"String",
      "SeverityCode":"String",
      "Description":"String" 
} ] ,    "Warning": [ {
      "Message":"String",
      "SeverityCode":"String" 
} ]  
} 
}

<Order>

Element Name Field Type
OrderID 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.