πŸ”‘ Correios Request Return Authorization

This method enables processing the postage authorization request or reverse collection,
returning the e-ticket number (postage authorization code that must be informed to the
consumer for posting at the Correios branch) or the collection number.

Inputs:

TypeNameDescription
stringUsernameThe username for accessing the Web Service Correios.
stringPasswordThe password associated with the Web Service Correios username.
stringService CodeThe service code for Correios return service.
stringPostage Card NumberThe number of the Correios postage card.
stringAdministrative CodeThe administrative code for the Correios customer.
stringShipper Address 1The first line of the shipper's address.
stringShipper CityThe city of the shipper's address.
stringShipper StateThe Brazilian state of the shipper.
stringShipper Address NumberThe address number (line 2) of the shipper's address.
stringShipper Phone Area CodeThe area code for the shipper's phone number in Brazil.
stringShipper e-mailThe email address of the shipper.
stringShipper NameThe name of the shipper.
stringShipper PhoneThe phone number of the shipper.
stringShipper Zip CodeThe zip code of the shipper in Brazil.
stringRecipient NameThe name of the recipient.
stringRecipient AddressThe first line of the recipient's address.
stringRecipient zip codeThe zip code of the recipient.
stringRecipient CityThe city of the recipient's address.
stringRecipient StateThe Brazilian state of the recipient.
stringRecipient Address NumberThe address number (line 2) of the recipient's address.
stringRecipient e-mailThe email address of the recipient.
stringRecipient Phone Area CodeThe area code for the recipient's phone number in Brazil.
stringRecipient PhoneThe phone number of the recipient.
stringOrder NumberThe order number associated with the shipment.

Outputs:

TypeNameDescription
booleanSuccessIndicates whether the Web Service managed to retrieve the authorization code successfully or not.
stringError CodeThe error code in the Web Service response. It is '00' if there are no errors.
ObjectResult ObjectThe result object containing various details from the Web Service response.
stringAuthorization CodeThe authorization code obtained from the Web Service response.
stringExpire DateThe expiration date of the authorization code.
ObjectResponse JSONThe JSON object containing the entire Web Service response.

This actions replaces the return label action, because the return label is generated at the post office when the customer provides the Authorization Code returned by Correios Web Service.