Peoplevine Connect

POS (Point of Sale)

Good to know: Splitting your product into fundamental concepts, objects, or areas can be a great way to let readers deep dive into the concepts that matter most to them.

Lookup Members

With this method you can lookup members.

Request

GET https://connect.peoplevine.com/pos/members?auth_id=...&company=...&user=...&pass=...&host=...&input=

ParametherDescription

auth_id

Peoplevine integration account ID

company

Peoplevine company ID

user

Peoplevine user name

pass

Peoplevine user password

host

Default region 1. Values: region 1, region 2 (UK)

input

Peoplevine member ID, name or phone number

Response

The response will include a list of members, their basic profile information, past visits, frequently purchased items and other related tags.

{
    "members": [
        {
            "customer_no": 6448,
            "company_no": 4,
            "business_location_no": 23,
            "membership_id": "3295650884",
            "membership_title": "Gleneagles Townhouse",
            "customer_name": "Mark Dyason",
            "member_discount": 0.0,
            "giftcard_balance": 0.0,
            "has_card_on_file": true,
            "profile_photo": "https://api.peoplevine.co.uk/file/secure/files/4/survey/3/42caa7e2d-1aae-7eb0472a83.png",
            "birthdate": "1971-11-11T00:00:00Z",
            "anniversary": "1900-01-01T00:00:00Z",
            "visits": [
                "2022-08-29T12:01:25.68Z",
                "2022-08-08T18:50:50.367Z",
                "2022-08-08T15:19:39.407Z",
                "2022-06-11T17:03:24.487Z",
                "2022-06-09T21:28:18.71Z",
                "2022-06-09T17:12:24.437Z",
                "2022-06-07T17:50:18.553Z",
                "2022-06-06T18:16:06.86Z",
                "2022-06-04T20:31:09.047Z",
                "2022-06-04T20:22:59.95Z"
            ],
            "purchases": [
                "Highland Spring still 750ml",
                "175 Chablis Domaine Fournillon",
                "50 Portobello Road Navy",
                "125 Ruinart Blanc de Blanc",
                "Trolley Negroni",
                "Fevertree Tonic Water",
                "125 Veuve Clicquot Rose NV",
                "The Architect",
                "Olives",
                "Orange Juice"
            ],
            "attributes": {
                "Billing Frequency": "Monthly",
                "County": "Midlothian",
                "Direct Debit": "Yes",
                "GoCardless": "CU001KH974G5T2",
                "Hotel discount code": "MDY1111",
                "Import Label": "24/01/2022",
                "Industry": "Accounting & Finance",
                "Source": "SevenRooms, SevenRooms",
                "Title": "Mr",
                "Wellness: Decompress Preference": "Swimming",
                "Wellness: Training Preference": "Swimming"
            },
            "notes": []
        }
    ],
    "success": true,
    "reason": null,
    "message": null
}

Create Order

With this method you can create an order in Peoplevine to track member and guest spend. It is required to have an order created in order to charge a person.

Request

POST https://connect.peoplevine.com/pos/order?auth_id=...&company=...&user=...&pass=...&host=

ParametherDescription

auth_id

Peoplevine integration account ID

company

Peoplevine company ID

user

Peoplevine user name

pass

Peoplevine user password

host

Optional. Values: region 1(default), region 2(UK)

