AddOrder

Endpoint URL https://www.yournetosite.com.au/do/WS/NetoAPI
Method POST
XML Headers
NETOAPI_ACTION AddOrder
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 AddOrder
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 add a new order/invoice. A successful call to AddOrder returns the unique identifier (OrderID) for the new order, and the date and time the order was added (CurrentTime)
XSD Schema AddOrder XSD   |   AddOrder Response XSD

AddOrder Post

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

XML POST

<?xml version="1.0" encoding="utf-8"?>
<AddOrder>
   <Order> 
    <OrderID>(String)</OrderID>    
    <PurchaseOrderNumber>(String)</PurchaseOrderNumber>    
    <OrderType></OrderType>    
    <OnHoldType></OnHoldType>    
    <UserGroup>(String)</UserGroup>    
    <DocumentTemplate>(String)</DocumentTemplate>    
    <DatePlacedUTC>(DateTime)</DatePlacedUTC>    
    <DatePlaced>(DateTime)</DatePlaced>    
    <DateRequired>(DateTime)</DateRequired>    
    <DateRequiredUTC>(DateTime)</DateRequiredUTC>    
    <DateInvoiced>(DateTime)</DateInvoiced>    
    <DateInvoicedUTC>(DateTime)</DateInvoicedUTC>    
    <DateDue>(DateTime)</DateDue>    
    <DateDueUTC>(DateTime)</DateDueUTC>    
    <Username>(String)</Username>    
    <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>    
    <Operator>(String)</Operator>    
    <OperatorDateUpdated>(DateTime)</OperatorDateUpdated>    
    <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>    
    <StickyNoteTitle>(String)</StickyNoteTitle>    
    <StickyNote>(String)</StickyNote>    
     <StickyNotes> 
       <StickyNote> 
        <Title>(String)</Title>        
        <Description>(String)</Description>        
       </StickyNote>      
     </StickyNotes>    <OrderStatus></OrderStatus>    
    <OrderApproval>(Boolean)</OrderApproval>    
    <PaymentMethod>(String)</PaymentMethod>    
    <PaymentTerms>(String)</PaymentTerms>    
    <TaxInclusive>(Boolean)</TaxInclusive>    
    <TaxFreeShipping>(Boolean)</TaxFreeShipping>    
    <BPAYCRN>(String)</BPAYCRN>    
    <ShippingMethod>(String)</ShippingMethod>    
    <ShippingCost>(Decimal)</ShippingCost>    
    <ShippingDiscount>(Decimal)</ShippingDiscount>    
    <SignatureRequired>(Boolean)</SignatureRequired>    
    <CurrencyCode>(String)</CurrencyCode>    
     <OrderLine> 
       <ExtraOptions> 
         <ExtraOption> 
          <Name>(String)</Name>          
          <Value>(String)</Value>          
         </ExtraOption>        
       </ExtraOptions>      <SKU>(String)</SKU>      
      <ItemNotes>(String)</ItemNotes>      
      <ItemDescription>(String)</ItemDescription>      
      <ItemSerialNumber>(String)</ItemSerialNumber>      
      <Dropshipper>(String)</Dropshipper>      
      <WarehouseName>(String)</WarehouseName>      
      <WarehouseReference>(String)</WarehouseReference>      
      <TaxFree>(Boolean)</TaxFree>      
      <WarehouseID>(Integer)</WarehouseID>      
      <Quantity>(Integer)</Quantity>      
      <UnitPrice>(Decimal)</UnitPrice>      
      <UnitCost>(Decimal)</UnitCost>      
      <ShippingWeight>(Decimal)</ShippingWeight>      
      <QuantityShipped>(Integer)</QuantityShipped>      
      <DiscountPercent>(Decimal)</DiscountPercent>      
      <DiscountAmount>(Decimal)</DiscountAmount>      
      <Cubic>(Decimal)</Cubic>      
      <ExternalSystemIdentifier>(String)</ExternalSystemIdentifier>      
      <ExternalOrderReference>(String)</ExternalOrderReference>      
      <ExternalOrderLineReference>(String)</ExternalOrderLineReference>      
       <KitComponents> 
         <KitComponent> 
          <ComponentSKU>(String)</ComponentSKU>          
          <ComponentValue>(Decimal)</ComponentValue>          
          <AssembleQuantity>(Integer)</AssembleQuantity>          
          <ComponentTaxFree>(Boolean)</ComponentTaxFree>          
         </KitComponent>        
       </KitComponents>     </OrderLine>    
    <OrderRounding>(Decimal)</OrderRounding>    
   </Order>  

</AddOrder>

JSON POST

