POS integrations management

Get logistic integrations

GET https://integrations.mipos.shop/api/v1/logistic/pos/list

Provides a list of delivery integrations registered in the platform

Headers

Name	Type	Description
Authorization	string	Bearer {access_token}

200

[
    {
        "id": 8,
        "name": "logistic company"
    }
]

Change status logistic integration

POST https://integrations.mipos.shop/api/v1/logistic/pos/change/status

Enable the selected integration for this store

Headers

Name	Type	Description
Content-Type	string	application/json
Authorization	string	Bearer {access_token}

Request Body

Name	Type	Description
status	string	"enable" or "disable"
external_store_id	string	ID of the store in the logistic system
store_id	string	ID of the store in the platform
integration_id	string	ID of the integration in the platform

200 Cake successfully retrieved.

{
    "message": "Successful change of status.",
    "data": null
}

401

"Unauthorized."

409 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

{
    "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."
    ]
}

Manage Status Delivery Webhook

POST https://integrations.mipos.shop/api/v1/logistic/pos/webhook/status/manage

Create or update webhook for changes of delivery status of an order .

Headers

Name	Type	Description
Authorization	string	Bearer {access_token}
Content-type	string	application/json

Request Body

Name	Type	Description
integration_id	string	Your Logistic System Id
url	string	Webhook URL

201

{
    "message": "Webhook successfully configured.",
    "data": null
}

409

{
    "message": [
        "Unable to set up the webhook URL."
    ],
    "data": null
}

422

{
    "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": ....
    }
}

Manage Location Delivery Webhook

POST https://integrations.mipos.shop/api/v1/logistic/pos/webhook/location/manage

Create or update webhook for changes of location of an order .

Headers

Name	Type	Description
Authorization	string	Bearer {access_token}
Content-type	string	application/json

Request Body

Name	Type	Description
integration_id	string	Your Logistic System Id
url	string	Webhook URL

200

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

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