API - UpdateOrder

Overview

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

UpdateOrder Post

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>
    <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>(Boolean)</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>
      <SKU>(String)</SKU>
      <TrackingDetails>
        <ShippingMethod>(String)</ShippingMethod>
        <TrackingNumber>(String)</TrackingNumber>
        <DateShipped>(DateTime)</DateShipped>
      </TrackingDetails>
    </OrderLine>
  </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",
    "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":"Boolean",
    "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",
      "SKU":"String",
      "TrackingDetails": {
        "ShippingMethod":"String",
        "TrackingNumber":"String",
        "DateShipped":"DateTime"
      } 
    } ]
  } ]
}

<Order>

Element Name Required Field Type / Options
OrderID Optional String(15)
PurchaseOrderNumber Optional String(15)
OnHoldType Optional Enumeration(On Hold, Layby)
Email Required String(50)
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 Required String(50)
BillPostCode Required 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 Required String(50)
ShipPostCode Required String(15)
ShipContactPhone Optional String(30)
ShipCountry Optional String(2)
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 Boolean(True, False)
SendOrderEmail Optional String
StickyNoteTitle Optional String(150)
StickyNote Optional String(5)
StickyNotes Optional StickyNotesType
OrderLine Optional
Supports Multiple Elements
OrderLineType

<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
SKU Optional String(25)
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

More 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
JSON

Response (Success)

XML
JSON