POS integration
by Vizulink

POS integration

Integrating Point of Sale into the rewards system
Operations
Search Purchases
GET /purchases
Submit Purchase
POST /purchases
Void Purchase
POST /purchases/{id}/cancel
Ad Hoc Return of Goods
POST /purchases/ad_hoc_return
Search Contacts
GET /contacts
Get Contact
GET /contacts/{id}
List Loyalty Identifiers
GET /contacts/{id}/loyalty_identifiers
Synchronise Products
POST /synchronise_products
Contact
Get Account Financials
GET /accounts/{id}/financials
Get Account Rewards
GET /accounts/{id}/rewards
Get Account Financials
GET /accounts/{id}/financials

Get a single account, along with its fiancial details

Path variables

id
string GUID required

The account identifier whose financial details will be retrieved

Example:
cdfd962b-e203-4c91-a2ba-12be3c669a53

Responses

200 200

OK

Body
application/json
Object
name
string

The account’s name

Example:
John Smith AC00123456
number
string

The account’s number

Example:
AC00123456
is_primary
boolean

Defines whether the account is the primary one of the contact

Example:
true
life_cycle_state
string

The account’s life cycle state

Enumeration:
ACTIVE
SUSPENDED
TERMINATED
currency_code
string

The account’s currency (3 code currency)

Example:
EUR
balance
number

The account’s calculated balance

Example:
200
overdue_amount
number

The unpaid amount that is passed its due date

Example:
100.5
credit_limit
number

The account’s credit limit

Example:
98
accounting_period_id
string GUID

The ID of the latest closed accounting period

Example:
CAD1E31269B76D7A65ACCE45B2E68DFD
accounting_period_name
string

The name of the account’s latest accounting period

Example:
OCTOBER2018
opening_balance
number

The opening balance brought forwards after the latest closed accounting period

Example:
100.5
classification
Object
id
string GUID

The unique identifier of the Account classification

Example:
CAD1E31269B76D7A65ACCE45B2E68DFD
name
string

The name of the Account classification

Example:
VIP
wallet
Array

The account’s wallet information (if available)

Object
id
string GUID

The wallet’s unique identifier

Example:
CAD1E31269B76D7A65ACCE45B2E68DFD
code
string

A unique 16-digit code that if not provided, it is auto-generated

Example:
W00123456
balance
number

The total balance of the wallet

Example:
150.5
commerce_balance
number

The commerce balance of the wallet

Example:
98
open_balance
number

The open balance of the wallet

life_cycle_state
string

The wallet’s life cycle state

Enumeration:
EFFECTIVE
CANCELLED
minimum_balance
number

The minimum wallet balance threshold. If not provided, the global rules apply

Example:
9
limit_rules
Array

Defines the limit rules applied on specific wallet. If not provided, the global rules apply

Object
minimum_amount
number

The minimum amount allowed

Example:
100.5
maximum_amount
number

The maximum amount allowed

Example:
200
period
string

The period for which the limit is applied

Enumeration:
DAILY
MONTHLY
ANNUAL
transaction_type
string

The wallet transaction type for which the limit is applied

Enumeration:
CREDIT
DEBIT
TOPUP
TRANSFER
auto_topup
Object

Details about auto-topup details

threshold
number

Sets the threshold for the auto topup to be performed

Example:
10.5
amount
number

The amount to get topped up

Example:
10.5
payment_method
string

Indicates the method of collecting money

Enumeration:
CASH
BANK_TRANSFER
CARD
DIRECT_DEBIT
WALLET
PAYPAL
ACCOUNT
payment_method_id
string

The contact’s actual preferred payment method. Required and mandatory only for online payments (Card, Wallet, PayPal and Account). Defaults to the primary payment method, if any.

billing_address
Object

Details about the billing address

id
string GUID

The address identifier

Example:
CAD1E31269B76D7A65ACCE45B2E68DFD
address_line_1
string

The address line 1

Example:
2265 Oak Street
address_line_2
string

The address line 2

Example:
n/a
state_province_county
string

The address state/province/county

Example:
New York
town_city
string

The address town/city

Example:
Old Forge
postal_code
string

The address postal code

Example:
13420
country_code
string

The address country code

Example:
USA
show more
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter

400 Unauthorized

The provided API Key or Token is invalid

400 Forbidden

The API key or Token does not have permissions to perform the request

400 Not Found

The requested resource does not exist

400 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request

400 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request

400 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance

400 Gateway Timeout

The server did not receive a timely response from the upstream server

Get Account Rewards
GET /accounts/{id}/rewards

Get a single account, along with its reward details

Path variables

id
string GUID required

The account identifier whose details will be retrieved

Example:
4AD9C84FA60F9FE407140E20F707726A

Responses

200 200

OK

Body
application/json
Object
id
string GUID

The account identifier

Example:
cdfd962b-e203-4c91-a2ba-12be3c669a53
name
string

The account’s name

Example:
John Smith AC00123456
number
string

The account’s number

Example:
AC00123456
currency_code
string

The account’s currency (3 code currency)

Example:
EUR
signed_up_on
integer epoch

The date when the account was signed up for the first time

Example:
1583846865
sign_up_organisation
Object

Information about the organisation that sign up the account for the first time

id
string GUID

The organisation identifier

Example:
CAD1E31269B76D7A65ACCE45B2E68DFD
name
string

The organisation name

Example:
CRMdotCOM
spending_blocked_status
boolean

Defines whether the account can spend or not

Example:
false
spending_blocked_date
integer epoch

The date that the spending status of the account was updated

Example:
1583846865
spending_blocked_user
Object

Information about the user that updated the spending status of the account

id
string GUID

The user identifier

Example:
CAD1E31269B76D7A65ACCE45B2E68DFD
email_address
string

The user’s email address

Example:
johndoe@crm.com
first_name
string

The user’s first name

Example:
John
last_name
string

The user’s last name

Example:
Doe
automatic_spend_settings
Object

Information about the automatic spend settings for the account

enable_automatic_spend
boolean

Defines whether automatic spend is enabled for the account

Example:
true
automatic_spend_preference
string

Defines whether automatic spends will occur on the next purchase of a specific merchant or based on wallet balance and purchase amount to a group of merchants

Enumeration:
NEXT_MERCHANT_PURCHASE
ALL_MERCHANT_PURCHASE
minimum_wallet_balance
number

