Listar Categorias

Listando Categorias

Para listar as categorias criadas em nossa plataforma e suas informações, realize a consulta via GET na rota Url/segments/{segmentId}/categories.

O SegmentID deverá ser informado, saiba mais em Login via API. O uso de seu Bearer Token também será necessário.

Listar Categorias

GET {Url}/segments/{segmentId}/categories

Path Parameters

Name	Type	Description
segmentId	string	ID de Segmento
companies	string	ID de Empresas que listarão as categorias

Query Parameters

Name	Type	Description
name	String	Nome da categoria que deseja listar

200 OK

[
  {
    "_id": "string",
    "createdAt": "2020-01-01T00:00:00Z",
    "updatedAt": "2020-01-01T00:00:00Z",
    "companies": [
      {
        "_id": "string",
        "createdAt": "2020-01-01T00:00:00Z",
        "updatedAt": "2020-01-01T00:00:00Z",
        "segment": "string",
        "type": "private",
        "document": "string",
        "name": "string",
        "tag": "string",
        "logoUrl": "string",
        "crtId": "string",
        "addresses": [
          {
            "_id": "string",
            "country": "string",
            "state": "string",
            "city": "string",
            "neighborhood": "string",
            "street": "string",
            "number": "string",
            "complement": "string",
            "postalCode": "string"
          }
        ],
        "contacts": [
          {
            "contact": "string",
            "type": "whatsapp"
          }
        ],
        "integration": {
          "praNotas": {
            "authorization": "string",
            "homologation": true,
            "certificate": "string",
            "status": "string",
            "count": 0,
            "serie": "string",
            "csc": "string",
            "cscId": "string"
          },
          "pagaRapido": {
            "authorization": "string",
            "subscription": "string"
          },
          "praSaques": {
            "token": "string"
          }
        },
        "activityBranch": {
          "_id": "string",
          "name": "string",
          "examples": "string",
          "value": "retail"
        },
        "stockSettings": {
          "stockLocalDevice": {
            "_id": "string",
            "createdAt": "2020-01-01T00:00:00Z",
            "updatedAt": "2020-01-01T00:00:00Z",
            "name": "string",
            "company": null,
            "acronym": "string",
            "segment": "string"
          },
          "stockLocalCatalog": {
            "_id": "string",
            "createdAt": "2020-01-01T00:00:00Z",
            "updatedAt": "2020-01-01T00:00:00Z",
            "name": "string",
            "company": null,
            "acronym": "string",
            "segment": "string"
          }
        }
      }
    ],
    "segment": "string",
    "name": "string",
    "systemCode": "string",
    "categoryId": "string",
    "iconUrl": "string",
    "subcategories": [],
    "status": "active",
    "salesChannelCategories": [
      {
        "appConfiguration": {},
        "salesChannelCategory": {
          "_id": "string",
          "createdAt": "2020-01-01T00:00:00Z",
          "updatedAt": "2020-01-01T00:00:00Z",
          "externalId": "string",
          "name": "string",
          "app": "string",
          "picture": "string",
          "previousCategories": [],
          "childrens": [],
          "customFields": []
        },
        "externalId": "string"
      }
    ]
  }
]

401 Verifique o Bearer Token utilizado e tente novamente

[]

404 Verifique a rota e método utilizado e tente novamente.

[]

Caso a requisição esteja correta, o código 200 OK será retornado. Prossiga para a próxima sessão para finalizar o cadastro de seus produtos.

Outros Erros: Caso sejam retornados outros erros, favor entrar em contato com o time de integração.