Criação de Eventos

Criando Eventos

Para criar o seu evento, informe os dados necessários, via POST na rota Url/segments/{segmentId}/events

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

Criar Categoria

POST {Url}/segments/{segmentId}/events

Path Parameters

Name	Type	Description
segmentId*	string	ID de Segmento
companies	string	ID das empresas que criarão o evento

Request Body

Name	Type	Description
company*	string	ID do negócio
name*	string	Nome do Evento
startDate*	object	Data de Início
endDate*	object	Data de Término
prepaid*	boolean	Se o evento aceita pagamento pré-pago (Sim: true | Não: false )
devices*	array	Terminais que serão usados no evento [ device: ID do Terminal* stockLocal: ID do Local de Estoque* ]
products*	array	Produtos que serão vendidos [ product: ID do produto* newPrice: Novo preço do produto para o evento* inventories: [ inventory: ID do local de estoque* stock: Quantidade em estoque* ] ]

201 Evento criado com sucesso

{
  "_id": "string",
  "createdAt": "2020-01-01T00:00:00Z",
  "updatedAt": "2020-01-01T00:00:00Z",
  "segment": "string",
  "company": {
    "_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"
      }
    }
  },
  "name": "string",
  "startDate": {},
  "endDate": {},
  "prepaid": true
}

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 201 Created será retornado. Prossiga para as próximas sessões para entender mais sobre as funções disponíveis.

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