Pedido¶

Adicionar Pedido¶

Referência¶

POST https://api.dezwork.com/v1/pedidos

Parâmetros	Tipo	Descrição
orderNumber*	int	Número do pedido
totalAmount*	decimal	Valor total do pedido em reais
shippingAmount*	decimal	Valor do frete em reais
status*	int	Status do pedido. Consultar tabela de status
paymentForm*	string	Forma de pagamento (“creditcard”,”bankslip” ou “bankdeposit”)
shippingDeadline*	int	Prazo de entrega em dias
shippingForm	string	Forma de entrega (“pac” ou “sedex”)
shippingAddress*	obj	Endereço de entrega, objeto do tipo endereço
client*	obj/int	Objeto cliente ou ID de cliente existente
items*	array	Array contendo objetos itens do pedido

Nota

Parâmetros com asterisco ( * ) são obrigatórios

Exemplo de Requisição¶

{
    "orderNumber": "0123456",
    "totalAmount": "352.50",
    "shippingAmount": "25.00",
    "status": 1,
    "paymentForm": "bankslip",
    "shippingDeadline": 7,
    "shippingAddress": {
        "street": "Avenida Independência",
        "number": "1011",
        "complement": "Sala 04",
        "district": "Centro",
        "city": "Garibaldi",
        "state": "RS",
        "postcode": "95720000"
    },
    "client": {
        "type": "PF",
        "name": "Nome do Cliente",
        "document": "00857893050",
        "phone": "54999999999",
        "birthDate": "2000-02-02",
        "gender": 1,
        "active": true,
        "password": "senha_exemplo",
        "mail": "dev@branvo.com",
        "addresses": [
            {
                "street": "Rua João Pessoa",
                "number": "17",
                "complement": "Sala 04",
                "district": "Centro",
                "city": "Garibaldi",
                "state": "RS",
                "postcode": "95720000",
                "responsibleName": "Nome do responsável",
                "reference": "Super Mercado Y",
                "type": "1"
            }
        ]
    },
    "items": [
        {
            "idProductVariation": 2,
            "quantity": 5,
            "value": "50.00"
        },
        {
            "idProduct": 1,
            "quantity": 1,
            "value": "102.25"
        }
    ]    
}

Resposta¶

Status 201: CREATED¶

{
    "success": true,
    "data": {
        "id": 1,
        "orderNumber": "0123456",
        "totalAmount": "352.50",
        "shippingAmount": "25.00",
        "status": 1,
        "paymentForm": "bankslip",
        "shippingDeadline": 7,
        "createdAt": "01/01/2019 10:00:00",
        "updatedAt": "01/01/2019 10:00:00",
        "shippingAddress": {
            "street": "Avenida Independência",
            "number": "1011",
            "complement": "Sala 04",
            "district": "Centro",
            "city": "Garibaldi",
            "state": "RS",
            "postcode": "95720000"
        },
        "client": {
            "id": 1,
            "name": "Nome do Cliente",
            "document": "008.578.930-50"
        },
        "items": [
            {
                "id": 1,
                "idProductVariation": 2,
                "quantity": 5,
                "value": "50.00"
            },
            {
                "id": 2,
                "idProduct": 1,
                "quantity": 1,
                "value": "102.25"
            }
        ]
    }
}

Status 400: Bad Request¶

Ocorre quando há algum problema nos parâmetros enviados.

{
    "success": false,
    "errorCode": "EPT",
    "errorMessage": "Parâmetro [parametro] é obrigatório"
}

Atualizar Status do Pedido¶

Referência¶

PUT https://api.dezwork.com/v1/pedidos

Nota

Parâmetros com asterisco ( * ) são obrigatórios

Exemplo de Requisição¶

{
    "id": 1,
    "status": 5
}

Resposta¶

Status 200: OK¶

{
    "success": true,
    "data": {
        "id": 1,
        "orderNumber": "0123456",
        "totalAmount": "352.50",
        "shippingAmount": "25.00",
        "status": 5,
        "paymentForm": "bankslip",
        "shippingDeadline": 7,
        "createdAt": "01/01/2019 10:00:00",
        "updatedAt": "01/01/2019 10:00:00",
        "shippingAddress": {
            "street": "Avenida Independência",
            "number": "1011",
            "complement": "Sala 04",
            "district": "Centro",
            "city": "Garibaldi",
            "state": "RS",
            "postcode": "95720000"
        },
        "client": {
            "id": 1,
            "name": "Nome do Cliente",
            "document": "008.578.930-50"
        },
        "items": [
            {
                "id": 1,
                "idProductVariation": 2,
                "quantity": 5,
                "value": "50.00"
            },
            {
                "id": 2,
                "idProduct": 1,
                "quantity": 1,
                "value": "102.25"
            }
        ]
    }
}

