Histórico da Página

...

Esta documentação tem como finalidade demonstrar o formato JSON para envio de requisições de pedidos com vários itens, como valor fracionado, adicionais e desconto na API Order MesaCartão Consumo, utilizando o endpoint newOrder.

...

Bloco de código

title	JSON da requisição do vários itens no pedido
linenumbers	true

{
	"integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812",
	"data": {
		"id": "29261444-5ff8-40b2-bce1-42848247d4a2",
		"type": "TABLECARD",
		"displayId": "8",
		"createdAt": "2024-06-24T17:35:00",
		"orderTiming": "2024-06-24T17:40:24",
		"preparationStartDateTime": "2024-06-24T18:00:00",
		"merchant": {
			"id": "c312d2ff-1a8f-40ad-8eed-9ae9a908df6e",
			"name": "BOTECO DO ALBINO"
		},
		"items": [
			{
				"id": "2",
				"index": "2",
				"name": "A FRANCESA",
				"externalCode": "1",
				"unit": "UN",
				"quantity": 0.5,
				"specialInstructions": "Teste",
				"unitPrice": {
					"value": 69.90,
					"currency": "R$"
				},
				"optionsPrice": {
					"value": 1.00,
					"currency": "R$"
				},
				"totalPrice": {
					"value": 34.95,
					"currency": "R$"
				},
				"options": [
					{
						"index": "3",
						"id": "3",
						"name": "COMPOSICAO A",
						"externalCode": "201",
						"unit": "UN",
						"quantity": 1,
						"unitPrice": {
							"value": 1.00,
							"currency": "R$"
						},
						"originalPrice": {
							"value": 1.00,
							"currency": "RS"
						},
						"totalPrice": {
							"value": 1.0,
							"currency": "R$"
						},
						"productionPoint": "Adicional Composicao A"
					}
				]
			},
			{
				"id": "4",
				"index": "4",
				"name": "AERADO",
				"externalCode": "2",
				"unit": "UN",
				"quantity": 1,
				"specialInstructions": "Teste",
				"unitPrice": {
					"value": 32.99,
					"currency": "R$"
				},
				"optionsPrice": {
					"value": 37.99,
					"currency": "R$"
				},
				"totalPrice": {
					"value": 32.99,
					"currency": "R$"
				},
				"options": [
					{
						"index": "5",
						"id": "5",
						"name": "AVELA",
						"externalCode": "4",
						"unit": "UN",
						"quantity": 1,
						"unitPrice": {
							"value": 37.99,
							"currency": "R$"
						},
						"originalPrice": {
							"value": 37.99,
							"currency": "RS"
						},
						"totalPrice": {
							"value": 37.99,
							"currency": "R$"
						},
						"productionPoint": "Adicional Avela"
					}
				]
			}
		],
		"otherFees": [],
		"discounts": [
			{
				"value": 1,
				"target": "ITEM",
				"targetId": "02",
				"sponsorshipValues": [
					{
						"name": "MARKETPLACE",
						"value": 10.00
					}
				]
			}
		],
		"total": {
			"items": 67.94,
			"otherFees": 38.99,
			"discount": 10.00,
			"orderAmount": 96.93,
			"additionalFees": 0,
			"deliveryFee": 0
		},
		"payments": {null,
			"prepaiddelivery": 0.0null,
			"pendingextraInfo": 0.0"Teste",
			"methodsschedule": [null,
				{"indoor": null,
					"valuetakeout": 96,93null,
					"currencytable": "BRL"null,
					"typecard": "PREPAID",
		{
			"methodwaiterCode": "credit"9999,
					"methodInfocardNumber": "Visa"29,
					"changeFor": 0.0
				}
			]
		},
		"delivery": null,
		"extraInfo": "Teste",
		"schedule": null,
		"indoor": null,
		"takeout": null,
		"table": {
			"waiterCode": "96.93",
			"tableNumber": "8",
			"chairNumber": "1"deliveryTableNumber": 29
		}, 
		"card": null
	}
}

Nota

title	Nota: HTTP Status Code = 200 OK

Sua solicitação foi aceita mas ainda não processada, aguarde alguns instantes e procure o status.

...

Bloco de código

title	JSON Inválido
linenumbers	true

{
	"integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812",
	"data": {
		"id": "29261444-5ff8-40b2-bce1-42848247d4a2",
		"type": "TABLECARD",
		"displayId": 8,
		"createdAt": "2024-06-24T17:35:00",
		"orderTiming": "2024-06-24T17:40:24",
		"preparationStartDateTime": "2024-06-24T18:00:00",
		"merchant": {
			"id": "c312d2ff-1a8f-40ad-8eed-9ae9a908df6e",
			"name": "BOTECO DO ALBINO"
		},
		"items": [
			{
				"id": "2",
				"index": "2",
				"name": "A FRANCESA",
				"externalCode": "1",
				"unit": "UN",
				"quantity": 0.5,
				"specialInstructions": "Teste",
				"unitPrice": {
					"value": 69.90,
					"currency": "R$"
				},
				"optionsPrice": {
					"value": 1.00,
					"currency": "R$"
				},
				"totalPrice": {
					"value": 34.95,
					"currency": "R$"
				},
				"options": [
					{
						"index": "3",
						"id": "3",
						"name": "COMPOSICAO A",
						"externalCode": "201",
						"unit": "UN",
						"quantity": 1,
						"unitPrice": {
							"value": 1.00,
							"currency": "R$"
						},
						"originalPrice": {
							"value": 1.00,
							"currency": "RS"
						},
						"totalPrice": {
							"value": 1.0,
							"currency": "R$"
						},
						"productionPoint": "Adicional Composicao A"
					}
				]
			},
			{
				"id": "4",
				"index": "4",
				"name": "AERADO",
				"externalCode": "2",
				"unit": "UN"},
				"quantity": 1,{
				"specialInstructionsid": "Teste4",
				"unitPriceindex": {"4",
					"valuename": 32.99"AERADO",
					"currencyexternalCode": "R$"
				}2",
				"optionsPriceunit": {"UN",
					"valuequantity": 37.991,
					"currencyspecialInstructions": "R$"
				}Teste",
				"totalPriceunitPrice": {
					"value": 32.99,
					"currency": "R$"
				},
				"optionsoptionsPrice": [
					{
						"indexvalue": "5"37.99,
						"idcurrency": "5R$",
				},
				"nametotalPrice": "AVELA",{
						"externalCodevalue": "4"32.99,
						"unitcurrency": "UNR$",
				},
				"quantityoptions": 1,[
						"unitPrice": {
							"valueindex": 37.99"5",
							"currencyid": "R$"
						}5",
						"originalPricename": {"AVELA",
							"valueexternalCode": 37.99"4",
							"currencyunit": "RSUN",
						}"quantity": 1,
						"totalPriceunitPrice": {
							"value": 37.99,
							"currency": "R$"
						},
						"productionPointoriginalPrice": "Adicional Avela"
					}
				]
{
					}
		],
		"otherFees": [],
		"discounts": [
			{
				"value": 137.99,
				"target": "ITEM",
				"targetIdcurrency": "02"RS"
						},
						"sponsorshipValuestotalPrice": [{
					{		"value": 37.99,
							"namecurrency": "MARKETPLACE"R$"
						},
						"valueproductionPoint": 10.00"Adicional Avela"
					}
				]
			}
		],
		"totalotherFees": {[],
			"itemsdiscounts": 67.94,[
			"otherFees": 38.99,{
				"discountvalue": 10.001,
				"orderAmounttarget": 96.93"ITEM",
				"additionalFeestargetId": 0"02",
				"deliveryFeesponsorshipValues": 0[
			},
		"payments": {
						"prepaidname": 0.0"MARKETPLACE",
						"pendingvalue": 010.0,00
			"methods": [		}
				{]
			}
		],
		"valuetotal": 96,93,{
			"items": 67.94,
			"currencyotherFees": "BRL"38.99,
					"typediscount": "PREPAID"10.00,
					"methodorderAmount": "credit"96.93,
					"methodInfoadditionalFees": "Visa"0,
					"changeFordeliveryFee": 0.0
				},
			]
		}"payments": null,
		"delivery": null,
		"extraInfo": "Teste",
		"schedule": null,
		"indoor": null,
		"takeout": null,
		"table": null,
		"card": {
			"waiterCode": "96.93"9999,
			"tableNumbercardNumber": "8"29,
			"chairNumberdeliveryTableNumber": "1"29
		}, 
		"card": null
	}
}

Bloco de código

title	JSON Resposta
linenumbers	true

{
	"errors": [
		{
			"key": "displayId",
			"message": "body.data.displayId must be a string"
		}
	]
}

...

Bloco de código

title	JSON Inválido
linenumbers	true

{
	"integrationHubServiceId": "3fea8768-bbd9-454b-9e7b-40841e9a6812",
	"data": {
		"id": "29261444-5ff8-40b2-bce1-42848247d4a2",
		"type": "TABLECARD",
		"displayId": "8",
		"createdAt": "2024-06-24T17:35:00",
		"orderTiming": "2024-06-24T17:40:24",
		"preparationStartDateTime": "2024-06-24T18:00:00",,
		"items": [
			{
				"id": "2",
				"index": "2",
				"name": "A FRANCESA",
				"externalCode": "1",
				"unit": "UN",
				"quantity": 0.5,
				"specialInstructions": "Teste",
				"unitPrice": {
					"value": 69.90,
					"currency": "R$"
				},
				"optionsPrice": {
					"value": 1.00,
					"currency": "R$"
				},
				"totalPrice": {
					"value": 34.95,
					"currency": "R$"
				},
				"options": [
					{
						"index": "3",
						"id": "3",
						"name": "COMPOSICAO A",
						"externalCode": "201",
						"unit": "UN",
						"quantity": 1,
						"unitPrice": {
							"value": 1.00,
							"currency": "R$"
						},
						"originalPrice": {
							"value": 1.00,
							"currency": "RS"
						},
						"totalPrice": {
							"value": 1.0,
							"currency": "R$"
						},
						"productionPoint": "Adicional Composicao A"
					}
				]
			},
			{
				"id": "4",
				"index": "4",
				"name": "AERADO",
				"externalCode": "2",
				"unit": "UN",
				"quantity": 1,
				"specialInstructions": "Teste",
				"unitPrice": {
					"value": 32.99,
					"currency": "R$"
				},
				"optionsPrice": {
					"value": 37.99,
					"currency": "R$"
				},
				"totalPriceunitPrice": {
					"value": 32.99,
					"currency": "R$"
				},
				"optionsoptionsPrice": [
					{
						"indexvalue": "5"37.99,
						"idcurrency": "5R$",
				},
				"nametotalPrice": "AVELA",{
						"externalCodevalue": "4"32.99,
						"unitcurrency": "UNR$",
				},
				"quantityoptions": 1,[
						"unitPrice": {
							"valueindex": 37.99"5",
							"currencyid": "R$"
						}5",
						"originalPricename": {"AVELA",
							"valueexternalCode": 37.99"4",
							"currencyunit": "RSUN",
						}"quantity": 1,
						"totalPriceunitPrice": {
							"value": 37.99,
							"currency": "R$"
						},
						"productionPointoriginalPrice": "Adicional Avela"
					}
				]
			}
		],
		"otherFees": [],
		"discounts": [{
			{
				"value": 137.99,
							"targetcurrency": "ITEMRS",
					"targetId": "02"	},
						"sponsorshipValuestotalPrice": [{
							{"value": 37.99,
							"namecurrency": "MARKETPLACE"R$"
						},
						"valueproductionPoint": 10.00"Adicional Avela"
					}
				]
			}
		],
		"totalotherFees": {[],
			"itemsdiscounts": 67.94,[
			"otherFees": 38.99,
{
				"discountvalue": 10.001,
				"orderAmounttarget": 96.93"ITEM",
				"additionalFeestargetId": 0"02",
				"deliveryFeesponsorshipValues": 0[
		},
			"payments": {
						"prepaidname": 0.0"MARKETPLACE",
						"pendingvalue": 0.0,
	10.00
					}
				]
			}
		],
		"methodstotal": [
				{
					"valueitems": 96,9367.94,
					"currencyotherFees": "BRL"38.99,
					"typediscount": "PREPAID"10.00,
					"methodorderAmount": "credit"96.93,
					"methodInfoadditionalFees": "Visa"0,
					"changeFordeliveryFee": 0.0
				},
			]
		}"payments": null,
		"delivery": null,
		"extraInfo": "Teste",
		"schedule": null,
		"indoor": null,
		"takeout": null,
		"table": {null,
			"waiterCodecard": "96.93",{
			"tableNumberwaiterCode": "8"9999,
			"chairNumbercardNumber": "1"29,
		},
		"carddeliveryTableNumber": null29
		} 
	}
}

