Introdução#
https://api.storycrm.app/v1/company
Endpoints#
Identificador da Company#
O {company_id} representa o identificador único da company, ele deve ser usado nas requisições como:GET https://api.storycrm.app/v1/company/{company_id}
Create Company#
Uma company pode ser criada através do seguinte caminho:https://api.storycrm.app/v1/entreprises/company/
Parâmetros para criação de uma Company#
| Parâmetro | Descricão | Tipo | Obrigatório |
|---|
| reference | É o nome da Company, nome da loja ou filial que está vinculada a uma Enterprise | string | Sim |
| identify | Número CNPJ ou Tax Id identificador da filial ou loja | string | Sim |
| address | Endereço da Loja ou filia, caso seja online colocar o da Matriz | string | Sim |
Show Company#
Para obter informações de uma Company deve-se fazer uma requisição GET no seguinte caminho:https://api.storycrm.app/v1/entreprises/company/{company_id}
Não é necessário enviar nada no body da requisição.
Update Company#
Para se atualizar uma Company deve-se fazer uma requisição PUT no seguinte caminho:https://api.storycrm.app/v1/entreprises/company/{company_id}
Parâmetros para atualização de uma Company#
| Parâmetro | Descricão | Tipo | Obrigatório |
|---|
| reference | É o nome da Company, nome da loja ou filial que está vinculada a uma Enterprise | string | Sim |
| identify | Número CNPJ ou Tax Id identificador da filial ou loja | string | Sim |
| address | Endereço da Loja ou filia, caso seja online colocar o da Matriz | string | Sim |
Delete Company#
Para deletar uma Company deve-se fazer uma requisição DELETE no seguinte caminho:https://api.storycrm.app/v1/entreprises/company/{company_id}
Não é necessário enviar nada no body da requisição.
Parâmetros para atualização de uma Company#
| Parâmetro | Descricão | Tipo | Obrigatório |
|---|
| page | É o número da página da lista de compnies que se quer visualizar | number | Sim |
