01. VISÃO GERAL

Criação da API para disponibilizar informações dos produtos que sofreram alteração em um período de tempo.

02. EXEMPLO DE UTILIZAÇÃO

http://{{host}}/api/ecommerce/v1/orderChangeStatus

Na requisição é informado o Código da empresa companyId , data inicial do período da alteração initialLastChangeDate e data inicial do período da alteração finalLastChangeDate

http://{{host}}/api/ecommerce/v1/orderChangeStatus?companyId=1&initialLastChangeDate=2020-01-06 T00:00:00&finalLastChangeDate=2020-02-10 T10:59:16

Parâmetro	Tipo	Formato	Descrição	Exemplo
Authorization (header)	string		Cabeçalho usado para autorização das requisições *required
companyId (query)	string		Código da Empresa **required	/orderChangeStatus?companyId=1
companyCnpjNumber (query)	string		Documento da empresa **required	/orderChangeStatus?companyCnpjNumber=1
initialLastChangeDate	Date		Data inicial da alteração do pedido *required	/orderChangeStatus? companyId=1& initialLastChangeDate=2020-01-06 T00:00:00
finalLastChangeDate	Date		Data final da alteração do pedido *required	/orderChangeStatus? companyId=1& finalLastChangeDate=2020-02-10 T10:59:16
customerOrderNumber (query)	string		Número do pedido do cliente	/orderChangeStatus?companyId=5&initialLastChangeDate=2020-01-18 T00:00:00&finalLastChangeDate=2020-02-19 T08:54:30&customerOrderNumber=147
customerCode (query)	integer	int32	Código do cliente	/orderChangeStatus? companyId=1& initialLastChangeDate=2020-01-06 T00:00:00& finalLastChangeDate=2020-02-10 T10:59:16& customerCode=6632
customerCpfCnpjNumber (query)	string		Documento do cliente	/orderChangeStatus? companyId=1& initialLastChangeDate=2020-01-06 T00:00:00& finalLastChangeDate=2020-02-10 T10:59:16& customerCpfCnpjNumber=09102437000291
IsAttendedTransaction	string		Informar true para retornar apenas pedidos com transação atendida ou false para retornar todos os pedidos, caso não informe o valor default será false	/orderChangeStatus? BranchId=1& InitialLastChangeDate=2020-10-30T00%3A24%3A20& FinalLastChangeDate=2020-10-31T10%3A24%3A20& IsAttendedTransaction=true& CompanyId%20=1
page (query)	integer	int32	Paginação da Coleção	/orderChangeStatus?companyId=1&branchId=1&page=3
pageSize (query)	integer	int32	Quantidade de Itens por Pagina	/orderChangeStatus?companyId=1&branchId=1&pageSize=3
initialOrderDate (query)	Date		Data inicial do pedido	/orderChangeStatus? companyId=1&f initialLastChangeDate=2020-01-06 T00:00:00& finalLastChangeDate=2020-02-10 T10:59:16& initialOrderDate=2008-05-05 T00:00:00
finalOrderDate (query)	Date		Data final do pedido	/orderChangeStatus? companyId=1& initialLastChangeDate=2020-01-06 T00:00:00& finalLastChangeDate=2020-02-10 T10:59:16& finalOrderDate=2009-05-07 T00:00:00
situationType (query)	integer	int32	Situação do pedido	/orderChangeStatus? companyId=1& initialLastChangeDate=2020-01-06 T00:00:00&f initialLastChangeDate=2020-02-10 T10:59:16& situationType=3
operationCode (query)	integer	int32	Operação do pedido	/orderChangeStatus?companyId=1&initialLastChangeDate=2020-01-06 T00:00:00&finalLastChangeDate=2020-02-10 T10:59:16&operationCode=2077

Importante!

Os campos **required necessitam de pelo menos uma informação, logo, quando uma é informada, o outro campo deixa de ser obrigatório.

