π 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:
| Name | Type | Description |
|---|---|---|
| Username | string | The username for accessing the Web Service Correios. |
| Password | string | The password associated with the Web Service Correios username. |
| Service Code | string | The service code for Correios return service. |
| Postage Card Number | string | The number of the Correios postage card. |
| Administrative Code | string | The administrative code for the Correios customer. |
| Shipper Address 1 | string | The first line of the shipper's address. |
| Shipper City | string | The city of the shipper's address. |
| Shipper State | string | The Brazilian state of the shipper. |
| Shipper Address Number | string | The address number (line 2) of the shipper's address. |
| Shipper Phone Area Code | string | The area code for the shipper's phone number in Brazil. |
| Shipper e-mail | string | The email address of the shipper. |
| Shipper Name | string | The name of the shipper. |
| Shipper Phone | string | The phone number of the shipper. |
| Shipper Zip Code | string | The zip code of the shipper in Brazil. |
| Recipient Name | string | The name of the recipient. |
| Recipient Address | string | The first line of the recipient's address. |
| Recipient zip code | string | The zip code of the recipient. |
| Recipient City | string | The city of the recipient's address. |
| Recipient State | string | The Brazilian state of the recipient. |
| Recipient Address Number | string | The address number (line 2) of the recipient's address. |
| Recipient e-mail | string | The email address of the recipient. |
| Recipient Phone Area Code | string | The area code for the recipient's phone number in Brazil. |
| Recipient Phone | string | The phone number of the recipient. |
| Order Number | string | The order number associated with the shipment. |
Outputs:
| Name | Type | Description |
|---|---|---|
| Success | boolean | Indicates whether the Web Service managed to retrieve the authorization code successfully or not. |
| Error Code | string | The error code in the Web Service response. It is '00' if there are no errors. |
| Result Object | Object | The result object containing various details from the Web Service response. |
| Authorization Code | string | The authorization code obtained from the Web Service response. |
| Expire Date | string | The expiration date of the authorization code. |
| Response JSON | Object | 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 2 months ago
