Documentation

🔑 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:

NameTypeDescription
UsernamestringThe username for accessing the Web Service Correios.
PasswordstringThe password associated with the Web Service Correios username.
Service CodestringThe service code for Correios return service.
Postage Card NumberstringThe number of the Correios postage card.
Administrative CodestringThe administrative code for the Correios customer.
Shipper Address 1stringThe first line of the shipper's address.
Shipper CitystringThe city of the shipper's address.
Shipper StatestringThe Brazilian state of the shipper.
Shipper Address NumberstringThe address number (line 2) of the shipper's address.
Shipper Phone Area CodestringThe area code for the shipper's phone number in Brazil.
Shipper e-mailstringThe email address of the shipper.
Shipper NamestringThe name of the shipper.
Shipper PhonestringThe phone number of the shipper.
Shipper Zip CodestringThe zip code of the shipper in Brazil.
Recipient NamestringThe name of the recipient.
Recipient AddressstringThe first line of the recipient's address.
Recipient zip codestringThe zip code of the recipient.
Recipient CitystringThe city of the recipient's address.
Recipient StatestringThe Brazilian state of the recipient.
Recipient Address NumberstringThe address number (line 2) of the recipient's address.
Recipient e-mailstringThe email address of the recipient.
Recipient Phone Area CodestringThe area code for the recipient's phone number in Brazil.
Recipient PhonestringThe phone number of the recipient.
Order NumberstringThe order number associated with the shipment.

Outputs:

NameTypeDescription
SuccessbooleanIndicates whether the Web Service managed to retrieve the authorization code successfully or not.
Error CodestringThe error code in the Web Service response. It is '00' if there are no errors.
Result ObjectObjectThe result object containing various details from the Web Service response.
Authorization CodestringThe authorization code obtained from the Web Service response.
Expire DatestringThe expiration date of the authorization code.
Response JSONObjectThe 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.