Bloco de código

title	JSON Resposta
linenumbers	true

{
	"errors": [
		{
			"key": "merchant",
			"message": "body.data.merchant is required"
		}
	]
}

...

Bloco de código

title	Integration Hub Code Inválido
linenumbers	true

{
	"integrationHubServiceId": "f1b874af-96ab-4535-aac3-25118fe586cc",
	"data": {
		"id": "29261444-5ff8-40b2-bce1-42848247d4a2",
		"type": "TABLECARD",
		"displayId": "8",
		"createdAt": "2024-06-24T17:35:00",
		"orderTiming": "2024-06-24T17:40:24",
		"preparationStartDateTime": "2024-06-24T18:00:00",
		"merchant": {
			"id": "c312d2ff-1a8f-40ad-8eed-9ae9a908df6e",
			"name": "BOTECO DO ALBINO"
		},
		"items": [
			{
				"id": "2",
				"index": "2",
				"name": "A FRANCESA",
				"externalCode": "1",
				"unit": "UN",
				"quantity": 0.5,
				"specialInstructions": "Teste",
				"unitPrice": {
					"value": 69.90,
					"currency": "R$"
				},
				"optionsPrice": {
					"value": 1.00,
					"currency": "R$"
				},
				"totalPrice": {
					"value": 34.95,
					"currency": "R$"
				},
				"options": [
					{
						"index": "3",
						"id": "3",
						"name": "COMPOSICAO A",
						"externalCode": "201",
						"unit": "UN",
						"quantity": 1,
						"unitPrice": {
							"value": 1.00,
							"currency": "R$"
						},
						"originalPrice": {
							"value": 1.00,
							"currency": "RS"
						},
						"totalPrice": {
							"value": 1.0,
							"currency": "R$"
						},
						"productionPoint": "Adicional Composicao A"
					}
				]
			},
			{
				"id": "4",
				"index": "4",
				"name": "AERADO",
				"externalCode": "2",]
				"unit": "UN"},
				"quantity": 1,{
				"specialInstructionsid": "Teste4",
				"unitPriceindex": {"4",
					"valuename": 32.99"AERADO",
					"currencyexternalCode": "R$"
				}2",
				"optionsPriceunit": {"UN",
					"valuequantity": 37.991,
					"currencyspecialInstructions": "R$"
				}Teste",
				"totalPriceunitPrice": {
					"value": 32.99,
					"currency": "R$"
				},
				"optionsoptionsPrice": [
					{
						"indexvalue": "5"37.99,
						"idcurrency": "5R$",
				},
				"nametotalPrice": "AVELA",{
						"externalCodevalue": "4"32.99,
						"unitcurrency": "UNR$",
				},
				"quantityoptions": 1,[
						"unitPrice": {
							"valueindex": 37.99"5",
							"currencyid": "R$"
						}5",
						"originalPricename": {"AVELA",
							"valueexternalCode": 37.99"4",
							"currencyunit": "RSUN",
						}"quantity": 1,
						"totalPriceunitPrice": {
							"value": 37.99,
							"currency": "R$"
						},
						"productionPointoriginalPrice": "Adicional Avela"
					}{
				]
			}
		],
		"otherFees": [],
		"discounts": [
			{
				"value": 137.99,
				"target": "ITEM",
				"targetIdcurrency": "02"RS"
						},
						"sponsorshipValuestotalPrice": [{
					{		"value": 37.99,
							"namecurrency": "MARKETPLACE"R$"
						},
						"valueproductionPoint": 10.00"Adicional Avela"
					}
				]
			}
		],
		"totalotherFees": {[],
			"itemsdiscounts": 67.94,[
			"otherFees": 38.99,
{
				"discountvalue": 10.001,
				"orderAmounttarget": 96.93"ITEM",
				"additionalFeestargetId": 0"02",
				"deliveryFeesponsorshipValues": 0[
		},
			"payments": {
						"prepaidname": 0.0"MARKETPLACE",
						"pendingvalue": 010.0,00
					"methods": [}
				{]
			}
		],
		"valuetotal": 96,93,{
			"items": 67.94,
			"currencyotherFees": "BRL"38.99,
					"typediscount": "PREPAID"10.00,
					"methodorderAmount": "credit"96.93,
					"methodInfoadditionalFees": "Visa"0,
					"changeFordeliveryFee": 0.0
				},
			]
		}"payments": null,
		"delivery": null,
		"extraInfo": "Teste",
		"schedule": null,
		"indoor": null,
		"takeout": null,
		"table": null,
		"card": {
			"waiterCode": "96.93"9999,
			"tableNumbercardNumber": "8"29,
			"chairNumberdeliveryTableNumber": "1"29
		},
		"card": null 
	}
}

Bloco de código

title	JSON Response
linenumbers	true

{
	"errors": [
		{
			"key": "integrationHubServiceId",
			"message": "Provider Merchant for integrationHubServiceId \"f1b874af-96ab-4535-aac3-25118fe586cc\" not found or disabled"
		}
	]
}

...

Dica

title	Saiba mais!

Para obter detalhes técnicos sobre o envio de requisições ao endpoint newOrder, incluindo a estrutura do corpo da requisição para itens com um de valor integral e outro com valor fracionando, adicionais e desconto acesse a documentação clicando aqui.

...

05. LINKS
Âncora
links
links

New Order Mesa - Itens Fracionando
New Order Mesa - Vários Itens

Templatedocumentos

Páginas filhas

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

05. LINKS
Âncora
links
links

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 1

Nova versão 2

Chave

05. LINKS Âncoralinkslinks

05. LINKS
Âncora
links
links