Árvore de páginas

Objetivo

A finalidade deste método é possibilitar a consulta de preços dos produtos por empresa e segmento.

Chamada

GET api/v2/sm_products/product-price?
CODE_EAN=
{CODE_EAN}&LAST_UPDATE_DATE=
{LAST_UPDATE_DATE}&NUMBER_COMPANY=
{NUMBER_COMPANY}&NUMBER_SEGMENT=
{NUMBER_SEGMENT}&REG_NUMBER=
{REG_NUMBER}&SALES_TABLE_NUMBER=
{SALES_TABLE_NUMBER}&SEQ_PRODUCT=
{SEQ_PRODUCT}&_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)
code_eanEAN Code – (EAN: European Article Number) – OptionalstringNão há.
last_update_dateUpdate Date – Format: dd/mm/aaaa or ddmmaaaa – OptionalstringNão há.
number_companyNumber Company – Format: 000 – Optional if [reg_number] is informedintegerNão há.
number_segmentNumber Segment – Format: 00 Optional – Note: If not informed, will be considered the main segment of the companyintegerNão há.
reg_numberBrazilian Registry of Corporate Taxpayers (CNPJ) – Format: 00.000.000/0001-00 or 00000000000000 – Optional if [company] is informedstringNão há.
sales_table_numberNumber Table Sale – Optional – Note: If not informed, will be considered all sales tablestringTamanho da String: inclusive between 0 and 3
seq_productSequence of Product – OptionalintegerNão há.
_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)

ProductPriceResponseDTO – List of Price of Products

Collection of ProductPriceResponseDTO

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
code_eanEAN Code – (EAN: European Article Number)stringNão há.
date_end_promotionDate End PromotiondateNão há.
date_start_promotionDate Start PromotiondateNão há.
lower_sale_priceLower Sale Pricedecimal numberNão há.
normal_base_priceNormal Base Pricedecimal numberNão há.
number_companyNumber CompanyintegerNão há.
number_segmentNumber SegmentintegerNão há.
packingPackingstringNão há.
packing_quantityPacking Quantitydecimal numberNão há.
promotional_pricePromotional Pricedecimal numberNão há.
seq_productProduct Sequencedecimal numberNão há.
sales_tableList of Sales TableCollection of SalesTableResponseDTONão há.

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

[
  {
    "code_ean": "sample string 5",
    "date_end_promotion": "2019-10-31T15:37:25.125451-02:00",
    "date_start_promotion": "2019-10-31T15:37:25.125451-02:00",
    "lower_sale_price": 1.0,
    "normal_base_price": 1.0,
    "number_company": 1,
    "number_segment": 1,
    "packing": "sample string 6",
    "packing_quantity": 1.0,
    "promotional_price": 1.0,
    "seq_product": 7.0,
    "sales_table": [
      {
        "description_sales_table": "sample string 1",
        "number_sales_table": "sample string 2",
        "payment_condition": [
          {
            "description_payment_condition": "sample string 1",
            "number_payment_condition": 2,
            "price": 1.0
          },
          {
            "description_payment_condition": "sample string 1",
            "number_payment_condition": 2,
            "price": 1.0
          }
        ]
      },
      {
        "description_sales_table": "sample string 1",
        "number_sales_table": "sample string 2",
        "payment_condition": [
          {
            "description_payment_condition": "sample string 1",
            "number_payment_condition": 2,
            "price": 1.0
          },
          {
            "description_payment_condition": "sample string 1",
            "number_payment_condition": 2,
            "price": 1.0
          }
        ]
      }
    ]
  },
  {
    "code_ean": "sample string 5",
    "date_end_promotion": "2019-10-31T15:37:25.125451-02:00",
    "date_start_promotion": "2019-10-31T15:37:25.125451-02:00",
    "lower_sale_price": 1.0,
    "normal_base_price": 1.0,
    "number_company": 1,
    "number_segment": 1,
    "packing": "sample string 6",
    "packing_quantity": 1.0,
    "promotional_price": 1.0,
    "seq_product": 7.0,
    "sales_table": [
      {
        "description_sales_table": "sample string 1",
        "number_sales_table": "sample string 2",
        "payment_condition": [
          {
            "description_payment_condition": "sample string 1",
            "number_payment_condition": 2,
            "price": 1.0
          },
          {
            "description_payment_condition": "sample string 1",
            "number_payment_condition": 2,
            "price": 1.0
          }
        ]
      },
      {
        "description_sales_table": "sample string 1",
        "number_sales_table": "sample string 2",
        "payment_condition": [
          {
            "description_payment_condition": "sample string 1",
            "number_payment_condition": 2,
            "price": 1.0
          },
          {
            "description_payment_condition": "sample string 1",
            "number_payment_condition": 2,
            "price": 1.0
          }
        ]
      }
    ]
  }
]

