Criação de Categorias

Criando Categorias

Para começar a criar seus produtos e iniciar suas vendas, é necessário incluir sua primeira categoria de produtos.

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

Para criar a sua categoria, informe os dados da categoria, via POST na rota Url/segments/{segmentId}/categories

Criar Categoria

POST {Url}/segments/{segmentId}/categories

Path Parameters

Name	Type	Description
segmentId	string	ID de Segmento

Request Body

Name	Type	Description
name*	string	Nome da Categoria
systemCode	string	Código do Sistema Externo
categoryId	string	ID da Categoria Pai (se existir)
companies	array	ID das empresas que receberão a categoria
iconUrl	string	Url da imagem da categoria (https://subdominio.site.com.br/foto.png)
status	string	Status da Categoria (Ativa: active | Inativa: inactive )
salesChannelCategories	object	Categorias de canais de venda salesChannelCategories.appConfiguration: ID da configuração de APP* salesChannelCategories.salesChannelCategory: ID da categoria de canal de vendas salesChannelCategories.externalId: ID no canal de vendas

201 Categoria criada com sucesso

{
  "_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 o ID da categoria pai e tente novamente.

Caso a requisição esteja correta, o código 201 Created 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.