Atualizar associação

PUT https://.account-name.krzlabs.io/api/v1/associations/:id

Realiza a atualização de uma associação.


Path Params

id string required
ID da associação.

Body Params

Field Type Description optional Searchable
code (unique) String Identificador global da associação. not required false
type enum Identificador global do tipo de associação. required false
name Translate Nome da associação. required true
description Translate Descrição da associação. not required false
associated_products Array(Object) Lista de produtos associados.
A lkista de produtos associados é um array de objetos, contendo as seguintes propriedades:
'_id' - ID do produto. - ObjectId
'quantity' - Quantidade do produto. - Number
'delete' - Indica se o produto deve ser excluído. - Boolean
not required false
enabled Boolean Indica se a associação está habilitada. not required false
tags Array(string) Tags associadas a associação. not required false
item_type enum Indica se a associação é um kit ou um produto sugerido. required false
Exemplo em JSON
{
  "code": "ASSOC-001",
  "type": "COMPLEMENTARY",
  "name": {
    "pt": "Produto Complementar",
    "en": "Complementary Product"
  },
  "description": {
    "pt": "Associação de produtos complementares para venda conjunta",
    "en": "Association of complementary products for bundled sale"
  },
  "associated_products": [
    {
      "_id": "66b8f5e9d9f4ab1234567890",
      "quantity": 2,
      "delete": false
    },
    {
      "_id": "66b8f5e9d9f4ab1234567891",
      "quantity": 1,
      "delete": false
    }
  ],
  "enabled": true,
  "tags": ["promoção", "bundle", "cross-sell"],
  "item_type": "VARIANT"
}

Responses

Resposta de sucesso

200
Successfully retrieved API registry entry.
Field Type Description optional Searchable
code (unique) String Identificador global da associação. not required false
type enum Identificador global do tipo de associação. required false
name Translate Nome da associação. required true
description Translate Descrição da associação. not required false
associated_products Array(Object) Lista de produtos associados.
A lkista de produtos associados é um array de objetos, contendo as seguintes propriedades:
'_id' - ID do produto. - ObjectId
'quantity' - Quantidade do produto. - Number
'delete' - Indica se o produto deve ser excluído. - Boolean
not required false
enabled Boolean Indica se a associação está habilitada. not required false
tags Array(string) Tags associadas a associação. not required false
item_type enum Indica se a associação é um kit ou um produto sugerido. required false

Resposta de erro

400
Bad Request
Field Type Description
code Number Código da resposta http
kind String Tipo de mensagem
name String Nome da exceção lançada pela plataforma
title String Titulo do erro lançado pela plataforma
message String Mensagem indicando o probloma ocorrido
solution String Mensagem indicando uma possível solução para o problema

Copyright © 2025 kruzer | All Rights Reserved