GetCart

Overview

Endpoint URL https://www.yournetosite.com.au/do/WS/NetoAPI
Method POST
XML Headers
NETOAPI_ACTION GetCart
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 GetCart
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 The GetCart API call is used to return information on customer's shopping carts that are open, abandoned or completed, and are saved for up to 90 days.
XSD Schema GetCart XSD   |   GetCart Response XSD

GetCart Post

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

XML POST

<?xml version="1.0" encoding="utf-8"?>
<GetCart>
   <Filter> 
    <CartID>(String)</CartID>    
    <CheckoutStatus>Open</CheckoutStatus>    
    <CheckoutStatus>Closed</CheckoutStatus>    
    <CheckoutStatus>Abandoned</CheckoutStatus>    
    <DateCreatedFrom>(DateTime)</DateCreatedFrom>    
    <DateCreatedTo>(DateTime)</DateCreatedTo>    
    <DateUpdatedFrom>(DateTime)</DateUpdatedFrom>    
    <DateUpdatedTo>(DateTime)</DateUpdatedTo>    
    <Page>(Integer)</Page>    
    <Limit>(Integer)</Limit>    
    <OutputSelector>CartID</OutputSelector>    
    <OutputSelector>CheckoutStatus</OutputSelector>    
    <OutputSelector>CloseReason</OutputSelector>    
    <OutputSelector>DateCreated</OutputSelector>    
    <OutputSelector>DateCreatedUTC</OutputSelector>    
    <OutputSelector>DateUpdated</OutputSelector>    
    <OutputSelector>DateUpdatedUTC</OutputSelector>    
    <OutputSelector>CustomerEmail</OutputSelector>    
    <OutputSelector>RestoreCartUrl</OutputSelector>    
    <OutputSelector>CustomerUsername</OutputSelector>    
    <OutputSelector>BillingAddress</OutputSelector>    
    <OutputSelector>ShippingAddress</OutputSelector>    
    <OutputSelector>OrderLines</OutputSelector>    
    <OutputSelector>CartTotal</OutputSelector>    
    <OutputSelector>OrderID</OutputSelector>    
    <OutputSelector>NotifiedCustomer</OutputSelector>    
    <OutputSelector>IsProcessed</OutputSelector>    
   </Filter>
</GetCart>

JSON POST

{
  "Filter": {
    "CartID":["String"/*, ...*/],
    "CheckoutStatus":["Enumeration"/*, ...*/],
    "DateCreatedFrom":"DateTime",
    "DateCreatedTo":"DateTime",
    "DateUpdatedFrom":"DateTime",
    "DateUpdatedTo":"DateTime",
    "Page":"Integer",
    "Limit":"Integer",
    "OutputSelector":["Enumeration"/*, ...*/] 
} 
}

<Filter>

Element Name Required Field Type / Options
CartID Optional
Supports Multiple Elements
String(15)
CheckoutStatus Optional
Supports Multiple Elements
Enumeration(Open, Closed, Abandoned)
DateCreatedFrom Optional DateTime
DateCreatedTo Optional DateTime
DateUpdatedFrom Optional DateTime
DateUpdatedTo Optional DateTime
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 (CartID, CheckoutStatus, CloseReason, DateCreated, DateCreatedUTC, DateUpdated, DateUpdatedUTC, CustomerEmail, RestoreCartUrl, CustomerUsername, BillingAddress, ShippingAddress, OrderLines, CartTotal, OrderID, NotifiedCustomer, IsProcessed)

GetCart Responses

XML Response