application/xml, text/xml
Exemplo (Sample):

<ArrayOfProductPriceResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Consinco.SM.API.Entities.Entities.v2.Products">
  <ProductPriceResponseDTO>
    <CODE_EAN>sample string 5</CODE_EAN>
    <COUNT>1</COUNT>
    <DATE_END_PROMOTION>2019-10-31T15:37:25.125451-02:00</DATE_END_PROMOTION>
    <DATE_PRICE_VALIDATITON>2019-10-31T15:37:25.125451-02:00</DATE_PRICE_VALIDATITON>
    <DATE_START_PROMOTION>2019-10-31T15:37:25.125451-02:00</DATE_START_PROMOTION>
    <DESCRIPTION_PAYMENT_CONDITION>sample string 2</DESCRIPTION_PAYMENT_CONDITION>
    <DESCRIPTION_SALES_TABLE>sample string 3</DESCRIPTION_SALES_TABLE>
    <LOWER_SALE_PRICE>1</LOWER_SALE_PRICE>
    <NORMAL_BASE_PRICE>1</NORMAL_BASE_PRICE>
    <NUMBER_COMPANY>1</NUMBER_COMPANY>
    <NUMBER_PAYMENT_CONDITION>1</NUMBER_PAYMENT_CONDITION>
    <NUMBER_SALES_TABLE>sample string 4</NUMBER_SALES_TABLE>
    <NUMBER_SEGMENT>1</NUMBER_SEGMENT>
    <PACKING>sample string 6</PACKING>
    <PACKING_QUANTITY>1</PACKING_QUANTITY>
    <PRICE>1</PRICE>
    <PROMOTIONAL_PRICE>1</PROMOTIONAL_PRICE>
    <SEQ_PRODUCT>7</SEQ_PRODUCT>
    <SalesTableResponseDTO>
      <SalesTableResponseDTO>
        <DESCRIPTION_SALES_TABLE>sample string 1</DESCRIPTION_SALES_TABLE>
        <NUMBER_SALES_TABLE>sample string 2</NUMBER_SALES_TABLE>
        <PaymentConditionResponseDTO>
          <PaymentConditionResponseDTO>
            <DESCRIPTION_PAYMENT_CONDITION>sample string 1</DESCRIPTION_PAYMENT_CONDITION>
            <NUMBER_PAYMENT_CONDITION>2</NUMBER_PAYMENT_CONDITION>
            <PRICE>1</PRICE>
          </PaymentConditionResponseDTO>
          <PaymentConditionResponseDTO>
            <DESCRIPTION_PAYMENT_CONDITION>sample string 1</DESCRIPTION_PAYMENT_CONDITION>
            <NUMBER_PAYMENT_CONDITION>2</NUMBER_PAYMENT_CONDITION>
            <PRICE>1</PRICE>
          </PaymentConditionResponseDTO>
        </PaymentConditionResponseDTO>
      </SalesTableResponseDTO>
      <SalesTableResponseDTO>
        <DESCRIPTION_SALES_TABLE>sample string 1</DESCRIPTION_SALES_TABLE>
        <NUMBER_SALES_TABLE>sample string 2</NUMBER_SALES_TABLE>
        <PaymentConditionResponseDTO>
          <PaymentConditionResponseDTO>
            <DESCRIPTION_PAYMENT_CONDITION>sample string 1</DESCRIPTION_PAYMENT_CONDITION>
            <NUMBER_PAYMENT_CONDITION>2</NUMBER_PAYMENT_CONDITION>
            <PRICE>1</PRICE>
          </PaymentConditionResponseDTO>
          <PaymentConditionResponseDTO>
            <DESCRIPTION_PAYMENT_CONDITION>sample string 1</DESCRIPTION_PAYMENT_CONDITION>
            <NUMBER_PAYMENT_CONDITION>2</NUMBER_PAYMENT_CONDITION>
            <PRICE>1</PRICE>
          </PaymentConditionResponseDTO>
        </PaymentConditionResponseDTO>
      </SalesTableResponseDTO>
    </SalesTableResponseDTO>
  </ProductPriceResponseDTO>
  <ProductPriceResponseDTO>
    <CODE_EAN>sample string 5</CODE_EAN>
    <COUNT>1</COUNT>
    <DATE_END_PROMOTION>2019-10-31T15:37:25.125451-02:00</DATE_END_PROMOTION>
    <DATE_PRICE_VALIDATITON>2019-10-31T15:37:25.125451-02:00</DATE_PRICE_VALIDATITON>
    <DATE_START_PROMOTION>2019-10-31T15:37:25.125451-02:00</DATE_START_PROMOTION>
    <DESCRIPTION_PAYMENT_CONDITION>sample string 2</DESCRIPTION_PAYMENT_CONDITION>
    <DESCRIPTION_SALES_TABLE>sample string 3</DESCRIPTION_SALES_TABLE>
    <LOWER_SALE_PRICE>1</LOWER_SALE_PRICE>
    <NORMAL_BASE_PRICE>1</NORMAL_BASE_PRICE>
    <NUMBER_COMPANY>1</NUMBER_COMPANY>
    <NUMBER_PAYMENT_CONDITION>1</NUMBER_PAYMENT_CONDITION>
    <NUMBER_SALES_TABLE>sample string 4</NUMBER_SALES_TABLE>
    <NUMBER_SEGMENT>1</NUMBER_SEGMENT>
    <PACKING>sample string 6</PACKING>
    <PACKING_QUANTITY>1</PACKING_QUANTITY>
    <PRICE>1</PRICE>
    <PROMOTIONAL_PRICE>1</PROMOTIONAL_PRICE>
    <SEQ_PRODUCT>7</SEQ_PRODUCT>
    <SalesTableResponseDTO>
      <SalesTableResponseDTO>
        <DESCRIPTION_SALES_TABLE>sample string 1</DESCRIPTION_SALES_TABLE>
        <NUMBER_SALES_TABLE>sample string 2</NUMBER_SALES_TABLE>
        <PaymentConditionResponseDTO>
          <PaymentConditionResponseDTO>
            <DESCRIPTION_PAYMENT_CONDITION>sample string 1</DESCRIPTION_PAYMENT_CONDITION>
            <NUMBER_PAYMENT_CONDITION>2</NUMBER_PAYMENT_CONDITION>
            <PRICE>1</PRICE>
          </PaymentConditionResponseDTO>
          <PaymentConditionResponseDTO>
            <DESCRIPTION_PAYMENT_CONDITION>sample string 1</DESCRIPTION_PAYMENT_CONDITION>
            <NUMBER_PAYMENT_CONDITION>2</NUMBER_PAYMENT_CONDITION>
            <PRICE>1</PRICE>
          </PaymentConditionResponseDTO>
        </PaymentConditionResponseDTO>
      </SalesTableResponseDTO>
      <SalesTableResponseDTO>
        <DESCRIPTION_SALES_TABLE>sample string 1</DESCRIPTION_SALES_TABLE>
        <NUMBER_SALES_TABLE>sample string 2</NUMBER_SALES_TABLE>
        <PaymentConditionResponseDTO>
          <PaymentConditionResponseDTO>
            <DESCRIPTION_PAYMENT_CONDITION>sample string 1</DESCRIPTION_PAYMENT_CONDITION>
            <NUMBER_PAYMENT_CONDITION>2</NUMBER_PAYMENT_CONDITION>
            <PRICE>1</PRICE>
          </PaymentConditionResponseDTO>
          <PaymentConditionResponseDTO>
            <DESCRIPTION_PAYMENT_CONDITION>sample string 1</DESCRIPTION_PAYMENT_CONDITION>
            <NUMBER_PAYMENT_CONDITION>2</NUMBER_PAYMENT_CONDITION>
            <PRICE>1</PRICE>
          </PaymentConditionResponseDTO>
        </PaymentConditionResponseDTO>
      </SalesTableResponseDTO>
    </SalesTableResponseDTO>
  </ProductPriceResponseDTO>
</ArrayOfProductPriceResponseDTO>