Third Party Send Order
Third Party Send Order to Store
POST https://integrations.mipos.shop/third_party/v1/mely/order
This endpoint allows you to send orders to store
Headers
Content-type
string
application/json
Authorization
string
Bearer {access_token}
Request Body
delivery
object
Contains the delivery information
store
object
store object. contain store ID
id
string
Id order on the third party platform
created_at
string
Order creation date on the third party platform
total
number
Cost of the entire order (including 2 decimal places)
order_number
string
Number order on the third party platform
instructions
string
Instructions of the order
discount_value
number
Order discount value
total_with_discount
number
Cost with discount of the entire order (including 2 decimal places)
delivery_method
string
Third party delivery method. Example: delivery pickup
payment_method
string
Payment method. Example: cc = credit card cash
items
array
All the items contained within the order
client
object
Billing object
{ "name": "Cake's name", "recipe": "Cake's recipe name", "cake": "Binary cake"}{ "message": "Ain't no cake like that."}{
"messages": [
"The order pickup information is required.",
"The order delivery information is required.",
"The address information is required.",
"The address latitude is required.",
"The address longitude is required.",
"The contact phone information is required.",
"The contact name information is required.",
"The address information is required.",
"Invalid latitude coordinates.",
"Invalid longitude coordinates.",
"The estimated pickup information format is not valid."
]
}param
type
description
id
string (required)
Store id in the third party platform
menu_identifier
string (required)
Menu identifier from store
param
type
description
identifier
string (required)
billing identifier
firstName
string (required)
first name of the client
lastName
string (required)
last name of the client
string (optional)
email of the client
phone
string (optional)
phone of the client
address
string (optional)
address of the client
param
type
description
id
string (required)
Id item on your system
external_id
string (required)
Id item on the POS
name
string (required)
name item on the POS
quantity
number (required)
Quantity selected in the order
unit_value
number(required)
Unit value of the item + modifiers value (including 2 decimal places)
total_unit_value
number(required)
Unit value of the item + modifiers value (including 2 decimal places)
total_value
number(required)
Total value of the item + modifiers value (including 2 decimal places)
instructions
string (optional)
Instructions of the item
total_with_discount
number(required)
total_value - discount
modifiers
object (required)
[] default empty array
param
type
description
id
string (required)
id modifier on your system
external_id
string (required)
id modifier on the POS
name
string (required)
Name of the modifier
quantity
number (required)
Quantity selected in the order
unit_value
number (required)
Unit value of the modifier (including 2 decimal places)
total_value
number (required)
Total value of the modifier (including 2 decimal places)
This information is mandatory if an external service is to be used for deliveries.
param
type
description
origin
PointInfo (required)
Information where the order will be pickup
destination
PointInfo (required)
Information where the order will be delivered
estimated_pickup
string
Estimated time(yyyy-mm-dd hh:mm:ss) that the order will be ready for pick-up. If no information is sent for this field, this indicates that the order will be collected as soon as possible
param
type
description
address
string
(required)
Full address
reference
string
Help reference to identify the location
lat
string
(required)
Latitude of the address
lng
string
(required)
Longitude of the address
contact_phone
string
(required)
Contact phone
contact_name
string
(required)
Contact name
Json request example
{
"id": "12345678-123-1234-1234-123456789012",
"created_at": "2020-03-20T04:51:03Z",
"total": 25800,
"store": {
"id":"abc124..3312",
"menu_identifier": "????"
},
"order_number": "ABC12",
"instructions": "",
"items": [
{
"id": "aaa1",
"external_id": "13753",
"name": "El Xolo",
"quantity": 2,
"unit_value": 10900,
"total_unit_value": 12900,
"total_value": 25800,
"instructions": "",
"total_with_discount":25800,
"modifiers": [
{
"id": "bbb1",
"external_id": "3006",
"name": "Elige Tus Papas",
"quantity": 1,
"unit_value": 0,
"total_value": 0
},
{
"id": "ccc1",
"external_id": "3012",
"name": "Elige tu salchicha",
"quantity": 1,
"unit_value": 2000,
"total_value": 2000
}
]
}
],
"discount_value": 800,
"total_with_discount": 25000,
"delivery_method": "delivery",
"payment_method":"cc",
"client": {
"identifier": "9999999999",
"firstName": "Final",
"lastName": "Consumer",
"email": "",
"phone": "",
"address": ""
},
"delivery": {
"origin": {
"address": "Av. Emilio Estrada, Dátiles 109 Y, 090511",
"reference": "",
"lat": "-2.1665922",
"lng": "-79.9059292",
"contact_phone": "XXXXXXXXXXXX",
"contact_name": "Pick Up Store"
},
"destination": {
"address": "Dr. Alfredo Baquerizo Moreno 1007, Guayaquil 090313",
"reference": "Cerca del Malecón 2000",
"lat": "-2.1850754",
"lng": "-79.8902651",
"contact_phone": "YYYYYYYYYYYYY",
"contact_name": "Customer name"
},
"estimated_pickup": "2020-05-29 15:43:00",
"integration_id": "id of the integration for which you want to request the delivery service"
}
}Last updated
Was this helpful?