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

    Interface GetItemBaseInfoTaxInfo

    GetItemBaseInfoTaxInfo sub-interface for GetItemBaseInfoResponseData

    interface GetItemBaseInfoTaxInfo {
        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?: GetItemBaseInfoGroupItemInfo;
        hs_code?: string;
        icms_cst?: string;
        invoice_option?: string;
        measure_unit?: string;
        ncm?: string;
        operation_type?: string;
        origin?: string;
        pis?: string;
        pis_cofins_cst?: string | number;
        recopi_num?: string;
        tax_code?: string;
        tax_type?: number;
        vat_rate?: string;
    }
    Index

    Properties

    additional_info? cest? cofins? csosn? diff_state_cfop? ex_tipi? export_cfop? fci_num? federal_state_taxes? group_item_info? hs_code? icms_cst? invoice_option? measure_unit? ncm? operation_type? origin? pis? pis_cofins_cst? recopi_num? tax_code? tax_type? vat_rate?

    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)Note: cest = "00" means that this item doesn't have a CEST.

    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

    7101 - for sales of self-produced goods7102 - resale of third-party goodsa tax code used in Brazil to classify and identify the nature of goods or services transactions for tax purposes. This is used for goods export to other counties

    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?: GetItemBaseInfoGroupItemInfo

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

    hs_code?: string

    HS Code (Only for IN region)

    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.

    invoice_option?: string

    Value shuold be one of NO_INVOICES VAT_MARGIN_SCHEME_INVOICES VAT_INVOICES NON_VAT_INVOICES and if value is NON_VAT_INVOICE vat_rate should be null (PL region)

    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)Note: ncm = "00" means that this item doesn't have a NCM.

    operation_type?: string

    Only for BR shop.1: Retailer2: Manufacturer

    origin?: string

    Product source, domestic or foreig (BR region)

    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).

    tax_code?: string

    Tax Code (Only for IN 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

    vat_rate?: string

    Value should be one of 0% 5% 8% 23% NO_VAT_RATE (PL region)

    Settings

    Member Visibility

    On This Page

    Properties