{
  "order": {
    "coupons": null,
    "customer": {
      "customer_no": 2308472,
      "first_name": null,
      "middle_name": null,
      "last_name": null,
      "phone_number": null,
      "mobile_number": null,
      "email": null,
      "customer_reference": null,
      "birthdate": "0001-01-01T00:00:00",
      "address": null,
      "address2": null,
      "city": null,
      "state": null,
      "zip_code": null,
      "country": null,
      "website": null
    },
    "shippingAddress": null,
    "orderInfo": {
      "business_location_no": 0,
      "external_order_no": "0cf82bef95134c7593f7f8f74bbe724d00028311",
      "order_via": "connectedpos",
      "customer_no": 2308472,
      "first_name": null,
      "last_name": null,
      "email": null,
      "mobile_number": null,
      "customer_reference": null,
      "order_date": "2022-09-28T00:29:43.7627612+00:00",
      "order_status": "completed",
      "order_total": 137.78,
      "sub_total": 89.5,
      "shipping_total": 17.9,
      "tax_total": 7.38,
      "discount_total": 0.0,
      "tip_total": 23.0,
      "sessionID": null,
      "ip_address": null,
      "company_no": 811,
      "order_no": 0,
      "order_note": "Table #: 617123, Check #:33153",
      "flag_paid": -1,
      "flag_verified": -1,
      "flag_pulled": -1,
      "flag_shipped": -1,
      "flag_completed": -1,
      "flag_followup": 0,
      "flag_returned": 0,
      "flag_modified": 0,
      "order_source": "Simphony",
      "updateFields": null,
      "updateIfExists": true,
      "user": {
        "master_customer_no": null,
        "last_login": null,
        "business_location_no": null,
        "employee_id": "98925",
        "send_from": false,
        "welcome_message": null,
        "user_pin": null,
        "last_accessed": null,
        "password_expires": null,
        "failed_attempts": null,
        "company_no": null,
        "user_no": null,
        "first_name": "Kellee",
        "last_name": "Anderson",
        "mobile_number": null,
        "email": null,
        "username": "Anderson, Kellee",
        "password": null,
        "permission_level": null,
        "status": null,
        "created_on": null,
        "modified_on": null,
        "created_by": null
      }
    },
    "itemInfo": [
      {
        "external_id": "20010012",
        "pull_quantity": 1.0,
        "product": {
          "product_sku": "20010012",
          "product_short": "Titos",
          "unit_type": null,
          "description": null,
          "price": 15.0
        },
        "order_price": 15.0,
        "order_quantity": 1.0,
        "product_attributes": "2"
      },
      {
        "external_id": "80181018",
        "pull_quantity": 1.0,
        "product": {
          "product_sku": "80181018",
          "product_short": "$cosmo",
          "unit_type": null,
          "description": null,
          "price": 4.0
        },
        "order_price": 4.0,
        "order_quantity": 1.0,
        "product_attributes": "81"
      },
      {
        "external_id": "20010012",
        "pull_quantity": 1.0,
        "product": {
          "product_sku": "20010012",
          "product_short": "Titos",
          "unit_type": null,
          "description": null,
          "price": 15.0
        },
        "order_price": 15.0,
        "order_quantity": 1.0,
        "product_attributes": "2"
      },
      {
        "external_id": "80181018",
        "pull_quantity": 1.0,
        "product": {
          "product_sku": "80181018",
          "product_short": "$cosmo",
          "unit_type": null,
          "description": null,
          "price": 4.0
        },
        "order_price": 4.0,
        "order_quantity": 1.0,
        "product_attributes": "81"
      },
      {
        "external_id": "20020015",
        "pull_quantity": 1.0,
        "product": {
          "product_sku": "20020015",
          "product_short": "Tanqueray",
          "unit_type": null,
          "description": null,
          "price": 16.5
        },
        "order_price": 16.5,
        "order_quantity": 1.0,
        "product_attributes": "2"
      },
      {
        "external_id": "80182012",
        "pull_quantity": 1.0,
        "product": {
          "product_sku": "80182012",
          "product_short": "up",
          "unit_type": null,
          "description": null,
          "price": 0.0
        },
        "order_price": 0.0,
        "order_quantity": 1.0,
        "product_attributes": "81"
      },
      {
        "external_id": "80189007",
        "pull_quantity": 1.0,
        "product": {
          "product_sku": "80189007",
          "product_short": "olive",
          "unit_type": null,
          "description": null,
          "price": 0.0
        },
        "order_price": 0.0,
        "order_quantity": 1.0,
        "product_attributes": "81"
      },
      {
        "external_id": "20010012",
        "pull_quantity": 1.0,
        "product": {
          "product_sku": "20010012",
          "product_short": "Titos",
          "unit_type": null,
          "description": null,
          "price": 15.0
        },
        "order_price": 15.0,
        "order_quantity": 1.0,
        "product_attributes": "2"
      },
      {
        "external_id": "80181018",
        "pull_quantity": 1.0,
        "product": {
          "product_sku": "80181018",
          "product_short": "$cosmo",
          "unit_type": null,
          "description": null,
          "price": 4.0
        },
        "order_price": 4.0,
        "order_quantity": 1.0,
        "product_attributes": "81"
      },
      {
        "external_id": "20130008",
        "pull_quantity": 1.0,
        "product": {
          "product_sku": "20130008",
          "product_short": "Aperol Spritz",
          "unit_type": null,
          "description": null,
          "price": 16.0
        },
        "order_price": 16.0,
        "order_quantity": 1.0,
        "product_attributes": "2"
      }
    ],
    "payments": [
      {
        "created_on": "0001-01-01T00:00:00",
        "paid_on": "0001-01-01T00:00:00",
        "service_fee": 0,
        "discount_total": 0.0,
        "tax_amount": 7.38,
        "incoming_id": null,
        "incoming_authenticate_no": 0,
        "authenticate_no": 0,
        "transaction_data": null,
        "payment_type": "POS",
        "transaction_status": "processed",
        "charged_on": "2022-09-28T00:29:43.7627612+00:00",
        "transaction_id": "0cf82bef95134c7593f7f8f74bbe724d00028311",
        "transaction_amount": 137.78,
        "tip": 0.0,
        "refunded_amount": 0.0,
        "t_card_type": null,
        "t_card_four": null
      }
    ]
  }
}

