GetWarehouse

Endpoint URL

https://www.yournetosite.com.au/do/WS/NetoAPI

Method

POST

XML Headers

NETOAPI_ACTION	GetWarehouse
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	GetWarehouse
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 get warehouse data. A successful call to GetWarehouse returns the data requested.

XSD Schema

GetWarehouse XSD | GetWarehouse Response XSD

GetWarehouse Post

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

XML POST

<?xml version="1.0" encoding="utf-8"?>
<GetWarehouse>
   <Filter> 
    <WarehouseID>(Integer)</WarehouseID>    
    <WarehouseReference>(String)</WarehouseReference>    
    <WarehouseName>(String)</WarehouseName>    
    <Page>(Integer)</Page>    
    <Limit>(Integer)</Limit>    
    <OutputSelector>ID</OutputSelector>    
    <OutputSelector>WarehouseID</OutputSelector>    
    <OutputSelector>IsPrimary</OutputSelector>    
    <OutputSelector>IsActive</OutputSelector>    
    <OutputSelector>ShowQuantity</OutputSelector>    
    <OutputSelector>WarehouseReference</OutputSelector>    
    <OutputSelector>WarehouseName</OutputSelector>    
    <OutputSelector>WarehouseStreet1</OutputSelector>    
    <OutputSelector>WarehouseStreet2</OutputSelector>    
    <OutputSelector>WarehouseCity</OutputSelector>    
    <OutputSelector>WarehouseState</OutputSelector>    
    <OutputSelector>WarehousePostcode</OutputSelector>    
    <OutputSelector>WarehouseCountry</OutputSelector>    
    <OutputSelector>WarehouseContact</OutputSelector>    
    <OutputSelector>WarehousePhone</OutputSelector>    
    <OutputSelector>WarehouseNotes</OutputSelector>    
   </Filter>
</GetWarehouse>

JSON POST

{
  "Filter": {
    "WarehouseID":["Integer"/*, ...*/],
    "WarehouseReference":["String"/*, ...*/],
    "WarehouseName":["String"/*, ...*/],
    "Page":"Integer",
    "Limit":"Integer",
    "OutputSelector":["Enumeration"/*, ...*/] 
} 
}

<Filter>

Element Name	Required	Field Type / Options
WarehouseID	Optional Supports Multiple Elements	Integer
WarehouseReference	Optional Supports Multiple Elements	String(10)
WarehouseName	Optional Supports Multiple Elements	String(30)
Page	Optional	Integer
Limit	Optional	Integer

<OutputSelector>

Determines what is returned by the POST. Refer to the example response below this table or the related XSD schema for details and restrictions of each output element.

Note: Each OutputSelector should be a separate element in your post.

OutputSelector	Enumeration (ID, WarehouseID, IsPrimary, IsActive, ShowQuantity, WarehouseReference, WarehouseName, WarehouseStreet1, WarehouseStreet2, WarehouseCity, WarehouseState, WarehousePostcode, WarehouseCountry, WarehouseContact, WarehousePhone, WarehouseNotes)

GetWarehouse Responses

XML Response

<?xml version="1.0" encoding="utf-8"?>
<GetWarehouse>
   <Warehouse> 
    <ID>(String)</ID>    
    <WarehouseNotes>(String)</WarehouseNotes>    
    <WarehousePhone>(String)</WarehousePhone>    
    <WarehouseContact>(String)</WarehouseContact>    
    <WarehouseCountry>(String)</WarehouseCountry>    
    <WarehousePostcode>(String)</WarehousePostcode>    
    <WarehouseState>(String)</WarehouseState>    
    <WarehouseCity>(String)</WarehouseCity>    
    <WarehouseStreet2>(String)</WarehouseStreet2>    
    <WarehouseStreet1>(String)</WarehouseStreet1>    
    <WarehouseName>(String)</WarehouseName>    
    <WarehouseReference>(String)</WarehouseReference>    
    <ShowQuantity>(String)</ShowQuantity>    
    <IsActive>(Boolean)</IsActive>    
    <IsPrimary>(Boolean)</IsPrimary>    
    <WarehouseID>(Integer)</WarehouseID>    
   </Warehouse>  
   <Messages> 
     <Error> 
      <Message>(String)</Message>      
      <SeverityCode>(String)</SeverityCode>      
      <Description>(String)</Description>      
     </Error>    
     <Warning> 
      <Message>(String)</Message>      
      <SeverityCode>(String)</SeverityCode>      
     </Warning>    
   </Messages>
</GetWarehouse>

JSON Response

{
  "Warehouse": [ {
    "ID":"String",
    "WarehouseNotes":"String",
    "WarehousePhone":"String",
    "WarehouseContact":"String",
    "WarehouseCountry":"String",
    "WarehousePostcode":"String",
    "WarehouseState":"String",
    "WarehouseCity":"String",
    "WarehouseStreet2":"String",
    "WarehouseStreet1":"String",
    "WarehouseName":"String",
    "WarehouseReference":"String",
    "ShowQuantity":"String",
    "IsActive":"Boolean",
    "IsPrimary":"Boolean",
    "WarehouseID":"Integer" 
} ] ,  "Messages": {
    "Error": [ {
      "Message":"String",
      "SeverityCode":"String",
      "Description":"String" 
} ] ,    "Warning": [ {
      "Message":"String",
      "SeverityCode":"String" 
} ]  
} 
}

<Warehouse>

Element Name	Field Type
ID	String
WarehouseNotes	String
WarehousePhone	String
WarehouseContact	String
WarehouseCountry	String
WarehousePostcode	String
WarehouseState	String
WarehouseCity	String
WarehouseStreet2	String
WarehouseStreet1	String
WarehouseName	String
WarehouseReference	String
ShowQuantity	String
IsActive	Boolean
IsPrimary	Boolean
WarehouseID	Integer

<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