The minimum wallet balance amount that should be available for the spend to be performed. Applicable when automatic spend preference is for all merchant purchases

Example:
0.52
from_purchase_amount
number

The min amount (inclusive) that the purchase customer event total amount should be in order for the automatic spend to be applied. Applicable when automatic spend preference is for all merchant purchases

Example:
1.78
merchants
Array

Information about the merchants that automatic spending is allowed

Object
id
string GUID

The merchant record identifier

Example:
REC1E31269B76D7A65ACCE45B2E68DFD
is_next_visit
boolean

Defines whether the merchant is setup for automatic spend on the next visit

Example:
false
organisation
Object

Information about organisation

id
string GUID

The organisation identifier

Example:
CAD1E31269B76D7A65ACCE45B2E68DFD
name
string

The organisation name

Example:
Bravo Coffee
reward_tier
Object

Information about the account’s reward tier

id
string

The reward tier identifier

Example:
CAD1E31269B76D7A65ACCE45B2E68DFD
name
string

The reward tier name

Example:
Gold
color
string

The designated hexadecimal code of the tier’s color

Example:
#d4af37
period_value_units
number

The account’s value units that accumulated during the last rolling period

Example:
222
lifetime_value_units
number

The account’s value units that accumulated overall

Example:
333
next_tier_progression
number

The progression percentage until the next reward tier is reached

Example:
45.98
joined_reward_schemes
Array

Information about the reward schemes that the account has signed up to

Object
id
string GUID

The reward scheme identifier

Example:
CAD1E31269B76D7A65ACCE45B2E68DFD
name
string

The reward scheme name

Example:
CRMdotCOM Scheme
signed_up_on
integer epoch

The date when the account was signed up on the specific reward scheme

Example:
1583846865
email_address
string

The email address that was used during sign up (applicable if the reward scheme is a close loop scheme based on email domains)

Example:
johndoe@crm.com
sign_up_option
string

Defines how customers can sign up to the reward scheme

Enumeration:
AUTO_SIGN_UP
SELF_SIGN_UP
CLOSE_LOOP_SIGN_UP
preferred_payment_method
Object

The customer’s preferred payment method identifier that will be used for spending purposes for back-end reduction rewards (applicable payment methods are direct debit and credit cards related)

id
string GUID

The preferred payment method identifier

Example:
CAD1E31269B76D7A65ACCE45B2E68DFD
payment_method_type
string

The customer’s preferred payment method identifier that will be used for spending purposes

Enumeration:
CARD
DIRECT_DEBIT
first6
string

The first six digits of the card (applicable only if the payment method type is card based)

Example:
424242
last4
string

The last four digits of the card (applicable only if the payment method type is card based)

Example:
4242
iban
string

The bank’s iban (applicable only if the payment method type is direct debit based)

Example:
CY3550000000054910000003
show more
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter

400 Unauthorized

The provided API Key or Token is invalid

400 Forbidden

The API key or Token does not have permissions to perform the request

400 Not Found

The requested resource does not exist

400 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request

400 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request

400 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance

400 Gateway Timeout

The server did not receive a timely response from the upstream server

Search Purchases
GET /purchases

A supplementary API that enables the POS agents to search through existing purchases, either based on contact or specific purchase attributes

Request parameters

contact_id
string optional

The contact identifier who performed the purchase

Example:
c89d3d40-ca73-4d99-8f96-ef51f66d55a7
reference_number
string optional

The purchase’s reference number

Example:
REF1234
from_date
integer epoch optional

The date from which the purchase was performed.If not specified, then the last 10 purchases will be returned

Example:
11591774402
to_date
integer epoch optional

The date until which the purchase was performed

Example:
11591774402
life_cycle_state
string optional

The life cycle state of the customer event

Enumeration:
POSTED
CANCELLED
organisation_id
string GUID optional

The organisation that the purchase customer event was performed

Example:
CEEE83D6E0804A30966F684B0269AD91
tap_id
string GUID optional

The transaction acquiring point that captured the customer event

Example:
CEEE83D6E0804A30966F684B0269AD91
from_total_amount
number optional

Filters customer events that have greater or equal total amount as specified

Example:
112.32
to_total_amount
number optional

Filters customer events that have less or equal total amount as specified

Example:
2112.32
sort
string optional

Defines on which attribute the results should be sorted

Enumeration:
CREATED_DATE
UPDATED_DATE
order
string optional

Defines how the results will be ordered

Enumeration:
ASC
DESC
page
integer optional

The page number that should be retrieved

Example:
1
size
integer optional

The size (total records) of each page

Example:
14

Responses

200 200

The request has succeeded

Body
application/json
Object
content
Array
Object
id
string GUID

The purchase identifier (POS based)

Example:
CEEE83D6E0804A30966F684B0269AD91
reference_number
string

The purchase unique referene number (can be the same as the POS based identifier or a unique transaction number if it’s supported)

Example:
REF1234
contact
Object

Contact details

id
string GUID

The contact identifier

Example:
CAD1E31269B76D7A65ACCE45B2E68DFD
name
string

The contact full name

Example:
John Doe
code
string

The contact code

Example:
CO1234
account
Object

Account details

id
string GUID

The account identifier

Example:
CEEE83D6E0804A30966F684B0269AD91
name
string

The account name

Example:
ACR1234 John Doe
number
string

The account number

Example:
ACR1234
life_cycle_state
string

The purchase’s life cycle state

Example:
POSTED
reduction_method
string

The reduction method that was applied on the related spend

Example:
BACK_END
classification
Object

The purchase event’s classification details

id
string GUID

The classification identifier

Example:
CAD1E31269B76D7A65ACCE45B2E68DFD
name
string

The classification name

Example:
Delivery
total_net_amount
number

The purchase’s total net amount of all products’ net amount

Example:
1.51
total_tax_amount
number

The purchase’s total tax amount of all products’ tax amount

Example:
0.49
discount_amount
number

The purchase’s discount amount

Example:
1
total_amount
number

The purchase’s total amount after discount

Example:
1
organisation
Object

The organisation details at which the purchase was performed

id
string GUID

The organisation identifier at which the purchase was performed

Example:
CEEE83D6E0804A30966F684B0269AD91
name
string

The organisation name at which the purchase was performed

Example:
Bravo Coffee
performed_on
integer epoch

The date on which the purchase was performed

Example:
1576486645
paging
pages
show more
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter

400 Unauthorized

The provided API Key or Token is invalid

400 Forbidden

The API key or Token does not have permissions to perform the request

400 Not Found

The requested resource does not exist

400 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request

400 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request

400 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance

400 Gateway Timeout

The server did not receive a timely response from the upstream server

Submit Purchase
POST /purchases

Create a purchase customer event into CRM.COM (in posted state) based on the submitted POS purchase transaction

Request body

application/json
Object
id
string GUID

The purchase Identifier (POS based)

Example:
CEEE83D6E0804A30966F684B0269AD91
contact_id
string GUID required

The contact identifier that the purchase is created for (customer identification can be made either using contact_ud or cim)

Example:
3b6c40fb-1444-4719-bad0-0fbc30fa704a
cim
string required

The value for a single contact identification medium representing the customer that the purchase is created for (customer identification can be made either using contact_ud or cim)

Example:
4A30966F684B0269AD91
contact_token
string

The OTP token that will identify the contact who requested to spend (applicable on Customer Self Service Identification/Spend)

Example:
123456
reference_number
string required

The purchase unique referene number (can be the same as the POS based identifier or a unique transaction number if it’s supported)

Example:
RF000001
payment_medium_identifier
string

The unique identifier of the payment medium used in the purchase (e.g. the first 8 digits of a credit card)

Example:
42424242
performed_on
integer epoch

The date that the customer event was performed (if not specified, default to date of posting such purchase)

Example:
1572423477
reduction_method
string required

Defines the reduction method that will be applied on spend

Enumeration:
FRONT_END
BACK_END
products
Array required

The purchased products (either products object or explicit net/tax/total amounts should be provided)

Object
product_sku
string required

The purchased product sku family (either product sku or product famly should be speciifed)

Example:
FREDESPR001
product_name
string

The purchased product name (will be used on online product sync)

Example:
Freddo Espresso
product_family
string required

The purchase product family (either product sku or product famly should be speciifed)

Example:
Chocolates
net_amount
number required

The purchased product net amount

Example:
14.15
tax_amount
number required

The purchased product vat amount

Example:
1.04
total_amount
number required

The purchased product total amount (net and vat amount)

Example:
15.19
quantity
integer

The purchased product quantity

Example:
2
spend_request
Object

Information related with the ad-hoc spend request that should be created as part of the purchase

amount
number required

The amount to be spent by the specified spend request in system currency

Example:
2.12
merchant_tap
Object required

Details about the merchant’s point on which the purchase is made

id
string GUID required

The merchant transaction acquiring point identifier (either tap id or code should be provided)

Example:
CEEE83D6E0804A30966F684B0269AD91
code
string required

The merchant transaction acquiring point code (either tap id or code should be provided)

Example:
TAP001
outlet_tap
Object required

Details about the merchant’s outlet point on which the purchase is made

id
string GUID required

The outlet transaction acquiring point identifier (either tap id or code should be provided)

Example:
CEEE83D6E0804A30966F684B0269AD91
code
string required

The outlet transaction acquiring point code (either tap id or code should be provided)

Example:
8269
discount_amount
number

The discount of the purchase

Example:
1.56
net_amount
number required

The purchase net amount. Applicable when no products (sku/family) are provided

tax_amount
number required

The purchase tax amount. Applicable when no products (sku/family) are provided

total_amount
number required

The purchase total amount (net + tax - discount). Applicable when no products (sku/family) are provided

classification
Object

Details about the customer event classification

id
string GUID required

The customer event classification identifier

Example:
c8d83493-3f50-40df-adb0-762ec5f41863
name
string required

The customer event classification name

Example:
Delivery Purchase
pass
Object

Details about the pass

code
string required

The pass code

Example:
1231231231231231
otp
string

The pass one time password (if applicable)

Example:
2345
show more

Responses

200 200

The request has succeeded

Body
application/json
Object
id
string GUID

The purchase identifier

Example:
ccca2889-301b-40ad-aed9-9c3a78e6e50b
reference_number
string

The purchase reference number (applicable only for Front-End Reduction)

Example:
RF123
total_award
number

The total award amount (applicable only for Front-End Reduction)

Example:
1.4
total_spend
number

The sum of all spends (instant discount, auto spends, spends on request). Applicable only for Front End Reduction

Example:
2.21
instant_discount
number

The spend related to instant discount. Applicable only for Front End Reduction

Example:
0.21
auto_spend
number

The spend related to auto spend requests. Applicable only for Front End Reduction

Example:
1.51
spend_on_request
number

The actual spend related to requested spend requests. Applicable only for Front End Reduction

Example:
0.49
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter

400 Unauthorized

The provided API Key or Token is invalid

400 Forbidden

The API key or Token does not have permissions to perform the request

400 Not Found

The requested resource does not exist

400 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request

400 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request

400 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance

400 Gateway Timeout

The server did not receive a timely response from the upstream server

Void Purchase
POST /purchases/{id}/cancel

Cancel an existing customer’s purchase and as a result any related awards/spends will be reversed

Path variables

id
string GUID required

The purchase identifier (POS based) that will be cancelled

Example:
ccca2889-301b-40ad-aed9-9c3a78e6e50b

Responses

200 200

The request has succeeded

Body
application/json
Object
id
string GUID

The purchase identifier

Example:
ccca2889-301b-40ad-aed9-9c3a78e6e50b
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter

400 Unauthorized

The provided API Key or Token is invalid

400 Forbidden

The API key or Token does not have permissions to perform the request

400 Not Found

The requested resource does not exist

400 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request

400 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request

400 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance

400 Gateway Timeout

The server did not receive a timely response from the upstream server

Ad Hoc Return of Goods
POST /purchases/ad_hoc_return

Performs an ad hoc return of goods for a speciifc customer

Request body

application/json
Object
contact_id
string GUID required

The contact id that the customer event is created for (either contact_id or cim must be specified)

Example:
CEEE83D6E0804A30966F684B0269AD91
cim
string required

The value for a single contact identification medium representing the customer event is created for (either contact_id or cim must be specified)

Example:
4A30966F684B0269AD91
currency_code
string

The currency code

Example:
EUR
amount
number required

The amount (real currency) of purchased goods that are returned

Example:
14.56
merchant_tap
Object required

Details about the merchant that submits such transaction (either id or code should be specified)

id
string GUID

