Lookup Contacts

get /lookup_contacts

Deprecated!

This node is called for systems using lookup services for prefilling a new contact with information from third party system. See CrmContact for fields.

key

string

query

Key for finding contact.

Returns an array with 1 item of type CrmContact or an empty array if no contact could be found using the lookup service.

crmcontact

[
  {
    "email": "",
    "membernumber": "",
    "namefirst": "Johan",
    "namelast": "Andersson",
    "personalid": "6308212817",
    "company": "",
    "companyid": "",
    "phone": "",
    "mobile": "",
    "invoice_address": "Storgatan 1",
    "invoice_address2": "",
    "invoice_zip": "12345",
    "invoice_city": "Varberg",
    "invoice_state": "",
    "invoice_countryid": "se",
    "delivery_address": "Storgatan 1",
    "delivery_address2": "",
    "delivery_zip": "12345",
    "delivery_city": "Varberg",
    "delivery_state": "",
    "delivery_countryid": "se",
    "gender": "male",
    "birthday": "1963-08-21T00:00:00Z",
    "accepts_email": true,
    "accepts_sms": true,
    "accepts_mail": true,
    "acceptedconsents": [
      "1",
      "2"
    ],
    "voucherpasswords": [],
    "storeexternalid": null
  }
]

HTTP Status Code Summary
200	Returns an array with 1 item of type CrmContact or an empty array if no contact could be found using the lookup service.
400	Bad Request. Invalid syntax, missing required argument or invalid request.
401	Unauthorized. Authorization failed.
404	Resource not found. The url is invalid.
500	Internal Server Error.

Objects

crmbonuscheck
object

bonuscheckid

string

ID of the bonus check

name

string

Name displayed for the bonus check

description

string

Description of the bonus check

cartamount

money

The amount value of the bonus check

redeemed

boolean

Boolean value indicating if the bonus check has been redeemed

dateredeemed

integer

Optional. Timestamp indicating when the bonus check was redeemed

crmcontact
object

contactid

string

READ ONLY

ID of the contact.

membernumber

string

Member Number for the contact. (This field is used to represent the customer on purchase receipts)

string

Email for the contact.

namefirst

string

First Name of the contact.

namelast

string

Last Name of the contact.

personalid

string

Social Security Number (SSN) for the contact.

company

string

Company for the contact.

companyid

string

Company ID for the contact.

phone

string

Phone Number for the contact.

mobile

string

Mobile Phone number for the contact.

invoice_address

string

Address for the contact (invoice).

invoice_address2

string

Address line 2 for the contact (invoice).

invoice_zip

string

Zip Code for the contact (invoice).

invoice_city

string

City for the contact (invoice).

invoice_state

string

State/Region for the contact (invoice).

invoice_countryid

string

2 character country code according to ISO 3166-1 standard for the contact (invoice).

delivery_address

string

Address for the contact (delivery).

delivery_address2

string

Address line 2 for the contact (delivery).

delivery_zip

string

Zip Code for the contact (delivery).

delivery_city

string

City for the contact (delivery).

delivery_state

string

State/Region for the contact (delivery).

delivery_countryid

string

2 character country code according to ISO 3166-1 standard for the contact (delivery).

gender

Optional. Enumerated value for gender of the contact.

birthday

string

Optional. Date of birth for the contact in ISO 8601 format.

accepts_email

boolean

Boolean value indicating if contact accepts communication via email.

accepts_sms

boolean

Boolean value indicating if contact accepts communication via text messaging (SMS).

accepts_mail

boolean

Boolean value indicating if contact accepts communication via postal service.

acceptedconsents

array

(string)

Array of accepted consents (consentid) for the contact.

status_color

Extended. Optional. Enumerated value indicating status color for the contact.

status_text

string

Extended. Optional. Status Text for the contact.

promotions

array

(crmpromotion)

Extended. Optional. Array of CrmPromotion for the contact.

bonuschecks

array

(crmbonuscheck)

Extended. Optional. Array of CrmBonusCheck for the contact.

transactions

array

(crmtransaction)

Extended. Optional. Array of CrmTransaction for the contact.

voucherpasswords

array

(string)

Optional. Associated voucher passwords, used to activate campaigns for contact in Sitoo POS.

storeexternalid

string

Optional. Store External ID from where the contact was created.

crmpromotion
object

promotionid

string

ID of the promotion.

promotiontype

Enumerated value for type of promotion.

name

string

Name of the promotion.

description

string

Description of the promotion.

redeemed

boolean

Boolean value indicating if the promotion has been redeemed

dateredeemed

integer

Optional. Timestamp indicating when the promotion was redeemed

crmtransaction
object

transactionid