<?xml version="1.0" encoding="utf-8"?>
<GetCart>
   <Cart> 
    <CartID>(Integer)</CartID>    
    <CheckoutStatus>(String)</CheckoutStatus>    
    <DateCreated>(DateTime)</DateCreated>    
    <DateUpdated>(DateTime)</DateUpdated>    
    <DateCreatedUTC>(DateTime)</DateCreatedUTC>    
    <DateUpdatedUTC>(DateTime)</DateUpdatedUTC>    
    <CustomerEmail>(String)</CustomerEmail>    
    <RestoreCartUrl>(String)</RestoreCartUrl>    
    <CustomerUsername>(String)</CustomerUsername>    
    <NotifiedCustomer>(Boolean)</NotifiedCustomer>    
    <IsProcessed>(Boolean)</IsProcessed>    
     <BillingAddress> 
      <FirstName>(String)</FirstName>      
      <LastName>(String)</LastName>      
      <Company>(String)</Company>      
      <StreetLine1>(String)</StreetLine1>      
      <StreetLine2>(String)</StreetLine2>      
      <City>(String)</City>      
      <Country>(String)</Country>      
      <State>(String)</State>      
      <PostCode>(String)</PostCode>      
      <Phone>(String)</Phone>      
      <Fax>(String)</Fax>      
     </BillingAddress>     <ShippingAddress> 
      <FirstName>(String)</FirstName>      
      <LastName>(String)</LastName>      
      <Company>(String)</Company>      
      <StreetLine1>(String)</StreetLine1>      
      <StreetLine2>(String)</StreetLine2>      
      <City>(String)</City>      
      <Country>(String)</Country>      
      <State>(String)</State>      
      <PostCode>(String)</PostCode>      
      <Phone>(String)</Phone>      
      <Fax>(String)</Fax>      
     </ShippingAddress>    
     <OrderLines> 
       <OrderLine> 
        <ProductID>(Integer)</ProductID>        
        <SKU>(String)</SKU>        
        <Quantity>(Integer)</Quantity>        
        <ProductName>(String)</ProductName>        
        <UnitPrice>(Decimal)</UnitPrice>        
        <LinePrice>(Decimal)</LinePrice>        
       </OrderLine>      
     </OrderLines>    
    <CartTotal>(Decimal)</CartTotal>    
    <OrderID>(String)</OrderID>    
   </Cart>  
   <Messages> 
     <Error> 
      <Message>(String)</Message>      
      <SeverityCode>(String)</SeverityCode>      
      <Description>(String)</Description>      
     </Error>    
     <Warning> 
      <Message>(String)</Message>      
      <SeverityCode>(String)</SeverityCode>      
     </Warning>    
   </Messages>
</GetCart>

JSON Response

{
  "Cart": [ {
    "CartID":"Integer",
    "CheckoutStatus":"String",
    "DateCreated":"DateTime",
    "DateUpdated":"DateTime",
    "DateCreatedUTC":"DateTime",
    "DateUpdatedUTC":"DateTime",
    "CustomerEmail":"String",
    "RestoreCartUrl":"String",
    "CustomerUsername":"String",
    "NotifiedCustomer":"Boolean",
    "IsProcessed":"Boolean",
    "BillingAddress": {
      "FirstName":"String",
      "LastName":"String",
      "Company":"String",
      "StreetLine1":"String",
      "StreetLine2":"String",
      "City":"String",
      "Country":"String",
      "State":"String",
      "PostCode":"String",
      "Phone":"String",
      "Fax":"String" 
} ,    "ShippingAddress": [ {
      "FirstName":"String",
      "LastName":"String",
      "Company":"String",
      "StreetLine1":"String",
      "StreetLine2":"String",
      "City":"String",
      "Country":"String",
      "State":"String",
      "PostCode":"String",
      "Phone":"String",
      "Fax":"String" 
} ] ,    "OrderLines": [ {
      "OrderLine": [ {
        "ProductID":"Integer",
        "SKU":"String",
        "Quantity":"Integer",
        "ProductName":"String",
        "UnitPrice":"Decimal",
        "LinePrice":"Decimal" 
} ]  
} ] ,    "CartTotal":"Decimal",
    "OrderID":"String" 
} ] ,  "Messages": {
    "Error": [ {
      "Message":"String",
      "SeverityCode":"String",
      "Description":"String" 
} ] ,    "Warning": [ {
      "Message":"String",
      "SeverityCode":"String" 
} ]  
} 
}

<Cart>

Element Name Field Type
CartID Integer
CheckoutStatus String
DateCreated DateTime
DateUpdated DateTime
DateCreatedUTC DateTime
DateUpdatedUTC DateTime
CustomerEmail String
RestoreCartUrl String
CustomerUsername String
NotifiedCustomer Boolean
IsProcessed Boolean
BillingAddress BillingAddressType
ShippingAddress ShippingAddressType
OrderLines OrderLinesType
CartTotal Decimal
OrderID String

<BillingAddress>

Element Name Field Type
FirstName String
LastName String
Company String
StreetLine1 String
StreetLine2 String
City String
Country String
State String
PostCode String
Phone String
Fax String

<ShippingAddress>

Element Name Field Type
FirstName String
LastName String
Company String
StreetLine1 String
StreetLine2 String
City String
Country String
State String
PostCode String
Phone String
Fax String

<OrderLines>

Element Name Field Type
OrderLine OrderLineType

<OrderLine>

Element Name Field Type
ProductID Integer
SKU String
Quantity Integer
ProductName String
UnitPrice Decimal
LinePrice Decimal

<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, we would like to hear from you!

Contact Us

Was this article useful?

Be notified when this page is updated. Optional.