Overview

Introdução

https://api.storycrm.app/v1/orders

Orders são as as vendas ou pedidos vinculadas a uma Enterprise na API. Uma Enterprise pode conter diversas Orders que aconteceram em suas Companies. Toda Order está vinculada a um Customer e quando essa Order se enquandra em um estratégia, um giftback, ou pontuação pode ser gerada.

Endpoints

Identificador da Order

O {order_id} representa o identificador único de uma Order, ele deve ser usado nas requisições como:

GET https://api.storycrm.app/v1/orders/{order_id}

Create Order

Uma Order pode ser criada através do seguinte endpoint:

https://api.storycrm.app/v1/entreprises/orders/

É necessário criar o Customer antes da Order dentro da API da StoryCRM para se obter o customer_id

Parâmetros para criação de uma Order

Parâmetro	Descricão	Tipo	Obrigatório
price	É o valor total da Order. Soma de todos itens presentes nela.	string	Sim
company_id	É o id da Company em que a Order está sendo criada.	string	Sim
status	Staus em que se encontra a order no momento do envio. Podendo ser: CANCELED, DRAFT, COMPLETED ou INCOMPLETE	string	Sim
external_code	Código de referência interno da Order dentro do sistama/ERP	string	Sim
campaign_action	Determina se a order deve gerar giftback e pontuação ou não. Podendo ser: true ou false.	string	Sim
opened_at	Data e horário em que a compra/venda foi realizada.	string	Sim
closed_at	Data e horário em que a venda foi finalizada.	string	Sim
customer_id	Identificador do cliente vinculdo a compra	string	Sim
order_products	Relação de produtos vinculados na compra	object	Não

Campaign_action

Uma Order só gerará giftback ou pontos caso o parâmetro campaign_action seja enviado como true.

Price e Order_Products

Valor total de uma Order pode ser enviado no parâmetro price ou pode ser enviado através da lista de produtos da Order com o parâmetro order_products, sendo necessário criar os produtos previaMente no endpoint /products. Caso enviado via order_products a valor final da Order será a soma dos valores dos produtos enviados.

Show Order

Para obter informações de uma Order deve-se fazer uma requisição GET no seguinte caminho:

https://api.storycrm.app/v1/entreprises/orders/{order_id}

Não é necessário enviar nada no body da requisição.

Parâmetros para consulta dentro de uma Order

Parâmetro	Descricão	Tipo
order_status_id	Para buscar as Orders por Status. Podendo ser: CANCELED, DRAFT, COMPLETED ou INCOMPLETE	string
companies[]	Ids de companies nas quais se quer consultar Ordes.	array

Update Order

Para se atualizar uma Order deve-se fazer uma requisição PUT no seguinte caminho:

https://api.storycrm.app/v1/entreprises/orders/{order_id}

Parâmetros para atualização de uma Order

Parâmetro	Descricão	Tipo
price	É o valor total da Order. Soma de todos itens presentes nela	string
status	É o status na qual a Order se enconstra. Podendo ser: CANCELED, DRAFT, COMPLETED ou INCOMPLETE	string
order_products	Endereço da Loja ou filia, caso seja online colocar o da Matriz	string

Delete Order

Para deletar uma Order deve-se fazer uma requisição DELETE no seguinte caminho:

https://api.storycrm.app/v1/entreprises/order/{order_id}

Não é necessário enviar nada no body da requisição.

Index Order

Para se listar as Orders criadas dentro de uma enterprise deve-se fazer uma requisição tipo GET no seguinte caminho:

https://api.storycrm.app/v1/entreprises/orders

Não é necessário enviar nada no body da requisição.

Overview

Introdução#

Endpoints#

Identificador da Order#

Create Order#

Parâmetros para criação de uma Order#

Show Order#

Parâmetros para consulta dentro de uma Order#

Update Order#

Parâmetros para atualização de uma Order#

Delete Order#

Index Order#

Search Internal#

Introdução

Endpoints

Identificador da Order

Create Order

Parâmetros para criação de uma Order

Show Order

Parâmetros para consulta dentro de uma Order

Update Order

Parâmetros para atualização de uma Order

Delete Order

Index Order

Search Internal