POS integrations management

get
Get logistic integrations

https://integrations.mipos.shop/api/v1/logistic/pos/list
Provides a list of delivery integrations registered in the platform
Request
Response
Request
Headers
Authorization
required
string
Bearer {access_token}
Response
200: OK
[
{
"id": 8,
"name": "logistic company"
}
]

post
Change status logistic integration

https://integrations.mipos.shop/api/v1/logistic/pos/change/status
Enable the selected integration for this store
Request
Response
Request
Headers
Content-Type
required
string
application/json
Authorization
required
string
Bearer {access_token}
Body Parameters
status
required
string
"enable" or "disable"
external_store_id
required
string
ID of the store in the logistic system
store_id
required
string
ID of the store in the platform
integration_id
required
string
ID of the integration in the platform
Response
200: OK
Cake successfully retrieved.
{
"message": "Successful change of status.",
"data": null
}
401: Unauthorized
"Unauthorized."
409: Conflict
Could not find a cake matching this query.
{
"message": [
"You don't have this store available.",
"Integration not available.",
"This store does not have this integration enabled."
],
"data": null
}
422: Unprocessable Entity
{
"status": [
"The status field is required.",
"The status must be a string.",
"The selected status is invalid."
],
"store_id": [
"The store id field is required."
],
"external_store_id": [
"The external store id field is required."
],
"integration_id": [
"The integration id field is required.",
"The integration id must be a string.",
"The selected integration id is invalid."
]
}

post
Manage Status Delivery Webhook

https://integrations.mipos.shop/api/v1/logistic/pos/webhook/status/manage
Create or update webhook for changes of delivery status of an order .
Request
Response
Request
Headers
Authorization
required
string
Bearer {access_token}
Content-type
required
string
application/json
Body Parameters
integration_id
required
string
Your Logistic System Id
url
required
string
Webhook URL
Response
201: Created
{
"message": "Webhook successfully configured.",
"data": null
}
409: Conflict
{
"message": [
"Unable to set up the webhook URL."
],
"data": null
}
422: Unprocessable Entity
{
"integration_id": [
"The integration id field is required."
],
"url": [
"The url field is required."
]
}

The events you will receive in this webhook will have the following structure.

{
"service_identifier": "abc123",
"status": "....",
"location": {
"lat": ....,
"lng": ....
}
}

post
Manage Location Delivery Webhook

https://integrations.mipos.shop/api/v1/logistic/pos/webhook/location/manage
Create or update webhook for changes of location of an order .
Request
Response
Request
Headers
Authorization
required
string
Bearer {access_token}
Content-type
required
string
application/json
Body Parameters
integration_id
required
string
Your Logistic System Id
url
required
string
Webhook URL
Response
200: OK

The events you will receive in this webhook will have the following structure.

{
"service_identifier": "abc123",
"location": {
"lat": ....,
"lng": ....
}
}