Home TOTVS Varejo Supermercados

Árvore de páginas

  • Criado por Usuário desconhecido (luis.batista), última alteração em 20 abr, 2021

Objetivo

Recebe um pedido, realiza validações e gera um Pedido Web.

Request Information

URI Parameters

Não há.

Body Parameters

WebOrderDTO

NameNameDescriptionTypeAdditional information
finaliza_ped

Flag de finalização do pedido (S- Envia Pedido e já realiza integração com tabelas EDI / N [default] – Apenas salva pedido)

string

None.

cnpj

Numero do CNPJ - (00.000.000/0001-00 ou 00000000000000)

string

None.

entrega_retira

Tipo de Entrega(E – Entrega, R – Retira) - Default = "E"

string

None.

dta_basefaturamento

Data Base do faturamentoa (dd/mm/aaaa ou ddmmaaaa) (Opcional)

string

None.

itens

Itens do Pedido

Collection of WebOrderItemsDTO

None.


qtd_pedida

Quantidade Solicitada do Produto

decimal number

Required


qtd_embalagem

Quantidade da Embalagem

decimal number

Required


vlr_emb_tab_preco

Valor da Embalagem na tabela de Preços

decimal number

Required


seq_grade

Indica a sequência(código) da grade em questão (opcional)

integer

None.


seq_produto

Sequência númerica representativa do Produto

integer

Required


qtd_sugerida

Quantidade Sugerida do Produto

decimal number

Required

nro_empresa

Número da Empresa (opcional)

integer

None.

tp_pedido

Tipo do Pedido(C – Cotação, V- Venda)

string

None.

seq_ext_user

Sequence do Usuário (Opcional) - Se não informado, pedidos serão associados ao Usuário Master do Grupo com menor SEQ_GROUP

integer

None.

Request Formats

application/json, text/json

Sample:

{
  "finaliza_ped": "sample string 3",
  "cnpj": "sample string 4",
  "entrega_retira": "sample string 5",
  "dta_basefaturamento": "sample string 6",
  "itens": [
    {
      "qtd_pedida": 3.1,
      "qtd_embalagem": 4.1,
      "vlr_emb_tab_preco": 5.1,
      "seq_grade": 1,
      "seq_produto": 6,
      "qtd_sugerida": 7.1
    },
    {
      "qtd_pedida": 3.1,
      "qtd_embalagem": 4.1,
      "vlr_emb_tab_preco": 5.1,
      "seq_grade": 1,
      "seq_produto": 6,
      "qtd_sugerida": 7.1
    }
  ],
  "nro_empresa": 1,
  "tp_pedido": "sample string 7",
  "seq_ext_user": 1
}

application/xml, text/xml

Sample:

<WebOrderDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Consinco.SM.Api.Entities.Entities.v1.Sales">
  <_pageNo xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">1</_pageNo>
  <_pageSize xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">2</_pageSize>
  <CAN_FINALIZE_ORDER>sample string 3</CAN_FINALIZE_ORDER>
  <CNPJ>sample string 4</CNPJ>
  <IND_SHIPMENT_TYPE>sample string 5</IND_SHIPMENT_TYPE>
  <INVOICEMENT_BASE_DATE>sample string 6</INVOICEMENT_BASE_DATE>
  <ITEMS>
    <WebOrderItemsDTO>
      <_pageNo xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">1</_pageNo>
      <_pageSize xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">2</_pageSize>
      <QUANTITY_DEMANDED>3.1</QUANTITY_DEMANDED>
      <QUANTITY_PACKAGE>4.1</QUANTITY_PACKAGE>
      <SALES_TABLE_PRICE>5.1</SALES_TABLE_PRICE>
      <SEQ_GRID>1</SEQ_GRID>
      <SEQ_PRODUCT>6</SEQ_PRODUCT>
      <SUGGESTED_QUANTITY>7.1</SUGGESTED_QUANTITY>
    </WebOrderItemsDTO>
    <WebOrderItemsDTO>
      <_pageNo xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">1</_pageNo>
      <_pageSize xmlns="http://schemas.datacontract.org/2004/07/Kike.Web.Api.Dto">2</_pageSize>
      <QUANTITY_DEMANDED>3.1</QUANTITY_DEMANDED>
      <QUANTITY_PACKAGE>4.1</QUANTITY_PACKAGE>
      <SALES_TABLE_PRICE>5.1</SALES_TABLE_PRICE>
      <SEQ_GRID>1</SEQ_GRID>
      <SEQ_PRODUCT>6</SEQ_PRODUCT>
      <SUGGESTED_QUANTITY>7.1</SUGGESTED_QUANTITY>
    </WebOrderItemsDTO>
  </ITEMS>
  <NUMBER_COMPANY>1</NUMBER_COMPANY>
  <ORDER_TYPE>sample string 7</ORDER_TYPE>
  <SEQ_EXT_USER>1</SEQ_EXT_USER>
</WebOrderDTO>

Response Information

Response Codes

  • OK (200)
  • BadRequest (400)
  • Unauthorized (401)
  • InternalServerError (500)

Resource Description

WebOrderResponseDTO

NameDescriptionTypeAdditional information
seq_pedido

Sequência atribuída ao Pedido, para futuras Consultas

integer

None.

status

Status de Recebimento do Pedido(recebido/não recebido, inválido)

string

None.

callback_url

URL de callback para consulta posterior do processamento assíncrono

string

None.

Response Formats

application/json, text/json

Sample:

{
  "seq_pedido": 1,
  "status": "sample string 2",
  "callback_url": "sample string 3"
}

application/xml, text/xml

Sample:

<WebOrderResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Consinco.SM.Api.Entities.Entities.v1.Sales">
  <CALLBACKURL>sample string 3</CALLBACKURL>
  <SEQ_ORDER>1</SEQ_ORDER>
  <STATUS>sample string 2</STATUS>
</WebOrderResponseDTO>