The organisation (business/merchant) tap identifier

Example:
CEEE83D6E0804A30966F684B0269AD90
code
string

The organisation (business/merchant) tap code

Example:
EK123456
outlet_tap
Object required

Details about the venue that submits such transaction (either id or code should be specified)

id
string GUID required

The organisation (venue) tap identifier

Example:
CEEE83D6E0804A30966F684B0269AD91
code
string required

The organisation (venue) tap code

Example:
CD123456
show more

Responses

200 200

The request has succeeded

Body
application/json
Object
id
string GUID

The purchase identifier that ad hoc return of goods is applied

Example:
ccca2889-301b-40ad-aed9-9c3a78e6e50b
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter

400 Unauthorized

The provided API Key or Token is invalid

400 Forbidden

The API key or Token does not have permissions to perform the request

400 Not Found

The requested resource does not exist

400 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request

400 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request

400 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance

400 Gateway Timeout

The server did not receive a timely response from the upstream server

Search Contacts
GET /contacts

A supplementary API that enables the POS agents to search through existing contacts

Request parameters

search_value
string optional

The value of the search across Full Name, Company Name and Contact Code (case insensitive)

Example:
99542899
email_address
string optional

The contact’s email address

Example:
info@crm.com
phone_number
string optional

The contact’s phone number

Example:
0035722265566
code
string optional

The contact’s unique code

Example:
C0123456
loyalty_identifier
string optional

The contact’s loyalty identifier

Example:
12345974159
cim
string optional

The customer identification medium

Example:
123456
registered_from
integer epoch optional

The date from which the contact was registered

Example:
11591778885
registered_to
integer epoch optional

The date unitl which the contact was registered

Example:
11591778885
owned_by
string GUID optional

The unique identifier of the organisation that owns the contact

Example:
18044cbe-f9a4-4201-8c0a-4f731f31f41d
metrics
string optional

Defines the additional metrics to be retrieved in the response (comma separated)

Example:
SUBSCRIPTIONS, SCHEMES
include_financials
boolean optional

If set to true then information about the primary account and wallet will be also retrieved

Example:
true
sort
string optional

Defines on which attribute the results should be sorted

Enumeration:
CREATED_DATE
UPDATED_DATE
order
string optional

Defines how the results will be ordered

Enumeration:
ASC
DESC
page
integer optional

The page number that should be retrieved

Example:
1
size
integer optional

The size (total records) of each page

Example:
14

Responses

200 200

The request has succeeded

Body
application/json
Object
content
Array
Object
id
string GUID

The contact identifier

Example:
CAD1E31269B76D7A65ACCE45B2E68DFD
code
string

The contact code

Example:
ABC-123
contact_type
string

The contact type

Enumeration:
PERSON
COMPANY
contact_name
string

The contact full name

Example:
John CRM Doe
statutory_number
string

The contact statutory number

Example:
EF00001231
registered_on
integer epoch

The date on which the contact was registered

Example:
1591778719
category
Object

Details about contact category

id
string GUID

The category identifier

Example:
CAD1E31269B76D7A65ACCE45B2E68DFD
name
string

The category name

Example:
VIP
email_address
string

The contact’s email address

Example:
johndoe@crm.com
phones
Array

Details about contact phones

Object
id
string GUID

The phone identifier

Example:
60bcca96-4965-4d56-8341-cb6f5ae61803
phone_type
string

The phone type

Enumeration:
LANDLINE
MOBILE
FAX
is_primary
string

Defines whether the phone is the primary one

Example:
true
country_code
string

The phone country code on which is registered

Example:
357
number
string

The phone number

Example:
99999999
addresses
Array

Details about contact addresses

Object
id
string GUID

The address identifier

Example:
60bcca96-4965-4d56-8341-cb6f5ae61803
address_type
string

The address type

Enumeration:
HOME
BUSINESS
is_primary
boolean

Defines whether the address is the primary one

Example:
true
address_line_1
string

The address line 1

Example:
Elia Papakyriakou
address_line_2
string

The address line 2

Example:
7 Stars Tower
state_province_county
string

The address county

Example:
Egkomi
town_city
string

The address town

Example:
Nicosia
postal_code
string

The address postal code

Example:
2000
country
string

The address country

Example:
CYP
financials
Object

Details about the contact’s financials

account
Object

Details about the contact’s account

id
string GUID

The account identifier

Example:
CAD1E31269B76D7A65ACCE45B2E68DFD
number
string

The account number

Example:
AR123
life_cycle_state
string

The account state

Example:
SUSPENDED
currency_code
string

The account’s currency code

Example:
EUR
overdue_amount
integer

The account’s overdue amount

Example:
1
balance
integer

The account’s balance

Example:
200
wallet
Object

Details about the contact’s wallet

id
string GUID

The wallet identifier

Example:
CAD1E31269B76D7A65ACCE45B2E68DFD
code
string

The wallet code

Example:
W132
life_cycle_state
string

The wallet state

Example:
ACTIVE
balance
integer

The wallet’s balance (in real currency)

Example:
200
wallet_currency_code
string

The wallet’s balance currency code (real currecy)

Example:
EUR
interaction_status
string

The contact’s interaction status

Enumeration:
OPERATIONAL
NEVER_OPERATIONAL
RESTING
DORMANT
metrics
Object

The contact’s metrics

subscriptions
Object

Details about the contact’s subscriptions

timestamp
integer epoch

Defaults to current timestamp

Example:
1589791784
total
integer

The total number of subscriptions

Example:
2
schemes
Object

Details about the contact’s joined schemes

timestamp
integer epoch

Defaults to current timestamp

Example:
1589791784
total
integer

The total number of schemes that the customer joined

Example:
2
loyalty_identifiers
Array

The contact’s loyalty identifiers (cards)

Object
id
string GUID

The unique identifier of the loyalty identifier (CIM)

Example:
e172cdd1-41f4-47ec-717e-2c3733afb19f
identifier
string

The loyalty identifier

Example:
1478521478521
paging
pages
show more
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter

400 Unauthorized

The provided API Key or Token is invalid

400 Forbidden

The API key or Token does not have permissions to perform the request

400 Not Found

The requested resource does not exist

400 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request

400 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request

400 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance

400 Gateway Timeout

The server did not receive a timely response from the upstream server

Get Contact
GET /contacts/{id}

Get details for a specific contact

Path variables

id
string GUID required

