Needio.Services

<back to all web services

PrepareReturnRecordRequest

Requires Authentication
The following routes are available for this service:
All Verbs/Trans/PrepareReturnRecord/
PrepareReturnRecordRequest Parameters:
NameParameterData TypeRequiredDescription
TransItemIdqueryintNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
PrepareReturnRecordResponse 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
PrepareReturnRecordResponse Parameters:
NameParameterData TypeRequiredDescription
transactionReturnformTransactionReturnDTONo

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

HTTP + JSV

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

POST /Trans/PrepareReturnRecord/ HTTP/1.1 
Host: baseservices2.needion.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	TransItemId: 0,
	start: 2020-07-04T02:58:02.1406730+03:00
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	transactionReturn: 
	{
		ReturnId: 0,
		TransId: 0,
		TransDate: 0001-01-01,
		DeliveryDate: 0001-01-01,
		ReturnDate: 0001-01-01,
		MessageBody: String,
		Status: 1,
		AcceptRejectDate: 0001-01-01,
		RejectReasonId: 0,
		RejectReason: String,
		TicketId: String,
		TransItemId: 0,
		PostId: 0,
		VariantId: 0,
		Quantity: 0,
		ReturnReasonId: 0,
		ReturnReason: String,
		UnitPrice: 0,
		TotalAmount: 0,
		PostHeader: String,
		PostDescription: String,
		MessageHeader: String,
		MessageTo: String,
		TransactionItem: 
		{
			TransItemId: 0,
			StoreId: 0,
			PostId: 0,
			PostVariantId: 0,
			Name: String,
			Description: String,
			ListPrice: 0,
			UnitPrice: 0,
			Quantity: 0,
			TotalPrice: 0,
			MediaId: 0,
			RatedYn: False,
			ReturnedYn: False,
			ReturnedQuantity: 0,
			AlwAct: 1
		}
	},
	Result: False,
	ResMessage: String,
	Error: 
	{
		ErrorYn: False,
		ErrorCode: String,
		ErrorDescription: String
	}
}