🔑 Correios Request Return Authorization

Suggest Edits

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:

Type	Name	Description
string	Username	The username for accessing the Web Service Correios.
string	Password	The password associated with the Web Service Correios username.
string	Service Code	The service code for Correios return service.
string	Postage Card Number	The number of the Correios postage card.
string	Administrative Code	The administrative code for the Correios customer.
string	Shipper Address 1	The first line of the shipper's address.
string	Shipper City	The city of the shipper's address.
string	Shipper State	The Brazilian state of the shipper.
string	Shipper Address Number	The address number (line 2) of the shipper's address.
string	Shipper Phone Area Code	The area code for the shipper's phone number in Brazil.
string	Shipper e-mail	The email address of the shipper.
string	Shipper Name	The name of the shipper.
string	Shipper Phone	The phone number of the shipper.
string	Shipper Zip Code	The zip code of the shipper in Brazil.
string	Recipient Name	The name of the recipient.
string	Recipient Address	The first line of the recipient's address.
string	Recipient zip code	The zip code of the recipient.
string	Recipient City	The city of the recipient's address.
string	Recipient State	The Brazilian state of the recipient.
string	Recipient Address Number	The address number (line 2) of the recipient's address.
string	Recipient e-mail	The email address of the recipient.
string	Recipient Phone Area Code	The area code for the recipient's phone number in Brazil.
string	Recipient Phone	The phone number of the recipient.
string	Order Number	The order number associated with the shipment.

Outputs:

Type	Name	Description
boolean	Success	Indicates whether the Web Service managed to retrieve the authorization code successfully or not.
string	Error Code	The error code in the Web Service response. It is '00' if there are no errors.
Object	Result Object	The result object containing various details from the Web Service response.
string	Authorization Code	The authorization code obtained from the Web Service response.
string	Expire Date	The expiration date of the authorization code.
Object	Response JSON	The 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.

Updated 5 months ago