Login User by Username and Password

POST

/v1/login

Vendor Access: Allowed — Vendor users can access this endpoint.

Authenticates an individual user based on their OrderMesh platform credentials. This endpoint is primarily intended for manual development, debugging, and testing via the documentation portal's interactive console.

Warning: Do not use this method for automated production integrations. User sessions are short-lived and subject to manual logout or password changes, which will break automated workflows.

Request

Query Params

Body Params

application/json

Examples

Responses

🟢200

application/json

Returns the token and refresh token.

Body

🟠400

🟠401

🟠403

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.qa.ordermesh.io/user/v1/login?source=undefined' \
--header 'Content-Type: application/json' \
--data-raw '{
    "password": "ExamplePassword123!",
    "username": "john.doe@example.com"
}'

Response Example

200 - Success

{
    "accessToken": "eyJhbGciOiJSUzI1NiIsInR5cCIg...",
    "scope": "email profile",
    "tokenType": "Bearer",
    "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCIgOiAiSldUI...",
    "expiresIn": 900,
    "identityToken": null,
    "id": "c8f51b34-3c03-417c-b3ff-1e49a159e851",
    "shortId": "U02270001",
    "username": "",
    "email": "joe.bloggs@domain.com",
    "firstName": "Joe",
    "lastName": "Bloggs",
    "status": "enabled",
    "dateCreated": "2026-04-30T18:13:57.0698643Z",
    "attributes": {
        "merchantIds": [
            "merchant-1",
            "merchant-2"
        ],
        "vendorIds": [
            "vendor-1"
        ],
        "facilityIds": [
            "facility-1"
        ]
    },
    "roles": [
        {
            "id": "03d5cd96-6d1e-46de-94c3-ceeb57feeadb",
            "name": "merchant",
            "usersCount": null,
            "permissionSet": [
                {
                    "resourceId": "33c7a0f0-0036-4461-b677-97520b874824",
                    "resourceName": "order",
                    "resourceDisplayName": "Order",
                    "availablePermissions": [
                        {
                            "name": "get",
                            "description": ""
                        },
                        {
                            "name": "create",
                            "description": ""
                        }
                    ],
                    "associatedPermissions": [
                        {
                            "name": "get",
                            "description": ""
                        }
                    ]
                }
            ]
        }
    ]
}

Modified at 2026-05-27 12:48:26

Generate Service Client Access Token