Status 400: Bad Request¶

Ocorre quando há algum problema nos parâmetros enviados.

{
    "success": false,
    "errorCode": "EPT",
    "errorMessage": "Parâmetro [parametro] é obrigatório"
}

Consultar Pedido¶

Referência¶

GET https://api.dezwork.com/v1/pedidos/{id}

Basta uma requisição GET simples para esse endpoint, informando o ID do produto na URL para retornar o pedido em questão.

Resposta¶

Status 200: OK¶

{
    "success": true,
    "data": {
        "id": 1,
        "orderNumber": "0123456",
        "totalAmount": "352.50",
        "shippingAmount": "25.00",
        "status": 1,
        "paymentForm": "bankslip",
        "shippingDeadline": 7,
        "createdAt": "01/01/2019 10:00:00",
        "updatedAt": "01/01/2019 10:00:00",
        "shippingAddress": {
            "street": "Avenida Independência",
            "number": "1011",
            "complement": "Sala 04",
            "district": "Centro",
            "city": "Garibaldi",
            "state": "RS",
            "postcode": "95720000"
        },
        "client": {
            "id": 1,
            "name": "Nome do Cliente",
            "document": "008.578.930-50"
        },
        "items": [
            {
                "id": 1,
                "idProductVariation": 2,
                "quantity": 5,
                "value": "50.00"
            },
            {
                "id": 2,
                "idProduct": 1,
                "quantity": 1,
                "value": "102.25"
            }
        ]
    }
}

Consultar Pedidos¶

Referência¶

GET https://api.dezwork.com/v1/pedidos/pagina/{numero-pagina}

A API de pedidos realiza a consulta com paginação, onde a variável {numero-pagina} corresponde ao número da página desejada (1, 2, 3, …) e são retornados 50 pedidos por página. Os pedidos são retornados em ordem DECRESCENTE.

De forma opcional, pode ser passado via query param um parâmetro date, conforme especificação abaixo:

Parâmetro	Tipo	Descrição
date	string	Caso passado este parâmetro, aparecerão os pedidos que foram atualizados a partir desta data e hora. Formato: AAAA-MM-DD HH:MM:SS Ex: `{url}/v1/pedidos/pagina/1?date=2019-01-01 10:00:00`

Resposta¶

Status 200: OK¶

{
    "success": true,
    "data": [
        {
            "id": 1,
            "orderNumber": "0123456",
            "totalAmount": "352.50",
            "shippingAmount": "25.00",
            "status": 1,
            "paymentForm": "bankslip",
            "shippingDeadline": 7,
            "createdAt": "01/01/2019 10:00:00",
            "updatedAt": "01/01/2019 10:00:00",
            "shippingDeadline": 7,
            "shippingAddress": {
                "street": "Avenida Independência",
                "number": "1011",
                "complement": "Sala 04",
                "district": "Centro",
                "city": "Garibaldi",
                "state": "RS",
                "postcode": "95720000"
            },
            "client": {
                "id": 1,
                "name": "Nome do Cliente",
                "document": "008.578.930-50"
            },
            "items": [
                {
                    "id": 1,
                    "idProductVariation": 2,
                    "quantity": 5,
                    "value": "50.00"
                },
                {
                    "id": 2,
                    "idProduct": 1,
                    "quantity": 1,
                    "value": "102.25"
                }
            ]
        },
        {
            "id": 2,
            "orderNumber": "654321",
            "totalAmount": "153.20",
            "shippingAmount": "34.00",
            "status": 1,
            "paymentForm": "creditcard",
            "shippingDeadline": 7,
            "createdAt": "01/01/2019 10:00:00",
            "updatedAt": "01/01/2019 10:00:00",
            "shippingAddress": {
                "street": "Avenida Principal",
                "number": "12",
                "complement": "Casa 02",
                "district": "Centro",
                "city": "Garibaldi",
                "state": "RS",
                "postcode": "95720000"
            },
            "client": {
                "id": 1,
                "name": "Nome do Cliente",
                "document": "008.578.930-50"
            },
            "items": [
                {
                    "id": 1,
                    "idProductVariation": 2,
                    "quantity": 1,
                    "value": "70.00"
                },
                {
                    "id": 2,
                    "idProduct": 1,
                    "quantity": 4,
                    "value": "23.00"
                }
            ]
        }
    ]
}

