Histórico da Página

Objetivo

A finalidade deste método é a consulta de produtos.

Chamada

GET api/v2/sm_products/products?
PACKING_QUANTITY=
{PACKING_QUANTITY}&CATEGORY_TYPE=
{CATEGORY_TYPE}&CODE_ACCESS=
{CODE_ACCESS}&DESCRIPTION=
{DESCRIPTION}&FAMILY=
{FAMILY}&LAST_UPDATE_DATE=
{LAST_UPDATE_DATE}&LIST_DETAILS=
{LIST_DETAILS}&REG_NUMBER=
{REG_NUMBER}&SEQ_CATEGORY=
{SEQ_CATEGORY}&SEQ_FAMILY=
{SEQ_FAMILY}&SEQ_PRODUCT=
{SEQ_PRODUCT}&SEQ_SUPPLIER=
{SEQ_SUPPLIER}&STATUS_SALE=
{STATUS_SALE}&SEGMENT_NUMBER=
{SEGMENT_NUMBER}&_pageNo=
{_pageNo}&_pageSize={_pageSize}

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
category_type	Category Type (C = Consumer, L = Price List, M = Mix) – Optional – Note: To pass [CATEGORY_TYPE] and not to pass [SEQ_CATEGORY] can turn query slow.	string	Tamanho da String: inclusive between 0 and 1
code_access	Product Access Code – Optional	string	Tamanho da String: inclusive between 0 and 60
description	Product Description – Optional	string	Tamanho da String: inclusive between 0 and 50
family	Family Description – Optional	string	Tamanho da String: inclusive between 0 and 35
last_update_date	Last Update Date – (Optional) – (dd/mm/aaaa or ddmmaaaa)	string	Não há.
list_Details	List Details of Products – (Eg.: List of Suppliers) – (N – No, S – Yes) – Optional (Default “N”)	string	Não há.
reg_number	Brazilian Registry of Corporate Taxpayers – (00.000.000/0001-00 or 00000000000000) – Required	string	Não há.
seq_category	Category Sequence – Optional	string	Não há.
seq_family	Family Sequence – Optional	decimal number	Não há.
seq_product	Product Sequence – Optional	integer	Não há.
seq_supplier	Supplier Sequence – Optional	integer	Não há.
status_sale	Indicates if Product is Active to Sale – A = Active – (Return just products active to sale), I = Inactive – (Return just products inactive to sale), S = Suspended – (Return just products suspended to sale), T = All – (Return all products, includes all status – A, I and S) – Optional (Default “A”)	string	Tamanho da String: inclusive between 0 and 1
segment_number	Segment number – Optional	integer	Não há.
_pageNo		integer	Não há.
_pageSize		integer	Não há.

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

ProductResponseDTO – Lista de Produtos

