Para criar o seu pedido, informe os dados necessários, via POST na rota Url/segments/{segmentId}/orders
O SegmentID deverá ser informado, saiba mais em Login via API. O uso de seuBearer Tokentambém será necessário.
Criar Pedidos
POST{Url}/segments/{segmentId}/orders
Path Parameters
Name
Type
Description
segmentId
string
ID de Segmento
companies
string
ID das empresas que criarão o pedido
Request Body
Name
Type
Description
segment*
string
ID do segmento
company*
string
ID do negócio
amount*
string
Total
subtotal*
string
Soma do total dos itens
origin*
string
Origem (POS Fácil: pos-facil |
Menu Fácil: menu-facil | POS Multi: pos-multi | Aplicativo: app )
items*
string
Lista de produtos
[
segment: ID do Segmento*
company: ID da empresa*
product: {
id: ID do produto*
name: Nome do produto*
picture: URL da imagem do produto
additionals: {
price: Preço do complemento*
quantity: Quantidade *
name: Nome*
additionalId: ID do complemento*
externalId: Código do sistema
}
}
unitAmount: Preço da Unidade
fullAmount: Preço total (unidade * quantidade)
quantity: Quantidade*
category: {
id: ID da categoria do produto*
name: Nome da categoria*
}
discount: Valor do desconto
observation: Observação
canceled: Cancelado
externalId: ID externo
]
device
string
ID do terminal
cashier
string
ID do caixa
orderManualApproval
boolean
Aprovação manual de pedido
status
string
Estado do pedido:
(Aberto: open | Em Pagamento: checkout | Aguardando Aprovação: awaiting_approval | Problema de Envio: shipping_problem | Fechado: closed | Aprovado:approved | Cancelado: canceled | Rejeitado: rejected | Enviado: shipped | Entregado: delivered | Faturado: invoiced | Pronto:ready)
shippingAmount
string
Preço do frete
changeAmount
string
Valor do troco
customer
string
Dados do cliente
address{
city: Cidade*
cityIbge: Número do IBGE*
neighborhood: Bairro*
number: Número*
postalCode: CEP*
street: Logradouro*
complement: Complemento
}
name: Nome do cliente*
type: Tipo de cliente (Pessoa Jurídica: legal |
Pessoa Física: private)*
document: CPF/CNPJ do cliente
email: E-mail do cliente
phoneNumbers: Números de telefone
deliveryType
string
Tipo de Entrega
(Retirada: withdraw | Delivery: delivery | Marketplace: marketplace )
observation
string
Observação
pickUpOrder
boolean
Se o cliente irá retirar o pedido
(Sim: true | Não: false)
table
string
ID da mesa
tableTicket
string
ID da comanda
card
string
Dados do Cartão
paymentType
string
Tipo de Pagamento
(Cartão de Crédito: card | Cartão de Débito: debit_card | Boleto: boleto | Dinheiro: money | PIX: pix | Outros: other )
shippingMethod*
string
Forma de envio
shippingTrackCode*
string
Código de rastreio
shippingScheduledTo
object
Entrega agendado para
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.
