The following changes apply only to stores in Brazil.
To ensure tax compliance for all orders and avoid rejections during invoice issuance, the Orders API now includes new fields in the customApps
object.
The new fields are listed below:
marketplacePaymentMethods
: Payment methods used.marketplacePaymentCnpjAcquirers
: CNPJ of the acquirer.marketplacePaymentAuthorizationCodes
: Authorization code.marketplacePaymentCreditCardBrands
: Credit card brand. This field will be empty for other payment methods.
The new fields can be retrieved using the Get order endpoint, as in the example below:
_16"customData": {_16 {_16 "customApps": [_16 {_16 "id": "integration-marketplace-[marketplace name]",_16 "major": 1,_16 "fields": {_16 "marketplacePaymentCnpjAcquirers": "11.222.333/0001-44",_16 "marketplacePaymentAuthorizationCodes": "XYZ",_16 "marketplacePaymentCreditCardBrands": "",_16 "marketplacePaymentMethods": "Pix"_16 }_16 }_16 ]_16 }_16}
Values may vary between marketplaces, as they are passed as is, without standardization, from the marketplace. For example:
Credit Cards
,Credit
,Credit Card
,credit-card
.
Dafiti marketplace
For the Dafiti marketplace, the fields are in singular form:
marketplacePaymentMethod
marketplacePaymentCnpjAcquirer
marketplacePaymentAuthorizationCode
The field marketplacePaymentCreditCardBrands
is not available, as this information is already included in the marketplacePaymentMethod
field.
For more information, read the New mandatory fields for invoice issuance announcement.