Collection of ProductResponseDTO

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
code_access_main	Main Access Code	string	None.
code_nbm_sh	NBM/SH Code (NBM/SH = Brazilian Nomenclature of Goods/Harmonized System)	string	Não há.
conversion_factor	Conversion Factor	decimal number	Não há.
date_include	Inclusion Date	date	Não há.
date_end_promotion	Promotion Final Date	date	Não há.
date_start_promotion	Promotion Initial Date	date	Não há.
date_last_input	Date of Last Input	date	Não há.
quantity_over	Quantity of products which must be considered for “price_over” become the price	decimal number	Não há.
price_over	When quantity is above “quantity_over”, then this price can be used	decimal number	Não há.
date_last_purchase	Date of the Last Purchase	date	Não há.
date_last_stock_movement	Date of the Last Stock Movement	date	Não há.
date_update	Last Update Date	date	Não há.
date_update_price	Date of Price Update	date	Não há.
description	Description of Product	string	Não há.
description_composition	Composition Description of Product	string	Não há.
description_generic	Generic Description of Product	string	Não há.
description_reduced	Reduced Description of Product	string	Não há.
detailed_spotlight	Detailed Specifications	string	Não há.
expiration_date_days	Validity in Days	integer	Não há.
expiration_date_months	Validity in Months	integer	Não há.
family	Family of Product	string	Não há.
fractional_sale	Indicates if Accepts Fractional Sale	string	Não há.
integration_ecommerce	Indicates if Product is Integrated with Ecommerce	string	Não há.
manufacturer_reference	Manufacturer Reference	string	Não há.
media_sale_general	Media of Sale General	decimal number	Não há.
media_sale_out_promotion	Media of Sale Out Promotion Day	decimal number	Não há.
media_sale_promotion	Media of Sale Promotion Day	decimal number	Não há.
multiples_sale_ecommerce	Multiples of Sale Ecommerce	decimal number	Não há.
number_company	Number Company	integer	Não há.
number_division	Number Division	integer	Não há.
number_days_receipt_warning	Number of Days For Warning Receiving	integer	Não há.
number_taxation	Number Taxation – Note: This Taxation is in Accordance with [SEQ_FAMILY] of Product and [NUMBER_DIVISION] of Company	integer	Não há.
own_manufacturing_process	Indicates Own Manufacturing Process	string	Não há.
packing_default	Default Packing	string	Não há.
pesible	Indicates if Product is Pesible	string	Não há.
price_promotional	Promotional Price	decimal number	Não há.
price_sale	Sale Price	decimal number	Não há.
purchase_status	Purchase Status	string	Não há.
shop_maximum_stock	Shop Maximum Stock	decimal number	Não há.
shop_minimum_stock	Shop Minimum Stock	decimal number	Não há.
quantity_available	Quantity Available	decimal number	Não há.
quantity_pending_purchase	Purchase Order Pending Quantity	decimal number	Não há.
quantity_reserved_receipt	Quantity Reserved for Receipt	decimal number	Não há.
quantity_reserved_sale	Quantity Reserved for Sale	decimal number	Não há.
quantity_reserved_sale_web	Quantity Reserved for Sale Web	decimal number	Não há.
quantity_pending_shipping	Quantity Pending from the Shipping Order	decimal number	Não há.
reg_number	Brazilian Registry of Corporate Taxpayers	string	Não há.
seq_brand	Brand Sequence	integer	Não há.
box_price	Price of the Box	decimal number	Não há.
quantity_box	Quantity in the box	decimal number	Não há.
brand	Product’s Brand name	string	Tamanho da String: inclusive between 0 and 20
seq_category_main	Category Sequence	string	Não há.
date_offer	Date of the beginning offer	date	Não há.
seq_family	Family Sequence	decimal number	Não há.
seq_product	Product Sequence	decimal number	Não há.
seq_product_base	Product Base Sequence	decimal number	Não há.
seq_supplier_main	Main Supplier Sequence	decimal number	Não há.
situation_input_cofins	COFINS Fiscal Note Situation – Input – (COFINS = Contribution to Social Security Financing)	string	Não há.
situation_output_cofins	COFINS Fiscal Note Situation – Output – (COFINS = Contribution to Social Security Financing)	string	Não há.
situation_input_ipi	IPI Fiscal Note Situation – Input – (IPI = Taxes Over Industrialized Products)	string	Não há.
situation_output_ipi	IPI Fiscal Note Situation – Output – (IPI = Taxes Over Industrialized Products)	string	Não há.
situation_input_pis	PIS Fiscal Note Situation – Input – (PIS = Social Integration Program)	string	Não há.
situation_output_pis	PIS Fiscal Note Situation – Output – (PIS = Social Integration Program)	string	Não há.
state	State of Company	string	Não há.
stock_deposit	Deposit Stock	decimal number	Não há.
stock_exchange	Exchange Stock	decimal number	Não há.
stock_other	Other Stock	decimal number	Não há.
stock_store	Store Stock	decimal number	Não há.
stock_warehouse	Warehouse Stock	decimal number	Não há.
access_code_details	List of Details of Access Code	Collection of AccessCodeResponseDTO	Não há.
active_principle_details	List of Details of Active Principle	Collection of ActivePrincipleResponseDTO	Não há.
product_cost_details	List of Details of Product Cost	Collection of ProductCostResponseDTO	Não há.
last_product_purchase_details	List of Details of Last Product Purchase	Collection of ProductPurchaseResponseDTO	Não há..
category_details	List of Details of Category	Collection of CategoryResponseDTO	Não há..
packing_details	List of Details of Packing	Collection of PackingResponseDTO	Não há..
supplier_details	List of Details of Suppliers	Collection of SupplierResponseDTO	Não há..
product_similar_details	List of Similar Products	Collection of ProductSimilarResponseDTO	Não há..
tax_details	List of Details of Tax	Collection of TaxResponseDTO	Não há..

Formatos de Resposta (Response Formats)

application/json, text/json

...

Árvore de páginas

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

Objetivo

Chamada

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Parâmetros do Corpo (Body Parameters)

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

Formatos de Resposta (Response Formats)

application/json, text/json