Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

A finalidade deste método é, possibilitar a consulta dos custos associados aos produtos.

Chamada

GET api/v2/sm_products/product-cost

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

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
number_companyNumber Company – RequiredintegerNão há.
seq_productProduct Sequence – RequiredCollection of decimal numberRequerido
_pageNo
integerNão há.
_pageSize
integerNão há.

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Descrição do Recurso (Resource Description)

ProductCostResponseDTO – Lista custos dos produtos

Collection of ProductCostResponseDTO

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
fiscal_costFiscal Costdecimal numberNão há.
invoice_costInvoice Costdecimal numberNão há.
indicates_increase_cost_relationed_productIndicate if will be used extra in the cost of the relationed product. – N – No, S – YesstringNão há.
maximum_sales_price_companyMaximum Sales Price by Companydecimal numberNão há.
net_cost_valueNet Cost Valuedecimal numberNão há.
percentage_increase_cost_relativePercentage of extra cost relativedecimal numberNão há.
seq_productProduct sequencedecimal numberNão há.
seq_product_baseSequence base productdecimal numberNão há.
standard_sales_packagingStandard Sales Packagingdecimal numberNão há.
normal_marginStandard Sales PackagingstringNão há.
promo_marginStandard Sales PackagingstringNão há.

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

[
  {
    "fiscal_cost": 1.0,
    "invoice_cost": 1.0,
    "indicates_increase_cost_relationed_product": "sample string 1",
    "maximum_sales_price_company": 1.1,
    "net_cost_value": 1.0,
    "percentage_increase_cost_relative": 1.0,
    "seq_product": 2.0,
    "seq_product_base": 1.0,
    "standard_sales_packaging": 3.0,
    "normal_margin": "sample string 4",
    "promo_margin": "sample string 5"
  },
  {
    "fiscal_cost": 1.0,
    "invoice_cost": 1.0,
    "indicates_increase_cost_relationed_product": "sample string 1",
    "maximum_sales_price_company": 1.1,
    "net_cost_value": 1.0,
    "percentage_increase_cost_relative": 1.0,
    "seq_product": 2.0,
    "seq_product_base": 1.0,
    "standard_sales_packaging": 3.0,
    "normal_margin": "sample string 4",
    "promo_margin": "sample string 5"
  }
]

application/xml, text/xml

Exemplo (Sample):

<ArrayOfProductCostResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
 xmlns="http://schemas.datacontract.org/2004/07/SMProductsV3.Business.DTOs.Products">
  <ProductCostResponseDTO>
    <FISCAL_COST>1</FISCAL_COST>
    <INDICATES_INCREASE_COST_RELATIONED_PRODUCT>sample string 1</INDICATES_INCREASE_COST_RELATIONED_PRODUCT>
    <INVOICE_COST>1</INVOICE_COST>
    <MAXIMUM_SALES_PRICE_COMPANY>1.1</MAXIMUM_SALES_PRICE_COMPANY>
    <NET_COST_VALUE>1</NET_COST_VALUE>
    <NORMAL_MARGIN>sample string 4</NORMAL_MARGIN>
    <PERCENTAGE_INCREASE_COST_RELATIVE>1</PERCENTAGE_INCREASE_COST_RELATIVE>
    <PROMO_MARGIN>sample string 5</PROMO_MARGIN>
    <SEQ_PRODUCT>2</SEQ_PRODUCT>
    <SEQ_PRODUCT_BASE>1</SEQ_PRODUCT_BASE>
    <STANDARD_SALES_PACKAGING>3</STANDARD_SALES_PACKAGING>
  </ProductCostResponseDTO>
  <ProductCostResponseDTO>
    <FISCAL_COST>1</FISCAL_COST>
    <INDICATES_INCREASE_COST_RELATIONED_PRODUCT>sample string 1</INDICATES_INCREASE_COST_RELATIONED_PRODUCT>
    <INVOICE_COST>1</INVOICE_COST>
    <MAXIMUM_SALES_PRICE_COMPANY>1.1</MAXIMUM_SALES_PRICE_COMPANY>
    <NET_COST_VALUE>1</NET_COST_VALUE>
    <NORMAL_MARGIN>sample string 4</NORMAL_MARGIN>
    <PERCENTAGE_INCREASE_COST_RELATIVE>1</PERCENTAGE_INCREASE_COST_RELATIVE>
    <PROMO_MARGIN>sample string 5</PROMO_MARGIN>
    <SEQ_PRODUCT>2</SEQ_PRODUCT>
    <SEQ_PRODUCT_BASE>1</SEQ_PRODUCT_BASE>
    <STANDARD_SALES_PACKAGING>3</STANDARD_SALES_PACKAGING>
  </ProductCostResponseDTO>
</ArrayOfProductCostResponseDTO>