The contact identifier that should be returned

Example:
CAD1E31269B76D7A65ACCE45B2E68DFD

Responses

200 200

The request has succeeded

Body
application/json
Object
id
string GUID

The contact identifier

Example:
CAD1E31269B76D7A65ACCE45B2E68DFD
code
string

The contact’s unique code

Example:
ABC-123
contact_type
string

Type of contact support types include Person and Company.

Enumeration:
PERSON
COMPANY
company_name
string

The name of the company if the contact type is COMPANY

Example:
Louis Kozior
title
string

The title of the contact. Applicable only if the type is PERSON

Example:
Sir
first_name
string

The first name of the contact. Applicable and mandatory only if the type is PERSON

Example:
Louis
middle_name
string

The middle name of the contact. Applicable and mandatory only if the type is PERSON

Example:
Aloz
last_name
string

The last name of the contact. Applicable and mandatory only if the type is PERSON

Example:
Kozior
contact_name
string

The full name of the Contact taking into consideration the name display settings

Example:
Louis Aloz Kozior
email_address
string

The contact’s email

Example:
bill@gmail.com
loyalty_identifier
string

The contact loyalty identifier

Example:
1234567891234
preferred_language_code
string

The contact’s preferred language for communication

Example:
ENG
notes
string

Notes for the contact

Example:
Notes
statutory_number
string

The contact’s unique statutory code

Example:
EF-12345
is_tax_exempt
boolean

Defines whether the contact is Tax Exempt or not

Example:
true
category
Object

Details about the contact category

id
string GUID

The category identifier

Example:
8a317250-8076-24ea-6fa3-63812679e552
name
string

The category name

Example:
Category A
demographics
Object

Details about the contact’s dmographic information (applicable for PERSON contects)

gender
string

The contact gender

Example:
FEMALE
country_of_residence
string

The contact’s country of residence

Example:
CY
passport
Object

Details about the contact’s passport

passport_number
string

The passport number

Example:
PASS1234
issue_country_code
string

The issue country for the passport

Example:
GRC
expiration_date
integer epoch

The expiration date for the passport

Example:
129876567
id_details
Object

Details about the ID (applicable for PERSON contects)

id_number
string

The ID number

Example:
ID1234
issue_country_code
string

The country that issued such ID

Example:
CYP
expiration_date
integer epoch

The expiration date for the ID

Example:
129876567
name_day
Object

Details about the contact nameday (applicable for PERSON contects)

month
integer

The nameday month

Example:
10
day
integer

The nameday day

Example:
4
date_of_birth
Object

Details about the contact birthday (applicable for PERSON contects)

year
integer

The year of birth

Example:
2018
month
integer

The month of birth

Example:
10
day
string

The day of birth

Example:
16
addresses
Array

Details about the addresses

Object
id
string GUID

The address identifier

Example:
52e2dc4c-3dc1-8ceb-6a15-f1f1b82aed87
address_type
string

The address type

Enumeration:
HOME
BUSINESS
is_primary
boolean

Defines whether the address is primary or not

Example:
true
care_of
string

The address of care of

address_line_1
string

The address line 1

Example:
Elia Papakyriakou 7
address_line_2
string

The address line 2

Example:
Thomas V
state_province_county
string

The address state/province/county

Example:
Active
town_city
string

The address town/city

Example:
Nicosia
postal_code
string

The address postal code

Example:
2415
country
string

The address country

Example:
CYP
lat
number

The latitude of the address

Example:
35.157115
lon
number

The longitude of the address

Example:
33.313719
googlePlaceId
string

The Google textual identifier that uniquely identifies an address

Example:
ChIJrTLr-GyuEmsRBfy61i59si0
phones
Array

Details about the phones

Object
id
string GUID

The phone identifier

Example:
52e2dc4c-3dc1-8ceb-6a15-f1f1b82aed87
phone_type
string

The phone type

Enumeration:
LANDLINE
MOBILE
FAX
is_primary
boolean

Defines whether the phone is the primary one

Example:
true
country_code
string

The phone country code

Example:
44
number
string

The phone number

Example:
238065437
consent_state
string

The contact’s consent state

Enumeration:
PENDING
REJECTED
ACCEPTED
WITHDRAWN
is_anonymized
boolean

Defines whether the contact is anonymized

interaction_status
string enum

The contact’s interaction status, retrieved from REDIS

Example:
OPERATIONAL
total_spend
string

The contact’s total spend amount in the last 12 months, retrieved from REDIS

Example:
250
sms_opt_out
boolean

Defines whether the SMS communication will be opt out

Example:
true
email_opt_out
boolean

Defines whether the EMAIL communication will be opt out

Example:
true
kyc_profile
Object

Details about the KYC profile

id
string GUID

The KYC profile identifier

Example:
CAD1E31269B76D7A65ACCE45B2E68DFD
name
string

The name of the KYC profile

Example:
Standard
kyc_status
string

The status of the KYC profile assigned to Contact

Enumeration:
PENDING
VERIFIED
referral_code
string

The contact referral code

Example:
REF123
loyalty_identifiers
Array
Object
id
string GUID

The unique identifier of the loyalty identifier (CIM)

Example:
RTGFYHUJIKHYTRF
identifier
string

The loyalty identifier

Example:
5642456765432
custom_fields
custom_fields
show more
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter

400 Unauthorized

The provided API Key or Token is invalid

400 Forbidden

The API key or Token does not have permissions to perform the request

400 Not Found

The requested resource does not exist

400 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request

400 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request

400 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance

400 Gateway Timeout

The server did not receive a timely response from the upstream server

List Loyalty Identifiers
GET /contacts/{id}/loyalty_identifiers

Retrieve the loyalty identifiers for a specific contact

Path variables

id
string GUID required

The contact identifier that should be returned

Example:
CAD1E31269B76D7A65ACCE45B2E68DFD

Responses

200 200

The request has succeeded

Body
application/json
Object
content
Array
Object
id
string GUID

The unique identifier of the loyalty identifier (CIM)

Example:
1adaae9e-6dbb-f389-e5d0-8288f0c87a62
identifier
string

The loyalty identifier of the customer

Example:
2143454566754
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter

400 Unauthorized

The provided API Key or Token is invalid

400 Forbidden

The API key or Token does not have permissions to perform the request

400 Not Found

The requested resource does not exist

400 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request

400 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request

400 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance

400 Gateway Timeout

The server did not receive a timely response from the upstream server

Synchronise Products
POST /synchronise_products

Performs product synchornization between the products that exist in the POS system over to CRM.COM

Request body

application/json
Object
products
Array

Details about the products to synchornise

Object
sku
string required

The product sku

Example:
IL001
name
string

The product name

Example:
Iced Latte
description
string

The product description

Example:
Cold Brew Latte
type
Object

The product type (if type is provided, id or name should be specified)

id
string GUID required

The product type identifier

Example:
0c2582d9-6f5c-4477-86f5-74e2055b941d
name
string required

The product type name

Example:
Non-traceable goods
brand
Object

Details about the product brand (if brand is provided, id or name should be specified)

id
string GUID required

The product brand identifier

Example:
0c2582d9-6f5c-4477-86f5-74e2055b941d
name
string required

The product brand name

Example:
Brew Ltd
family
Object

Details about the product family (if family is provided, id or name should be specified)

id
string GUID required

The product family identifier

Example:
0c2582d9-6f5c-4477-86f5-74e2055b941d
name
string required

The product family name

Example:
Cold Coffee
categories
Array

Details about the product categories (for each provided category, id or name or code should be specified)

Object
id
string GUID required

The product category identifier

Example:
c4f611aa-eb51-9857-0e15-c1176ea3ade1
name
string required

The product category name

Example:
Milks
code
string required

The product category code

Example:
500
validity_period
Object

Defines the period that the product will be valid (if not specified, will be always valid)

from_date
integer epoch

The date from which the product will be valid

Example:
1
to_date
integer epoch

The date up to which the product will be valid

Example:
1
tax_rate
Object

Details about the product tax rate

id
string GUID

The tax rate identifier

Example:
0c2582d9-6f5c-4477-86f5-74e2055b941d
name
string

The tax rate name

pricing
pricing-request
variant_attributes
Array

Details about the product variant attributess

Object
key
string required

The variant key

Example:
size
value
string required

The variant value

Example:
medium
components
Array

Details about the product components

Object
sku
string required

The component product sku that will be used as component (sku or family, category or product type should be specified)

Example:
CPSKU01
product_family
Object

The component product family that will be used as component (sku or family, category or product type should be specified)

id
string GUID required

The product family identifer (id or name should be specified)

Example:
dd513fea-85dc-2bf1-dcab-2288c539f034
name
string

The product family name (id or name should be specified)

Example:
Extras
product_type
Object

The component product type that will be used as component (sku or family, category or product type should be specified)

id
string GUID required

The product type identifer (id or name should be specified)

Example:
dd513fea-85dc-2bf1-dcab-2288c539f034
name
string

The product type name (id or name should be specified)

Example:
Dry
product_category
Object

The component product category that will be used as component (sku or family, category or product type should be specified)

id
string GUID required

The product category identifer (id, name or codeshould be specified)

Example:
dd513fea-85dc-2bf1-dcab-2288c539f034
name
string

The product category name (id, name or codeshould be specified)

Example:
Milks
code
string

The product category code (id, name or codeshould be specified)

Example:
500
inclusive
boolean

Defines if pricing is inclusive

Example:
true
min_amount
integer

The minimum number of components that should be added (applicable only for product family and type)

Example:
1
max_amount
integer

The maximum number of components that should be added (applicable only for product family and type)

Example:
4
mandatory
boolean

Defines whether the component must be added to the product or not

Example:
true
classification
string

Defines the classification of the component

Enumeration:
ADDON
MODIFIER
creatives
creatives
main_product_sku
string required

The unique product sku of variant_attribute (required if the synced product is a variant attribute of another product)

Example:
SKU000A

Responses

200 200

The request has succeeded

Body
application/json
Object
id
string GUID

A unique identifier of the Web API call which can be used for triggering the webhook and relate the api request to the webhook request (enables integrator to match the api request with the webhook request).

Example:
a781bbc1-9067-c384-52fe-43586f89110a
400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter

400 Unauthorized

The provided API Key or Token is invalid

400 Forbidden

The API key or Token does not have permissions to perform the request

400 Not Found

The requested resource does not exist

400 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request

400 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request

400 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance

400 Gateway Timeout

The server did not receive a timely response from the upstream server

Parameters
order
string optional

Defines how the results will be ordered

Enumeration:
ASC
DESC
page
integer optional

The page number that should be retrieved

Example:
1
size
integer optional

The size (total records) of each page

Example:
14
sort
string optional

Defines on which attribute the results should be sorted

Enumeration:
CREATED_DATE
UPDATED_DATE
Type Definitions
Provision Order -using Webhooks

Order Provisioning to POS systems is achieved using CRM.COM Webhooks Adaptor (via CRM.COM Automations).

A webhook is an event notification method where an application (or a system) is provided with real time information for an order created in Vizulink without requiring an additional integration (the POS integrator is responsible to parse such order information in order to be able to perform POS operations).

Attached is the order details, send to a POS using a webhook

Object
type
string

The order event

Example:
CREATE_ORDER
submitted_date
integer epoch

The date that the event was submitted

Example:
11594205783
contact
Object

Details about the contact that placed the order

id
string GUID

The contact identifier

Example:
1866a75f-953e-4109-86b4-1cab53fbaaa8
code
string

The contact code

Example:
1234
name
string

The contact name

Example:
John Doe
financials
Object

Details about the account that placed the order

account
Object

Details about the customer’s account

id
string GUID

The account identifier

Example:
1e920b82-9f5e-4ab1-beab-e8dc92b5ee2e
name
string

The account name

Example:
AR132 John Doe
number
string

The account number

Example:
AR132
business
Object

Details about the business organisation

id
string GUID
Example:
3870f789-1a51-f454-def3-3e7e021f1136
name
string
subsidiary
Object

Details about subsidiary organisation

id
string GUID

The subsidiary organisation identifier

Example:
977e27af-0208-8abb-a195-f70d33c81633
name
string

The subsidiary organisation name

Example:
Delicious Bakery Cyprus
merchant
Object

Details about merchant organisation

id
string GUID

The merchant organisation identifier

Example:
36874a85-0b5b-ed40-1c06-f3181364f779
name
string

The merchant organisation name

Example:
Delicious Bakery
venue
Object

Details about venue organisation

id
string GUID

The venue organisation identifier