{
	"hasNext": false,
	"items": [
		{
			"companyCode": "string",
            "customerOrderNumber": "string",
            "companyCnpjNumber": "string",
            "orderCode": 0,
            "customerCode": 0,
            "customerCpfCnpjNumber": "string",
            "customerName": "string",
            "operationCode": 0,
            "paymentTermsCode": 0,
            "orderDate": "2020-01-01T00:00:00",
            "representativeCode": 0,
            "situationType": 0,
            "situationDescription": "string",
            "sellerCode": 0,
            "revenuesComissionPercentage": 0,
            "receivementComissionPercentage": 0,
            "shippingCompanyCode": 0,
            "shippingCompanyName": "string",
            "shippingCompanyRedispatchCode": 0,
            "shippingCompanyRedispatchName": "string",
            "freightType": "string",
            "arrivalDate": "2020-01-01T00:00:00",
            "cancelLimitDate": "2020-01-01T00:00:00",
            "completionForecastDate": "2020-01-01T00:00:00",
            "completionLimitDate": "2020-01-01T00:00:00",
            "completionLastDate": "2020-01-01T00:00:00",
            "chargingType": 0,
            "chargingDefaultType": 0,
            "currencyCode": 0,
            "averageTermNumber": 0,
            "basePaymentDate": "2020-01-01T00:00:00",
            "batchCode": "string",
            "discountPercentage": 0,
            "comissionTableCode": 0,
            "priceTableCode": 0,
            "freightValue": 0,
            "freightPercentage": 0,
            "totalValue": 0,
            "lastChangeDate": "2020-01-01T00:00:00",
            "liquidValue": 0,
            "requestedValue": 0,
            "attendedValue": 0,
            "pendingValue": 0
		}
	]
}

{
    "hasNext": false,
    "items": [
      {
            "companyCode": "1",
            "customerOrderNumber": null,
            "companyCnpjNumber": "00000000000000",
            "orderCode": 292955,
            "customerCode": 1763,
            "customerCpfCnpjNumber": "00000000000",
            "customerName": "BIAN CONFECCOES LTDA",
            "operationCode": 2019,
            "paymentTermsCode": 2456,
            "orderDate": "2009-01-14T00:00:00",
            "representativeCode": 2057,
            "situationType": 6,
            "situationDescription": "Cancelado",
            "sellerCode": null,
            "revenuesComissionPercentage": 3,
            "receivementComissionPercentage": 3,
            "shippingCompanyCode": 3366,
            "shippingCompanyName": "MTR TRANSPORTES LTDA",
            "shippingCompanyRedispatchCode": null,
            "shippingCompanyRedispatchName": null,
            "freightType": "1",
            "arrivalDate": "2009-01-20T00:00:00",
            "cancelLimitDate": null,
            "completionForecastDate": "2009-01-20T00:00:00",
            "completionLimitDate": null,
            "completionLastDate": null,
            "chargingType": 0,
            "chargingDefaultType": null,
            "currencyCode": 1,
            "averageTermNumber": 56,
            "basePaymentDate": null,
            "batchCode": null,
            "discountPercentage": null,
            "comissionTableCode": null,
            "priceTableCode": 1401,
            "freightValue": null,
            "freightPercentage": null,
            "totalValue": null,
            "lastChangeDate": "2020-02-10T10:59:17",
            "liquidValue": 28582,
            "requestedValue": 28582,
            "attendedValue": 28334,
            "pendingValue": 248
        },
        {
            "companyCode": "1",
            "customerOrderNumber": "PDV - ANDES",
            "companyCnpjNumber": "00000000000000",
            "orderCode": 300534,
            "customerCode": 20252,
            "customerCpfCnpjNumber": "00000000000000",
            "customerName": "VIA MODA CIA. LTDA",
            "operationCode": 2087,
            "paymentTermsCode": 1090,
            "orderDate": "2009-01-19T00:00:00",
            "representativeCode": 20149,
            "situationType": 5,
            "situationDescription": "Bloqueado",
            "sellerCode": null,
            "revenuesComissionPercentage": null,
            "receivementComissionPercentage": 7,
            "shippingCompanyCode": null,
            "shippingCompanyName": null,
            "shippingCompanyRedispatchCode": null,
            "shippingCompanyRedispatchName": null,
            "freightType": "1",
            "arrivalDate": null,
            "cancelLimitDate": null,
            "completionForecastDate": "2009-01-23T00:00:00",
            "completionLimitDate": null,
            "completionLastDate": null,
            "chargingType": 0,
            "chargingDefaultType": null,
            "currencyCode": 2,
            "averageTermNumber": 90,
            "basePaymentDate": null,
            "batchCode": null,
            "discountPercentage": null,
            "comissionTableCode": null,
            "priceTableCode": 1099,
            "freightValue": null,
            "freightPercentage": null,
            "totalValue": null,
            "lastChangeDate": "2020-02-10T10:59:17",
            "liquidValue": 463,
            "requestedValue": 473,
            "attendedValue": 0,
            "pendingValue": 463
        }
    ]
}

