Retrieve order details
Copy
curl --request GET \
--url https://api.artisn.desarrollo-redbrand.com/api/order/{orderId} \
--header 'Authorization: Bearer <token>'Copy
{
"orderId": "0000012194-081101",
"accountId": "10",
"account": "Artisn App",
"source": "App|Kiosco",
"platform": "Android",
"createdAt": "2022-11-02 08:14:00",
"channelId": "1",
"channelName": "Domicilio App",
"selectedShippingMethod": "delivery|pickup",
"accumulatePoints": true,
"redeemPoints": true,
"stock": false,
"discount": true,
"orderComment": "Comentario General del pedido",
"client": {
"uid": "Bwsyaszx36b5UXXdqFDFBi6ki7j1",
"name": "Sebastian",
"lastName": "Rodriguez",
"phone": "0972241639",
"email": "[email protected]",
"govIdType": "DNI",
"govIdTypeExternal": null,
"govIdNumber": "1751930486",
"externalId": null,
"id": "402399",
"billingInformation": {
"businessName": "Sebastian Rodriguez",
"govIdType": "CI",
"govIdTypeExternal": null,
"govIdNumber": "1751930486",
"phone": "0969150917",
"email": "[email protected]",
"address": "La Venecia 1 S57 415 y E4C",
"externalId": "1255",
"id": "205474"
},
"additionalInfo": {
"birthdate": "1984-09-18",
"gender": "masculino"
}
},
"store": {
"id": 10,
"name": "Gran Santa Fe",
"code": "T001",
"vendorId": 8,
"vendorName": "Blue Co",
"latitude": "-2.32423423",
"longitude": "-80.21312312"
},
"order": {
"products": [
{
"productId": "991117",
"product": "Hamburguesa + papas",
"quantity": 1,
"productComment": "incluye upsale y desct. pago puntos",
"rewardId": "UUID_DESCPUNTOS",
"price": {
"unitPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "7.7826",
"discountPercentage": "100.0000",
"discountsValue": "7.7826",
"subtotalIncludeDiscounts": "0.0000",
"taxesPercentage": "15.0000",
"taxValue": "0.0000",
"total": "0.0000",
"suggestedPrice": "8.9900"
},
"totalPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "7.7826",
"discountPercentage": "100.0000",
"discountsValue": "7.7826",
"subtotalIncludeDiscounts": "0.0000",
"taxesPercentage": "15.0000",
"taxValue": "0.0000",
"total": "0.0000",
"suggestedPrice": "8.9900"
}
},
"modifierGroups": [
{
"id": "1121",
"description": "Escoja su acompañante",
"selectedModifiers": [
{
"answerId": "1055",
"productId": "1025",
"product": "Papas",
"rewardId": "UUID_DESCPUNTOS",
"quantity": 1,
"removedQuantity": null,
"price": {
"unitPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "1.7304",
"discountPercentage": "100",
"discountsValue": "1.7304",
"subtotalIncludeDiscounts": "0.0000",
"taxesPercentage": "15.0000",
"taxValue": "0.0000",
"total": "0.0000",
"suggestedPrice": "2.2500"
},
"totalPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "1.7304",
"discountPercentage": "100",
"discountsValue": "1.7304",
"subtotalIncludeDiscounts": "0.0000",
"taxesPercentage": "15.0000",
"taxValue": "0.0000",
"total": "0.0000",
"suggestedPrice": "2.2500"
}
}
}
]
},
{
"id": "1133",
"description": "Personalice su hamburguesa. Agregue o quite ingredientes",
"selectedModifiers": [
{
"answerId": "1088",
"productId": "1025",
"rewardId": null,
"product": "Sin Tomate",
"quantity": null,
"removedQuantity": 1,
"price": {
"unitPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "0.0000",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "0.0000",
"taxesPercentage": "0.0000",
"taxValue": "0.0000",
"total": "0.0000",
"suggestedPrice": "0.0000"
},
"totalPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "0.0000",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "0.0000",
"taxesPercentage": "0.0000",
"taxValue": "0.0000",
"total": "0.0000",
"suggestedPrice": "0.0000"
}
}
}
]
}
],
"additionalInfo": {
"strategy": "Upsale",
"relatedProductId": "99105",
"redeemed": true,
"sort": 1,
"referenceUnitPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "6.0783",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "6.0783",
"taxesPercentage": "15.0000",
"taxValue": "0.9177",
"total": "6.9900",
"suggestedPrice": "11.2000"
},
"referenceTotalPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "6.0783",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "6.0783",
"taxesPercentage": "15.0000",
"taxValue": "0.9177",
"total": "6.9900",
"suggestedPrice": "11.2000"
},
"unitMeasurement": "unidad|caja"
}
},
{
"productId": "991117",
"product": "Sanduche y bebida. Extra nachos + salsa bbq",
"quantity": 2,
"productComment": "Producto con modificador 3er nivel",
"rewardId": null,
"price": {
"unitPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "6.9478",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "6.9478",
"taxesPercentage": "15.0000",
"taxValue": "1.0422",
"total": "7.9900",
"suggestedPrice": "10.9900"
},
"totalPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "13.8956",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "13.8956",
"taxesPercentage": "15.0000",
"taxValue": "2.0843",
"total": "15.9799",
"suggestedPrice": "21.9800"
}
},
"modifierGroups": [
{
"id": "1120",
"description": "Escoja su bebida",
"selectedModifiers": [
{
"productId": "1025",
"answerId": "1065",
"product": "Pepsi",
"quantity": 2,
"removedQuantity": null,
"price": {
"unitPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "0.0000",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "0.0000",
"taxesPercentage": "0.0000",
"taxValue": "0.0000",
"total": "0.0000",
"suggestedPrice": "0.9900"
},
"totalPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "0.0000",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "0.0000",
"taxesPercentage": "0.0000",
"taxValue": "0.0000",
"total": "0.0000",
"suggestedPrice": "1.9800"
}
}
}
]
},
{
"id": "1125",
"description": "Agregue extra nachos, ensalada o postre",
"selectedModifiers": [
{
"productId": "1035",
"answerId": "1044",
"product": "Nachos",
"quantity": 2,
"removedQuantity": null,
"price": {
"unitPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "4.3391",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "4.3391",
"taxesPercentage": "15.0000",
"taxValue": "0.6509",
"total": "4.9900",
"suggestedPrice": "0.0000"
},
"totalPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "8.6782",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "8.6782",
"taxesPercentage": "15.0000",
"taxValue": "1.3017",
"total": "9.9799",
"suggestedPrice": "0.0000"
}
},
"modifierGroups": [
{
"id": "1127",
"description": "Seleccione el tipo de salsa",
"selectedModifiers": [
{
"productId": "1033",
"answerId": "1018",
"product": "Salsa BBQ",
"quantity": 1,
"removedQuantity": null,
"price": {
"unitPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "2.2174",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "2.2174",
"taxesPercentage": "15.0000",
"taxValue": "0.3326",
"total": "2.5500",
"suggestedPrice": "4.7500"
},
"totalPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "2.2174",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "2.2174",
"taxesPercentage": "15.0000",
"taxValue": "0.3326",
"total": "2.5500",
"suggestedPrice": "4.7500"
}
}
}
]
}
]
}
]
}
],
"additionalInfo": {}
},
{
"productId": "44368",
"product": "Wings + papas",
"quantity": 1,
"productComment": "incluye reward de producto.",
"rewardId": "UUID_CUPON_PRODUCT",
"price": {
"unitPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "8.6870",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "8.6870",
"taxesPercentage": "15.0000",
"taxValue": "1.3031",
"total": "9.9901",
"suggestedPrice": "12.9900"
},
"totalPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "8.6870",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "8.6870",
"taxesPercentage": "15.0000",
"taxValue": "1.3031",
"total": "9.9901",
"suggestedPrice": "12.9900"
}
},
"modifierGroups": [
{
"id": "1121",
"description": "Escoja su acompañante",
"selectedModifiers": [
{
"productId": "1025",
"product": "Papas",
"quantity": 1,
"removedQuantity": null,
"price": {
"unitPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "1.9565",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "1.9565",
"taxesPercentage": "15.0000",
"taxValue": "0.2935",
"total": "2.2500",
"suggestedPrice": "2.2500"
},
"totalPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "1.9565",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "1.9565",
"taxesPercentage": "15.0000",
"taxValue": "0.2935",
"total": "2.2500",
"suggestedPrice": "2.2500"
}
}
}
]
}
],
"additionalInfo": {}
}
],
"stock": [
{
"productId": "10030",
"stock": 30
}
]
},
"shippingMethod": {
"delivery": {
"deliveryDate": "2022-07-05 18:24:00",
"latitude": "-2.2244266000000",
"longitude": "-80.9044868000000",
"country": "Colombia",
"city": "Bogota",
"mainStreet": "Calle 100 # 15-34",
"number": "",
"secondaryStreet": "",
"reference": "Casa gris",
"propertyId": 1,
"observationsAddress": "No sirve el intercomunicador",
"numberContactAddress": "101019987435",
"zipCode": "170904",
"nickName": "casa",
"externalId": "2056",
"id": "3012312",
"driverArrivalDateInStore": "2024-02-21T12:47:27Z",
"additionalInfo": {
"deliveryConfirmationCode": "PZ051"
}
},
"pickup": {
"pickupDate": "2022-07-05 18:39:00",
"prepDate": "2022-07-05 18:24:00",
"prepTimeUnit": "minute",
"prepTime": 15,
"propertyId": 1,
"carryOutOptions": "PickUp-LLevar",
"contactMethods": [
{
"type": "pager",
"identifier": "PG123"
},
{
"type": "sms",
"countryCode": "+57",
"phoneNumber": "3001234567"
},
{
"type": "whatsapp",
"countryCode": "+57",
"phoneNumber": "3007654321"
}
]
}
},
"payments": {
"totals": [
{
"rewardId": "UUID_CUPON_DESC_TOTAL",
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "39.3478",
"discountPercentage": "20.0000",
"discountsValue": "7.8696",
"subtotalIncludeDiscounts": "31.4782",
"taxesPercentage": "15.0000",
"taxValue": "4.7217",
"total": "36.2000"
}
],
"shippingCost": [
{
"quantity": 1,
"productId": "111",
"rewardId": "UUID_CUPON_FREEDELIVERY",
"currencyCode": "USD",
"subtotalWithoutTaxes": "2.3913",
"discountPercentage": "100.0000",
"discountsValue": "2.3913",
"subtotalIncludeDiscounts": "0.0000",
"taxesPercentage": "15.0000",
"taxValue": "0.0000",
"total": "0.0000"
}
],
"extraCharges": [
{
"quantity": 1,
"productId": "125",
"description": "tip",
"currencyCode": "USD",
"subtotalWithoutTaxes": "0.8696",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "0.8696",
"taxesPercentage": "15.0000",
"taxValue": "0.1304",
"total": "1.0000"
},
{
"quantity": 1,
"productId": null,
"description": "packing cost",
"currencyCode": "USD",
"subtotalWithoutTaxes": "3.0435",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "3.0435",
"taxesPercentage": "15.0000",
"taxValue": "0.4565",
"total": "3.5000"
}
],
"discounts": [
{
"rewardId": "UUI_DESCPUNTOS",
"productId": "991117",
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "7.7826",
"discountPercentage": "100.0000",
"discountsValue": "7.7826",
"subtotalIncludeDiscounts": "0.0000"
},
{
"rewardId": "UUI_DESCPUNTOS",
"productId": "1025",
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "1.7304",
"discountPercentage": "100",
"discountsValue": "1.7304",
"subtotalIncludeDiscounts": "0.0000"
},
{
"rewardId": "UUID_CUPON_FREEDELIVERY",
"productId": "111",
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "2.3913",
"discountPercentage": "100.0000",
"discountsValue": "2.3913",
"subtotalIncludeDiscounts": "0.0000"
},
{
"rewardId": "UUID_CUPON_DESC_TOTAL",
"productId": "111",
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "2.3913",
"discountPercentage": "100.0000",
"discountsValue": "2.3913",
"subtotalIncludeDiscounts": "0.0000"
}
],
"taxes": [
{
"name": "IVA 15%",
"currencyCode": "USD",
"subtotalWithoutTaxes": "31.4782",
"percentage": "15.0000",
"total": "4.7217"
}
],
"paymentMethods": [
{
"processor": "Kushki",
"currencyCode": "USD",
"paymentMethodCode": "2",
"transactionType": "credit",
"transactionId": "049258058662543450",
"transactionStatus": "APPROVED",
"tid": "CA303015",
"mid": "2000026002",
"authorizationCode": "428364",
"voucher": "358642",
"referenceNumber": "704891",
"exactPayment": true,
"customerCashAmount": "0.0000",
"totalBill": "30.0000",
"acquirer": {
"code": "004",
"name": "BANCO GUAYAQUIL"
},
"card": {
"mask": "459424XXXXXXX456",
"bin": "459424",
"lastFourDigits": "1456",
"brand": "MAST",
"externalCardBrandId": "28FA9351-5F07-EB11-80F1-000D3A019254",
"holder": "Sebastian Rodriguez",
"cardCountry": "Ecuador"
},
"transactionDate": {
"date": "2022-11-02 08:15:30",
"timeZoneType": 3,
"timeZoneName": "America/Guayaquil",
"weekNumber": 1
},
"metadata": {
"aid": "Specific to Ecuador (application identifier)",
"responseCode": "Transaction response code, '00' for success",
"transactionDate": "Date of the transaction in format YYYYMMDD",
"transactionTime": "Time of the transaction in format HHMMSS",
"cardBrand": "Card brand (e.g., VISA, MASTERCARD, ELECTRON)",
"batch": "Batch to which the transaction belongs",
"rrn": "Recovery Reference Number (RRN)",
"taxAmount": "Tax amount in the transaction (e.g., VAT)",
"totalPurchaseAmount": "Total value of the purchase",
"responseMessage": "Response message (e.g., 'OK')",
"authorizationResponseMessage": "Authorization response message (e.g., 'APPROVED TRANSACTION')"
}
},
{
"processor": "Efectivo",
"currencyCode": "USD",
"paymentMethodCode": "1",
"transactionType": null,
"transactionId": null,
"transactionStatus": null,
"tid": null,
"mid": null,
"authorizationCode": null,
"voucher": null,
"referenceNumber": null,
"exactPayment": true,
"customerCashAmount": "0.0000",
"totalBill": "6.2000",
"acquirer": null,
"card": null,
"transactionDate": {
"date": "2022-11-02 08:15:40",
"timeZoneType": 3,
"timeZoneName": "America/Guayaquil",
"weekNumber": 1
},
"metadata": {
"aid": "Specific to Ecuador (application identifier)",
"responseCode": "Transaction response code, '00' for success",
"transactionDate": "Date of the transaction in format YYYYMMDD",
"transactionTime": "Time of the transaction in format HHMMSS",
"cardBrand": "Card brand (e.g., VISA, MASTERCARD, ELECTRON)",
"batch": "Batch to which the transaction belongs",
"rrn": "Recovery Reference Number (RRN)",
"taxAmount": "Tax amount in the transaction (e.g., VAT)",
"totalPurchaseAmount": "Total value of the purchase",
"responseMessage": "Response message (e.g., 'OK')",
"authorizationResponseMessage": "Authorization response message (e.g., 'APPROVED TRANSACTION')"
}
}
]
},
"marketing": {
"loyalty": {
"accumulation": {
"storeCost": "100.0000",
"marketingCost": "112.0000",
"totalPoints": "212.0000"
},
"redemption": {
"storeCost": "80.0000",
"marketingCost": "160.0000",
"totalPoints": "240.0000"
},
"accountBalancePoints": "20"
},
"coupons": [
{
"rewardId": "UUI_DESCPUNTOS",
"name": "Descuento para pago con puntos",
"additionalInfo": {}
},
{
"rewardId": "UUID_CUPON_PRODUCT",
"name": "Cupon de producto",
"additionalInfo": {}
},
{
"rewardId": "UUID_CUPON_FREEDELIVERY",
"name": "Beneficio Free Delivery",
"additionalInfo": {}
},
{
"rewardId": "UUID_CUPON_DESC_TOTAL",
"name": "DEscuento al total de la orden",
"additionalInfo": {}
}
]
},
"additionalInfo": {
"kiosk": {
"ip": "10.101.4.32"
}
}
}Servicio Web de Inyección
Obtener orden
Gets detailed information of a specific order by its ID, including products, pricing, client details, store info, shipping, payments, marketing and additional info.
GET
/
order
/
{orderId}
Retrieve order details
Copy
curl --request GET \
--url https://api.artisn.desarrollo-redbrand.com/api/order/{orderId} \
--header 'Authorization: Bearer <token>'Copy
{
"orderId": "0000012194-081101",
"accountId": "10",
"account": "Artisn App",
"source": "App|Kiosco",
"platform": "Android",
"createdAt": "2022-11-02 08:14:00",
"channelId": "1",
"channelName": "Domicilio App",
"selectedShippingMethod": "delivery|pickup",
"accumulatePoints": true,
"redeemPoints": true,
"stock": false,
"discount": true,
"orderComment": "Comentario General del pedido",
"client": {
"uid": "Bwsyaszx36b5UXXdqFDFBi6ki7j1",
"name": "Sebastian",
"lastName": "Rodriguez",
"phone": "0972241639",
"email": "[email protected]",
"govIdType": "DNI",
"govIdTypeExternal": null,
"govIdNumber": "1751930486",
"externalId": null,
"id": "402399",
"billingInformation": {
"businessName": "Sebastian Rodriguez",
"govIdType": "CI",
"govIdTypeExternal": null,
"govIdNumber": "1751930486",
"phone": "0969150917",
"email": "[email protected]",
"address": "La Venecia 1 S57 415 y E4C",
"externalId": "1255",
"id": "205474"
},
"additionalInfo": {
"birthdate": "1984-09-18",
"gender": "masculino"
}
},
"store": {
"id": 10,
"name": "Gran Santa Fe",
"code": "T001",
"vendorId": 8,
"vendorName": "Blue Co",
"latitude": "-2.32423423",
"longitude": "-80.21312312"
},
"order": {
"products": [
{
"productId": "991117",
"product": "Hamburguesa + papas",
"quantity": 1,
"productComment": "incluye upsale y desct. pago puntos",
"rewardId": "UUID_DESCPUNTOS",
"price": {
"unitPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "7.7826",
"discountPercentage": "100.0000",
"discountsValue": "7.7826",
"subtotalIncludeDiscounts": "0.0000",
"taxesPercentage": "15.0000",
"taxValue": "0.0000",
"total": "0.0000",
"suggestedPrice": "8.9900"
},
"totalPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "7.7826",
"discountPercentage": "100.0000",
"discountsValue": "7.7826",
"subtotalIncludeDiscounts": "0.0000",
"taxesPercentage": "15.0000",
"taxValue": "0.0000",
"total": "0.0000",
"suggestedPrice": "8.9900"
}
},
"modifierGroups": [
{
"id": "1121",
"description": "Escoja su acompañante",
"selectedModifiers": [
{
"answerId": "1055",
"productId": "1025",
"product": "Papas",
"rewardId": "UUID_DESCPUNTOS",
"quantity": 1,
"removedQuantity": null,
"price": {
"unitPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "1.7304",
"discountPercentage": "100",
"discountsValue": "1.7304",
"subtotalIncludeDiscounts": "0.0000",
"taxesPercentage": "15.0000",
"taxValue": "0.0000",
"total": "0.0000",
"suggestedPrice": "2.2500"
},
"totalPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "1.7304",
"discountPercentage": "100",
"discountsValue": "1.7304",
"subtotalIncludeDiscounts": "0.0000",
"taxesPercentage": "15.0000",
"taxValue": "0.0000",
"total": "0.0000",
"suggestedPrice": "2.2500"
}
}
}
]
},
{
"id": "1133",
"description": "Personalice su hamburguesa. Agregue o quite ingredientes",
"selectedModifiers": [
{
"answerId": "1088",
"productId": "1025",
"rewardId": null,
"product": "Sin Tomate",
"quantity": null,
"removedQuantity": 1,
"price": {
"unitPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "0.0000",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "0.0000",
"taxesPercentage": "0.0000",
"taxValue": "0.0000",
"total": "0.0000",
"suggestedPrice": "0.0000"
},
"totalPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "0.0000",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "0.0000",
"taxesPercentage": "0.0000",
"taxValue": "0.0000",
"total": "0.0000",
"suggestedPrice": "0.0000"
}
}
}
]
}
],
"additionalInfo": {
"strategy": "Upsale",
"relatedProductId": "99105",
"redeemed": true,
"sort": 1,
"referenceUnitPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "6.0783",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "6.0783",
"taxesPercentage": "15.0000",
"taxValue": "0.9177",
"total": "6.9900",
"suggestedPrice": "11.2000"
},
"referenceTotalPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "6.0783",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "6.0783",
"taxesPercentage": "15.0000",
"taxValue": "0.9177",
"total": "6.9900",
"suggestedPrice": "11.2000"
},
"unitMeasurement": "unidad|caja"
}
},
{
"productId": "991117",
"product": "Sanduche y bebida. Extra nachos + salsa bbq",
"quantity": 2,
"productComment": "Producto con modificador 3er nivel",
"rewardId": null,
"price": {
"unitPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "6.9478",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "6.9478",
"taxesPercentage": "15.0000",
"taxValue": "1.0422",
"total": "7.9900",
"suggestedPrice": "10.9900"
},
"totalPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "13.8956",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "13.8956",
"taxesPercentage": "15.0000",
"taxValue": "2.0843",
"total": "15.9799",
"suggestedPrice": "21.9800"
}
},
"modifierGroups": [
{
"id": "1120",
"description": "Escoja su bebida",
"selectedModifiers": [
{
"productId": "1025",
"answerId": "1065",
"product": "Pepsi",
"quantity": 2,
"removedQuantity": null,
"price": {
"unitPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "0.0000",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "0.0000",
"taxesPercentage": "0.0000",
"taxValue": "0.0000",
"total": "0.0000",
"suggestedPrice": "0.9900"
},
"totalPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "0.0000",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "0.0000",
"taxesPercentage": "0.0000",
"taxValue": "0.0000",
"total": "0.0000",
"suggestedPrice": "1.9800"
}
}
}
]
},
{
"id": "1125",
"description": "Agregue extra nachos, ensalada o postre",
"selectedModifiers": [
{
"productId": "1035",
"answerId": "1044",
"product": "Nachos",
"quantity": 2,
"removedQuantity": null,
"price": {
"unitPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "4.3391",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "4.3391",
"taxesPercentage": "15.0000",
"taxValue": "0.6509",
"total": "4.9900",
"suggestedPrice": "0.0000"
},
"totalPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "8.6782",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "8.6782",
"taxesPercentage": "15.0000",
"taxValue": "1.3017",
"total": "9.9799",
"suggestedPrice": "0.0000"
}
},
"modifierGroups": [
{
"id": "1127",
"description": "Seleccione el tipo de salsa",
"selectedModifiers": [
{
"productId": "1033",
"answerId": "1018",
"product": "Salsa BBQ",
"quantity": 1,
"removedQuantity": null,
"price": {
"unitPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "2.2174",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "2.2174",
"taxesPercentage": "15.0000",
"taxValue": "0.3326",
"total": "2.5500",
"suggestedPrice": "4.7500"
},
"totalPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "2.2174",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "2.2174",
"taxesPercentage": "15.0000",
"taxValue": "0.3326",
"total": "2.5500",
"suggestedPrice": "4.7500"
}
}
}
]
}
]
}
]
}
],
"additionalInfo": {}
},
{
"productId": "44368",
"product": "Wings + papas",
"quantity": 1,
"productComment": "incluye reward de producto.",
"rewardId": "UUID_CUPON_PRODUCT",
"price": {
"unitPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "8.6870",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "8.6870",
"taxesPercentage": "15.0000",
"taxValue": "1.3031",
"total": "9.9901",
"suggestedPrice": "12.9900"
},
"totalPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "8.6870",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "8.6870",
"taxesPercentage": "15.0000",
"taxValue": "1.3031",
"total": "9.9901",
"suggestedPrice": "12.9900"
}
},
"modifierGroups": [
{
"id": "1121",
"description": "Escoja su acompañante",
"selectedModifiers": [
{
"productId": "1025",
"product": "Papas",
"quantity": 1,
"removedQuantity": null,
"price": {
"unitPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "1.9565",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "1.9565",
"taxesPercentage": "15.0000",
"taxValue": "0.2935",
"total": "2.2500",
"suggestedPrice": "2.2500"
},
"totalPrice": {
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "1.9565",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "1.9565",
"taxesPercentage": "15.0000",
"taxValue": "0.2935",
"total": "2.2500",
"suggestedPrice": "2.2500"
}
}
}
]
}
],
"additionalInfo": {}
}
],
"stock": [
{
"productId": "10030",
"stock": 30
}
]
},
"shippingMethod": {
"delivery": {
"deliveryDate": "2022-07-05 18:24:00",
"latitude": "-2.2244266000000",
"longitude": "-80.9044868000000",
"country": "Colombia",
"city": "Bogota",
"mainStreet": "Calle 100 # 15-34",
"number": "",
"secondaryStreet": "",
"reference": "Casa gris",
"propertyId": 1,
"observationsAddress": "No sirve el intercomunicador",
"numberContactAddress": "101019987435",
"zipCode": "170904",
"nickName": "casa",
"externalId": "2056",
"id": "3012312",
"driverArrivalDateInStore": "2024-02-21T12:47:27Z",
"additionalInfo": {
"deliveryConfirmationCode": "PZ051"
}
},
"pickup": {
"pickupDate": "2022-07-05 18:39:00",
"prepDate": "2022-07-05 18:24:00",
"prepTimeUnit": "minute",
"prepTime": 15,
"propertyId": 1,
"carryOutOptions": "PickUp-LLevar",
"contactMethods": [
{
"type": "pager",
"identifier": "PG123"
},
{
"type": "sms",
"countryCode": "+57",
"phoneNumber": "3001234567"
},
{
"type": "whatsapp",
"countryCode": "+57",
"phoneNumber": "3007654321"
}
]
}
},
"payments": {
"totals": [
{
"rewardId": "UUID_CUPON_DESC_TOTAL",
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "39.3478",
"discountPercentage": "20.0000",
"discountsValue": "7.8696",
"subtotalIncludeDiscounts": "31.4782",
"taxesPercentage": "15.0000",
"taxValue": "4.7217",
"total": "36.2000"
}
],
"shippingCost": [
{
"quantity": 1,
"productId": "111",
"rewardId": "UUID_CUPON_FREEDELIVERY",
"currencyCode": "USD",
"subtotalWithoutTaxes": "2.3913",
"discountPercentage": "100.0000",
"discountsValue": "2.3913",
"subtotalIncludeDiscounts": "0.0000",
"taxesPercentage": "15.0000",
"taxValue": "0.0000",
"total": "0.0000"
}
],
"extraCharges": [
{
"quantity": 1,
"productId": "125",
"description": "tip",
"currencyCode": "USD",
"subtotalWithoutTaxes": "0.8696",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "0.8696",
"taxesPercentage": "15.0000",
"taxValue": "0.1304",
"total": "1.0000"
},
{
"quantity": 1,
"productId": null,
"description": "packing cost",
"currencyCode": "USD",
"subtotalWithoutTaxes": "3.0435",
"discountPercentage": "0.0000",
"discountsValue": "0.0000",
"subtotalIncludeDiscounts": "3.0435",
"taxesPercentage": "15.0000",
"taxValue": "0.4565",
"total": "3.5000"
}
],
"discounts": [
{
"rewardId": "UUI_DESCPUNTOS",
"productId": "991117",
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "7.7826",
"discountPercentage": "100.0000",
"discountsValue": "7.7826",
"subtotalIncludeDiscounts": "0.0000"
},
{
"rewardId": "UUI_DESCPUNTOS",
"productId": "1025",
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "1.7304",
"discountPercentage": "100",
"discountsValue": "1.7304",
"subtotalIncludeDiscounts": "0.0000"
},
{
"rewardId": "UUID_CUPON_FREEDELIVERY",
"productId": "111",
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "2.3913",
"discountPercentage": "100.0000",
"discountsValue": "2.3913",
"subtotalIncludeDiscounts": "0.0000"
},
{
"rewardId": "UUID_CUPON_DESC_TOTAL",
"productId": "111",
"currencyCode": "USD",
"totalBeforeSale": "0.0000",
"subtotalWithoutTaxes": "2.3913",
"discountPercentage": "100.0000",
"discountsValue": "2.3913",
"subtotalIncludeDiscounts": "0.0000"
}
],
"taxes": [
{
"name": "IVA 15%",
"currencyCode": "USD",
"subtotalWithoutTaxes": "31.4782",
"percentage": "15.0000",
"total": "4.7217"
}
],
"paymentMethods": [
{
"processor": "Kushki",
"currencyCode": "USD",
"paymentMethodCode": "2",
"transactionType": "credit",
"transactionId": "049258058662543450",
"transactionStatus": "APPROVED",
"tid": "CA303015",
"mid": "2000026002",
"authorizationCode": "428364",
"voucher": "358642",
"referenceNumber": "704891",
"exactPayment": true,
"customerCashAmount": "0.0000",
"totalBill": "30.0000",
"acquirer": {
"code": "004",
"name": "BANCO GUAYAQUIL"
},
"card": {
"mask": "459424XXXXXXX456",
"bin": "459424",
"lastFourDigits": "1456",
"brand": "MAST",
"externalCardBrandId": "28FA9351-5F07-EB11-80F1-000D3A019254",
"holder": "Sebastian Rodriguez",
"cardCountry": "Ecuador"
},
"transactionDate": {
"date": "2022-11-02 08:15:30",
"timeZoneType": 3,
"timeZoneName": "America/Guayaquil",
"weekNumber": 1
},
"metadata": {
"aid": "Specific to Ecuador (application identifier)",
"responseCode": "Transaction response code, '00' for success",
"transactionDate": "Date of the transaction in format YYYYMMDD",
"transactionTime": "Time of the transaction in format HHMMSS",
"cardBrand": "Card brand (e.g., VISA, MASTERCARD, ELECTRON)",
"batch": "Batch to which the transaction belongs",
"rrn": "Recovery Reference Number (RRN)",
"taxAmount": "Tax amount in the transaction (e.g., VAT)",
"totalPurchaseAmount": "Total value of the purchase",
"responseMessage": "Response message (e.g., 'OK')",
"authorizationResponseMessage": "Authorization response message (e.g., 'APPROVED TRANSACTION')"
}
},
{
"processor": "Efectivo",
"currencyCode": "USD",
"paymentMethodCode": "1",
"transactionType": null,
"transactionId": null,
"transactionStatus": null,
"tid": null,
"mid": null,
"authorizationCode": null,
"voucher": null,
"referenceNumber": null,
"exactPayment": true,
"customerCashAmount": "0.0000",
"totalBill": "6.2000",
"acquirer": null,
"card": null,
"transactionDate": {
"date": "2022-11-02 08:15:40",
"timeZoneType": 3,
"timeZoneName": "America/Guayaquil",
"weekNumber": 1
},
"metadata": {
"aid": "Specific to Ecuador (application identifier)",
"responseCode": "Transaction response code, '00' for success",
"transactionDate": "Date of the transaction in format YYYYMMDD",
"transactionTime": "Time of the transaction in format HHMMSS",
"cardBrand": "Card brand (e.g., VISA, MASTERCARD, ELECTRON)",
"batch": "Batch to which the transaction belongs",
"rrn": "Recovery Reference Number (RRN)",
"taxAmount": "Tax amount in the transaction (e.g., VAT)",
"totalPurchaseAmount": "Total value of the purchase",
"responseMessage": "Response message (e.g., 'OK')",
"authorizationResponseMessage": "Authorization response message (e.g., 'APPROVED TRANSACTION')"
}
}
]
},
"marketing": {
"loyalty": {
"accumulation": {
"storeCost": "100.0000",
"marketingCost": "112.0000",
"totalPoints": "212.0000"
},
"redemption": {
"storeCost": "80.0000",
"marketingCost": "160.0000",
"totalPoints": "240.0000"
},
"accountBalancePoints": "20"
},
"coupons": [
{
"rewardId": "UUI_DESCPUNTOS",
"name": "Descuento para pago con puntos",
"additionalInfo": {}
},
{
"rewardId": "UUID_CUPON_PRODUCT",
"name": "Cupon de producto",
"additionalInfo": {}
},
{
"rewardId": "UUID_CUPON_FREEDELIVERY",
"name": "Beneficio Free Delivery",
"additionalInfo": {}
},
{
"rewardId": "UUID_CUPON_DESC_TOTAL",
"name": "DEscuento al total de la orden",
"additionalInfo": {}
}
]
},
"additionalInfo": {
"kiosk": {
"ip": "10.101.4.32"
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of the order to query. Example: '0000012194-081101'
Response
Order details
Unique order ID
ID of the account that placed the order
Account name
Source of the order, e.g., App or Kiosco
Platform used to place the order, e.g., Android, iOS
Order creation timestamp
Channel ID of the order
Channel name of the order
Selected shipping method, e.g., delivery or pickup
Whether the order accumulates loyalty points
Whether the order redeems loyalty points
Indicates if stock is available
Indicates if a discount was applied
General comment on the order
Information about the client
Show child attributes
Show child attributes
First customer identifier
name
lastname
phone
Type of Identification (e.g. 'DNI', 'CI', 'RUC', 'PASSPORT')
Identification Number
Billing info for the client
Show child attributes
Show child attributes
name
Type of Identification (e.g. 'DNI', 'CI', 'RUC', 'PASSPORT')
Identification Number
phone
address
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Unique identifier
name product
quantity
Customer review for the product
Benefit identifier or associated coupon.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Currency code (example USD)
Product value before discounts
Subtotal excluding taxes
Discount percentage applied
Discount amount applied.
Product value before discounts
Applied tax percentage
Tax value
Final product total
Suggested product price
Show child attributes
Show child attributes
Currency code (example USD)
Product value before discounts
Subtotal without taxes
Applied discount percentage
Applied discount value
Subtotal after applying discounts
Applied tax percentage
Tax value. / Value of taxes
Final product total
Suggested product price
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response or selection identifier
Modifier product identifier
Modifier product name
Reward identifier if applicable
Selected quantity of the modifier
Removed quantity if applicable
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Currency code (example USD)
Product value before discounts
Subtotal without taxes
Applied discount percentage
Applied discount value
Subtotal after applying discounts
Applied tax percentage
Tax value. / Value of taxes
Final product total
Suggested product price
Show child attributes
Show child attributes
Currency code (example USD)
Product value before discounts
Subtotal without taxes
Applied discount percentage
Applied discount value
Subtotal after applying discounts
Applied tax percentage
Tax value. / Value of taxes
Final product total
Suggested product price
Show child attributes
Show child attributes
Applied strategy (example Upsale)
Related product identifier
Indicates if the product was redeemed
Product position in the selection order
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Delivery date and time per shipment, type yyyy-MM-dd HH:mm:ss
latitude of the delivery location coordinates
longitude of the delivery location coordinates
country
city
mainStreet
number
secondaryStreet
reference
Property type identifier
Notes about the address / Address observations
Contact Number
zipCode
Identification Name
Identifier granted by external integrations
Unique identifier
Specifies the estimated date and time a delivery driver can arrive at the store to pick up an order
Show child attributes
Show child attributes
Pickup date and time, type yyyy-MM-dd HH:mm:ss
Preparation date and time, type yyyy-MM-dd HH:mm:ss
Time unit, for preparation
Preparation time
Property type identification
Delivery type, e.g. Takeaway (PickUp-LLevar), Dine-in
Show child attributes
Show child attributes
Contact type for notifications. Can be pager, sms, or whatsapp
Contact identifier (used only if type is pager)
Country code in international format (used for sms and whatsapp)
Phone number without the country code (used for sms and whatsapp)
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Coupon or reward identifier
Currency code
Total value before catalog discounts
Subtotal without taxes
Discount percentage
Discount value
Subtotal with discounts
Tax Percentage
Tax value
Total
Show child attributes
Show child attributes
quantity
product id
Coupon or reward identifier
Currency code
Subtotal without taxes
Discount percentage
Discount value
Subtotal with discounts
Tax Percentage
Tax value
total
Show child attributes
Show child attributes
quantity
product id
description
Currency Code
Subtotal without taxes
Discount percentage
Discount value
Subtotal with discounts
Tax Percentage
Tax value
total
Show child attributes
Show child attributes
Coupon or reward identifier
product id
Currency Code
Total value before catalog discounts
Subtotal without taxes
Discount percentage
Discount value
Subtotal with discounts
Show child attributes
Show child attributes
Payment processor
Currency code
Payment method code
Transaction type
Unique transaction identifier
Transaction status
Terminal identification number
Merchant identification code
Authorization code
Generated voucher
Reference number
Indicates if the payment is canceled with the same value
Cash amount that the customer will pay
Total value (decimal format)
Show child attributes
Show child attributes
Mask (likely referring to a masked card number)
Bin
Last 4 digits
Payment processor brand
Identifier granted by external integrations.
Cardholder name / Owner's name
Country
Show child attributes
Show child attributes
Transaction date and time in yyyy-MM-dd HH:mm:ss format
Time zone identifier
Time zone name
Transaction week number
Show child attributes
Show child attributes
Only applies to Ecuador (specific field)
Transaction response code, '00' for success
Specific transaction date in YYYYMMDD format
Specific transaction time in HHMMSS format
Card type (VISA, MASTERCARD, ELECTRON, etc.)
Batch the transaction belongs to
Recovery Reference Number
VAT value in the transaction (tax)
total Purchase Amount
Response message (example 'OK' or similar)
Authorization message (e.g., 'TRANS. APPROVED')
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Customer points balance
⌘I