Example:
36874a85-0b5b-ed40-1c06-f3181364f772
name
string

The venue organisation name

Example:
Delicious Bakery Nicosia
location
Object

Details about the contact’s delivery address

address_line_1
string

Address line 1 details

Example:
Elia Papakyriakou
address_line_2
string

Address line 2 details

Example:
7 Tower Stars
city
string

Address town/city

Example:
Nicosia
postal_code
string

Address postal code

Example:
2000
country
string

Address country (code)

Example:
CY
transaction
Object

Details about the order transaction

id
string GUID

The order identifier

Example:
1866a75f-953e-4109-86b4-1cab53fbaaa8
number
string

The order number

Example:
ORDER1234
life_cycle_state
string

The order state

Example:
IN_PROGRESS
currency_code
string

The currency in which the order was made (3 code currency)

Example:
EUR
net_amount
number

The order’s net amount

Example:
5.99
tax_amount
number

The order’s tax amount

Example:
1.99
discount_amount
number

The order’s discount amount

Example:
0.99
total_amount
number

The order’s total amount

Example:
6.99
order
Object

Details about the order

id
string GUID

The order identifier

Example:
674f61a3-8bab-1fa4-d702-3bcbc1d40308
number
string

The order number

Example:
12345
life_cycle_state
string

The state of the order

Enumeration:
NEW
IN_PROGRESS
COMPLETED
CANCELLED
ON_HOLD
supply_method
string

Defines how the order will be supplied

Enumeration:
DELIVERY
PICK_UP
ON_SITE
category
Object

Details about the order’s category

id
string GUID

The category identifier

Example:
674f61a3-8bab-1fa4-d702-3bcbc1d40301
name
string

The category name

cancellation_reason
Object

Details about the order’s cancellation reason

id
string GUID

The cancellation reason identifier

Example:
974f61a3-8bab-1fa4-d702-3bcbc1d40308
name
string

The cancellation reason name

Example:
Ordered by mistake
notes
string

The order notes

Example:
No additional notes
submitted_date
integer epoch

The date that the order was submitted

estimated_fulfillment_date
integer epoch

The estimated date that the order will be fulfilled

Example:
1594204578
completed_date
integer epoch

The date that the order was completed

Example:
1594204578
cancelled_date
integer epoch

The date that the order was cancelled

Example:
1594204578
expiration_date
integer epoch

The date that the order was expired

Example:
1594204578
requested_date
integer epoch

The date that the order was requested

Example:
1594204578
is_favourite
boolean

Defines whether the order is the favourited one (for the customer)

Example:
true
total_cost
number

The total cost of the order

Example:
9.99
currency
string

The order’s currency

Example:
EUR
payment_method_details
Object

Details about the payment method

payment_method
string

The payment method

Example:
CARD
brand
string

The payment method brand

Example:
VISA
funding_type
string

The type of funding on which the payment is made against

Example:
Credit
currency_code
string

The currency in which the order was made (3 code currency)

Example:
EUR
amount
number

The payment amount

Example:
6.99
products
Array

Details about the ordered products

Object
id
string GUID

The product identifier

Example:
f2195f8f-eabc-823a-e579-0359ff2d9bba
sku
string

The product sku

Example:
FR1234
name
string

The product name

Example:
Freddo Espresso
notes
string

The product notes

Example:
No extra
type
Object

Details about the product type

id
string GUID

The product type identifier

Example:
49026369-afd7-5f0a-e055-595c981d0694
name
string

The product type name

Example:
Continents
brand
Object

Details about the product brand

id
string GUID

The product brand identifier

Example:
0b2e57fb-cc0e-5d65-a7a9-ff8526543b96
name
string

The product brand name

Example:
Coffee Lab97
family
Object

Details about the product family

id
string GUID

The product family identifier

Example:
0b2e57fb-cc0e-5d65-a7a9-ff8526543b92
name
string

The product family name

Example:
Coffee
category
Object

Details about the product category

id
string GUID

The product category identifier

Example:
0b2e57fb-cc0e-5d65-a7a9-ff8526543b22
name
string

The product category name

Example:
Drinks
quantity
integer

The ordered product quantity

Example:
1
net_amount
number

The ordered product net amount

Example:
1.99
tax_amount
number

The ordered product tax amount

Example:
0.99
discount_amount
number

The ordered product discount amount

Example:
0.99
amount
number

The ordered product total amount

Example:
1.99
bundle_products
Array

Details about the bundle products

Object
id
string GUID

The bundle product identifier

Example:
7936ab8a-c901-117f-bbee-3036d152430f
sku
string

The bundle product sku

Example:
NS123
name
string

The bundle product name

Example:
Full Sugar
show more
creatives

A creative is an object that contains all the data required for visually rendering an image responsively. The object contains the initial image and a number of scale versions of it (srcset)

Array
Object
id
string GUID

The creative identifier

Example:
CA123456789AQWSXZAQWS1236547896541
type
string

Information about the creative type

Enumeration:
ATTACHMENT
PROFILEIMAGE
MARKETING
width
integer

The creative width

Example:
2159
height
integer

The creative height

Example:
3075
format
string

The creative format

Example:
jpg
url
string

The creative content URL

Example:
https://assets.crm.com/image/logo.jpg
public_id
string

The creative public identifier

Example:
crm-com/image
media
Array

Information about the creative transformations

Object
width
integer

The transformed creative width

Example:
200
height
integer

The transformed creative height

Example:
300
url
string

The transformed creative URL

Example:
https://asset.crm.com/image/offer/c_scale,w_200/logo.jpg
custom_fields

Includes a list of custom fields whose values can be set on creating or updating entities

Array
Object
key
string

The custom field’s unique key

Example:
back_office
value
string

The custom field’s value

Example:
0001-12345
pages
Object
page
integer

The page number

Example:
2
size
integer

The number of records per page

Example:
20
total
integer

The overal number of records

Example:
5124
pricing-request

Details about the product pricing

Object
rate_model
string

The pricing rate model

Example:
FLAT
tax_model
string

The pricing tax model

Example:
TAX_INCLUSIVE
price
number

The price (amount)

Example:
9.99
currency
string

The price currency (3 code)

Example:
EUR
tiers
Array

Details about the pricing tiering (required for Tiered and Volume based rate models)

Object
lower_tier
integer required

The lowest tier

Example:
1
upper_tier
integer

The top tier

Example:
5
price
number required