Response

Successfull response:

{
    "order_id": 54939,
    "success": true,
    "reason": null,
    "message": null
}

Process Payment

With this method you can process payment in Peoplevine

Request

POST https://connect.peoplevine.com/pos/payment?auth_id=...&company=...&user=...&pass=...&host=

ParametherDescription

auth_id

Peoplevine integration account ID

company

Peoplevine company ID

user

Peoplevine user name

pass

Peoplevine user password

host

Optional. Values: region 1(default), region 2(UK)

{
    "tax_amount": 4.916666,
    "discount_amount": 0.0,
    "processor": "pos",
    "card_no": 0,
    "membership_no": 0,
    "membership_id": "460746025",
    "membership_card_no": 0,
    "customer_no": 248234,
    "default_customer_no": 0,
    "company_no": 0,
    "ticketID": "94f72982b51c45a2a841a2ac1f7ecc9400001386",
    "external_order_no": "94f72982b51c45a2a841a2ac1f7ecc9400001386",
    "provider": "Simphony",
    "payment_type": "paywithbalance",
    "amount": 33.19,
    "tip": 0.0,
    "payment_id": "94f72982b51c45a2a841a2ac1f7ecc9400001386",
    "reference_type": "order",
    "order_no": 54939
}

Successfull response

{
    "amount": 33.19,
    "transaction_no": 4040244,
    "success": true,
    "reason": null,
    "message": null
}

Failed response

{
    "amount": 0.0,
    "transaction_no": 0,
    "success": false,
    "reason": "This action failed.",
    "message": null
}

Cancel Payment

With this method you can cancel a payment.

Request

GET https://connect.peoplevine.com/pos/refund?auth_id=...&company=...&user=...&pass=...&host=...&transaction_id=

PartametherDescription

auth_id

Peoplevine integration account ID

company

Peoplevine company ID

user

Peoplevine user name

pass

Peoplevine user password

host

Optional. Values: region 1(default), region 2(UK)

transaction_id

Peoplevine payment ID

Response

Successfull response

{
    "success": true,
    "reason": null,
    "message": null
}

Cancel Order

With this method you can cancel an order.

Request

POST https://connect.peoplevine.com/pos/cancel_order?auth_id=...&company=...&user=...&pass=...&host=...&transaction_id=

ParametherDescription

auth_id

Peoplevine integration account ID

company

Peoplevine company ID

user

Peoplevine user name

pass

Peoplevine user password

host

Optional. Values: region 1(default), region 2(UK)

{
    "order_info": {
        "business_location_no": 160236,
        "external_order_no": "dcd5f3697ae047aba1d5c595386d408200023148",
        "customer_no": 3240923,
        "company_no": 1118,
        "order_no": 2847253
    }
}

Response

Successfull response:

{
    "success": true,
    "reason": null,
    "message": null
}

For more information view our swagger API at https://connect.peoplevine.com/pos

PreviousConnect Worldpay and PeoplevineNextPMS (Property Management)

Last updated