Needio.Services

<back to all web services

CreateReturnRecordRequest

Requires Authentication
The following routes are available for this service:
All Verbs/Trans/CreateReturnRecord/
CreateReturnRecordRequest Parameters:
NameParameterData TypeRequiredDescription
TransactionReturnqueryTransactionReturnDTONo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
CreateReturnRecordResponse Parameters:
NameParameterData TypeRequiredDescription
TransactionReturnformTransactionReturnDTONo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
TransactionReturnDTO Parameters:
NameParameterData TypeRequiredDescription
ReturnIdformintNo
TransIdformintNo
TransDateformDateTimeNo
DeliveryDateformDateTimeNo
ReturnDateformDateTimeNo
MessageBodyformstringNo
StatusformTransactionReturnStatusNo
AcceptRejectDateformDateTimeNo
RejectReasonIdformshort?No
RejectReasonformstringNo
TicketIdformstringNo
TransItemIdformintNo
PostIdformint?No
VariantIdformint?No
QuantityformintNo
ReturnReasonIdformshort?No
ReturnReasonformstringNo
UnitPriceformdecimalNo
TotalAmountformdecimalNo
PostHeaderformstringNo
PostDescriptionformstringNo
MessageHeaderformstringNo
MessageToformstringNo
TransactionItemformTransactionItemDTONo
TransactionReturnStatus Enum:
NameValue
Inprogress1
Approve10
Reject20
TransactionItemDTO Parameters:
NameParameterData TypeRequiredDescription
TransItemIdformintNo
StoreIdformint?No
PostIdformint?No
PostVariantIdformint?No
NameformstringNo
DescriptionformstringNo
ListPriceformdecimalNo
UnitPriceformdecimalNo
QuantityformintNo
TotalPriceformdecimalNo
MediaIdformint?No
RatedYnformboolNo
ReturnedYnformboolNo
ReturnedQuantityformintNo
AlwActformTransactionItemAlwActNo
TransactionItemAlwAct Enum:
NameValue
CanRate1
CanReturn2
CreateReturnRecordResponse Parameters:
NameParameterData TypeRequiredDescription
TransactionReturnformTransactionReturnDTONo

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 /Trans/CreateReturnRecord/ HTTP/1.1 
Host: baseservices2.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateReturnRecordRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel">
  <TransactionReturn xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.Models">
    <d2p1:AcceptRejectDate>0001-01-01T00:00:00</d2p1:AcceptRejectDate>
    <d2p1:DeliveryDate>0001-01-01T00:00:00</d2p1:DeliveryDate>
    <d2p1:MessageBody>String</d2p1:MessageBody>
    <d2p1:MessageHeader>String</d2p1:MessageHeader>
    <d2p1:MessageTo>String</d2p1:MessageTo>
    <d2p1:PostDescription>String</d2p1:PostDescription>
    <d2p1:PostHeader>String</d2p1:PostHeader>
    <d2p1:PostId>0</d2p1:PostId>
    <d2p1:Quantity>0</d2p1:Quantity>
    <d2p1:RejectReason>String</d2p1:RejectReason>
    <d2p1:RejectReasonId>0</d2p1:RejectReasonId>
    <d2p1:ReturnDate>0001-01-01T00:00:00</d2p1:ReturnDate>
    <d2p1:ReturnId>0</d2p1:ReturnId>
    <d2p1:ReturnReason>String</d2p1:ReturnReason>
    <d2p1:ReturnReasonId>0</d2p1:ReturnReasonId>
    <d2p1:Status>Inprogress</d2p1:Status>
    <d2p1:TicketId>String</d2p1:TicketId>
    <d2p1:TotalAmount>0</d2p1:TotalAmount>
    <d2p1:TransDate>0001-01-01T00:00:00</d2p1:TransDate>
    <d2p1:TransId>0</d2p1:TransId>
    <d2p1:TransItemId>0</d2p1:TransItemId>
    <d2p1:TransactionItem>
      <d2p1:AlwAct>CanRate</d2p1:AlwAct>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:ListPrice>0</d2p1:ListPrice>
      <d2p1:MediaId>0</d2p1:MediaId>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:PostId>0</d2p1:PostId>
      <d2p1:PostVariantId>0</d2p1:PostVariantId>
      <d2p1:Quantity>0</d2p1:Quantity>
      <d2p1:RatedYn>false</d2p1:RatedYn>
      <d2p1:ReturnedQuantity>0</d2p1:ReturnedQuantity>
      <d2p1:ReturnedYn>false</d2p1:ReturnedYn>
      <d2p1:StoreId>0</d2p1:StoreId>
      <d2p1:TotalPrice>0</d2p1:TotalPrice>
      <d2p1:TransItemId>0</d2p1:TransItemId>
      <d2p1:UnitPrice>0</d2p1:UnitPrice>
    </d2p1:TransactionItem>
    <d2p1:UnitPrice>0</d2p1:UnitPrice>
    <d2p1:VariantId>0</d2p1:VariantId>
  </TransactionReturn>
</CreateReturnRecordRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateReturnRecordResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel">
  <Error>
    <ErrorCode>String</ErrorCode>
    <ErrorDescription>String</ErrorDescription>
    <ErrorYn>false</ErrorYn>
  </Error>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <TransactionReturn xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.Models">
    <d2p1:AcceptRejectDate>0001-01-01T00:00:00</d2p1:AcceptRejectDate>
    <d2p1:DeliveryDate>0001-01-01T00:00:00</d2p1:DeliveryDate>
    <d2p1:MessageBody>String</d2p1:MessageBody>
    <d2p1:MessageHeader>String</d2p1:MessageHeader>
    <d2p1:MessageTo>String</d2p1:MessageTo>
    <d2p1:PostDescription>String</d2p1:PostDescription>
    <d2p1:PostHeader>String</d2p1:PostHeader>
    <d2p1:PostId>0</d2p1:PostId>
    <d2p1:Quantity>0</d2p1:Quantity>
    <d2p1:RejectReason>String</d2p1:RejectReason>
    <d2p1:RejectReasonId>0</d2p1:RejectReasonId>
    <d2p1:ReturnDate>0001-01-01T00:00:00</d2p1:ReturnDate>
    <d2p1:ReturnId>0</d2p1:ReturnId>
    <d2p1:ReturnReason>String</d2p1:ReturnReason>
    <d2p1:ReturnReasonId>0</d2p1:ReturnReasonId>
    <d2p1:Status>Inprogress</d2p1:Status>
    <d2p1:TicketId>String</d2p1:TicketId>
    <d2p1:TotalAmount>0</d2p1:TotalAmount>
    <d2p1:TransDate>0001-01-01T00:00:00</d2p1:TransDate>
    <d2p1:TransId>0</d2p1:TransId>
    <d2p1:TransItemId>0</d2p1:TransItemId>
    <d2p1:TransactionItem>
      <d2p1:AlwAct>CanRate</d2p1:AlwAct>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:ListPrice>0</d2p1:ListPrice>
      <d2p1:MediaId>0</d2p1:MediaId>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:PostId>0</d2p1:PostId>
      <d2p1:PostVariantId>0</d2p1:PostVariantId>
      <d2p1:Quantity>0</d2p1:Quantity>
      <d2p1:RatedYn>false</d2p1:RatedYn>
      <d2p1:ReturnedQuantity>0</d2p1:ReturnedQuantity>
      <d2p1:ReturnedYn>false</d2p1:ReturnedYn>
      <d2p1:StoreId>0</d2p1:StoreId>
      <d2p1:TotalPrice>0</d2p1:TotalPrice>
      <d2p1:TransItemId>0</d2p1:TransItemId>
      <d2p1:UnitPrice>0</d2p1:UnitPrice>
    </d2p1:TransactionItem>
    <d2p1:UnitPrice>0</d2p1:UnitPrice>
    <d2p1:VariantId>0</d2p1:VariantId>
  </TransactionReturn>
</CreateReturnRecordResponse>