Consultar Status dos Itens dos Pedidos - GET

Objetivo

A finalidade deste método é possibilitar a consulta dos status dos itens dos pedidos.

Chamada

GET api/v1/sm/sales/orders-items-status?RETURN_TYPE={RETURN_TYPE}&ORDER_NUMBER={ORDER_NUMBER}&ORDER_NUMBER_SFA={ORDER_NUMBER_SFA}&ONLY_SFA={ONLY_SFA}&CNPJ={CNPJ}&COMPANY_NUMBER={COMPANY_NUMBER}&INCLUSION_DATE={INCLUSION_DATE}&UPDATE_DATE={UPDATE_DATE}&SEGMENT_NUMBER={SEGMENT_NUMBER}&ORDER_STATUS={ORDER_STATUS}&_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)
return_type	Indica o tipo de estrutura de retorno da informação: I = Itens; C = cortes. Padrão: I.	string	Não há.
order_number	Número do pedido de venda no Consinco ERP.	integer	Não há.
order_number_sfa	Número de pedido de software de terceiros integrado.	integer	Não há.
only_sfa	Filtro para retornar apenas pedidos com origem AFV. Siglas: S (Sim), N (Não) – Opcional	string	Não há.
cnpj	CNPJ da empresa utilizado como filtro de informações. – (00.000.000 / 0001-00 ou 00000000000000)	string	Não há.
company_number	Número da empresa do pedido de vendas. Quando informado, o parâmetro CNPJ é ignorado.	integer	Não há.
inclusion_date	Data em que o pedido foi adicionado / exportado para o ERP. Formatos: ddmmaaaahhmm ou dd / mm / aaaa hh: mm – opcional	string	Não há.
update_date	Data da última alteração feita no pedido de venda. Formatos: ddmmaaaahhmm ou dd / mm / aaaa hh: mm – opcional	string	Não há.
segment_number	Número do segmento específico de vendas para buscar alguma informação. Quando não informado, é considerado o principal segmento da empresa.	integer	Não há.
order_status	Filtro de status do pedido de vendas: T = todos, F = faturado, C = cancelado, L = liberado, P = em pré-separação, R = em roteamento, S = em separação, A = em análise, W = separado. Padrão: T.	string	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)

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
order_number	Número dos pedidos de venda no Consinco ERP.	integer	Não há.
order_number_sfa	Número de pedido de software de terceiros integrado.	integer	Não há.
order_items	Itens do Pedido	Collection of OrderItemResponseDTO	Não há.

Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

[
  {
    "order_number": 1,
    "order_number_sfa": 1,
    "order_items": [
      {
        "product_number": 1,
        "item_number": 2,
        "inclusion_date": "2020-09-03T10:28:36.5852276-03:00",
        "update_date": "2020-09-03T10:28:36.5852276-03:00",
        "packing_quantity": 1.1,
        "quantity_served": 1.1,
        "sale_price": 1.0,
        "list_price": 1.1,
        "cutting_quantity": 1.0,
        "item_margin_percentage": 1,
        "access_code": "sample string 3"
      },
      {
        "product_number": 1,
        "item_number": 2,
        "inclusion_date": "2020-09-03T10:28:36.5852276-03:00",
        "update_date": "2020-09-03T10:28:36.5852276-03:00",
        "packing_quantity": 1.1,
        "quantity_served": 1.1,
        "sale_price": 1.0,
        "list_price": 1.1,
        "cutting_quantity": 1.0,
        "item_margin_percentage": 1,
        "access_code": "sample string 3"
      }
    ]
  },
  {
    "order_number": 1,
    "order_number_sfa": 1,
    "order_items": [
      {
        "product_number": 1,
        "item_number": 2,
        "inclusion_date": "2020-09-03T10:28:36.5852276-03:00",
        "update_date": "2020-09-03T10:28:36.5852276-03:00",
        "packing_quantity": 1.1,
        "quantity_served": 1.1,
        "sale_price": 1.0,
        "list_price": 1.1,
        "cutting_quantity": 1.0,
        "item_margin_percentage": 1,
        "access_code": "sample string 3"
      },
      {
        "product_number": 1,
        "item_number": 2,
        "inclusion_date": "2020-09-03T10:28:36.5852276-03:00",
        "update_date": "2020-09-03T10:28:36.5852276-03:00",
        "packing_quantity": 1.1,
        "quantity_served": 1.1,
        "sale_price": 1.0,
        "list_price": 1.1,
        "cutting_quantity": 1.0,
        "item_margin_percentage": 1,
        "access_code": "sample string 3"
      }
    ]
  }
]

application/xml, text/xml