IMPORTANTE!

A requisição utilizada no exemplo se encontra em 1. Requisição -> Exemplo de Utilização

Nome	Tipo	Formato	Descrição
companyCode	String		Código da empresa
customerOrderNumber	String		Documento do cliente
companyCnpjNumber	String		Documento da empresa
orderCode	Int		Código do pedido
customerCode	Int		Código do cliente
customerCpfCnpjNumber	String		Documento da pessoa
customerName	String		Nome do cliente
operationCode	Int		Código da operação
paymentTermsCode	Int		Código dos termos de pagamento
orderDate	Date		Data do pedido
representativeCode	Int		Código do representante
situationType	Int		Tipo da situação
situationDescription	String		Descrição da situação
sellerCode	Int		Código do vendedor
revenuesComissionPercentage	Int		Porcentagem da comissão de faturamento
receivementComissionPercentage	Int		porcentagem comissão recebimento
shippingCompanyCode	Int		Código da transportadora
shippingCompanyName	String		Nome da transportadora
shippingCompanyRedispatchCode	Int		Código da transportadora de despache
shippingCompanyRedispatchName	String		Nome da transportadora de despache
freightType	String		Tipo do frete
arrivalDate	String	Date-time	Data da chegada
cancelLimitDate	String	Date-time	Data do limite de cancelamento
completionForecastDate	String	Date-time	Data de previsão de baixa
completionLimitDate	String	Date-time	Data limite de baixa
completionLastDate	String	Date-time	Data da ultima baixa
chargingType	Int		Tipo de cobrança
chargingDefaultType	Int		Tipo de cobrança padrão
currencyCode	Int		Codigo da moeda
averageTermNumber	Int		Numero do prazo médio
basePaymentDate	String	Date-time	Data base de pagamento
batchCode	String		Código do lote
discountPercentage	Int		Percentual de desconto
comissionTableCode	Int		Código da tabela de comissão
priceTableCode	Int		Código da tabela de preço
freightValue	Int		valor de frete
freightPercentage	Int		Percentual de frete
totalValue	Int		Valor total
lastChangeDate	String	Date-time	Data de alteração
liquidValue	Int		Valor liquido
requestedValue	Int		Valor solicitado
attendedValue	Int		Valor atendido
pendingValue	Int		Valor pendente

Código	Descrição
-1	Erro não tratado

03. DOCUMENTOS DE REFERÊNCIA

DOCUMENTAÇÃO DA API: https://www30.bhan.com.br:12443/api/ecommerce/v1/swagger/index.html

Páginas filhas

DR VA - API Ecommerce - OrderChangeStatus - Pedidos Alterados

01. VISÃO GERAL

02. EXEMPLO DE UTILIZAÇÃO

IMPORTANTE!

03. DOCUMENTOS DE REFERÊNCIA