01. DADOS GERAIS

02. SITUAÇÃO/REQUISITO

• Realizar a criação do controller do produto embalagem no PDVSync.Client.API
• Realizar a inclusão do Produto embalagem no PDVSync.Client.Down
• Realizar a baixa de um produto com produto embalagem

03. SOLUÇÃO

PDVSync.Client.Api

Obeservações

Foi criado um novo controller a fim de realizar o gerenciamento de produto embalagem.

• Nesse novo controller foram criado os métodos seguindo o padrão de rest API
  • POST: Para inserção do produto embalagem no banco de dados
  • PUT: Para atualização de um registro de produto embalagem
  • GET: Para busca de produto embalagem
  • PATCH: Para atualização de um campo específico de um produto embalagem
• Os métodos utilizam autenticação seguindo o padrão de segurança do projeto
• O controlle foi criado somenta na V2 da api

Segue abaixo a definição dos métodos, exemplos de payloads e possíveis retornos

Definição dos endpoints

POST

URL: /api/v2/produtosembalagem

Exemplo de body da requisição

{
    "codigoBarras": "string",
    "descricao": "string",
    "pesoBruto": 0,
    "pesoLiquido": 0,
    "quantidade": 0,
    "unidadeMedida": "string",
    "situacao": 0,
    "idRetaguarda": "string",
    "id": 0,
    "dataCadastro": "2023-09-07T11:09:38.913Z",
    "dataAtualizacao": "2023-09-07T11:09:38.913Z"
}

Definição dos campos de requisição

Retornos

• HTTP 200 - Ok

{
    "codigoBarras": "string",
    "descricao": "string",
    "pesoBruto": 0,
    "pesoLiquido": 0,
    "quantidade": 0,
    "unidadeMedida": "string",
    "situacao": 0,
    "idRetaguarda": "string",
    "id": 0,
    "dataCadastro": "2023-09-07T11:09:38.915Z",
    "dataAtualizacao": "2023-09-07T11:09:38.915Z",
    "_expandables": [
        "string"
    ]
}

• HTTP 400 - Bad request

{
    "code": "string",
    "message": "string",
    "detailedMessage": "string",
    "helpUrl": "string",
    "details": [
        {
            "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "code": "string",
            "message": "string",
            "detailedMessage": "string"
        }
    ]
}

PUT

URL: /api/v2/produtosembalagem/{id}

Definição dos campos de requisição

Exemplo de body da requisição

{
    "codigoBarras": "string",
    "descricao": "string",
    "pesoBruto": 0,
    "pesoLiquido": 0,
    "quantidade": 0,
    "unidadeMedida": "string",
    "situacao": 0,
    "idRetaguarda": "string",
    "dataCadastro": "2023-09-07T11:36:47.690Z",
    "dataAtualizacao": "2023-09-07T11:36:47.690Z"
}

Definição dos campos de requisição

Retornos

• HTTP 200 - Ok

{
    "codigoBarras": "string",
    "descricao": "string",
    "pesoBruto": 0,
    "pesoLiquido": 0,
    "quantidade": 0,
    "unidadeMedida": "string",
    "situacao": 0,
    "idRetaguarda": "string",
    "id": 0,
    "dataCadastro": "2023-09-07T11:09:38.915Z",
    "dataAtualizacao": "2023-09-07T11:09:38.915Z",
    "_expandables": [
        "string"
    ]
}

• HTTP 400 - Bad request

{
    "code": "string",
    "message": "string",
    "detailedMessage": "string",
    "helpUrl": "string",
    "details": [
        {
            "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "code": "string",
            "message": "string",
            "detailedMessage": "string"
        }
    ]
}

GET

URL: /api/v2/produtosembalagem/{idRetaguarda}

Definição dos campos de requisição

Retornos

• HTTP 200 - Ok

{
    "codigoBarras": "string",
    "descricao": "string",
    "pesoBruto": 0,
    "pesoLiquido": 0,
    "quantidade": 0,
    "unidadeMedida": "string",
    "situacao": 0,
    "idRetaguarda": "string",
    "id": 0,
    "dataCadastro": "2023-09-07T11:09:38.915Z",
    "dataAtualizacao": "2023-09-07T11:09:38.915Z",
    "_expandables": [
        "string"
    ]
}

• HTTP 400 - Bad request

{
    "code": "string",
    "message": "string",
    "detailedMessage": "string",
    "helpUrl": "string",
    "details": [
        {
            "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "code": "string",
            "message": "string",
            "detailedMessage": "string"
        }
    ]
}