Remover Pedido¶

Referência¶

DELETE https://api.dezwork.com/v1/pedidos/{id}

Basta uma requisição DELETE simples para esse endpoint, informando o ID na URL para remover o pedido em questão.

Resposta¶

Status 200: OK¶

{
    "success": true,
    "data": {
        "id": 1,
        "orderNumber": "0123456",
        "totalAmount": "352.50",
        "shippingAmount": "25.00",
        "status": 1,
        "paymentForm": "bankslip",
        "shippingDeadline": 7,
        "createdAt": "01/01/2019 10:00:00",
        "updatedAt": "01/01/2019 10:00:00",
        "shippingAddress": {
            "street": "Avenida Independência",
            "number": "1011",
            "complement": "Sala 04",
            "district": "Centro",
            "city": "Garibaldi",
            "state": "RS",
            "postcode": "95720000"
        },
        "client": {
            "id": 1,
            "name": "Nome do Cliente",
            "document": "008.578.930-50"
        },
        "items": [
            {
                "id": 1,
                "idProductVariation": 2,
                "quantity": 5,
                "value": "50.00"
            },
            {
                "id": 2,
                "idProduct": 1,
                "quantity": 1,
                "value": "102.25"
            }
        ]
    }
}

Inserir Nota Fiscal do Pedido¶

Referência¶

POST https://api.dezwork.com/v1/pedidos/{id}/nf

Informe o ID do pedido, ao qual pertence a nota fiscal, na URL.

Parâmetros	Tipo	Descrição
file*	string	URL do arquivo da nota fiscal/DANFE (PDF ou imagens)

Nota

Parâmetros com asterisco ( * ) são obrigatórios

Exemplo de Requisição¶

{
	"file": "http://url.da.nota.fiscal.ou.danfe"
}

Resposta¶

Status 200: OK¶

{
    "success": true,
    "data": {
        "id": 1,
        "file": "http://url.da.nota.fiscal"
    }
}

Status 400: Bad Request¶

Ocorre quando há algum problema nos parâmetros enviados.

{
    "success": false,
    "errorCode": "EPT",
    "errorMessage": "Parâmetro [parametro] é obrigatório"
}

Atualizar Nota Fiscal do Pedido¶

Referência¶

PUT https://api.dezwork.com/v1/pedidos/{id}/nf

Informe o ID do pedido, ao qual pertence a nota fiscal, na URL.

Parâmetros	Tipo	Descrição
file*	string	URL do arquivo da nota fiscal/DANFE (PDF ou imagens)

Nota

Parâmetros com asterisco ( * ) são obrigatórios

Exemplo de Requisição¶

{
	"file": "http://url.da.nota.fiscal.ou.danfe"
}

Resposta¶

Status 200: OK¶

{
    "success": true,
    "data": {
        "id": 1,
        "file": "http://url.da.nota.fiscal"
    }
}

Status 400: Bad Request¶

Ocorre quando há algum problema nos parâmetros enviados.

{
    "success": false,
    "errorCode": "EPT",
    "errorMessage": "Parâmetro [parametro] é obrigatório"
}

Consultar Nota Fiscal do Pedido¶

Referência¶

GET https://api.dezwork.com/v1/pedidos/{id}/nf

Basta uma requisição GET simples para esse endpoint, informando o ID do pedido na URL, para retornar a nota fiscal do pedido em questão.

Resposta¶

Status 200: OK¶

{
    "success": true,
    "data": [
        {
            "id": 1,
            "file": "http://url.da.nota.fiscal"
        }
    ]
}

Status 400: Bad Request¶

Ocorre quando há algum problema nos parâmetros enviados.

{
    "success": false,
    "errorCode": "EPT",
    "errorMessage": "Parâmetro [parametro] é obrigatório"
}

Remover Nota Fiscal do Pedido¶

Referência¶

DELETE https://api.dezwork.com/v1/pedidos/{id}/nf

Basta uma requisição DELETE simples para esse endpoint, informando o ID do pedido na URL, para remover a nota fiscal do pedido em questão.

Resposta¶

Status 200: OK¶

{
    "success": true,
    "data": {
        "id": 1,
        "file": "http://url.da.nota.fiscal"
    }
}

Status 400: Bad Request¶

Ocorre quando há algum problema nos parâmetros enviados.

{
    "success": false,
    "errorCode": "EPT",
    "errorMessage": "Parâmetro [parametro] é obrigatório"
}