{
  "Order": [ {
    "OrderID":"String",
    "PurchaseOrderNumber":"String",
    "OrderType":"Enumeration",
    "OnHoldType":"Enumeration",
    "UserGroup":"String",
    "DocumentTemplate":"String",
    "DatePlacedUTC":"DateTime",
    "DatePlaced":"DateTime",
    "DateRequired":"DateTime",
    "DateRequiredUTC":"DateTime",
    "DateInvoiced":"DateTime",
    "DateInvoicedUTC":"DateTime",
    "DateDue":"DateTime",
    "DateDueUTC":"DateTime",
    "Username":"String",
    "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",
    "Operator":"String",
    "OperatorDateUpdated":"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",
    "StickyNoteTitle":"String",
    "StickyNote":"String",
    "StickyNotes": {
      "StickyNote": [ {
        "Title":"String",
        "Description":"String" 
} ]  
} ,    "OrderStatus":"Enumeration",
    "OrderApproval":"Boolean",
    "PaymentMethod":"String",
    "PaymentTerms":"String",
    "TaxInclusive":"Boolean",
    "TaxFreeShipping":"Boolean",
    "BPAYCRN":"String",
    "ShippingMethod":"String",
    "ShippingCost":"Decimal",
    "ShippingDiscount":"Decimal",
    "SignatureRequired":"Boolean",
    "CurrencyCode":"String",
    "OrderLine": [ {
      "ExtraOptions": {
        "ExtraOption": [ {
          "Name":"String",
          "Value":"String" 
} ]  
} ,      "SKU":"String",
      "ItemNotes":"String",
      "ItemDescription":"String",
      "ItemSerialNumber":"String",
      "Dropshipper":"String",
      "WarehouseName":"String",
      "WarehouseReference":"String",
      "TaxFree":"Boolean",
      "WarehouseID":"Integer",
      "Quantity":"Integer",
      "UnitPrice":"Decimal",
      "UnitCost":"Decimal",
      "ShippingWeight":"Decimal",
      "QuantityShipped":"Integer",
      "DiscountPercent":"Decimal",
      "DiscountAmount":"Decimal",
      "Cubic":"Decimal",
      "ExternalSystemIdentifier":"String",
      "ExternalOrderReference":"String",
      "ExternalOrderLineReference":"String",
      "KitComponents": {
        "KitComponent": [ {
          "ComponentSKU":"String",
          "ComponentValue":"Decimal",
          "AssembleQuantity":"Integer",
          "ComponentTaxFree":"Boolean" 
} ]  
}  
} ] ,    "OrderRounding":"Decimal" 
} ] 
}

<Order>

Element Name Required Field Type / Options
OrderID Required String(15)
PurchaseOrderNumber Optional String(50)
OrderType Optional Enumeration(sales, dropshipping, quote)
OnHoldType Optional Enumeration(On Hold, Layby)
UserGroup Optional String(50)
DocumentTemplate Optional String(50)
DatePlacedUTC Optional DateTime
DatePlaced Optional DateTime
DateRequired Optional DateTime
DateRequiredUTC Optional DateTime
DateInvoiced Optional DateTime
DateInvoicedUTC Optional DateTime
DateDue Optional DateTime
DateDueUTC Optional DateTime
Username Optional String(25)
Email Required String(250)
BillFirstName Optional String(50)
BillLastName Optional String(50)
BillCompany Required String(50)
BillStreet1 Optional String(50)
BillStreet2 Optional String(50)
BillCity Optional String(50)
BillState Optional String(50)
BillPostCode Optional String(15)
BillContactPhone Optional String(30)
BillCountry Optional String(2)
ShipFirstName Optional String(50)
ShipLastName Optional String(50)
ShipCompany Required String(50)
ShipStreet1 Optional String(50)
ShipStreet2 Optional String(50)
ShipCity Optional String(50)
ShipState Optional String(50)
ShipPostCode Optional String(15)
ShipContactPhone Optional String(30)
ShipCountry Optional String(2)
EnableAddressValidation Optional Boolean(True, False)
Operator Optional String(25)
OperatorDateUpdated 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
StickyNoteTitle Optional String(150)
StickyNote Optional String(5000)
StickyNotes Optional StickyNotesType
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)
PaymentMethod Optional String(100)
PaymentTerms Optional String(50)
TaxInclusive Optional Boolean(True, False)
TaxFreeShipping Optional Boolean(True, False)
BPAYCRN Optional String(20)
ShippingMethod Optional String(50)
ShippingCost Optional Decimal
ShippingDiscount Optional Decimal
SignatureRequired Optional Boolean(True, False)
CurrencyCode Optional String(3)
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
Title Required String(150)
Description Required String(5000)

<OrderLine>

Element Name Required Field Type / Options
ExtraOptions Optional ExtraOptionsType
SKU Required String(25)
ItemNotes Optional String(255)
ItemDescription Optional String(255)
ItemSerialNumber Optional String(50)
Dropshipper Optional String(20)
WarehouseName Optional String(30)
WarehouseReference Optional String(10)
TaxFree Optional Boolean(True, False)
WarehouseID Optional Integer
Quantity Required Integer
UnitPrice Optional Decimal
UnitCost Optional Decimal
ShippingWeight Optional Decimal
QuantityShipped Optional Integer
DiscountPercent Optional Decimal
DiscountAmount Optional Decimal
Cubic Optional Decimal
ExternalSystemIdentifier Optional String
ExternalOrderReference Optional String(50)
ExternalOrderLineReference Optional String(50)
KitComponents Optional KitComponentsType

<ExtraOptions>

Element Name Required Field Type / Options
ExtraOption Optional
Supports Multiple Elements		 ExtraOptionType

<ExtraOption>

Element Name Required Field Type / Options
Name Required String(150)
Value Required String(5000)

<KitComponents>

Element Name Required Field Type / Options
KitComponent Optional
Supports Multiple Elements		 KitComponentType

<KitComponent>

Element Name Required Field Type / Options
ComponentSKU Required String(25)
ComponentValue Optional Decimal
AssembleQuantity Required Integer
ComponentTaxFree Optional Boolean(True, False)

AddOrder Responses

XML Response

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

JSON Response

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

<Order>

Element Name Field Type
OrderID String

<StickyNotes>

Element Name Field Type
Note NoteType

<Note>

Element Name Field Type
ID String
Title String
Description String

<Messages>

Element Name Field Type
Warning WarningType
Error ErrorType

<Warning>

Element Name Field Type
Message String
SeverityCode String

<Error>

Element Name Field Type
Message String
SeverityCode String
Description 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.