Criação de Pedido
Criando Pedidos
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 seu Bearer Token também será necessário.
Criar Pedidos
POST {Url}/segments/{segmentId}/orders
Path Parameters
segmentId
string
ID de Segmento
companies
string
ID das empresas que criarão o pedido
Request Body
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
{
"approved": true,
"error": "string",
"orderId": "string",
"order": {
"_id": "string",
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-01T00:00:00Z",
"code": "string",
"segment": "string",
"origin": "pos-facil",
"observation": "string",
"shippingScheduledTo": {},
"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"
}
}
},
"customer": {
"_id": "string",
"address": {
"city": "string",
"cityIbge": "string",
"neighborhood": "string",
"number": "string",
"postalCode": "string",
"street": "string",
"complement": "string"
},
"document": "string",
"email": "string",
"name": "string",
"phoneNumbers": "string",
"type": "legal"
},
"device": {
"_id": "string",
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-01T00:00:00Z",
"installationId": "string",
"manufacturer": "string",
"deviceModel": "string",
"serial": "string",
"acquirer": "string",
"os": "string",
"systemVersion": "string",
"appVersion": "string",
"status": "active",
"lastSigninAt": {},
"lastSigninBy": "string",
"createdBy": "string"
},
"cashier": {
"_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"
}
}
},
"origin": "app",
"device": {
"_id": "string",
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-01T00:00:00Z",
"installationId": "string",
"manufacturer": "string",
"deviceModel": "string",
"serial": "string",
"acquirer": "string",
"os": "string",
"systemVersion": "string",
"appVersion": "string",
"status": "active",
"lastSigninAt": {},
"lastSigninBy": "string",
"createdBy": "string"
},
"event": {
"_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
},
"user": {
"_id": "string",
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-01T00:00:00Z",
"name": "string",
"avatarUrl": "string",
"phoneNumber": "string",
"document": "string",
"email": "string",
"status": "active",
"access": [
{
"segment": "string",
"companies": [
"string"
],
"group": "string"
}
],
"screensJourneyConfirmations": [
"string"
],
"hasConfirmedPageJourneySecondStep": true
},
"status": "open",
"blockedAt": {},
"closedAt": {},
"transactions": [
{
"_id": "string",
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-01T00:00:00Z",
"segment": "string",
"company": "string",
"device": "string",
"cardFlag": "string",
"cashier": "string",
"order": "string",
"transactionType": "payment",
"paymentType": "money",
"externalPaymentType": "string",
"cardType": "credit",
"amount": 0,
"acquirerTransactionId": "string",
"canceled": true,
"observation": "string",
"status": "string",
"externalId": "string"
}
],
"orders": [
[
null
]
],
"orderAmountMax": 0,
"orderAmountAvg": 0,
"moneyPaymentsSum": 0,
"moneyChangeSum": 0,
"cardPaymentsSum": 0,
"boletoPaymentsSum": 0,
"depositTransactionsSum": 0,
"withdrawTransactionsSum": 0,
"moneyReceivedAmount": 0,
"cardReceivedAmount": 0
},
"status": "open",
"exported": true,
"exportedAt": {},
"subtotal": 0,
"discount": 0,
"amount": 0,
"shippingAmount": 0,
"paidAmount": 0,
"changeAmount": 0,
"items": [
{
"_id": "string",
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-01T00:00:00Z",
"segment": "string",
"company": "string",
"category": {
"_id": "string",
"name": "string"
},
"product": {
"_id": "string",
"name": "string",
"picture": "string",
"additionals": [
{
"price": 0,
"quantity": 0,
"externalId": "string",
"name": "string",
"additionalId": "string"
}
]
},
"unitAmount": 0,
"discount": 0,
"fullAmount": 0,
"quantity": 0,
"observation": "string",
"device": "string",
"cashier": "string",
"order": "string",
"kdsStatus": "waiting",
"kdsTimes": {},
"canceled": true,
"externalId": "string"
}
],
"itemsCount": 0,
"transactions": [
{
"_id": "string",
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-01T00:00:00Z",
"segment": "string",
"company": "string",
"device": "string",
"cardFlag": "string",
"cashier": "string",
"order": "string",
"transactionType": "payment",
"paymentType": "money",
"externalPaymentType": "string",
"cardType": "credit",
"amount": 0,
"acquirerTransactionId": "string",
"canceled": true,
"observation": "string",
"status": "string",
"externalId": "string"
}
],
"table": {
"_id": "string",
"createdAt": "2020-01-01T00:00:00Z",
"updatedAt": "2020-01-01T00:00:00Z",
"name": "string",
"status": "available"
},
"tableTicket": {
"_id": "string",
"name": "string"
},
"deliveryType": "withdraw",
"paymentType": "card"
}
}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.
Last updated
Was this helpful?