NAV

<back to all web services

NAVReturnCreate

The following routes are available for this service:
POST/returns
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class NAVReturnCreate implements IPost
    {
        public NAVReturnHeaderCreate header = null;
        public ArrayList<NAVReturnInboundSkuCreate> inboundSkus = null;
        public ArrayList<NAVReturnOutboundSkuCreate> outboundSkus = null;
        public NAVReturnAddress billingAddress = null;
        public NAVReturnAddress shippingAddress = null;
        
        public NAVReturnHeaderCreate getHeader() { return header; }
        public NAVReturnCreate setHeader(NAVReturnHeaderCreate value) { this.header = value; return this; }
        public ArrayList<NAVReturnInboundSkuCreate> getInboundSkus() { return inboundSkus; }
        public NAVReturnCreate setInboundSkus(ArrayList<NAVReturnInboundSkuCreate> value) { this.inboundSkus = value; return this; }
        public ArrayList<NAVReturnOutboundSkuCreate> getOutboundSkus() { return outboundSkus; }
        public NAVReturnCreate setOutboundSkus(ArrayList<NAVReturnOutboundSkuCreate> value) { this.outboundSkus = value; return this; }
        public NAVReturnAddress getBillingAddress() { return billingAddress; }
        public NAVReturnCreate setBillingAddress(NAVReturnAddress value) { this.billingAddress = value; return this; }
        public NAVReturnAddress getShippingAddress() { return shippingAddress; }
        public NAVReturnCreate setShippingAddress(NAVReturnAddress value) { this.shippingAddress = value; return this; }
    }

    public static class NAVReturnHeaderCreate
    {
        public String originalOrderNumber = null;
        public String originalOrderTypeId = null;
        public String rmaNote = null;
        public String shipLabelType = null;
        
        public String getOriginalOrderNumber() { return originalOrderNumber; }
        public NAVReturnHeaderCreate setOriginalOrderNumber(String value) { this.originalOrderNumber = value; return this; }
        public String getOriginalOrderTypeId() { return originalOrderTypeId; }
        public NAVReturnHeaderCreate setOriginalOrderTypeId(String value) { this.originalOrderTypeId = value; return this; }
        public String getRmaNote() { return rmaNote; }
        public NAVReturnHeaderCreate setRmaNote(String value) { this.rmaNote = value; return this; }
        public String getShipLabelType() { return shipLabelType; }
        public NAVReturnHeaderCreate setShipLabelType(String value) { this.shipLabelType = value; return this; }
    }

    public static class NAVReturnInboundSkuCreate
    {
        public String skuCode = null;
        public Integer orderLineNumber = null;
        public Integer quantityReturned = null;
        public String reasonType = null;
        public String rmaNote = null;
        
        public String getSkuCode() { return skuCode; }
        public NAVReturnInboundSkuCreate setSkuCode(String value) { this.skuCode = value; return this; }
        public Integer getOrderLineNumber() { return orderLineNumber; }
        public NAVReturnInboundSkuCreate setOrderLineNumber(Integer value) { this.orderLineNumber = value; return this; }
        public Integer getQuantityReturned() { return quantityReturned; }
        public NAVReturnInboundSkuCreate setQuantityReturned(Integer value) { this.quantityReturned = value; return this; }
        public String getReasonType() { return reasonType; }
        public NAVReturnInboundSkuCreate setReasonType(String value) { this.reasonType = value; return this; }
        public String getRmaNote() { return rmaNote; }
        public NAVReturnInboundSkuCreate setRmaNote(String value) { this.rmaNote = value; return this; }
    }

    public static class NAVReturnOutboundSkuCreate
    {
        public String skuCode = null;
        public Integer orderLineNumber = null;
        public Integer quantityReturned = null;
        public String reasonType = null;
        
        public String getSkuCode() { return skuCode; }
        public NAVReturnOutboundSkuCreate setSkuCode(String value) { this.skuCode = value; return this; }
        public Integer getOrderLineNumber() { return orderLineNumber; }
        public NAVReturnOutboundSkuCreate setOrderLineNumber(Integer value) { this.orderLineNumber = value; return this; }
        public Integer getQuantityReturned() { return quantityReturned; }
        public NAVReturnOutboundSkuCreate setQuantityReturned(Integer value) { this.quantityReturned = value; return this; }
        public String getReasonType() { return reasonType; }
        public NAVReturnOutboundSkuCreate setReasonType(String value) { this.reasonType = value; return this; }
    }

    public static class NAVReturnAddress
    {
        public String firstName = null;
        public String lastName = null;
        public String addressLine1 = null;
        public String addressLine2 = null;
        public String addressLine3 = null;
        public String addressLine4 = null;
        public String addressLine5 = null;
        public String city = null;
        public String stateProvinceCode = null;
        public String postalCode = null;
        public String county = null;
        public String countryCode = null;
        
        public String getFirstName() { return firstName; }
        public NAVReturnAddress setFirstName(String value) { this.firstName = value; return this; }
        public String getLastName() { return lastName; }
        public NAVReturnAddress setLastName(String value) { this.lastName = value; return this; }
        public String getAddressLine1() { return addressLine1; }
        public NAVReturnAddress setAddressLine1(String value) { this.addressLine1 = value; return this; }
        public String getAddressLine2() { return addressLine2; }
        public NAVReturnAddress setAddressLine2(String value) { this.addressLine2 = value; return this; }
        public String getAddressLine3() { return addressLine3; }
        public NAVReturnAddress setAddressLine3(String value) { this.addressLine3 = value; return this; }
        public String getAddressLine4() { return addressLine4; }
        public NAVReturnAddress setAddressLine4(String value) { this.addressLine4 = value; return this; }
        public String getAddressLine5() { return addressLine5; }
        public NAVReturnAddress setAddressLine5(String value) { this.addressLine5 = value; return this; }
        public String getCity() { return city; }
        public NAVReturnAddress setCity(String value) { this.city = value; return this; }
        public String getStateProvinceCode() { return stateProvinceCode; }
        public NAVReturnAddress setStateProvinceCode(String value) { this.stateProvinceCode = value; return this; }
        public String getPostalCode() { return postalCode; }
        public NAVReturnAddress setPostalCode(String value) { this.postalCode = value; return this; }
        public String getCounty() { return county; }
        public NAVReturnAddress setCounty(String value) { this.county = value; return this; }
        public String getCountryCode() { return countryCode; }
        public NAVReturnAddress setCountryCode(String value) { this.countryCode = value; return this; }
    }

    public static class NAVReturnCreateResponse
    {
        public String rmaNumber = null;
        public String packingListURI = null;
        public BigDecimal total = null;
        public ResponseStatus responseStatus = null;
        
        public String getRmaNumber() { return rmaNumber; }
        public NAVReturnCreateResponse setRmaNumber(String value) { this.rmaNumber = value; return this; }
        public String getPackingListURI() { return packingListURI; }
        public NAVReturnCreateResponse setPackingListURI(String value) { this.packingListURI = value; return this; }
        public BigDecimal getTotal() { return total; }
        public NAVReturnCreateResponse setTotal(BigDecimal value) { this.total = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public NAVReturnCreateResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

}

Java NAVReturnCreate DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /returns HTTP/1.1 
Host: extensions.avon.ca 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<NAVReturnCreate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NAV.ServiceModel">
  <BillingAddress>
    <AddressLine1>String</AddressLine1>
    <AddressLine2>String</AddressLine2>
    <AddressLine3>String</AddressLine3>
    <AddressLine4>String</AddressLine4>
    <AddressLine5>String</AddressLine5>
    <City>String</City>
    <CountryCode>String</CountryCode>
    <County>String</County>
    <FirstName>String</FirstName>
    <LastName>String</LastName>
    <PostalCode>String</PostalCode>
    <StateProvinceCode>String</StateProvinceCode>
  </BillingAddress>
  <Header>
    <OriginalOrderNumber>String</OriginalOrderNumber>
    <OriginalOrderTypeId>String</OriginalOrderTypeId>
    <RmaNote>String</RmaNote>
    <ShipLabelType>String</ShipLabelType>
  </Header>
  <InboundSkus>
    <NAVReturnInboundSkuCreate>
      <OrderLineNumber>0</OrderLineNumber>
      <QuantityReturned>0</QuantityReturned>
      <ReasonType>String</ReasonType>
      <RmaNote>String</RmaNote>
      <SkuCode>String</SkuCode>
    </NAVReturnInboundSkuCreate>
  </InboundSkus>
  <OutboundSkus>
    <NAVReturnOutboundSkuCreate>
      <OrderLineNumber>0</OrderLineNumber>
      <QuantityReturned>0</QuantityReturned>
      <ReasonType>String</ReasonType>
      <SkuCode>String</SkuCode>
    </NAVReturnOutboundSkuCreate>
  </OutboundSkus>
  <ShippingAddress>
    <AddressLine1>String</AddressLine1>
    <AddressLine2>String</AddressLine2>
    <AddressLine3>String</AddressLine3>
    <AddressLine4>String</AddressLine4>
    <AddressLine5>String</AddressLine5>
    <City>String</City>
    <CountryCode>String</CountryCode>
    <County>String</County>
    <FirstName>String</FirstName>
    <LastName>String</LastName>
    <PostalCode>String</PostalCode>
    <StateProvinceCode>String</StateProvinceCode>
  </ShippingAddress>
</NAVReturnCreate>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<NAVReturnCreateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NAV.ServiceModel">
  <PackingListURI>String</PackingListURI>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <RmaNumber>String</RmaNumber>
  <Total>0</Total>
</NAVReturnCreateResponse>