Obter todas as relações de produtos

GET https://.account-name.krzlabs.io/api/v1/products-relations

Realiza a busca de relações de produtos


Request

paginação / link de referência
Entenda como aplicar paginação e ordenação na sua listagem
Entenda como aplicar filtros na sua listagem
Entenda como expandir entidades relacionadas nos documentos da listagem

Responses

Resposta de sucesso

200
Successfully retrieved API registry entry.
Field Type Description Optional Searchable
type enum(ProductRelationTypeEnum) Referência à família do produto.
Possíveis valores:
ASSOCIATION = 'association',
KIT_PRODUCTS = 'kit_products',
KIT_SERVICES = 'kit_services',
ELIGIBLE_SERVICE_PRODUCTS = 'eligible_service_products',
INELIGIBLE_SERVICE_PRODUCTS = 'ineligible_service_products',
ELIGIBLE_SERVICE_CATEGORIES = 'eligible_service_categories',
INELIGIBLE_SERVICE_CATEGORIES = 'ineligible_service_categories'
required false
product_id ObjectId Referência ao produto. required false
kit_products Array(Object) Referência ao produto
Requer duas keys:
   - id: ObjectId - required
   - quantity: number - required
not required false
kit_services Array(Object) Referência ao produto
Requer duas keys:
   - id: ObjectId - required
   - quantity: number - required
not required false
association array(Object) Referência ao produto
Requer duas keys:
   - id: ObjectId - required
not required false
eligible_service_products array(Object) Referência ao produto
Requer uma key:
   - id: ObjectId - required
not required false
ineligible_service_products array(Object) Referência ao produto
Requer uma key:
   - id: ObjectId - required
not required false
eligible_service_categories array(Object) Referência ao produto
Requer uma key:
   - id: ObjectId - required
not required false
ineligible_service_categories array(Object) Referência ao produto
Requer duas keys:
   - id: ObjectId - required
   - category_tree_id: ObjectId - required
not required false
Exemplo de resposta em JSON
{
  "type": "association",
  "product_id": "64f1b3d4e5d987654321cdef",
  "kit_products": [
    { "id": "64f1c4e6e5d567890abcd111", "quantity": 2 },
    { "id": "64f1c4e6e5d567890abcd112", "quantity": 5 }
  ],
  "kit_services": [
    { "id": "64f1c4e6e5d567890abcd113", "quantity": 1 }
  ],
  "association": [
    { "id": "64f1c4e6e5d567890abcd114" },
    { "id": "64f1c4e6e5d567890abcd115" }
  ],
  "eligible_service_products": [
    { "id": "64f1c4e6e5d567890abcd116" }
  ],
  "ineligible_service_products": [
    { "id": "64f1c4e6e5d567890abcd117" }
  ],
  "eligible_service_categories": [
    { "id": "64f1c4e6e5d567890abcd118" }
  ],
  "ineligible_service_categories": [
    { 
      "id": "64f1c4e6e5d567890abcd119", 
      "category_tree_id": "64f1c4e6e5d567890abcd120"
    }
  ]
}

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