Shopee SDK API Reference - v2.8.0
    Preparing search index...

    Interface BatchAddItemTaxInfo

    BatchAddItemTaxInfo sub-interface for BatchAddItemItem

    interface BatchAddItemTaxInfo {
        additional_info?: string;
        cest?: string;
        cofins?: string;
        csosn?: string;
        diff_state_cfop?: string;
        ex_tipi?: string;
        export_cfop?: string;
        fci_num?: string;
        federal_state_taxes?: string;
        group_item_info?: BatchAddItemGroupItemInfo;
        icms_cst?: string;
        measure_unit?: string;
        ncm?: string;
        operation_type?: string;
        origin?: string;
        pis?: string;
        pis_cofins_cst?: string | number;
        recopi_num?: string;
        same_state_cfop?: string;
        tax_type?: number;
    }
    Index

    Properties

    additional_info?: string

    Only for BR shop.Include relevant information to display on Invoice.

    cest?: string

    Tax Replacement Specifying Code (CEST), to separate within the same NCM products that do or do not have ICMS tax substitution. (BR region)CEST must have 7 digits, OR, if your item doesn't have a CEST enter the value "00".

    cofins?: string

    Only for BR shop.COFINS – Contribuição para Financiamento da Seguridade Social (Contribution for Social Security Funding). It is a government tax to collect resources for public health system and social security.COFINS % - the tax applied to this product

    csosn?: string

    Code of Operation Status – Simples Nacional, code for company operations to identify the origin of the goods and the taxation regime of the operations.(BR region)

    diff_state_cfop?: string

    Tax Code of Operations and Installments for orders that seller and buyer are in different states. It identifies a specific operation by category at the time of issuing the invoice.(BR region)

    ex_tipi?: string

    Only for BR shop.The EXTIPI field in the NF-e (Nota Fiscal Eletrônica) is used to indicate if there's an exception to the IPI (Imposto sobre Produtos Industrializados) tax rate for a specific product.

    export_cfop?: string

    [BR region]7101 - for sales of self-produced goods7102 - resale of third-party goods

    fci_num?: string

    Only for BR shop.The FCI Control Number is a unique identifier assigned to each import FCI (Import Content Form). It's mandatory on the corresponding NF-e (electronic invoice) to ensure compliance with Brazilian import tax regulations.

    federal_state_taxes?: string

    Only for BR shop.Enter the total percentage of the combination of federal, state, and municipal taxes, using up to two decimals.

    group_item_info?: BatchAddItemGroupItemInfo

    Only for BR shop.Required if the item is a group item.

    icms_cst?: string

    Only for BR shop.ICMS - Imposto sobre Circulação de Mercadorias e Serviços (Circulation of Goods and Services Tax). CST - Código da Situação Tributária (Tax Situation Code) is represented by a combination of 3 numbers with the purpose of demonstrating the origin of a product and determining the form of taxation that will apply to it. Therefore, each digit in the CST Table has a specific meaning: the first digit indicates the origin of the operation, the second digit represents the ICMS taxation on the operation and the third digit provides additional information about the form of taxation.

    measure_unit?: string

    (BR region)

    ncm?: string

    Mercosur Common Nomenclature, it is a convention between Mercosur member countries to easily recognize goods, services and productive factors negotiated among themselves. (BR region)NCM must have 8 digits, OR, if your item doesn't have a NCM enter the value "00"

    operation_type?: string

    Only for BR shop.1: Retailer2: Manufacturer

    origin?: string

    Product source, domestic or foreig (BR region).|0 - National, except for those indicated in codes 3, 4, 5, and 8| |1 - Foreign: Direct import, except for that indicated in code 6| |2 - Foreign: Acquired in the domestic market, except for that indicated in code 7| |3 - National: Goods or products with Import Content greater than 40% and less than or equal to 70%| |4 - National: Produced in compliance with the basic production processes outlined in the legislations cited in the Agreements| |5 - National: Goods or products with Import Content less than or equal to 40%| |6 - Foreign: Direct import, without a national equivalent, listed by CAMEX and natural gas| |7 - Foreign: Acquired in the domestic market, without a national equivalent, listed by CAMEX and natural gas| |8 - National: Goods or products with Import Content greater than 70%|

    pis?: string

    Only for BR shop.PIS - Programa de Integração Social (Social Integration Program). It is a government tax to collect resources for the payment of unemployment insurance and other employee related rights.PIS % - the tax applied to this product

    pis_cofins_cst?: string | number

    Only for BR shop.The CST PIS/Cofins is a code on the Electronic Invoice (NF-e) that identifies the tax situation of PIS (Programa de Integração Social) and Cofins (Contribuição para o Financiamento da Seguridade Social) in sales of goods.

    recopi_num?: string

    Only for BR shop.RECOPI NACIONAL is a Brazilian government system that facilitates the registration and management of tax-exempt operations involving paper destined for printing books, newspapers, and periodicals (known as "papel imune" in Portuguese).

    same_state_cfop?: string

    Tax Code of Operations and Installments for orders that seller and buyer are in the same state. It identifies a specific operation by category at the time of issuing the invoice.(BR region)

    tax_type?: number

    tax_type only for TW whitelist shop. Shopee will referred Tax type when substitute sellers for issuing e-receipts to buyers. All variations share the same tax type. The meaning of value: 0: no tax type1: tax-able2: tax-free