Opções de Variação¶

Para trabalhar com variações nas lojas virtuais da Dezwork, você precisa cadastrar os seus tipos e suas opções. Por exemplo: Cores (tipo): Azul, Branco, Preto (opções), Tamanhos (tipo): P, M, G (opções).

Adicionar Opções de Variação¶

Referência¶

POST https://api.dezwork.com/v1/produtos/opcaoVariacao

Parameters	type	Descrição
idType*	int	ID do tipo dessa opção de variação
title*	string	Nome/título do tipo de variação
active	int(0, 1)	Tipo de variação ativo?

Nota

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

Exemplo de Requisição¶

{
    "idType": 1,
    "title": "Tipo de Variação 1",
    "active": 1
}

Resposta¶

Status 201: CREATED¶

{
    "success": true,
    "data": {
        "variationOption": {
            "id": 1,
            "idType": 1,
            "title": "Opção de Variação 1",
            "active": 1
        }
    }
}

Status 400: Bad Request¶

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

{
    "success": false,
    "errorCode": "EPT001",
    "errorMessage": "Campo {$campo} é obrigatório"
}

Atualizar Opções de Variação¶

Referência¶

PUT https://api.dezwork.com/v1/produtos/opcaoVariacao

Nota

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

Exemplo de Requisição¶

{
    "id": 1,
    "idType": 1,
    "description": "Tipo de Variação 1",
    "active": 1
}

Resposta¶

Status 200: OK¶

{
    "success": true,
    "data": {
        "variationOption": {
            "id": 1,
            "idType": 1,
            "title": "Opção de Variação 1",
            "active": 1
        }
    }
}

Status 400: Bad Request¶

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

{
    "success": false,
    "errorCode": "EPT001",
    "errorMessage": "Campo {$campo} é obrigatório"
}

Consultar Opções de Variação¶

Referência¶

GET https://api.dezwork.com/v1/produtos/opcaoVariacao

Basta uma requisição GET simples para esse endpoint para retornar todas as opções de variação cadastrados em uma loja.

Resposta¶

Status 200: OK¶

{
    "success": true,
    "data": {
        "variationOptions": [
            {
                "id": 1,
                "idType": 1,
                "title": "Opção de Variação 1",
                "active": true
            },
            {
                "id": 2,
                "idType": 1,
                "title": "Opção de Variação 2",
                "active": true
            }
        ]
    }
}

Status 400: Bad Request¶

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

{
    "success": false,
    "errorCode": "EPT001",
    "errorMessage": "Campo {$campo} é obrigatório"
}

Consultar Opções de Variação por ID¶

Referência¶

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

Basta uma requisição GET simples para esse endpoint, informando o ID da opção de variação na URL para retornar a opção de variação em questão.

Resposta¶

Status 200: OK¶

{
    "success": true,
    "data": {
        "variationOption": {
            "id": 1,
            "idType": 1,
            "title": "Opção de Variação 1",
            "active": 1
        }
    }
}

Status 400: Bad Request¶

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

{
    "success": false,
    "errorCode": "EPT001",
    "errorMessage": "Campo {$campo} é obrigatório"
}

Consultar Opções de Variação por Tipo¶

Referência¶

GET https://api.dezwork.com/v1/produtos/tipoVariacao/{id}/opcoes

Basta uma requisição GET simples para esse endpoint, informando o ID do tipo de variação na URL para retornar todas as opções de variação do tipo em questão.

Resposta¶

Status 200: OK¶

{
    "success": true,
    "data": {
        "variationOptions": [
            {
                "id": 1,
                "idType": 1,
                "title": "Opção de Variação 1",
                "active": true
            },
            {
                "id": 2,
                "idType": 1,
                "title": "Opção de Variação 2",
                "active": true
            }
        ]
    }
}

Status 400: Bad Request¶

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

{
    "success": false,
    "errorCode": "EPT001",
    "errorMessage": "Campo {$campo} é obrigatório"
}

Excluir Opções de Variação¶

Referência¶

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

Basta uma requisição DELETE simples para esse endpoint, informando o ID da opção de variação na URL para excluir a opção de variação em questão.

Resposta¶

Status 200: OK¶

{
    "success": true,
    "data": {
        "variationOption": {
            "id": 1,
            "idType": 1,
            "title": "Opção de Variação 1",
            "active": 1
        }
    }
}

Status 400: Bad Request¶

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

{
    "success": false,
    "errorCode": "EPT001",
    "errorMessage": "Campo {$campo} é obrigatório"
}