Needio.Services

<back to all web services

CreateRequestReturnByBuyerRequest

Requires Authentication
Required role:Guest
The following routes are available for this service:
All Verbs/Trans/CreateRequestReturnByBuyer/
CreateRequestReturnByBuyerRequest Parameters:
NameParameterData TypeRequiredDescription
TransIdqueryintNo
DeliveryTypequeryDeliveryTypesNo
ReturnItemListqueryList<CustomReturnItemDTO>No
WorkingUserTypequeryWorkingUserTypeNo
AdminUserIdqueryintNo
AdminUserNamequerystringNo
AdminReasonquerystringNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
isAdminformboolNo
CmdformstringNo
CreateRequestReturnByBuyerResponse Parameters:
NameParameterData TypeRequiredDescription
InsertReturnIdformintNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ExYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
DeliveryTypes Enum:
NameValue
None0
DeliveryToAddress1
DeliveryInStore2
DeliveryByCargo4
CustomReturnItemDTO Parameters:
NameParameterData TypeRequiredDescription
ToReturnformboolNo
ReturnItemDTO Parameters:
NameParameterData TypeRequiredDescription
ReturnItemIdformintNo
ReturnIdformintNo
TransItemIdformintNo
PostIdformint?No
PostVariantIdformint?No
NameformstringNo
ReasonIdformshort?No
ReasonformstringNo
DescriptionformstringNo
ListPriceformdecimalNo
SalePriceformdecimalNo
UnitPriceformdecimalNo
QuantityformintNo
TotalPriceformdecimalNo
MediaIdformint?No
AlwActformReturnItemAlwActNo
InProgressCountformintNo
MaxReturnCountformintNo
PaidPriceformdecimal?No
GiftAmountformdecimal?No
DiscountAmountformdecimal?No
NetUnitPriceformdecimal?No
NetTotalPriceformdecimal?No
TransactionItemformTransactionItemDTONo
ReturnItemAlwAct Enum:
NameValue
CanReturn1
TransactionItemDTO Parameters:
NameParameterData TypeRequiredDescription
TransItemIdformintNo
StoreIdformint?No
PostIdformint?No
PostVariantIdformint?No
NameformstringNo
DescriptionformstringNo
ListPriceformdecimalNo
UnitPriceformdecimalNo
QuantityformintNo
TotalPriceformdecimalNo
MediaIdformint?No
RatedYnformboolNo
ReturnedYnformboolNo
ReturnedQuantityformintNo
AlwActformTransactionItemAlwActNo
AllowReturnformboolNo
AllowedReturnDateformDateTime?No
ReturnCountformintNo
MediaUrlformstringNo
CategoryformstringNo
GiftAmountformdecimal?No
PaidPriceformdecimal?No
DiscountAmountformdecimal?No
MessageformstringNo
NetUnitPriceformdecimal?No
NetTotalPriceformdecimal?No
CampaignIdformint?No
ItemDataformItemDataDtoNo
SerialNumberformstringNo
TransactionItemAlwAct Enum:
NameValue
CanRate1
CanReturn2
ShowReturnInfo4
AllowSerialNumber8
ItemDataDto Parameters:
NameParameterData TypeRequiredDescription
ItemDataTypeformItemDataTypesNo
ItemDataformstringNo
ItemDataTypes Enum:
NameValue
Aydem1
Personalized2
WorkingUserType Enum:
NameValue
Buyer1
Seller2
Admin3
Hangfire4
AdminForBuyer5
AdminForSeller6
CreateRequestReturnByBuyerResponse Parameters:
NameParameterData TypeRequiredDescription
InsertReturnIdformintNo

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

<CreateRequestReturnByBuyerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <APIKey>String</APIKey>
  <Cmd>String</Cmd>
  <DeviceUUID>String</DeviceUUID>
  <isAdmin>false</isAdmin>
  <start>0001-01-01T00:00:00</start>
  <AdminReason>String</AdminReason>
  <AdminUserId>0</AdminUserId>
  <AdminUserName>String</AdminUserName>
  <DeliveryType>None</DeliveryType>
  <ReturnItemList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:CustomReturnItemDTO>
      <d2p1:AlwAct>CanReturn</d2p1:AlwAct>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:DiscountAmount>0</d2p1:DiscountAmount>
      <d2p1:GiftAmount>0</d2p1:GiftAmount>
      <d2p1:InProgressCount>0</d2p1:InProgressCount>
      <d2p1:ListPrice>0</d2p1:ListPrice>
      <d2p1:MaxReturnCount>0</d2p1:MaxReturnCount>
      <d2p1:MediaId>0</d2p1:MediaId>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:NetTotalPrice>0</d2p1:NetTotalPrice>
      <d2p1:NetUnitPrice>0</d2p1:NetUnitPrice>
      <d2p1:PaidPrice>0</d2p1:PaidPrice>
      <d2p1:PostId>0</d2p1:PostId>
      <d2p1:PostVariantId>0</d2p1:PostVariantId>
      <d2p1:Quantity>0</d2p1:Quantity>
      <d2p1:Reason>String</d2p1:Reason>
      <d2p1:ReasonId>0</d2p1:ReasonId>
      <d2p1:ReturnId>0</d2p1:ReturnId>
      <d2p1:ReturnItemId>0</d2p1:ReturnItemId>
      <d2p1:SalePrice>0</d2p1:SalePrice>
      <d2p1:TotalPrice>0</d2p1:TotalPrice>
      <d2p1:TransItemId>0</d2p1:TransItemId>
      <d2p1:TransactionItem>
        <d2p1:AllowReturn>false</d2p1:AllowReturn>
        <d2p1:AllowedReturnDate>0001-01-01T00:00:00</d2p1:AllowedReturnDate>
        <d2p1:AlwAct>CanRate</d2p1:AlwAct>
        <d2p1:CampaignId>0</d2p1:CampaignId>
        <d2p1:Category>String</d2p1:Category>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:DiscountAmount>0</d2p1:DiscountAmount>
        <d2p1:GiftAmount>0</d2p1:GiftAmount>
        <d2p1:ItemData>
          <d2p1:ItemData>String</d2p1:ItemData>
          <d2p1:ItemDataType>Aydem</d2p1:ItemDataType>
        </d2p1:ItemData>
        <d2p1:ListPrice>0</d2p1:ListPrice>
        <d2p1:MediaId>0</d2p1:MediaId>
        <d2p1:MediaUrl>String</d2p1:MediaUrl>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:NetTotalPrice>0</d2p1:NetTotalPrice>
        <d2p1:NetUnitPrice>0</d2p1:NetUnitPrice>
        <d2p1:PaidPrice>0</d2p1:PaidPrice>
        <d2p1:PostId>0</d2p1:PostId>
        <d2p1:PostVariantId>0</d2p1:PostVariantId>
        <d2p1:Quantity>0</d2p1:Quantity>
        <d2p1:RatedYn>false</d2p1:RatedYn>
        <d2p1:ReturnCount>0</d2p1:ReturnCount>
        <d2p1:ReturnedQuantity>0</d2p1:ReturnedQuantity>
        <d2p1:ReturnedYn>false</d2p1:ReturnedYn>
        <d2p1:SerialNumber>String</d2p1:SerialNumber>
        <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:ToReturn>false</d2p1:ToReturn>
    </d2p1:CustomReturnItemDTO>
  </ReturnItemList>
  <TransId>0</TransId>
  <WorkingUserType>Buyer</WorkingUserType>
</CreateRequestReturnByBuyerRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateRequestReturnByBuyerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <Error>
    <ErrorCode>String</ErrorCode>
    <ErrorDescription>String</ErrorDescription>
    <ErrorYn>false</ErrorYn>
    <ExYn>false</ExYn>
  </Error>
  <PageInfo>
    <CurrentPage>0</CurrentPage>
    <TotalPageCount>0</TotalPageCount>
    <TotalRecordCount>0</TotalRecordCount>
  </PageInfo>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <InsertReturnId>0</InsertReturnId>
</CreateRequestReturnByBuyerResponse>