string

READ ONLY

ID of the transaction.

receiptid

string

Optional. Sitoo Receipt ID for the transaction. (If set, then can be used to perform refund in Sitoo POS)

orderid

integer

Optional. Sitoo Order ID for the transaction. (If set, then can be used to perform refund in Sitoo POS)

orderexternalid

string

Optional. Sitoo Order External ID for the transaction. (If set, then can be used to perform refund in Sitoo POS)

datecreated

integer

Timestamp for when the transaction was created.

storeid

string

Store ID for the transaction.

storename

string

Store Name for the transaction.

storeexternalid

string

Optional. Store External ID for the transaction.

posid

string

Optional. POS ID for the transaction.

roundoff

money

Optional. Round Off for the transaction.

items

array

(crmtransactionitem)

Items in this transaction. Array of CrmTransactionItem.

payments

array

(crmtransactionpayment)

Payments for this transaction. Array of CrmTransactionPayment.

redeemedpromotions

array

(string)

Optional. Array with ID for promotions used in this transaction.

redeemedbonuschecks

array

(string)

Optional. Array with ID for bonus checks used in this transaction.

currencycode

string

Optional. Currency used for this transaction (3-letter ISO 4217).

crmtransactionitem
object

itemid

string

ID of transaction item.

sku

string

Stock Keeping Unit (SKU) for transaction item.

productname

string

Title row 1 for transaction item.

productname2

string

Optional. Title row 2 for transaction item.

note

string

Optional. Note for transaction item.

productgroupname

string

Name of product group for transaction item.

brand

string

Optional. Brand for transaction item.

custom1

string

Optional. Custom field 1 for transaction item.

custom2

string

Optional. Custom field 2 for transaction item.

custom3

string

Optional. Custom field 3 for transaction item.

custom4

string

Optional. Custom field 4 for transaction item.

custom5

string

Optional. Custom field 5 for transaction item.

vatvalue

number

VAT percentage for transaction item.

total

money

Total amount for item incl VAT (before applying manual discount and discounts)

vat

money

VAT amount for total.

manual_discount

money

Manual discount incl VAT

manual_discountvat

money

VAT amount for manual discount

manual_discountname

string

Optional. Name provided for manual discount

quantity

integer

Quantity for transaction item.

unitsize

decimalquantity

Optional. Unit Size (How much that is included in each unit).

unitlabel

string

Optional. Label for unit of transaction item. (e.g. kg)

discounts

array

(crmtransactionitemdiscount)

Array of CrmTransactionItemDiscount.

crmtransactionitemdiscount
object

name

string

Name of discount.

total

money

Discount incl VAT.

vat

money

VAT included in discount.

discountid

string

Optional. ID of discount.

discountcode

string

Optional. Code for discount.

crmtransactionpayment
object

paymentid

string

ID of the payment.

name

string

Name of the payment.

total

money

Amount for the payment.

decimalquantity

gender
string

female Female
male Male
undisclosed Undisclosed

money
string

Pattern: ^[-+]?[0-9]+\.[0-9]{2}$

Example: "123.00"

promotiontype
object

The type of promotion

oneOf:

promotiontypecartamount
object

type

string

REQUIRED

The type of this promotion.

VALUES
cart_amount

value_money

money

REQUIRED

Cart amount to discount.

promotiontypecartpercent
object

type

string

REQUIRED

The type of this promotion.

VALUES
cart_percent

value_int

integer

REQUIRED

Percent to discount.

Minimum: 1

Maximum: 100

promotiontypemanual
object

type

string

REQUIRED

The type of this promotion.

VALUES
manual

promotiontypeoffer
object

type

string

REQUIRED

The type of this promotion.

VALUES
offer

value_string

string

REQUIRED

Voucher password that can enable campaigns that already exist in the Sitoo Platform.

status_color
string

green Green
orange Orange
red Red

Lookup Contacts

Lookup Contacts

Objects

crmbonuscheckobject

crmcontactobject

crmpromotionobject

crmtransactionobject

crmtransactionitemobject

crmtransactionitemdiscountobject

crmtransactionpaymentobject

decimalquantity

genderstring

moneystring

promotiontypeobject

promotiontypecartamountobject

promotiontypecartpercentobject

promotiontypemanualobject

promotiontypeofferobject

status_colorstring

crmbonuscheck
object

crmcontact
object

crmpromotion
object

crmtransaction
object

crmtransactionitem
object

crmtransactionitemdiscount
object

crmtransactionpayment
object

gender
string

money
string

promotiontype
object

promotiontypecartamount
object

promotiontypecartpercent
object

promotiontypemanual
object

promotiontypeoffer
object

status_color
string