Endereço¶

Importante

Por questões internas, em ambiente sandbox, os cadastros de endereços de clientes não serão salvos permanentemente, sendo resetados de 30 em 30 minutos.

Adicionar Endereço¶

Referência¶

POST https://api.dezwork.com/v1/clientes/enderecos

Nota

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

Exemplo de Requisição¶

{
    "idClient": 1,
    "street": "Rua João Pessoa",
    "number": "17",
    "complement": "Sala 04",
    "district": "Centro",
    "city": "Garibaldi",
    "state": "RS",
    "postcode": "95720000",
    "responsibleName": "TESTE RESPONSÁVEL",
    "reference": "Super Mercado X",
    "type": 1
}

Resposta¶

Status 201: CREATED¶

{
    "success": true,
    "data": {
        "address": {
            "id": 1,
            "idClient": 1,
            "street": "Rua João Pessoa",
            "number": "17",
            "complement": "Sala 04",
            "district": "Centro",
            "city": "Garibaldi",
            "state": "RS",
            "postcode": "95720000",
            "responsibleName": "TESTE RESPONSÁVEL",
            "reference": "Super Mercado X",
            "type": 1
        }        
    }
}

Status 400: Bad Request¶

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

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

Atualizar Endereço¶

Referência¶

PUT https://api.dezwork.com/v1/clientes/enderecos

Nota

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

Exemplo de Requisição¶

{
    "id": 1,
    "idClient": 1,
    "street": "Rua João Pessoa",
    "number": "17",
    "complement": "Sala 04",
    "district": "Centro",
    "city": "Garibaldi",
    "state": "RS",
    "postcode": "95720000",
    "responsibleName": "TESTE RESPONSÁVEL",
    "reference": "Super Mercado X",
    "type": 1
}

Resposta¶

Status 200: OK¶

{
    "success": true,
    "data": {
        "address": {
            "id": 1,
            "idClient": 1,
            "street": "Rua João Pessoa",
            "number": "17",
            "complement": "Sala 04",
            "district": "Centro",
            "city": "Garibaldi",
            "state": "RS",
            "postcode": "95720000",
            "responsibleName": "TESTE RESPONSÁVEL",
            "reference": "Super Mercado X",
            "type": 1
        }        
    }
}

Status 400: Bad Request¶

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

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

Consultar Endereços¶

Referência¶

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

Basta uma requisição GET simples para esse endpoint, informando o ID do cliente na URL para retornar os endereços do mesmo.

Resposta¶

Status 200: OK¶

{
    "success": true,
    "data": {
        "addresses": [
            {
                "id": 1,
                "idClient": 1,
                "street": "Rua João Pessoa",
                "number": "17",
                "complement": "Sala 04",
                "district": "Centro",
                "city": "Garibaldi",
                "state": "RS",
                "postcode": "95720000",
                "responsibleName": "TESTE RESPONSÁVEL",
                "reference": "Super Mercado X",
                "type": 1
            },
            {
                "id": 2,
                "idClient": 1,
                "street": "Rua Salgado Filho",
                "number": "250",
                "district": "Centro",
                "city": "Garibaldi",
                "state": "RS",
                "postcode": "95720000",
                "responsibleName": "TESTE RESPONSÁVEL",
                "type": 2
            }
        ]
    }
}

Status 400: Bad Request¶

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

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

Consultar Endereço por ID¶

Referência¶

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

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

Resposta¶

Status 200: OK¶

{
    "success": true,
    "data": {
        "address": {
            "id": 1,
            "idClient": 1,
            "street": "Rua João Pessoa",
            "number": "17",
            "complement": "Sala 04",
            "district": "Centro",
            "city": "Garibaldi",
            "state": "RS",
            "postcode": "95720000",
            "responsibleName": "TESTE RESPONSÁVEL",
            "reference": "Super Mercado X",
            "type": 1
        }        
    }
}

Status 400: Bad Request¶

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

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

Excluir Endereço¶

Referência¶

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

Basta uma requisição DELETE simples para esse endpoint, informando o ID do endereço na URL para excluir o endereço em questão.

Resposta¶

Status 200: OK¶

{
    "success": true,
    "data": {
        "address": {
            "id": 1,
            "idClient": 1,
            "street": "Rua João Pessoa",
            "number": "17",
            "complement": "Sala 04",
            "district": "Centro",
            "city": "Garibaldi",
            "state": "RS",
            "postcode": "95720000",
            "responsibleName": "TESTE RESPONSÁVEL",
            "reference": "Super Mercado X",
            "type": 1
        }        
    }
}

Status 400: Bad Request¶

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

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