The tier price (amount)

Example:
8.99
provisionorder

Order Provisioning to POS systems is achieved using CRM.COM Webhooks Adaptor (via CRM.COM Automations).

A webhook is an event notification method where an application (or a system) is provided with real time information for an order created in CRM.COM without requiring an additional integration (the POS integrator is responsible to parse such order information in order to be able to perform POS operations).

Attached is the order details, send to a POS using a webhook

Object
id
string GUID

The order identifier

Example:
1866a75f-953e-4109-86b4-1cab53fbaaa8
number
string

The order number

Example:
ORDER1234
life_cycle_state
string

The order state

Example:
IN_PROGRESS
notes
string

The order notes

Example:
Lorem Ipsum
number_of_milestones
integer

The order’s total number of milestones

Example:
1
supply_method
string

Defines how the order will be supplied

Enumeration:
DELIVERY
PICK_UP
ON_SITE
total_cost
number

The order’s total cost

Example:
5.99
currency
string

The currency in which the order was made (3 code currency)

Example:
EUR
is_favorite
boolean

Defines whether this order is the customer’s favourite one

Example:
true
contact
Object

Details about the contact that placed the order

id
string GUID

The contact identifier

Example:
1866a75f-953e-4109-86b4-1cab53fbaaa8
code
string

The contact code

Example:
1234
name
string

The contact name

Example:
John Doe
address
Object

Details about the contact’s address

address_line_1
string

Address line 1 details

Example:
Elia Papakyriakou
address_line_2
string

Address line 2 details

Example:
7 Tower Stars
state_province_county
string

Address state/province/county

Example:
Egkomi
town_city
string

Address town/city

Example:
Nicosia
postal_code
string

Address postal code

Example:
2000
country
string

Address country (code)

Example:
CY
category
Object

Details about the order’s category

id
string GUID

The category identifier

Example:
1866a75f-953e-4109-86b4-1cab53fbaaa8
name
string

The category name

Example:
Seasonal
cancellation_reason
Object

Details about the reason for cancelling the order

id
string GUID

The cancellation reason identifier

Example:
1866a75f-953e-4109-86b4-1cab53fbaaa8
name
string

The cancellation reasn name

Example:
Placed by mistake
fulfilled_by
Object

Details about who will fulfill the order

id
string GUID

The organisation identifier

Example:
1866a75f-953e-4109-86b4-1cab53fbaaa8
name
string

The organisation name

Example:
CRM Nicosia
assignee
Object

Details about the person/organisation that is responsible for the order

user
Object

Details about the user responible for the order

id
string GUID

The user identifier

Example:
1866a75f-953e-4109-86b4-1cab53fbaaa8
username
string

The user’s username

Example:
j_doe@crm.com
organisation
Object

Details about the organisation responsible for the order

id
string GUID

The organisation identifier

Example:
1866a75f-953e-4109-86b4-1cab53fbaaa8
name
string

The organisation name

Example:
CRM Nicosia
order_items
Array

Details about the ordered items

Object
id
string GUID

The order item identifier

Example:
1866a75f-953e-4109-86b4-1cab53fbaaa8
notes
string

The order item notes

Example:
Lorem Ipsum
life_cycle_state
string

The order item state

Example:
PENDING_DELIVERY
quantity
integer

The order item quantity

Example:
1
product
Object

Details about the ordered product

id
string GUID

The product identifier

Example:
1866a75f-953e-4109-86b4-1cab53fbaaa8
sku
string

The product sku

Example:
SKU1234
name
string

The product name

Example:
Iced Latte
quantity
integer

The product quantity

Example:
2
price
number

The product price

Example:
1.7
cost
number

The product cost

Example:
3.4
components
Array

Details about the product’s components

Object
id
string GUID

The component identifier

Example:
1866a75f-953e-4109-86b4-1cab53fbaaa8
sku
string

The component sku

Example:
B1234
name
string

The component name

Example:
Brown Sugar
quantity
integer

The component quantity

Example:
1
price
number

The component price

Example:
0.5
variants
Array

Details about the product variants

Object
key
string

The variant key

Example:
size
name
string

The variant name

Example:
Size
value
string

The variant value

Example:
Grande
key_dates
Object

Details about order’s key dates

submitted_on
integer epoch

The date that the order was submitted

Example:
1592809457
completed_on
integer epoch

The date that the order was completed

Example:
1592809457
cancelled_on
integer epoch

The date that the order was cancelled

Example:
1592809457
estimated_fulfillment_in
integer

The time in which the order is estimated to be fulfilled

Example:
30
estimated_fulfillment_UOT
string

The unit of time of which the order is estimated to be fulfilled

Example:
MINUTES
estimated_fulfillment
integer epoch

The date that the order is estimated to be fulfillment

Example:
1592809457
expires_on
integer epoch

The date that the order is estimated to be expired

Example:
1592809457
payment_milestones
Array

Details about the order’s payment milestones

Object
payment_method
string

The payment method

Example:
CARD
paid_on
string

Defines on which state of the milestone the payment will be made

Example:
ON_COMPLETE
posted_on
integer epoch

The date that the payment is posted

Example:
1234567
payment_method_details
Object

Details about the payment method

brand
string

The payment method brand

Example:
VISA
last4
integer

The last 4 digits of the payment method

Example:
1234
funding_type
string

The type of funding on which the payment is made against

Example:
Credit
invoice
Object

Details about the invoice

id
string GUID

The invoice identifier

Example:
1866a75f-953e-4109-86b4-1cab53fbaaa8
number
string

The invoice number

Example:
INV1234
payment
Object

Details about the payment

id
string GUID

The payment identifier

Example:
1866a75f-953e-4109-86b4-1cab53fbaaa8
number
string

The payment number

Example:
PAY1234
show more
Responses
400 Bad Gateway

The server received an invalid response from the upstream server it accessed in attempting to fulfill the request

400 Bad Request

The input request was invalid or incorrect, often due to missing a required parameter

400 Forbidden

The API key or Token does not have permissions to perform the request

400 Gateway Timeout

The server did not receive a timely response from the upstream server

400 Internal Server Error

The server encountered an unexpected condition which prevented it from fulfilling the request

400 Not Found

The requested resource does not exist

400 Service Unavailable

The server is currently unable to handle the request due to a temporary overloading or maintenance

400 Unauthorized

The provided API Key or Token is invalid