Buscar Negócio por ID

Buscando Negócios por ID

Caso já saiba o ID do negócio e deseje consultar seus dados, informe o ID via GET na rota Url/segments/{segmentId}/companies/{id}.

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

Consultar Negócio

GET {Url}/segments/{segmentId}/companies/{id}

Path Parameters

Name	Type	Description
segmentId	string	ID de Segmento
id	string	ID do Negócio

200 OK

{
  "_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"
    }
  }
}

401 Verifique o Bearer Token utilizado e tente novamente.

[]

404 Negócio não encontrado. Verifique também a rota e método utilizado.

[]

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

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