/returns/courier/status

This API updates the courier return status. Allowed returnAction is ACCEPT for now. Multiple updates are allowed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Request

ParameterNameDataTypeParameterTypeRequirementDescription
returnActionStringbodyMandatoryIt is the action on return by seller
returnStatusUpdatesMap<String, CourierReturnDTO>bodyMandatoryIt is a Map<String,CourierReturnDTO> where Sub order code is the key and CourierReturnDTO is the value

CourierReturnDTO :

FieldNameDataTypeDescription
disputeCategory(Mandatory if returnAction is DISPUTE)IntegerCategory to which dispute belongs
description(Optional)StringDescription of the dispute issue
urls(Optional)ListIt is a list of URLs.

Response

metadata :

FieldNameDataTypeDescription
requestIdStringUnique ID for the request
clientIdStringPartner Id
responseTimeLongResponse Time
requestedURIStringRequested URI
messageStringError message

payload :

FieldNameDataTypeDescription
returnStatusUpdatesResponseMap<String, UpdateResponse>Map of Sub order code and UpdateResponse

UpdateResponse :

FieldNameDataTypeDescription
operationSuccessfulbooleanDescribes whether operation Successful or not
errorMessageStringError message will be given if operationSuccessful is false otherwise it will be null.
Responses

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/json